babylon.module.d.ts 6.6 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703155704155705155706155707155708155709155710155711155712155713155714155715155716155717155718155719155720155721155722155723155724155725155726155727155728155729155730155731155732155733155734155735155736155737155738155739155740155741155742155743155744155745155746155747155748155749155750155751155752155753155754155755155756155757155758155759155760155761155762155763155764155765155766155767155768155769155770155771155772155773
  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. /** @hidden */
  16447. _waitingOverrideMeshId: Nullable<string>;
  16448. /**
  16449. * Specifies if the skeleton should be serialized
  16450. */
  16451. doNotSerialize: boolean;
  16452. private _useTextureToStoreBoneMatrices;
  16453. /**
  16454. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16455. * Please note that this option is not available if the hardware does not support it
  16456. */
  16457. get useTextureToStoreBoneMatrices(): boolean;
  16458. set useTextureToStoreBoneMatrices(value: boolean);
  16459. private _animationPropertiesOverride;
  16460. /**
  16461. * Gets or sets the animation properties override
  16462. */
  16463. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16464. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16465. /**
  16466. * List of inspectable custom properties (used by the Inspector)
  16467. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16468. */
  16469. inspectableCustomProperties: IInspectable[];
  16470. /**
  16471. * An observable triggered before computing the skeleton's matrices
  16472. */
  16473. onBeforeComputeObservable: Observable<Skeleton>;
  16474. /**
  16475. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16476. */
  16477. get isUsingTextureForMatrices(): boolean;
  16478. /**
  16479. * Gets the unique ID of this skeleton
  16480. */
  16481. get uniqueId(): number;
  16482. /**
  16483. * Creates a new skeleton
  16484. * @param name defines the skeleton name
  16485. * @param id defines the skeleton Id
  16486. * @param scene defines the hosting scene
  16487. */
  16488. constructor(
  16489. /** defines the skeleton name */
  16490. name: string,
  16491. /** defines the skeleton Id */
  16492. id: string, scene: Scene);
  16493. /**
  16494. * Gets the current object class name.
  16495. * @return the class name
  16496. */
  16497. getClassName(): string;
  16498. /**
  16499. * Returns an array containing the root bones
  16500. * @returns an array containing the root bones
  16501. */
  16502. getChildren(): Array<Bone>;
  16503. /**
  16504. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16505. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16506. * @returns a Float32Array containing matrices data
  16507. */
  16508. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16509. /**
  16510. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16511. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16512. * @returns a raw texture containing the data
  16513. */
  16514. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16515. /**
  16516. * Gets the current hosting scene
  16517. * @returns a scene object
  16518. */
  16519. getScene(): Scene;
  16520. /**
  16521. * Gets a string representing the current skeleton data
  16522. * @param fullDetails defines a boolean indicating if we want a verbose version
  16523. * @returns a string representing the current skeleton data
  16524. */
  16525. toString(fullDetails?: boolean): string;
  16526. /**
  16527. * Get bone's index searching by name
  16528. * @param name defines bone's name to search for
  16529. * @return the indice of the bone. Returns -1 if not found
  16530. */
  16531. getBoneIndexByName(name: string): number;
  16532. /**
  16533. * Creater a new animation range
  16534. * @param name defines the name of the range
  16535. * @param from defines the start key
  16536. * @param to defines the end key
  16537. */
  16538. createAnimationRange(name: string, from: number, to: number): void;
  16539. /**
  16540. * Delete a specific animation range
  16541. * @param name defines the name of the range
  16542. * @param deleteFrames defines if frames must be removed as well
  16543. */
  16544. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16545. /**
  16546. * Gets a specific animation range
  16547. * @param name defines the name of the range to look for
  16548. * @returns the requested animation range or null if not found
  16549. */
  16550. getAnimationRange(name: string): Nullable<AnimationRange>;
  16551. /**
  16552. * Gets the list of all animation ranges defined on this skeleton
  16553. * @returns an array
  16554. */
  16555. getAnimationRanges(): Nullable<AnimationRange>[];
  16556. /**
  16557. * Copy animation range from a source skeleton.
  16558. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16559. * @param source defines the source skeleton
  16560. * @param name defines the name of the range to copy
  16561. * @param rescaleAsRequired defines if rescaling must be applied if required
  16562. * @returns true if operation was successful
  16563. */
  16564. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16565. /**
  16566. * Forces the skeleton to go to rest pose
  16567. */
  16568. returnToRest(): void;
  16569. private _getHighestAnimationFrame;
  16570. /**
  16571. * Begin a specific animation range
  16572. * @param name defines the name of the range to start
  16573. * @param loop defines if looping must be turned on (false by default)
  16574. * @param speedRatio defines the speed ratio to apply (1 by default)
  16575. * @param onAnimationEnd defines a callback which will be called when animation will end
  16576. * @returns a new animatable
  16577. */
  16578. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16579. /**
  16580. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16581. * @param skeleton defines the Skeleton containing the animation range to convert
  16582. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16583. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16584. * @returns the original skeleton
  16585. */
  16586. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16587. /** @hidden */
  16588. _markAsDirty(): void;
  16589. /** @hidden */
  16590. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16591. /** @hidden */
  16592. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16593. private _computeTransformMatrices;
  16594. /**
  16595. * Build all resources required to render a skeleton
  16596. */
  16597. prepare(): void;
  16598. /**
  16599. * Gets the list of animatables currently running for this skeleton
  16600. * @returns an array of animatables
  16601. */
  16602. getAnimatables(): IAnimatable[];
  16603. /**
  16604. * Clone the current skeleton
  16605. * @param name defines the name of the new skeleton
  16606. * @param id defines the id of the new skeleton
  16607. * @returns the new skeleton
  16608. */
  16609. clone(name: string, id?: string): Skeleton;
  16610. /**
  16611. * Enable animation blending for this skeleton
  16612. * @param blendingSpeed defines the blending speed to apply
  16613. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16614. */
  16615. enableBlending(blendingSpeed?: number): void;
  16616. /**
  16617. * Releases all resources associated with the current skeleton
  16618. */
  16619. dispose(): void;
  16620. /**
  16621. * Serialize the skeleton in a JSON object
  16622. * @returns a JSON object
  16623. */
  16624. serialize(): any;
  16625. /**
  16626. * Creates a new skeleton from serialized data
  16627. * @param parsedSkeleton defines the serialized data
  16628. * @param scene defines the hosting scene
  16629. * @returns a new skeleton
  16630. */
  16631. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16632. /**
  16633. * Compute all node absolute transforms
  16634. * @param forceUpdate defines if computation must be done even if cache is up to date
  16635. */
  16636. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16637. /**
  16638. * Gets the root pose matrix
  16639. * @returns a matrix
  16640. */
  16641. getPoseMatrix(): Nullable<Matrix>;
  16642. /**
  16643. * Sorts bones per internal index
  16644. */
  16645. sortBones(): void;
  16646. private _sortBones;
  16647. }
  16648. }
  16649. declare module "babylonjs/Meshes/instancedMesh" {
  16650. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16651. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16652. import { Camera } from "babylonjs/Cameras/camera";
  16653. import { Node } from "babylonjs/node";
  16654. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16655. import { Mesh } from "babylonjs/Meshes/mesh";
  16656. import { Material } from "babylonjs/Materials/material";
  16657. import { Skeleton } from "babylonjs/Bones/skeleton";
  16658. import { Light } from "babylonjs/Lights/light";
  16659. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16660. /**
  16661. * Creates an instance based on a source mesh.
  16662. */
  16663. export class InstancedMesh extends AbstractMesh {
  16664. private _sourceMesh;
  16665. private _currentLOD;
  16666. /** @hidden */
  16667. _indexInSourceMeshInstanceArray: number;
  16668. constructor(name: string, source: Mesh);
  16669. /**
  16670. * Returns the string "InstancedMesh".
  16671. */
  16672. getClassName(): string;
  16673. /** Gets the list of lights affecting that mesh */
  16674. get lightSources(): Light[];
  16675. _resyncLightSources(): void;
  16676. _resyncLightSource(light: Light): void;
  16677. _removeLightSource(light: Light, dispose: boolean): void;
  16678. /**
  16679. * If the source mesh receives shadows
  16680. */
  16681. get receiveShadows(): boolean;
  16682. /**
  16683. * The material of the source mesh
  16684. */
  16685. get material(): Nullable<Material>;
  16686. /**
  16687. * Visibility of the source mesh
  16688. */
  16689. get visibility(): number;
  16690. /**
  16691. * Skeleton of the source mesh
  16692. */
  16693. get skeleton(): Nullable<Skeleton>;
  16694. /**
  16695. * Rendering ground id of the source mesh
  16696. */
  16697. get renderingGroupId(): number;
  16698. set renderingGroupId(value: number);
  16699. /**
  16700. * Returns the total number of vertices (integer).
  16701. */
  16702. getTotalVertices(): number;
  16703. /**
  16704. * Returns a positive integer : the total number of indices in this mesh geometry.
  16705. * @returns the numner of indices or zero if the mesh has no geometry.
  16706. */
  16707. getTotalIndices(): number;
  16708. /**
  16709. * The source mesh of the instance
  16710. */
  16711. get sourceMesh(): Mesh;
  16712. /**
  16713. * Creates a new InstancedMesh object from the mesh model.
  16714. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16715. * @param name defines the name of the new instance
  16716. * @returns a new InstancedMesh
  16717. */
  16718. createInstance(name: string): InstancedMesh;
  16719. /**
  16720. * Is this node ready to be used/rendered
  16721. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16722. * @return {boolean} is it ready
  16723. */
  16724. isReady(completeCheck?: boolean): boolean;
  16725. /**
  16726. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16727. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16728. * @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.
  16729. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16730. */
  16731. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16732. /**
  16733. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16734. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16735. * The `data` are either a numeric array either a Float32Array.
  16736. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16737. * 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).
  16738. * Note that a new underlying VertexBuffer object is created each call.
  16739. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16740. *
  16741. * Possible `kind` values :
  16742. * - VertexBuffer.PositionKind
  16743. * - VertexBuffer.UVKind
  16744. * - VertexBuffer.UV2Kind
  16745. * - VertexBuffer.UV3Kind
  16746. * - VertexBuffer.UV4Kind
  16747. * - VertexBuffer.UV5Kind
  16748. * - VertexBuffer.UV6Kind
  16749. * - VertexBuffer.ColorKind
  16750. * - VertexBuffer.MatricesIndicesKind
  16751. * - VertexBuffer.MatricesIndicesExtraKind
  16752. * - VertexBuffer.MatricesWeightsKind
  16753. * - VertexBuffer.MatricesWeightsExtraKind
  16754. *
  16755. * Returns the Mesh.
  16756. */
  16757. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16758. /**
  16759. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16760. * If the mesh has no geometry, it is simply returned as it is.
  16761. * The `data` are either a numeric array either a Float32Array.
  16762. * No new underlying VertexBuffer object is created.
  16763. * 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.
  16764. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16765. *
  16766. * Possible `kind` values :
  16767. * - VertexBuffer.PositionKind
  16768. * - VertexBuffer.UVKind
  16769. * - VertexBuffer.UV2Kind
  16770. * - VertexBuffer.UV3Kind
  16771. * - VertexBuffer.UV4Kind
  16772. * - VertexBuffer.UV5Kind
  16773. * - VertexBuffer.UV6Kind
  16774. * - VertexBuffer.ColorKind
  16775. * - VertexBuffer.MatricesIndicesKind
  16776. * - VertexBuffer.MatricesIndicesExtraKind
  16777. * - VertexBuffer.MatricesWeightsKind
  16778. * - VertexBuffer.MatricesWeightsExtraKind
  16779. *
  16780. * Returns the Mesh.
  16781. */
  16782. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16783. /**
  16784. * Sets the mesh indices.
  16785. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16786. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16787. * This method creates a new index buffer each call.
  16788. * Returns the Mesh.
  16789. */
  16790. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16791. /**
  16792. * Boolean : True if the mesh owns the requested kind of data.
  16793. */
  16794. isVerticesDataPresent(kind: string): boolean;
  16795. /**
  16796. * Returns an array of indices (IndicesArray).
  16797. */
  16798. getIndices(): Nullable<IndicesArray>;
  16799. get _positions(): Nullable<Vector3[]>;
  16800. /**
  16801. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16802. * This means the mesh underlying bounding box and sphere are recomputed.
  16803. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16804. * @returns the current mesh
  16805. */
  16806. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16807. /** @hidden */
  16808. _preActivate(): InstancedMesh;
  16809. /** @hidden */
  16810. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16811. /** @hidden */
  16812. _postActivate(): void;
  16813. getWorldMatrix(): Matrix;
  16814. get isAnInstance(): boolean;
  16815. /**
  16816. * Returns the current associated LOD AbstractMesh.
  16817. */
  16818. getLOD(camera: Camera): AbstractMesh;
  16819. /** @hidden */
  16820. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16821. /** @hidden */
  16822. _syncSubMeshes(): InstancedMesh;
  16823. /** @hidden */
  16824. _generatePointsArray(): boolean;
  16825. /** @hidden */
  16826. _updateBoundingInfo(): AbstractMesh;
  16827. /**
  16828. * Creates a new InstancedMesh from the current mesh.
  16829. * - name (string) : the cloned mesh name
  16830. * - newParent (optional Node) : the optional Node to parent the clone to.
  16831. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16832. *
  16833. * Returns the clone.
  16834. */
  16835. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16836. /**
  16837. * Disposes the InstancedMesh.
  16838. * Returns nothing.
  16839. */
  16840. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16841. }
  16842. module "babylonjs/Meshes/mesh" {
  16843. interface Mesh {
  16844. /**
  16845. * Register a custom buffer that will be instanced
  16846. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16847. * @param kind defines the buffer kind
  16848. * @param stride defines the stride in floats
  16849. */
  16850. registerInstancedBuffer(kind: string, stride: number): void;
  16851. /**
  16852. * true to use the edge renderer for all instances of this mesh
  16853. */
  16854. edgesShareWithInstances: boolean;
  16855. /** @hidden */
  16856. _userInstancedBuffersStorage: {
  16857. data: {
  16858. [key: string]: Float32Array;
  16859. };
  16860. sizes: {
  16861. [key: string]: number;
  16862. };
  16863. vertexBuffers: {
  16864. [key: string]: Nullable<VertexBuffer>;
  16865. };
  16866. strides: {
  16867. [key: string]: number;
  16868. };
  16869. };
  16870. }
  16871. }
  16872. module "babylonjs/Meshes/abstractMesh" {
  16873. interface AbstractMesh {
  16874. /**
  16875. * Object used to store instanced buffers defined by user
  16876. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16877. */
  16878. instancedBuffers: {
  16879. [key: string]: any;
  16880. };
  16881. }
  16882. }
  16883. }
  16884. declare module "babylonjs/Materials/shaderMaterial" {
  16885. import { Nullable } from "babylonjs/types";
  16886. import { Scene } from "babylonjs/scene";
  16887. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16888. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16889. import { Mesh } from "babylonjs/Meshes/mesh";
  16890. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16891. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16892. import { Effect } from "babylonjs/Materials/effect";
  16893. import { Material } from "babylonjs/Materials/material";
  16894. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16895. /**
  16896. * Defines the options associated with the creation of a shader material.
  16897. */
  16898. export interface IShaderMaterialOptions {
  16899. /**
  16900. * Does the material work in alpha blend mode
  16901. */
  16902. needAlphaBlending: boolean;
  16903. /**
  16904. * Does the material work in alpha test mode
  16905. */
  16906. needAlphaTesting: boolean;
  16907. /**
  16908. * The list of attribute names used in the shader
  16909. */
  16910. attributes: string[];
  16911. /**
  16912. * The list of unifrom names used in the shader
  16913. */
  16914. uniforms: string[];
  16915. /**
  16916. * The list of UBO names used in the shader
  16917. */
  16918. uniformBuffers: string[];
  16919. /**
  16920. * The list of sampler names used in the shader
  16921. */
  16922. samplers: string[];
  16923. /**
  16924. * The list of defines used in the shader
  16925. */
  16926. defines: string[];
  16927. }
  16928. /**
  16929. * 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.
  16930. *
  16931. * This returned material effects how the mesh will look based on the code in the shaders.
  16932. *
  16933. * @see https://doc.babylonjs.com/how_to/shader_material
  16934. */
  16935. export class ShaderMaterial extends Material {
  16936. private _shaderPath;
  16937. private _options;
  16938. private _textures;
  16939. private _textureArrays;
  16940. private _floats;
  16941. private _ints;
  16942. private _floatsArrays;
  16943. private _colors3;
  16944. private _colors3Arrays;
  16945. private _colors4;
  16946. private _colors4Arrays;
  16947. private _vectors2;
  16948. private _vectors3;
  16949. private _vectors4;
  16950. private _matrices;
  16951. private _matrixArrays;
  16952. private _matrices3x3;
  16953. private _matrices2x2;
  16954. private _vectors2Arrays;
  16955. private _vectors3Arrays;
  16956. private _vectors4Arrays;
  16957. private _cachedWorldViewMatrix;
  16958. private _cachedWorldViewProjectionMatrix;
  16959. private _renderId;
  16960. private _multiview;
  16961. private _cachedDefines;
  16962. /** Define the Url to load snippets */
  16963. static SnippetUrl: string;
  16964. /** Snippet ID if the material was created from the snippet server */
  16965. snippetId: string;
  16966. /**
  16967. * Instantiate a new shader material.
  16968. * 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.
  16969. * This returned material effects how the mesh will look based on the code in the shaders.
  16970. * @see https://doc.babylonjs.com/how_to/shader_material
  16971. * @param name Define the name of the material in the scene
  16972. * @param scene Define the scene the material belongs to
  16973. * @param shaderPath Defines the route to the shader code in one of three ways:
  16974. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  16975. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  16976. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  16977. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  16978. * @param options Define the options used to create the shader
  16979. */
  16980. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  16981. /**
  16982. * Gets the shader path used to define the shader code
  16983. * It can be modified to trigger a new compilation
  16984. */
  16985. get shaderPath(): any;
  16986. /**
  16987. * Sets the shader path used to define the shader code
  16988. * It can be modified to trigger a new compilation
  16989. */
  16990. set shaderPath(shaderPath: any);
  16991. /**
  16992. * Gets the options used to compile the shader.
  16993. * They can be modified to trigger a new compilation
  16994. */
  16995. get options(): IShaderMaterialOptions;
  16996. /**
  16997. * Gets the current class name of the material e.g. "ShaderMaterial"
  16998. * Mainly use in serialization.
  16999. * @returns the class name
  17000. */
  17001. getClassName(): string;
  17002. /**
  17003. * Specifies if the material will require alpha blending
  17004. * @returns a boolean specifying if alpha blending is needed
  17005. */
  17006. needAlphaBlending(): boolean;
  17007. /**
  17008. * Specifies if this material should be rendered in alpha test mode
  17009. * @returns a boolean specifying if an alpha test is needed.
  17010. */
  17011. needAlphaTesting(): boolean;
  17012. private _checkUniform;
  17013. /**
  17014. * Set a texture in the shader.
  17015. * @param name Define the name of the uniform samplers as defined in the shader
  17016. * @param texture Define the texture to bind to this sampler
  17017. * @return the material itself allowing "fluent" like uniform updates
  17018. */
  17019. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  17020. /**
  17021. * Set a texture array in the shader.
  17022. * @param name Define the name of the uniform sampler array as defined in the shader
  17023. * @param textures Define the list of textures to bind to this sampler
  17024. * @return the material itself allowing "fluent" like uniform updates
  17025. */
  17026. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  17027. /**
  17028. * Set a float in the shader.
  17029. * @param name Define the name of the uniform as defined in the shader
  17030. * @param value Define the value to give to the uniform
  17031. * @return the material itself allowing "fluent" like uniform updates
  17032. */
  17033. setFloat(name: string, value: number): ShaderMaterial;
  17034. /**
  17035. * Set a int in the shader.
  17036. * @param name Define the name of the uniform as defined in the shader
  17037. * @param value Define the value to give to the uniform
  17038. * @return the material itself allowing "fluent" like uniform updates
  17039. */
  17040. setInt(name: string, value: number): ShaderMaterial;
  17041. /**
  17042. * Set an array of floats in the shader.
  17043. * @param name Define the name of the uniform as defined in the shader
  17044. * @param value Define the value to give to the uniform
  17045. * @return the material itself allowing "fluent" like uniform updates
  17046. */
  17047. setFloats(name: string, value: number[]): ShaderMaterial;
  17048. /**
  17049. * Set a vec3 in the shader from a Color3.
  17050. * @param name Define the name of the uniform as defined in the shader
  17051. * @param value Define the value to give to the uniform
  17052. * @return the material itself allowing "fluent" like uniform updates
  17053. */
  17054. setColor3(name: string, value: Color3): ShaderMaterial;
  17055. /**
  17056. * Set a vec3 array in the shader from a Color3 array.
  17057. * @param name Define the name of the uniform as defined in the shader
  17058. * @param value Define the value to give to the uniform
  17059. * @return the material itself allowing "fluent" like uniform updates
  17060. */
  17061. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  17062. /**
  17063. * Set a vec4 in the shader from a Color4.
  17064. * @param name Define the name of the uniform as defined in the shader
  17065. * @param value Define the value to give to the uniform
  17066. * @return the material itself allowing "fluent" like uniform updates
  17067. */
  17068. setColor4(name: string, value: Color4): ShaderMaterial;
  17069. /**
  17070. * Set a vec4 array in the shader from a Color4 array.
  17071. * @param name Define the name of the uniform as defined in the shader
  17072. * @param value Define the value to give to the uniform
  17073. * @return the material itself allowing "fluent" like uniform updates
  17074. */
  17075. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  17076. /**
  17077. * Set a vec2 in the shader from a Vector2.
  17078. * @param name Define the name of the uniform as defined in the shader
  17079. * @param value Define the value to give to the uniform
  17080. * @return the material itself allowing "fluent" like uniform updates
  17081. */
  17082. setVector2(name: string, value: Vector2): ShaderMaterial;
  17083. /**
  17084. * Set a vec3 in the shader from a Vector3.
  17085. * @param name Define the name of the uniform as defined in the shader
  17086. * @param value Define the value to give to the uniform
  17087. * @return the material itself allowing "fluent" like uniform updates
  17088. */
  17089. setVector3(name: string, value: Vector3): ShaderMaterial;
  17090. /**
  17091. * Set a vec4 in the shader from a Vector4.
  17092. * @param name Define the name of the uniform as defined in the shader
  17093. * @param value Define the value to give to the uniform
  17094. * @return the material itself allowing "fluent" like uniform updates
  17095. */
  17096. setVector4(name: string, value: Vector4): ShaderMaterial;
  17097. /**
  17098. * Set a mat4 in the shader from a Matrix.
  17099. * @param name Define the name of the uniform as defined in the shader
  17100. * @param value Define the value to give to the uniform
  17101. * @return the material itself allowing "fluent" like uniform updates
  17102. */
  17103. setMatrix(name: string, value: Matrix): ShaderMaterial;
  17104. /**
  17105. * Set a float32Array in the shader from a matrix array.
  17106. * @param name Define the name of the uniform as defined in the shader
  17107. * @param value Define the value to give to the uniform
  17108. * @return the material itself allowing "fluent" like uniform updates
  17109. */
  17110. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  17111. /**
  17112. * Set a mat3 in the shader from a Float32Array.
  17113. * @param name Define the name of the uniform as defined in the shader
  17114. * @param value Define the value to give to the uniform
  17115. * @return the material itself allowing "fluent" like uniform updates
  17116. */
  17117. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17118. /**
  17119. * Set a mat2 in the shader from a Float32Array.
  17120. * @param name Define the name of the uniform as defined in the shader
  17121. * @param value Define the value to give to the uniform
  17122. * @return the material itself allowing "fluent" like uniform updates
  17123. */
  17124. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17125. /**
  17126. * Set a vec2 array in the shader from a number array.
  17127. * @param name Define the name of the uniform as defined in the shader
  17128. * @param value Define the value to give to the uniform
  17129. * @return the material itself allowing "fluent" like uniform updates
  17130. */
  17131. setArray2(name: string, value: number[]): ShaderMaterial;
  17132. /**
  17133. * Set a vec3 array in the shader from a number array.
  17134. * @param name Define the name of the uniform as defined in the shader
  17135. * @param value Define the value to give to the uniform
  17136. * @return the material itself allowing "fluent" like uniform updates
  17137. */
  17138. setArray3(name: string, value: number[]): ShaderMaterial;
  17139. /**
  17140. * Set a vec4 array in the shader from a number array.
  17141. * @param name Define the name of the uniform as defined in the shader
  17142. * @param value Define the value to give to the uniform
  17143. * @return the material itself allowing "fluent" like uniform updates
  17144. */
  17145. setArray4(name: string, value: number[]): ShaderMaterial;
  17146. private _checkCache;
  17147. /**
  17148. * Specifies that the submesh is ready to be used
  17149. * @param mesh defines the mesh to check
  17150. * @param subMesh defines which submesh to check
  17151. * @param useInstances specifies that instances should be used
  17152. * @returns a boolean indicating that the submesh is ready or not
  17153. */
  17154. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17155. /**
  17156. * Checks if the material is ready to render the requested mesh
  17157. * @param mesh Define the mesh to render
  17158. * @param useInstances Define whether or not the material is used with instances
  17159. * @returns true if ready, otherwise false
  17160. */
  17161. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17162. /**
  17163. * Binds the world matrix to the material
  17164. * @param world defines the world transformation matrix
  17165. * @param effectOverride - If provided, use this effect instead of internal effect
  17166. */
  17167. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17168. /**
  17169. * Binds the submesh to this material by preparing the effect and shader to draw
  17170. * @param world defines the world transformation matrix
  17171. * @param mesh defines the mesh containing the submesh
  17172. * @param subMesh defines the submesh to bind the material to
  17173. */
  17174. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17175. /**
  17176. * Binds the material to the mesh
  17177. * @param world defines the world transformation matrix
  17178. * @param mesh defines the mesh to bind the material to
  17179. * @param effectOverride - If provided, use this effect instead of internal effect
  17180. */
  17181. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17182. protected _afterBind(mesh?: Mesh): void;
  17183. /**
  17184. * Gets the active textures from the material
  17185. * @returns an array of textures
  17186. */
  17187. getActiveTextures(): BaseTexture[];
  17188. /**
  17189. * Specifies if the material uses a texture
  17190. * @param texture defines the texture to check against the material
  17191. * @returns a boolean specifying if the material uses the texture
  17192. */
  17193. hasTexture(texture: BaseTexture): boolean;
  17194. /**
  17195. * Makes a duplicate of the material, and gives it a new name
  17196. * @param name defines the new name for the duplicated material
  17197. * @returns the cloned material
  17198. */
  17199. clone(name: string): ShaderMaterial;
  17200. /**
  17201. * Disposes the material
  17202. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17203. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17204. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17205. */
  17206. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17207. /**
  17208. * Serializes this material in a JSON representation
  17209. * @returns the serialized material object
  17210. */
  17211. serialize(): any;
  17212. /**
  17213. * Creates a shader material from parsed shader material data
  17214. * @param source defines the JSON represnetation of the material
  17215. * @param scene defines the hosting scene
  17216. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17217. * @returns a new material
  17218. */
  17219. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17220. /**
  17221. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17222. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17223. * @param url defines the url to load from
  17224. * @param scene defines the hosting scene
  17225. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17226. * @returns a promise that will resolve to the new ShaderMaterial
  17227. */
  17228. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17229. /**
  17230. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17231. * @param snippetId defines the snippet to load
  17232. * @param scene defines the hosting scene
  17233. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17234. * @returns a promise that will resolve to the new ShaderMaterial
  17235. */
  17236. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17237. }
  17238. }
  17239. declare module "babylonjs/Shaders/color.fragment" {
  17240. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17241. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17242. /** @hidden */
  17243. export var colorPixelShader: {
  17244. name: string;
  17245. shader: string;
  17246. };
  17247. }
  17248. declare module "babylonjs/Shaders/color.vertex" {
  17249. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17250. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17251. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17252. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17253. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17254. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17255. /** @hidden */
  17256. export var colorVertexShader: {
  17257. name: string;
  17258. shader: string;
  17259. };
  17260. }
  17261. declare module "babylonjs/Meshes/linesMesh" {
  17262. import { Nullable } from "babylonjs/types";
  17263. import { Scene } from "babylonjs/scene";
  17264. import { Color3 } from "babylonjs/Maths/math.color";
  17265. import { Node } from "babylonjs/node";
  17266. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17267. import { Mesh } from "babylonjs/Meshes/mesh";
  17268. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17269. import { Effect } from "babylonjs/Materials/effect";
  17270. import { Material } from "babylonjs/Materials/material";
  17271. import "babylonjs/Shaders/color.fragment";
  17272. import "babylonjs/Shaders/color.vertex";
  17273. /**
  17274. * Line mesh
  17275. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17276. */
  17277. export class LinesMesh extends Mesh {
  17278. /**
  17279. * If vertex color should be applied to the mesh
  17280. */
  17281. readonly useVertexColor?: boolean | undefined;
  17282. /**
  17283. * If vertex alpha should be applied to the mesh
  17284. */
  17285. readonly useVertexAlpha?: boolean | undefined;
  17286. /**
  17287. * Color of the line (Default: White)
  17288. */
  17289. color: Color3;
  17290. /**
  17291. * Alpha of the line (Default: 1)
  17292. */
  17293. alpha: number;
  17294. /**
  17295. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17296. * This margin is expressed in world space coordinates, so its value may vary.
  17297. * Default value is 0.1
  17298. */
  17299. intersectionThreshold: number;
  17300. private _colorShader;
  17301. private color4;
  17302. /**
  17303. * Creates a new LinesMesh
  17304. * @param name defines the name
  17305. * @param scene defines the hosting scene
  17306. * @param parent defines the parent mesh if any
  17307. * @param source defines the optional source LinesMesh used to clone data from
  17308. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17309. * When false, achieved by calling a clone(), also passing False.
  17310. * This will make creation of children, recursive.
  17311. * @param useVertexColor defines if this LinesMesh supports vertex color
  17312. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17313. */
  17314. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17315. /**
  17316. * If vertex color should be applied to the mesh
  17317. */
  17318. useVertexColor?: boolean | undefined,
  17319. /**
  17320. * If vertex alpha should be applied to the mesh
  17321. */
  17322. useVertexAlpha?: boolean | undefined);
  17323. private _addClipPlaneDefine;
  17324. private _removeClipPlaneDefine;
  17325. isReady(): boolean;
  17326. /**
  17327. * Returns the string "LineMesh"
  17328. */
  17329. getClassName(): string;
  17330. /**
  17331. * @hidden
  17332. */
  17333. get material(): Material;
  17334. /**
  17335. * @hidden
  17336. */
  17337. set material(value: Material);
  17338. /**
  17339. * @hidden
  17340. */
  17341. get checkCollisions(): boolean;
  17342. /** @hidden */
  17343. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17344. /** @hidden */
  17345. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17346. /**
  17347. * Disposes of the line mesh
  17348. * @param doNotRecurse If children should be disposed
  17349. */
  17350. dispose(doNotRecurse?: boolean): void;
  17351. /**
  17352. * Returns a new LineMesh object cloned from the current one.
  17353. */
  17354. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17355. /**
  17356. * Creates a new InstancedLinesMesh object from the mesh model.
  17357. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17358. * @param name defines the name of the new instance
  17359. * @returns a new InstancedLinesMesh
  17360. */
  17361. createInstance(name: string): InstancedLinesMesh;
  17362. }
  17363. /**
  17364. * Creates an instance based on a source LinesMesh
  17365. */
  17366. export class InstancedLinesMesh extends InstancedMesh {
  17367. /**
  17368. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17369. * This margin is expressed in world space coordinates, so its value may vary.
  17370. * Initilized with the intersectionThreshold value of the source LinesMesh
  17371. */
  17372. intersectionThreshold: number;
  17373. constructor(name: string, source: LinesMesh);
  17374. /**
  17375. * Returns the string "InstancedLinesMesh".
  17376. */
  17377. getClassName(): string;
  17378. }
  17379. }
  17380. declare module "babylonjs/Shaders/line.fragment" {
  17381. /** @hidden */
  17382. export var linePixelShader: {
  17383. name: string;
  17384. shader: string;
  17385. };
  17386. }
  17387. declare module "babylonjs/Shaders/line.vertex" {
  17388. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17389. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17390. /** @hidden */
  17391. export var lineVertexShader: {
  17392. name: string;
  17393. shader: string;
  17394. };
  17395. }
  17396. declare module "babylonjs/Rendering/edgesRenderer" {
  17397. import { Nullable } from "babylonjs/types";
  17398. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17399. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17400. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17401. import { IDisposable } from "babylonjs/scene";
  17402. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17403. import "babylonjs/Shaders/line.fragment";
  17404. import "babylonjs/Shaders/line.vertex";
  17405. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17406. import { SmartArray } from "babylonjs/Misc/smartArray";
  17407. module "babylonjs/scene" {
  17408. interface Scene {
  17409. /** @hidden */
  17410. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17411. }
  17412. }
  17413. module "babylonjs/Meshes/abstractMesh" {
  17414. interface AbstractMesh {
  17415. /**
  17416. * Gets the edgesRenderer associated with the mesh
  17417. */
  17418. edgesRenderer: Nullable<EdgesRenderer>;
  17419. }
  17420. }
  17421. module "babylonjs/Meshes/linesMesh" {
  17422. interface LinesMesh {
  17423. /**
  17424. * Enables the edge rendering mode on the mesh.
  17425. * This mode makes the mesh edges visible
  17426. * @param epsilon defines the maximal distance between two angles to detect a face
  17427. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17428. * @returns the currentAbstractMesh
  17429. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17430. */
  17431. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17432. }
  17433. }
  17434. module "babylonjs/Meshes/linesMesh" {
  17435. interface InstancedLinesMesh {
  17436. /**
  17437. * Enables the edge rendering mode on the mesh.
  17438. * This mode makes the mesh edges visible
  17439. * @param epsilon defines the maximal distance between two angles to detect a face
  17440. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17441. * @returns the current InstancedLinesMesh
  17442. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17443. */
  17444. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17445. }
  17446. }
  17447. /**
  17448. * Defines the minimum contract an Edges renderer should follow.
  17449. */
  17450. export interface IEdgesRenderer extends IDisposable {
  17451. /**
  17452. * Gets or sets a boolean indicating if the edgesRenderer is active
  17453. */
  17454. isEnabled: boolean;
  17455. /**
  17456. * Renders the edges of the attached mesh,
  17457. */
  17458. render(): void;
  17459. /**
  17460. * Checks wether or not the edges renderer is ready to render.
  17461. * @return true if ready, otherwise false.
  17462. */
  17463. isReady(): boolean;
  17464. /**
  17465. * List of instances to render in case the source mesh has instances
  17466. */
  17467. customInstances: SmartArray<Matrix>;
  17468. }
  17469. /**
  17470. * Defines the additional options of the edges renderer
  17471. */
  17472. export interface IEdgesRendererOptions {
  17473. /**
  17474. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17475. * If not defined, the default value is true
  17476. */
  17477. useAlternateEdgeFinder?: boolean;
  17478. /**
  17479. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17480. * If not defined, the default value is true.
  17481. * 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)
  17482. * This option is used only if useAlternateEdgeFinder = true
  17483. */
  17484. useFastVertexMerger?: boolean;
  17485. /**
  17486. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17487. * The default value is 1e-6
  17488. * This option is used only if useAlternateEdgeFinder = true
  17489. */
  17490. epsilonVertexMerge?: number;
  17491. /**
  17492. * 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
  17493. * 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.
  17494. * This option is used only if useAlternateEdgeFinder = true
  17495. */
  17496. applyTessellation?: boolean;
  17497. /**
  17498. * 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
  17499. * The default value is 1e-6
  17500. * This option is used only if useAlternateEdgeFinder = true
  17501. */
  17502. epsilonVertexAligned?: number;
  17503. }
  17504. /**
  17505. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17506. */
  17507. export class EdgesRenderer implements IEdgesRenderer {
  17508. /**
  17509. * Define the size of the edges with an orthographic camera
  17510. */
  17511. edgesWidthScalerForOrthographic: number;
  17512. /**
  17513. * Define the size of the edges with a perspective camera
  17514. */
  17515. edgesWidthScalerForPerspective: number;
  17516. protected _source: AbstractMesh;
  17517. protected _linesPositions: number[];
  17518. protected _linesNormals: number[];
  17519. protected _linesIndices: number[];
  17520. protected _epsilon: number;
  17521. protected _indicesCount: number;
  17522. protected _lineShader: ShaderMaterial;
  17523. protected _ib: DataBuffer;
  17524. protected _buffers: {
  17525. [key: string]: Nullable<VertexBuffer>;
  17526. };
  17527. protected _buffersForInstances: {
  17528. [key: string]: Nullable<VertexBuffer>;
  17529. };
  17530. protected _checkVerticesInsteadOfIndices: boolean;
  17531. protected _options: Nullable<IEdgesRendererOptions>;
  17532. private _meshRebuildObserver;
  17533. private _meshDisposeObserver;
  17534. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17535. isEnabled: boolean;
  17536. /**
  17537. * List of instances to render in case the source mesh has instances
  17538. */
  17539. customInstances: SmartArray<Matrix>;
  17540. private static GetShader;
  17541. /**
  17542. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17543. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17544. * @param source Mesh used to create edges
  17545. * @param epsilon sum of angles in adjacency to check for edge
  17546. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17547. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17548. * @param options The options to apply when generating the edges
  17549. */
  17550. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17551. protected _prepareRessources(): void;
  17552. /** @hidden */
  17553. _rebuild(): void;
  17554. /**
  17555. * Releases the required resources for the edges renderer
  17556. */
  17557. dispose(): void;
  17558. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17559. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17560. /**
  17561. * Checks if the pair of p0 and p1 is en edge
  17562. * @param faceIndex
  17563. * @param edge
  17564. * @param faceNormals
  17565. * @param p0
  17566. * @param p1
  17567. * @private
  17568. */
  17569. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17570. /**
  17571. * push line into the position, normal and index buffer
  17572. * @protected
  17573. */
  17574. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17575. /**
  17576. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17577. */
  17578. private _tessellateTriangle;
  17579. private _generateEdgesLinesAlternate;
  17580. /**
  17581. * Generates lines edges from adjacencjes
  17582. * @private
  17583. */
  17584. _generateEdgesLines(): void;
  17585. /**
  17586. * Checks wether or not the edges renderer is ready to render.
  17587. * @return true if ready, otherwise false.
  17588. */
  17589. isReady(): boolean;
  17590. /**
  17591. * Renders the edges of the attached mesh,
  17592. */
  17593. render(): void;
  17594. }
  17595. /**
  17596. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17597. */
  17598. export class LineEdgesRenderer extends EdgesRenderer {
  17599. /**
  17600. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17601. * @param source LineMesh used to generate edges
  17602. * @param epsilon not important (specified angle for edge detection)
  17603. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17604. */
  17605. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17606. /**
  17607. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17608. */
  17609. _generateEdgesLines(): void;
  17610. }
  17611. }
  17612. declare module "babylonjs/Rendering/renderingGroup" {
  17613. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17614. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17615. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17616. import { Nullable } from "babylonjs/types";
  17617. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17618. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17619. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17620. import { Material } from "babylonjs/Materials/material";
  17621. import { Scene } from "babylonjs/scene";
  17622. /**
  17623. * This represents the object necessary to create a rendering group.
  17624. * This is exclusively used and created by the rendering manager.
  17625. * To modify the behavior, you use the available helpers in your scene or meshes.
  17626. * @hidden
  17627. */
  17628. export class RenderingGroup {
  17629. index: number;
  17630. private static _zeroVector;
  17631. private _scene;
  17632. private _opaqueSubMeshes;
  17633. private _transparentSubMeshes;
  17634. private _alphaTestSubMeshes;
  17635. private _depthOnlySubMeshes;
  17636. private _particleSystems;
  17637. private _spriteManagers;
  17638. private _opaqueSortCompareFn;
  17639. private _alphaTestSortCompareFn;
  17640. private _transparentSortCompareFn;
  17641. private _renderOpaque;
  17642. private _renderAlphaTest;
  17643. private _renderTransparent;
  17644. /** @hidden */
  17645. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17646. onBeforeTransparentRendering: () => void;
  17647. /**
  17648. * Set the opaque sort comparison function.
  17649. * If null the sub meshes will be render in the order they were created
  17650. */
  17651. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17652. /**
  17653. * Set the alpha test sort comparison function.
  17654. * If null the sub meshes will be render in the order they were created
  17655. */
  17656. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17657. /**
  17658. * Set the transparent sort comparison function.
  17659. * If null the sub meshes will be render in the order they were created
  17660. */
  17661. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17662. /**
  17663. * Creates a new rendering group.
  17664. * @param index The rendering group index
  17665. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17666. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17667. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17668. */
  17669. 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>);
  17670. /**
  17671. * Render all the sub meshes contained in the group.
  17672. * @param customRenderFunction Used to override the default render behaviour of the group.
  17673. * @returns true if rendered some submeshes.
  17674. */
  17675. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17676. /**
  17677. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17678. * @param subMeshes The submeshes to render
  17679. */
  17680. private renderOpaqueSorted;
  17681. /**
  17682. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17683. * @param subMeshes The submeshes to render
  17684. */
  17685. private renderAlphaTestSorted;
  17686. /**
  17687. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17688. * @param subMeshes The submeshes to render
  17689. */
  17690. private renderTransparentSorted;
  17691. /**
  17692. * Renders the submeshes in a specified order.
  17693. * @param subMeshes The submeshes to sort before render
  17694. * @param sortCompareFn The comparison function use to sort
  17695. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17696. * @param transparent Specifies to activate blending if true
  17697. */
  17698. private static renderSorted;
  17699. /**
  17700. * Renders the submeshes in the order they were dispatched (no sort applied).
  17701. * @param subMeshes The submeshes to render
  17702. */
  17703. private static renderUnsorted;
  17704. /**
  17705. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17706. * are rendered back to front if in the same alpha index.
  17707. *
  17708. * @param a The first submesh
  17709. * @param b The second submesh
  17710. * @returns The result of the comparison
  17711. */
  17712. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17713. /**
  17714. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17715. * are rendered back to front.
  17716. *
  17717. * @param a The first submesh
  17718. * @param b The second submesh
  17719. * @returns The result of the comparison
  17720. */
  17721. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17722. /**
  17723. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17724. * are rendered front to back (prevent overdraw).
  17725. *
  17726. * @param a The first submesh
  17727. * @param b The second submesh
  17728. * @returns The result of the comparison
  17729. */
  17730. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17731. /**
  17732. * Resets the different lists of submeshes to prepare a new frame.
  17733. */
  17734. prepare(): void;
  17735. dispose(): void;
  17736. /**
  17737. * Inserts the submesh in its correct queue depending on its material.
  17738. * @param subMesh The submesh to dispatch
  17739. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17740. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17741. */
  17742. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17743. dispatchSprites(spriteManager: ISpriteManager): void;
  17744. dispatchParticles(particleSystem: IParticleSystem): void;
  17745. private _renderParticles;
  17746. private _renderSprites;
  17747. }
  17748. }
  17749. declare module "babylonjs/Rendering/renderingManager" {
  17750. import { Nullable } from "babylonjs/types";
  17751. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17752. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17753. import { SmartArray } from "babylonjs/Misc/smartArray";
  17754. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17755. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17756. import { Material } from "babylonjs/Materials/material";
  17757. import { Scene } from "babylonjs/scene";
  17758. import { Camera } from "babylonjs/Cameras/camera";
  17759. /**
  17760. * Interface describing the different options available in the rendering manager
  17761. * regarding Auto Clear between groups.
  17762. */
  17763. export interface IRenderingManagerAutoClearSetup {
  17764. /**
  17765. * Defines whether or not autoclear is enable.
  17766. */
  17767. autoClear: boolean;
  17768. /**
  17769. * Defines whether or not to autoclear the depth buffer.
  17770. */
  17771. depth: boolean;
  17772. /**
  17773. * Defines whether or not to autoclear the stencil buffer.
  17774. */
  17775. stencil: boolean;
  17776. }
  17777. /**
  17778. * This class is used by the onRenderingGroupObservable
  17779. */
  17780. export class RenderingGroupInfo {
  17781. /**
  17782. * The Scene that being rendered
  17783. */
  17784. scene: Scene;
  17785. /**
  17786. * The camera currently used for the rendering pass
  17787. */
  17788. camera: Nullable<Camera>;
  17789. /**
  17790. * The ID of the renderingGroup being processed
  17791. */
  17792. renderingGroupId: number;
  17793. }
  17794. /**
  17795. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17796. * It is enable to manage the different groups as well as the different necessary sort functions.
  17797. * This should not be used directly aside of the few static configurations
  17798. */
  17799. export class RenderingManager {
  17800. /**
  17801. * The max id used for rendering groups (not included)
  17802. */
  17803. static MAX_RENDERINGGROUPS: number;
  17804. /**
  17805. * The min id used for rendering groups (included)
  17806. */
  17807. static MIN_RENDERINGGROUPS: number;
  17808. /**
  17809. * Used to globally prevent autoclearing scenes.
  17810. */
  17811. static AUTOCLEAR: boolean;
  17812. /**
  17813. * @hidden
  17814. */
  17815. _useSceneAutoClearSetup: boolean;
  17816. private _scene;
  17817. private _renderingGroups;
  17818. private _depthStencilBufferAlreadyCleaned;
  17819. private _autoClearDepthStencil;
  17820. private _customOpaqueSortCompareFn;
  17821. private _customAlphaTestSortCompareFn;
  17822. private _customTransparentSortCompareFn;
  17823. private _renderingGroupInfo;
  17824. /**
  17825. * Instantiates a new rendering group for a particular scene
  17826. * @param scene Defines the scene the groups belongs to
  17827. */
  17828. constructor(scene: Scene);
  17829. private _clearDepthStencilBuffer;
  17830. /**
  17831. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17832. * @hidden
  17833. */
  17834. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17835. /**
  17836. * Resets the different information of the group to prepare a new frame
  17837. * @hidden
  17838. */
  17839. reset(): void;
  17840. /**
  17841. * Dispose and release the group and its associated resources.
  17842. * @hidden
  17843. */
  17844. dispose(): void;
  17845. /**
  17846. * Clear the info related to rendering groups preventing retention points during dispose.
  17847. */
  17848. freeRenderingGroups(): void;
  17849. private _prepareRenderingGroup;
  17850. /**
  17851. * Add a sprite manager to the rendering manager in order to render it this frame.
  17852. * @param spriteManager Define the sprite manager to render
  17853. */
  17854. dispatchSprites(spriteManager: ISpriteManager): void;
  17855. /**
  17856. * Add a particle system to the rendering manager in order to render it this frame.
  17857. * @param particleSystem Define the particle system to render
  17858. */
  17859. dispatchParticles(particleSystem: IParticleSystem): void;
  17860. /**
  17861. * Add a submesh to the manager in order to render it this frame
  17862. * @param subMesh The submesh to dispatch
  17863. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17864. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17865. */
  17866. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17867. /**
  17868. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17869. * This allowed control for front to back rendering or reversly depending of the special needs.
  17870. *
  17871. * @param renderingGroupId The rendering group id corresponding to its index
  17872. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17873. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17874. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17875. */
  17876. 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;
  17877. /**
  17878. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17879. *
  17880. * @param renderingGroupId The rendering group id corresponding to its index
  17881. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17882. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17883. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17884. */
  17885. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17886. /**
  17887. * Gets the current auto clear configuration for one rendering group of the rendering
  17888. * manager.
  17889. * @param index the rendering group index to get the information for
  17890. * @returns The auto clear setup for the requested rendering group
  17891. */
  17892. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17893. }
  17894. }
  17895. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17896. import { SmartArray } from "babylonjs/Misc/smartArray";
  17897. import { Nullable } from "babylonjs/types";
  17898. import { Scene } from "babylonjs/scene";
  17899. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17900. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17901. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17902. import { Mesh } from "babylonjs/Meshes/mesh";
  17903. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17904. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17905. import { Effect } from "babylonjs/Materials/effect";
  17906. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17907. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17908. import "babylonjs/Shaders/shadowMap.fragment";
  17909. import "babylonjs/Shaders/shadowMap.vertex";
  17910. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17911. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17912. import { Observable } from "babylonjs/Misc/observable";
  17913. /**
  17914. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17915. */
  17916. export interface ICustomShaderOptions {
  17917. /**
  17918. * Gets or sets the custom shader name to use
  17919. */
  17920. shaderName: string;
  17921. /**
  17922. * The list of attribute names used in the shader
  17923. */
  17924. attributes?: string[];
  17925. /**
  17926. * The list of unifrom names used in the shader
  17927. */
  17928. uniforms?: string[];
  17929. /**
  17930. * The list of sampler names used in the shader
  17931. */
  17932. samplers?: string[];
  17933. /**
  17934. * The list of defines used in the shader
  17935. */
  17936. defines?: string[];
  17937. }
  17938. /**
  17939. * Interface to implement to create a shadow generator compatible with BJS.
  17940. */
  17941. export interface IShadowGenerator {
  17942. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  17943. id: string;
  17944. /**
  17945. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  17946. * @returns The render target texture if present otherwise, null
  17947. */
  17948. getShadowMap(): Nullable<RenderTargetTexture>;
  17949. /**
  17950. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  17951. * @param subMesh The submesh we want to render in the shadow map
  17952. * @param useInstances Defines wether will draw in the map using instances
  17953. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  17954. * @returns true if ready otherwise, false
  17955. */
  17956. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  17957. /**
  17958. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  17959. * @param defines Defines of the material we want to update
  17960. * @param lightIndex Index of the light in the enabled light list of the material
  17961. */
  17962. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  17963. /**
  17964. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  17965. * defined in the generator but impacting the effect).
  17966. * It implies the unifroms available on the materials are the standard BJS ones.
  17967. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  17968. * @param effect The effect we are binfing the information for
  17969. */
  17970. bindShadowLight(lightIndex: string, effect: Effect): void;
  17971. /**
  17972. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  17973. * (eq to shadow prjection matrix * light transform matrix)
  17974. * @returns The transform matrix used to create the shadow map
  17975. */
  17976. getTransformMatrix(): Matrix;
  17977. /**
  17978. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  17979. * Cube and 2D textures for instance.
  17980. */
  17981. recreateShadowMap(): void;
  17982. /**
  17983. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17984. * @param onCompiled Callback triggered at the and of the effects compilation
  17985. * @param options Sets of optional options forcing the compilation with different modes
  17986. */
  17987. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  17988. useInstances: boolean;
  17989. }>): void;
  17990. /**
  17991. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17992. * @param options Sets of optional options forcing the compilation with different modes
  17993. * @returns A promise that resolves when the compilation completes
  17994. */
  17995. forceCompilationAsync(options?: Partial<{
  17996. useInstances: boolean;
  17997. }>): Promise<void>;
  17998. /**
  17999. * Serializes the shadow generator setup to a json object.
  18000. * @returns The serialized JSON object
  18001. */
  18002. serialize(): any;
  18003. /**
  18004. * Disposes the Shadow map and related Textures and effects.
  18005. */
  18006. dispose(): void;
  18007. }
  18008. /**
  18009. * Default implementation IShadowGenerator.
  18010. * This is the main object responsible of generating shadows in the framework.
  18011. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  18012. */
  18013. export class ShadowGenerator implements IShadowGenerator {
  18014. /**
  18015. * Name of the shadow generator class
  18016. */
  18017. static CLASSNAME: string;
  18018. /**
  18019. * Shadow generator mode None: no filtering applied.
  18020. */
  18021. static readonly FILTER_NONE: number;
  18022. /**
  18023. * Shadow generator mode ESM: Exponential Shadow Mapping.
  18024. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18025. */
  18026. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  18027. /**
  18028. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  18029. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  18030. */
  18031. static readonly FILTER_POISSONSAMPLING: number;
  18032. /**
  18033. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  18034. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18035. */
  18036. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  18037. /**
  18038. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  18039. * edge artifacts on steep falloff.
  18040. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18041. */
  18042. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  18043. /**
  18044. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  18045. * edge artifacts on steep falloff.
  18046. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18047. */
  18048. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  18049. /**
  18050. * Shadow generator mode PCF: Percentage Closer Filtering
  18051. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18052. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  18053. */
  18054. static readonly FILTER_PCF: number;
  18055. /**
  18056. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  18057. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18058. * Contact Hardening
  18059. */
  18060. static readonly FILTER_PCSS: number;
  18061. /**
  18062. * Reserved for PCF and PCSS
  18063. * Highest Quality.
  18064. *
  18065. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  18066. *
  18067. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  18068. */
  18069. static readonly QUALITY_HIGH: number;
  18070. /**
  18071. * Reserved for PCF and PCSS
  18072. * Good tradeoff for quality/perf cross devices
  18073. *
  18074. * Execute PCF on a 3*3 kernel.
  18075. *
  18076. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  18077. */
  18078. static readonly QUALITY_MEDIUM: number;
  18079. /**
  18080. * Reserved for PCF and PCSS
  18081. * The lowest quality but the fastest.
  18082. *
  18083. * Execute PCF on a 1*1 kernel.
  18084. *
  18085. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  18086. */
  18087. static readonly QUALITY_LOW: number;
  18088. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18089. id: string;
  18090. /** Gets or sets the custom shader name to use */
  18091. customShaderOptions: ICustomShaderOptions;
  18092. /**
  18093. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  18094. */
  18095. onBeforeShadowMapRenderObservable: Observable<Effect>;
  18096. /**
  18097. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  18098. */
  18099. onAfterShadowMapRenderObservable: Observable<Effect>;
  18100. /**
  18101. * Observable triggered before a mesh is rendered in the shadow map.
  18102. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  18103. */
  18104. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  18105. /**
  18106. * Observable triggered after a mesh is rendered in the shadow map.
  18107. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  18108. */
  18109. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  18110. protected _bias: number;
  18111. /**
  18112. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  18113. */
  18114. get bias(): number;
  18115. /**
  18116. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  18117. */
  18118. set bias(bias: number);
  18119. protected _normalBias: number;
  18120. /**
  18121. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18122. */
  18123. get normalBias(): number;
  18124. /**
  18125. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18126. */
  18127. set normalBias(normalBias: number);
  18128. protected _blurBoxOffset: number;
  18129. /**
  18130. * Gets the blur box offset: offset applied during the blur pass.
  18131. * Only useful if useKernelBlur = false
  18132. */
  18133. get blurBoxOffset(): number;
  18134. /**
  18135. * Sets the blur box offset: offset applied during the blur pass.
  18136. * Only useful if useKernelBlur = false
  18137. */
  18138. set blurBoxOffset(value: number);
  18139. protected _blurScale: number;
  18140. /**
  18141. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  18142. * 2 means half of the size.
  18143. */
  18144. get blurScale(): number;
  18145. /**
  18146. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  18147. * 2 means half of the size.
  18148. */
  18149. set blurScale(value: number);
  18150. protected _blurKernel: number;
  18151. /**
  18152. * Gets the blur kernel: kernel size of the blur pass.
  18153. * Only useful if useKernelBlur = true
  18154. */
  18155. get blurKernel(): number;
  18156. /**
  18157. * Sets the blur kernel: kernel size of the blur pass.
  18158. * Only useful if useKernelBlur = true
  18159. */
  18160. set blurKernel(value: number);
  18161. protected _useKernelBlur: boolean;
  18162. /**
  18163. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18164. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18165. */
  18166. get useKernelBlur(): boolean;
  18167. /**
  18168. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18169. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18170. */
  18171. set useKernelBlur(value: boolean);
  18172. protected _depthScale: number;
  18173. /**
  18174. * Gets the depth scale used in ESM mode.
  18175. */
  18176. get depthScale(): number;
  18177. /**
  18178. * Sets the depth scale used in ESM mode.
  18179. * This can override the scale stored on the light.
  18180. */
  18181. set depthScale(value: number);
  18182. protected _validateFilter(filter: number): number;
  18183. protected _filter: number;
  18184. /**
  18185. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18186. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18187. */
  18188. get filter(): number;
  18189. /**
  18190. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18191. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18192. */
  18193. set filter(value: number);
  18194. /**
  18195. * Gets if the current filter is set to Poisson Sampling.
  18196. */
  18197. get usePoissonSampling(): boolean;
  18198. /**
  18199. * Sets the current filter to Poisson Sampling.
  18200. */
  18201. set usePoissonSampling(value: boolean);
  18202. /**
  18203. * Gets if the current filter is set to ESM.
  18204. */
  18205. get useExponentialShadowMap(): boolean;
  18206. /**
  18207. * Sets the current filter is to ESM.
  18208. */
  18209. set useExponentialShadowMap(value: boolean);
  18210. /**
  18211. * Gets if the current filter is set to filtered ESM.
  18212. */
  18213. get useBlurExponentialShadowMap(): boolean;
  18214. /**
  18215. * Gets if the current filter is set to filtered ESM.
  18216. */
  18217. set useBlurExponentialShadowMap(value: boolean);
  18218. /**
  18219. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18220. * exponential to prevent steep falloff artifacts).
  18221. */
  18222. get useCloseExponentialShadowMap(): boolean;
  18223. /**
  18224. * Sets the current filter to "close ESM" (using the inverse of the
  18225. * exponential to prevent steep falloff artifacts).
  18226. */
  18227. set useCloseExponentialShadowMap(value: boolean);
  18228. /**
  18229. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18230. * exponential to prevent steep falloff artifacts).
  18231. */
  18232. get useBlurCloseExponentialShadowMap(): boolean;
  18233. /**
  18234. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18235. * exponential to prevent steep falloff artifacts).
  18236. */
  18237. set useBlurCloseExponentialShadowMap(value: boolean);
  18238. /**
  18239. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18240. */
  18241. get usePercentageCloserFiltering(): boolean;
  18242. /**
  18243. * Sets the current filter to "PCF" (percentage closer filtering).
  18244. */
  18245. set usePercentageCloserFiltering(value: boolean);
  18246. protected _filteringQuality: number;
  18247. /**
  18248. * Gets the PCF or PCSS Quality.
  18249. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18250. */
  18251. get filteringQuality(): number;
  18252. /**
  18253. * Sets the PCF or PCSS Quality.
  18254. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18255. */
  18256. set filteringQuality(filteringQuality: number);
  18257. /**
  18258. * Gets if the current filter is set to "PCSS" (contact hardening).
  18259. */
  18260. get useContactHardeningShadow(): boolean;
  18261. /**
  18262. * Sets the current filter to "PCSS" (contact hardening).
  18263. */
  18264. set useContactHardeningShadow(value: boolean);
  18265. protected _contactHardeningLightSizeUVRatio: number;
  18266. /**
  18267. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18268. * Using a ratio helps keeping shape stability independently of the map size.
  18269. *
  18270. * It does not account for the light projection as it was having too much
  18271. * instability during the light setup or during light position changes.
  18272. *
  18273. * Only valid if useContactHardeningShadow is true.
  18274. */
  18275. get contactHardeningLightSizeUVRatio(): number;
  18276. /**
  18277. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18278. * Using a ratio helps keeping shape stability independently of the map size.
  18279. *
  18280. * It does not account for the light projection as it was having too much
  18281. * instability during the light setup or during light position changes.
  18282. *
  18283. * Only valid if useContactHardeningShadow is true.
  18284. */
  18285. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18286. protected _darkness: number;
  18287. /** Gets or sets the actual darkness of a shadow */
  18288. get darkness(): number;
  18289. set darkness(value: number);
  18290. /**
  18291. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18292. * 0 means strongest and 1 would means no shadow.
  18293. * @returns the darkness.
  18294. */
  18295. getDarkness(): number;
  18296. /**
  18297. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18298. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18299. * @returns the shadow generator allowing fluent coding.
  18300. */
  18301. setDarkness(darkness: number): ShadowGenerator;
  18302. protected _transparencyShadow: boolean;
  18303. /** Gets or sets the ability to have transparent shadow */
  18304. get transparencyShadow(): boolean;
  18305. set transparencyShadow(value: boolean);
  18306. /**
  18307. * Sets the ability to have transparent shadow (boolean).
  18308. * @param transparent True if transparent else False
  18309. * @returns the shadow generator allowing fluent coding
  18310. */
  18311. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18312. /**
  18313. * Enables or disables shadows with varying strength based on the transparency
  18314. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18315. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18316. * mesh.visibility * alphaTexture.a
  18317. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18318. */
  18319. enableSoftTransparentShadow: boolean;
  18320. protected _shadowMap: Nullable<RenderTargetTexture>;
  18321. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18322. /**
  18323. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18324. * @returns The render target texture if present otherwise, null
  18325. */
  18326. getShadowMap(): Nullable<RenderTargetTexture>;
  18327. /**
  18328. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18329. * @returns The render target texture if the shadow map is present otherwise, null
  18330. */
  18331. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18332. /**
  18333. * Gets the class name of that object
  18334. * @returns "ShadowGenerator"
  18335. */
  18336. getClassName(): string;
  18337. /**
  18338. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18339. * @param mesh Mesh to add
  18340. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18341. * @returns the Shadow Generator itself
  18342. */
  18343. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18344. /**
  18345. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18346. * @param mesh Mesh to remove
  18347. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18348. * @returns the Shadow Generator itself
  18349. */
  18350. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18351. /**
  18352. * Controls the extent to which the shadows fade out at the edge of the frustum
  18353. */
  18354. frustumEdgeFalloff: number;
  18355. protected _light: IShadowLight;
  18356. /**
  18357. * Returns the associated light object.
  18358. * @returns the light generating the shadow
  18359. */
  18360. getLight(): IShadowLight;
  18361. /**
  18362. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18363. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18364. * It might on the other hand introduce peter panning.
  18365. */
  18366. forceBackFacesOnly: boolean;
  18367. protected _scene: Scene;
  18368. protected _lightDirection: Vector3;
  18369. protected _effect: Effect;
  18370. protected _viewMatrix: Matrix;
  18371. protected _projectionMatrix: Matrix;
  18372. protected _transformMatrix: Matrix;
  18373. protected _cachedPosition: Vector3;
  18374. protected _cachedDirection: Vector3;
  18375. protected _cachedDefines: string;
  18376. protected _currentRenderID: number;
  18377. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18378. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18379. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18380. protected _blurPostProcesses: PostProcess[];
  18381. protected _mapSize: number;
  18382. protected _currentFaceIndex: number;
  18383. protected _currentFaceIndexCache: number;
  18384. protected _textureType: number;
  18385. protected _defaultTextureMatrix: Matrix;
  18386. protected _storedUniqueId: Nullable<number>;
  18387. /** @hidden */
  18388. static _SceneComponentInitialization: (scene: Scene) => void;
  18389. /**
  18390. * Creates a ShadowGenerator object.
  18391. * A ShadowGenerator is the required tool to use the shadows.
  18392. * Each light casting shadows needs to use its own ShadowGenerator.
  18393. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18394. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18395. * @param light The light object generating the shadows.
  18396. * @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.
  18397. */
  18398. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18399. protected _initializeGenerator(): void;
  18400. protected _createTargetRenderTexture(): void;
  18401. protected _initializeShadowMap(): void;
  18402. protected _initializeBlurRTTAndPostProcesses(): void;
  18403. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18404. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18405. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18406. protected _applyFilterValues(): void;
  18407. /**
  18408. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18409. * @param onCompiled Callback triggered at the and of the effects compilation
  18410. * @param options Sets of optional options forcing the compilation with different modes
  18411. */
  18412. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18413. useInstances: boolean;
  18414. }>): void;
  18415. /**
  18416. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18417. * @param options Sets of optional options forcing the compilation with different modes
  18418. * @returns A promise that resolves when the compilation completes
  18419. */
  18420. forceCompilationAsync(options?: Partial<{
  18421. useInstances: boolean;
  18422. }>): Promise<void>;
  18423. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18424. private _prepareShadowDefines;
  18425. /**
  18426. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18427. * @param subMesh The submesh we want to render in the shadow map
  18428. * @param useInstances Defines wether will draw in the map using instances
  18429. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18430. * @returns true if ready otherwise, false
  18431. */
  18432. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18433. /**
  18434. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18435. * @param defines Defines of the material we want to update
  18436. * @param lightIndex Index of the light in the enabled light list of the material
  18437. */
  18438. prepareDefines(defines: any, lightIndex: number): void;
  18439. /**
  18440. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18441. * defined in the generator but impacting the effect).
  18442. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18443. * @param effect The effect we are binfing the information for
  18444. */
  18445. bindShadowLight(lightIndex: string, effect: Effect): void;
  18446. /**
  18447. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18448. * (eq to shadow prjection matrix * light transform matrix)
  18449. * @returns The transform matrix used to create the shadow map
  18450. */
  18451. getTransformMatrix(): Matrix;
  18452. /**
  18453. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18454. * Cube and 2D textures for instance.
  18455. */
  18456. recreateShadowMap(): void;
  18457. protected _disposeBlurPostProcesses(): void;
  18458. protected _disposeRTTandPostProcesses(): void;
  18459. /**
  18460. * Disposes the ShadowGenerator.
  18461. * Returns nothing.
  18462. */
  18463. dispose(): void;
  18464. /**
  18465. * Serializes the shadow generator setup to a json object.
  18466. * @returns The serialized JSON object
  18467. */
  18468. serialize(): any;
  18469. /**
  18470. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18471. * @param parsedShadowGenerator The JSON object to parse
  18472. * @param scene The scene to create the shadow map for
  18473. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18474. * @returns The parsed shadow generator
  18475. */
  18476. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18477. }
  18478. }
  18479. declare module "babylonjs/Lights/light" {
  18480. import { Nullable } from "babylonjs/types";
  18481. import { Scene } from "babylonjs/scene";
  18482. import { Vector3 } from "babylonjs/Maths/math.vector";
  18483. import { Color3 } from "babylonjs/Maths/math.color";
  18484. import { Node } from "babylonjs/node";
  18485. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18486. import { Effect } from "babylonjs/Materials/effect";
  18487. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18488. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18489. /**
  18490. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18491. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18492. * 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.
  18493. */
  18494. export abstract class Light extends Node {
  18495. /**
  18496. * Falloff Default: light is falling off following the material specification:
  18497. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18498. */
  18499. static readonly FALLOFF_DEFAULT: number;
  18500. /**
  18501. * Falloff Physical: light is falling off following the inverse squared distance law.
  18502. */
  18503. static readonly FALLOFF_PHYSICAL: number;
  18504. /**
  18505. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18506. * to enhance interoperability with other engines.
  18507. */
  18508. static readonly FALLOFF_GLTF: number;
  18509. /**
  18510. * Falloff Standard: light is falling off like in the standard material
  18511. * to enhance interoperability with other materials.
  18512. */
  18513. static readonly FALLOFF_STANDARD: number;
  18514. /**
  18515. * If every light affecting the material is in this lightmapMode,
  18516. * material.lightmapTexture adds or multiplies
  18517. * (depends on material.useLightmapAsShadowmap)
  18518. * after every other light calculations.
  18519. */
  18520. static readonly LIGHTMAP_DEFAULT: number;
  18521. /**
  18522. * material.lightmapTexture as only diffuse lighting from this light
  18523. * adds only specular lighting from this light
  18524. * adds dynamic shadows
  18525. */
  18526. static readonly LIGHTMAP_SPECULAR: number;
  18527. /**
  18528. * material.lightmapTexture as only lighting
  18529. * no light calculation from this light
  18530. * only adds dynamic shadows from this light
  18531. */
  18532. static readonly LIGHTMAP_SHADOWSONLY: number;
  18533. /**
  18534. * Each light type uses the default quantity according to its type:
  18535. * point/spot lights use luminous intensity
  18536. * directional lights use illuminance
  18537. */
  18538. static readonly INTENSITYMODE_AUTOMATIC: number;
  18539. /**
  18540. * lumen (lm)
  18541. */
  18542. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18543. /**
  18544. * candela (lm/sr)
  18545. */
  18546. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18547. /**
  18548. * lux (lm/m^2)
  18549. */
  18550. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18551. /**
  18552. * nit (cd/m^2)
  18553. */
  18554. static readonly INTENSITYMODE_LUMINANCE: number;
  18555. /**
  18556. * Light type const id of the point light.
  18557. */
  18558. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18559. /**
  18560. * Light type const id of the directional light.
  18561. */
  18562. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18563. /**
  18564. * Light type const id of the spot light.
  18565. */
  18566. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18567. /**
  18568. * Light type const id of the hemispheric light.
  18569. */
  18570. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18571. /**
  18572. * Diffuse gives the basic color to an object.
  18573. */
  18574. diffuse: Color3;
  18575. /**
  18576. * Specular produces a highlight color on an object.
  18577. * Note: This is note affecting PBR materials.
  18578. */
  18579. specular: Color3;
  18580. /**
  18581. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18582. * falling off base on range or angle.
  18583. * This can be set to any values in Light.FALLOFF_x.
  18584. *
  18585. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18586. * other types of materials.
  18587. */
  18588. falloffType: number;
  18589. /**
  18590. * Strength of the light.
  18591. * Note: By default it is define in the framework own unit.
  18592. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18593. */
  18594. intensity: number;
  18595. private _range;
  18596. protected _inverseSquaredRange: number;
  18597. /**
  18598. * Defines how far from the source the light is impacting in scene units.
  18599. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18600. */
  18601. get range(): number;
  18602. /**
  18603. * Defines how far from the source the light is impacting in scene units.
  18604. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18605. */
  18606. set range(value: number);
  18607. /**
  18608. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18609. * of light.
  18610. */
  18611. private _photometricScale;
  18612. private _intensityMode;
  18613. /**
  18614. * Gets the photometric scale used to interpret the intensity.
  18615. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18616. */
  18617. get intensityMode(): number;
  18618. /**
  18619. * Sets the photometric scale used to interpret the intensity.
  18620. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18621. */
  18622. set intensityMode(value: number);
  18623. private _radius;
  18624. /**
  18625. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18626. */
  18627. get radius(): number;
  18628. /**
  18629. * sets the light radius used by PBR Materials to simulate soft area lights.
  18630. */
  18631. set radius(value: number);
  18632. private _renderPriority;
  18633. /**
  18634. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18635. * exceeding the number allowed of the materials.
  18636. */
  18637. renderPriority: number;
  18638. private _shadowEnabled;
  18639. /**
  18640. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18641. * the current shadow generator.
  18642. */
  18643. get shadowEnabled(): boolean;
  18644. /**
  18645. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18646. * the current shadow generator.
  18647. */
  18648. set shadowEnabled(value: boolean);
  18649. private _includedOnlyMeshes;
  18650. /**
  18651. * Gets the only meshes impacted by this light.
  18652. */
  18653. get includedOnlyMeshes(): AbstractMesh[];
  18654. /**
  18655. * Sets the only meshes impacted by this light.
  18656. */
  18657. set includedOnlyMeshes(value: AbstractMesh[]);
  18658. private _excludedMeshes;
  18659. /**
  18660. * Gets the meshes not impacted by this light.
  18661. */
  18662. get excludedMeshes(): AbstractMesh[];
  18663. /**
  18664. * Sets the meshes not impacted by this light.
  18665. */
  18666. set excludedMeshes(value: AbstractMesh[]);
  18667. private _excludeWithLayerMask;
  18668. /**
  18669. * Gets the layer id use to find what meshes are not impacted by the light.
  18670. * Inactive if 0
  18671. */
  18672. get excludeWithLayerMask(): number;
  18673. /**
  18674. * Sets the layer id use to find what meshes are not impacted by the light.
  18675. * Inactive if 0
  18676. */
  18677. set excludeWithLayerMask(value: number);
  18678. private _includeOnlyWithLayerMask;
  18679. /**
  18680. * Gets the layer id use to find what meshes are impacted by the light.
  18681. * Inactive if 0
  18682. */
  18683. get includeOnlyWithLayerMask(): number;
  18684. /**
  18685. * Sets the layer id use to find what meshes are impacted by the light.
  18686. * Inactive if 0
  18687. */
  18688. set includeOnlyWithLayerMask(value: number);
  18689. private _lightmapMode;
  18690. /**
  18691. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18692. */
  18693. get lightmapMode(): number;
  18694. /**
  18695. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18696. */
  18697. set lightmapMode(value: number);
  18698. /**
  18699. * Shadow generator associted to the light.
  18700. * @hidden Internal use only.
  18701. */
  18702. _shadowGenerator: Nullable<IShadowGenerator>;
  18703. /**
  18704. * @hidden Internal use only.
  18705. */
  18706. _excludedMeshesIds: string[];
  18707. /**
  18708. * @hidden Internal use only.
  18709. */
  18710. _includedOnlyMeshesIds: string[];
  18711. /**
  18712. * The current light unifom buffer.
  18713. * @hidden Internal use only.
  18714. */
  18715. _uniformBuffer: UniformBuffer;
  18716. /** @hidden */
  18717. _renderId: number;
  18718. /**
  18719. * Creates a Light object in the scene.
  18720. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18721. * @param name The firendly name of the light
  18722. * @param scene The scene the light belongs too
  18723. */
  18724. constructor(name: string, scene: Scene);
  18725. protected abstract _buildUniformLayout(): void;
  18726. /**
  18727. * Sets the passed Effect "effect" with the Light information.
  18728. * @param effect The effect to update
  18729. * @param lightIndex The index of the light in the effect to update
  18730. * @returns The light
  18731. */
  18732. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18733. /**
  18734. * Sets the passed Effect "effect" with the Light textures.
  18735. * @param effect The effect to update
  18736. * @param lightIndex The index of the light in the effect to update
  18737. * @returns The light
  18738. */
  18739. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18740. /**
  18741. * Binds the lights information from the scene to the effect for the given mesh.
  18742. * @param lightIndex Light index
  18743. * @param scene The scene where the light belongs to
  18744. * @param effect The effect we are binding the data to
  18745. * @param useSpecular Defines if specular is supported
  18746. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18747. */
  18748. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18749. /**
  18750. * Sets the passed Effect "effect" with the Light information.
  18751. * @param effect The effect to update
  18752. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18753. * @returns The light
  18754. */
  18755. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18756. /**
  18757. * Returns the string "Light".
  18758. * @returns the class name
  18759. */
  18760. getClassName(): string;
  18761. /** @hidden */
  18762. readonly _isLight: boolean;
  18763. /**
  18764. * Converts the light information to a readable string for debug purpose.
  18765. * @param fullDetails Supports for multiple levels of logging within scene loading
  18766. * @returns the human readable light info
  18767. */
  18768. toString(fullDetails?: boolean): string;
  18769. /** @hidden */
  18770. protected _syncParentEnabledState(): void;
  18771. /**
  18772. * Set the enabled state of this node.
  18773. * @param value - the new enabled state
  18774. */
  18775. setEnabled(value: boolean): void;
  18776. /**
  18777. * Returns the Light associated shadow generator if any.
  18778. * @return the associated shadow generator.
  18779. */
  18780. getShadowGenerator(): Nullable<IShadowGenerator>;
  18781. /**
  18782. * Returns a Vector3, the absolute light position in the World.
  18783. * @returns the world space position of the light
  18784. */
  18785. getAbsolutePosition(): Vector3;
  18786. /**
  18787. * Specifies if the light will affect the passed mesh.
  18788. * @param mesh The mesh to test against the light
  18789. * @return true the mesh is affected otherwise, false.
  18790. */
  18791. canAffectMesh(mesh: AbstractMesh): boolean;
  18792. /**
  18793. * Sort function to order lights for rendering.
  18794. * @param a First Light object to compare to second.
  18795. * @param b Second Light object to compare first.
  18796. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18797. */
  18798. static CompareLightsPriority(a: Light, b: Light): number;
  18799. /**
  18800. * Releases resources associated with this node.
  18801. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18802. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18803. */
  18804. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18805. /**
  18806. * Returns the light type ID (integer).
  18807. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18808. */
  18809. getTypeID(): number;
  18810. /**
  18811. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18812. * @returns the scaled intensity in intensity mode unit
  18813. */
  18814. getScaledIntensity(): number;
  18815. /**
  18816. * Returns a new Light object, named "name", from the current one.
  18817. * @param name The name of the cloned light
  18818. * @param newParent The parent of this light, if it has one
  18819. * @returns the new created light
  18820. */
  18821. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18822. /**
  18823. * Serializes the current light into a Serialization object.
  18824. * @returns the serialized object.
  18825. */
  18826. serialize(): any;
  18827. /**
  18828. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18829. * This new light is named "name" and added to the passed scene.
  18830. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18831. * @param name The friendly name of the light
  18832. * @param scene The scene the new light will belong to
  18833. * @returns the constructor function
  18834. */
  18835. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18836. /**
  18837. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18838. * @param parsedLight The JSON representation of the light
  18839. * @param scene The scene to create the parsed light in
  18840. * @returns the created light after parsing
  18841. */
  18842. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18843. private _hookArrayForExcluded;
  18844. private _hookArrayForIncludedOnly;
  18845. private _resyncMeshes;
  18846. /**
  18847. * Forces the meshes to update their light related information in their rendering used effects
  18848. * @hidden Internal Use Only
  18849. */
  18850. _markMeshesAsLightDirty(): void;
  18851. /**
  18852. * Recomputes the cached photometric scale if needed.
  18853. */
  18854. private _computePhotometricScale;
  18855. /**
  18856. * Returns the Photometric Scale according to the light type and intensity mode.
  18857. */
  18858. private _getPhotometricScale;
  18859. /**
  18860. * Reorder the light in the scene according to their defined priority.
  18861. * @hidden Internal Use Only
  18862. */
  18863. _reorderLightsInScene(): void;
  18864. /**
  18865. * Prepares the list of defines specific to the light type.
  18866. * @param defines the list of defines
  18867. * @param lightIndex defines the index of the light for the effect
  18868. */
  18869. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18870. }
  18871. }
  18872. declare module "babylonjs/Cameras/targetCamera" {
  18873. import { Nullable } from "babylonjs/types";
  18874. import { Camera } from "babylonjs/Cameras/camera";
  18875. import { Scene } from "babylonjs/scene";
  18876. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18877. /**
  18878. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18879. * This is the base of the follow, arc rotate cameras and Free camera
  18880. * @see https://doc.babylonjs.com/features/cameras
  18881. */
  18882. export class TargetCamera extends Camera {
  18883. private static _RigCamTransformMatrix;
  18884. private static _TargetTransformMatrix;
  18885. private static _TargetFocalPoint;
  18886. private _tmpUpVector;
  18887. private _tmpTargetVector;
  18888. /**
  18889. * Define the current direction the camera is moving to
  18890. */
  18891. cameraDirection: Vector3;
  18892. /**
  18893. * Define the current rotation the camera is rotating to
  18894. */
  18895. cameraRotation: Vector2;
  18896. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18897. ignoreParentScaling: boolean;
  18898. /**
  18899. * When set, the up vector of the camera will be updated by the rotation of the camera
  18900. */
  18901. updateUpVectorFromRotation: boolean;
  18902. private _tmpQuaternion;
  18903. /**
  18904. * Define the current rotation of the camera
  18905. */
  18906. rotation: Vector3;
  18907. /**
  18908. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18909. */
  18910. rotationQuaternion: Quaternion;
  18911. /**
  18912. * Define the current speed of the camera
  18913. */
  18914. speed: number;
  18915. /**
  18916. * Add constraint to the camera to prevent it to move freely in all directions and
  18917. * around all axis.
  18918. */
  18919. noRotationConstraint: boolean;
  18920. /**
  18921. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18922. * panning
  18923. */
  18924. invertRotation: boolean;
  18925. /**
  18926. * Speed multiplier for inverse camera panning
  18927. */
  18928. inverseRotationSpeed: number;
  18929. /**
  18930. * Define the current target of the camera as an object or a position.
  18931. */
  18932. lockedTarget: any;
  18933. /** @hidden */
  18934. _currentTarget: Vector3;
  18935. /** @hidden */
  18936. _initialFocalDistance: number;
  18937. /** @hidden */
  18938. _viewMatrix: Matrix;
  18939. /** @hidden */
  18940. _camMatrix: Matrix;
  18941. /** @hidden */
  18942. _cameraTransformMatrix: Matrix;
  18943. /** @hidden */
  18944. _cameraRotationMatrix: Matrix;
  18945. /** @hidden */
  18946. _referencePoint: Vector3;
  18947. /** @hidden */
  18948. _transformedReferencePoint: Vector3;
  18949. /** @hidden */
  18950. _reset: () => void;
  18951. private _defaultUp;
  18952. /**
  18953. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  18954. * This is the base of the follow, arc rotate cameras and Free camera
  18955. * @see https://doc.babylonjs.com/features/cameras
  18956. * @param name Defines the name of the camera in the scene
  18957. * @param position Defines the start position of the camera in the scene
  18958. * @param scene Defines the scene the camera belongs to
  18959. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  18960. */
  18961. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  18962. /**
  18963. * Gets the position in front of the camera at a given distance.
  18964. * @param distance The distance from the camera we want the position to be
  18965. * @returns the position
  18966. */
  18967. getFrontPosition(distance: number): Vector3;
  18968. /** @hidden */
  18969. _getLockedTargetPosition(): Nullable<Vector3>;
  18970. private _storedPosition;
  18971. private _storedRotation;
  18972. private _storedRotationQuaternion;
  18973. /**
  18974. * Store current camera state of the camera (fov, position, rotation, etc..)
  18975. * @returns the camera
  18976. */
  18977. storeState(): Camera;
  18978. /**
  18979. * Restored camera state. You must call storeState() first
  18980. * @returns whether it was successful or not
  18981. * @hidden
  18982. */
  18983. _restoreStateValues(): boolean;
  18984. /** @hidden */
  18985. _initCache(): void;
  18986. /** @hidden */
  18987. _updateCache(ignoreParentClass?: boolean): void;
  18988. /** @hidden */
  18989. _isSynchronizedViewMatrix(): boolean;
  18990. /** @hidden */
  18991. _computeLocalCameraSpeed(): number;
  18992. /**
  18993. * Defines the target the camera should look at.
  18994. * @param target Defines the new target as a Vector or a mesh
  18995. */
  18996. setTarget(target: Vector3): void;
  18997. /**
  18998. * Defines the target point of the camera.
  18999. * The camera looks towards it form the radius distance.
  19000. */
  19001. get target(): Vector3;
  19002. set target(value: Vector3);
  19003. /**
  19004. * Return the current target position of the camera. This value is expressed in local space.
  19005. * @returns the target position
  19006. */
  19007. getTarget(): Vector3;
  19008. /** @hidden */
  19009. _decideIfNeedsToMove(): boolean;
  19010. /** @hidden */
  19011. _updatePosition(): void;
  19012. /** @hidden */
  19013. _checkInputs(): void;
  19014. protected _updateCameraRotationMatrix(): void;
  19015. /**
  19016. * 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)
  19017. * @returns the current camera
  19018. */
  19019. private _rotateUpVectorWithCameraRotationMatrix;
  19020. private _cachedRotationZ;
  19021. private _cachedQuaternionRotationZ;
  19022. /** @hidden */
  19023. _getViewMatrix(): Matrix;
  19024. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  19025. /**
  19026. * @hidden
  19027. */
  19028. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  19029. /**
  19030. * @hidden
  19031. */
  19032. _updateRigCameras(): void;
  19033. private _getRigCamPositionAndTarget;
  19034. /**
  19035. * Gets the current object class name.
  19036. * @return the class name
  19037. */
  19038. getClassName(): string;
  19039. }
  19040. }
  19041. declare module "babylonjs/Events/keyboardEvents" {
  19042. /**
  19043. * Gather the list of keyboard event types as constants.
  19044. */
  19045. export class KeyboardEventTypes {
  19046. /**
  19047. * The keydown event is fired when a key becomes active (pressed).
  19048. */
  19049. static readonly KEYDOWN: number;
  19050. /**
  19051. * The keyup event is fired when a key has been released.
  19052. */
  19053. static readonly KEYUP: number;
  19054. }
  19055. /**
  19056. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19057. */
  19058. export class KeyboardInfo {
  19059. /**
  19060. * Defines the type of event (KeyboardEventTypes)
  19061. */
  19062. type: number;
  19063. /**
  19064. * Defines the related dom event
  19065. */
  19066. event: KeyboardEvent;
  19067. /**
  19068. * Instantiates a new keyboard info.
  19069. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19070. * @param type Defines the type of event (KeyboardEventTypes)
  19071. * @param event Defines the related dom event
  19072. */
  19073. constructor(
  19074. /**
  19075. * Defines the type of event (KeyboardEventTypes)
  19076. */
  19077. type: number,
  19078. /**
  19079. * Defines the related dom event
  19080. */
  19081. event: KeyboardEvent);
  19082. }
  19083. /**
  19084. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19085. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  19086. */
  19087. export class KeyboardInfoPre extends KeyboardInfo {
  19088. /**
  19089. * Defines the type of event (KeyboardEventTypes)
  19090. */
  19091. type: number;
  19092. /**
  19093. * Defines the related dom event
  19094. */
  19095. event: KeyboardEvent;
  19096. /**
  19097. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  19098. */
  19099. skipOnPointerObservable: boolean;
  19100. /**
  19101. * Instantiates a new keyboard pre info.
  19102. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19103. * @param type Defines the type of event (KeyboardEventTypes)
  19104. * @param event Defines the related dom event
  19105. */
  19106. constructor(
  19107. /**
  19108. * Defines the type of event (KeyboardEventTypes)
  19109. */
  19110. type: number,
  19111. /**
  19112. * Defines the related dom event
  19113. */
  19114. event: KeyboardEvent);
  19115. }
  19116. }
  19117. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  19118. import { Nullable } from "babylonjs/types";
  19119. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19120. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19121. /**
  19122. * Manage the keyboard inputs to control the movement of a free camera.
  19123. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19124. */
  19125. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  19126. /**
  19127. * Defines the camera the input is attached to.
  19128. */
  19129. camera: FreeCamera;
  19130. /**
  19131. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19132. */
  19133. keysUp: number[];
  19134. /**
  19135. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19136. */
  19137. keysUpward: number[];
  19138. /**
  19139. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19140. */
  19141. keysDown: number[];
  19142. /**
  19143. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19144. */
  19145. keysDownward: number[];
  19146. /**
  19147. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19148. */
  19149. keysLeft: number[];
  19150. /**
  19151. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19152. */
  19153. keysRight: number[];
  19154. private _keys;
  19155. private _onCanvasBlurObserver;
  19156. private _onKeyboardObserver;
  19157. private _engine;
  19158. private _scene;
  19159. /**
  19160. * Attach the input controls to a specific dom element to get the input from.
  19161. * @param element Defines the element the controls should be listened from
  19162. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19163. */
  19164. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19165. /**
  19166. * Detach the current controls from the specified dom element.
  19167. * @param element Defines the element to stop listening the inputs from
  19168. */
  19169. detachControl(element: Nullable<HTMLElement>): void;
  19170. /**
  19171. * Update the current camera state depending on the inputs that have been used this frame.
  19172. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19173. */
  19174. checkInputs(): void;
  19175. /**
  19176. * Gets the class name of the current intput.
  19177. * @returns the class name
  19178. */
  19179. getClassName(): string;
  19180. /** @hidden */
  19181. _onLostFocus(): void;
  19182. /**
  19183. * Get the friendly name associated with the input class.
  19184. * @returns the input friendly name
  19185. */
  19186. getSimpleName(): string;
  19187. }
  19188. }
  19189. declare module "babylonjs/Events/pointerEvents" {
  19190. import { Nullable } from "babylonjs/types";
  19191. import { Vector2 } from "babylonjs/Maths/math.vector";
  19192. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19193. import { Ray } from "babylonjs/Culling/ray";
  19194. /**
  19195. * Gather the list of pointer event types as constants.
  19196. */
  19197. export class PointerEventTypes {
  19198. /**
  19199. * 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.
  19200. */
  19201. static readonly POINTERDOWN: number;
  19202. /**
  19203. * The pointerup event is fired when a pointer is no longer active.
  19204. */
  19205. static readonly POINTERUP: number;
  19206. /**
  19207. * The pointermove event is fired when a pointer changes coordinates.
  19208. */
  19209. static readonly POINTERMOVE: number;
  19210. /**
  19211. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19212. */
  19213. static readonly POINTERWHEEL: number;
  19214. /**
  19215. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19216. */
  19217. static readonly POINTERPICK: number;
  19218. /**
  19219. * The pointertap event is fired when a the object has been touched and released without drag.
  19220. */
  19221. static readonly POINTERTAP: number;
  19222. /**
  19223. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19224. */
  19225. static readonly POINTERDOUBLETAP: number;
  19226. }
  19227. /**
  19228. * Base class of pointer info types.
  19229. */
  19230. export class PointerInfoBase {
  19231. /**
  19232. * Defines the type of event (PointerEventTypes)
  19233. */
  19234. type: number;
  19235. /**
  19236. * Defines the related dom event
  19237. */
  19238. event: PointerEvent | MouseWheelEvent;
  19239. /**
  19240. * Instantiates the base class of pointers info.
  19241. * @param type Defines the type of event (PointerEventTypes)
  19242. * @param event Defines the related dom event
  19243. */
  19244. constructor(
  19245. /**
  19246. * Defines the type of event (PointerEventTypes)
  19247. */
  19248. type: number,
  19249. /**
  19250. * Defines the related dom event
  19251. */
  19252. event: PointerEvent | MouseWheelEvent);
  19253. }
  19254. /**
  19255. * This class is used to store pointer related info for the onPrePointerObservable event.
  19256. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19257. */
  19258. export class PointerInfoPre extends PointerInfoBase {
  19259. /**
  19260. * Ray from a pointer if availible (eg. 6dof controller)
  19261. */
  19262. ray: Nullable<Ray>;
  19263. /**
  19264. * Defines the local position of the pointer on the canvas.
  19265. */
  19266. localPosition: Vector2;
  19267. /**
  19268. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19269. */
  19270. skipOnPointerObservable: boolean;
  19271. /**
  19272. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19273. * @param type Defines the type of event (PointerEventTypes)
  19274. * @param event Defines the related dom event
  19275. * @param localX Defines the local x coordinates of the pointer when the event occured
  19276. * @param localY Defines the local y coordinates of the pointer when the event occured
  19277. */
  19278. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19279. }
  19280. /**
  19281. * This type contains all the data related to a pointer event in Babylon.js.
  19282. * 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.
  19283. */
  19284. export class PointerInfo extends PointerInfoBase {
  19285. /**
  19286. * Defines the picking info associated to the info (if any)\
  19287. */
  19288. pickInfo: Nullable<PickingInfo>;
  19289. /**
  19290. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19291. * @param type Defines the type of event (PointerEventTypes)
  19292. * @param event Defines the related dom event
  19293. * @param pickInfo Defines the picking info associated to the info (if any)\
  19294. */
  19295. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19296. /**
  19297. * Defines the picking info associated to the info (if any)\
  19298. */
  19299. pickInfo: Nullable<PickingInfo>);
  19300. }
  19301. /**
  19302. * Data relating to a touch event on the screen.
  19303. */
  19304. export interface PointerTouch {
  19305. /**
  19306. * X coordinate of touch.
  19307. */
  19308. x: number;
  19309. /**
  19310. * Y coordinate of touch.
  19311. */
  19312. y: number;
  19313. /**
  19314. * Id of touch. Unique for each finger.
  19315. */
  19316. pointerId: number;
  19317. /**
  19318. * Event type passed from DOM.
  19319. */
  19320. type: any;
  19321. }
  19322. }
  19323. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19324. import { Observable } from "babylonjs/Misc/observable";
  19325. import { Nullable } from "babylonjs/types";
  19326. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19327. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19328. /**
  19329. * Manage the mouse inputs to control the movement of a free camera.
  19330. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19331. */
  19332. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19333. /**
  19334. * Define if touch is enabled in the mouse input
  19335. */
  19336. touchEnabled: boolean;
  19337. /**
  19338. * Defines the camera the input is attached to.
  19339. */
  19340. camera: FreeCamera;
  19341. /**
  19342. * Defines the buttons associated with the input to handle camera move.
  19343. */
  19344. buttons: number[];
  19345. /**
  19346. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19347. */
  19348. angularSensibility: number;
  19349. private _pointerInput;
  19350. private _onMouseMove;
  19351. private _observer;
  19352. private previousPosition;
  19353. /**
  19354. * Observable for when a pointer move event occurs containing the move offset
  19355. */
  19356. onPointerMovedObservable: Observable<{
  19357. offsetX: number;
  19358. offsetY: number;
  19359. }>;
  19360. /**
  19361. * @hidden
  19362. * If the camera should be rotated automatically based on pointer movement
  19363. */
  19364. _allowCameraRotation: boolean;
  19365. /**
  19366. * Manage the mouse inputs to control the movement of a free camera.
  19367. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19368. * @param touchEnabled Defines if touch is enabled or not
  19369. */
  19370. constructor(
  19371. /**
  19372. * Define if touch is enabled in the mouse input
  19373. */
  19374. touchEnabled?: boolean);
  19375. /**
  19376. * Attach the input controls to a specific dom element to get the input from.
  19377. * @param element Defines the element the controls should be listened from
  19378. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19379. */
  19380. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19381. /**
  19382. * Called on JS contextmenu event.
  19383. * Override this method to provide functionality.
  19384. */
  19385. protected onContextMenu(evt: PointerEvent): void;
  19386. /**
  19387. * Detach the current controls from the specified dom element.
  19388. * @param element Defines the element to stop listening the inputs from
  19389. */
  19390. detachControl(element: Nullable<HTMLElement>): void;
  19391. /**
  19392. * Gets the class name of the current intput.
  19393. * @returns the class name
  19394. */
  19395. getClassName(): string;
  19396. /**
  19397. * Get the friendly name associated with the input class.
  19398. * @returns the input friendly name
  19399. */
  19400. getSimpleName(): string;
  19401. }
  19402. }
  19403. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19404. import { Nullable } from "babylonjs/types";
  19405. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19406. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19407. /**
  19408. * Manage the touch inputs to control the movement of a free camera.
  19409. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19410. */
  19411. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19412. /**
  19413. * Define if mouse events can be treated as touch events
  19414. */
  19415. allowMouse: boolean;
  19416. /**
  19417. * Defines the camera the input is attached to.
  19418. */
  19419. camera: FreeCamera;
  19420. /**
  19421. * Defines the touch sensibility for rotation.
  19422. * The higher the faster.
  19423. */
  19424. touchAngularSensibility: number;
  19425. /**
  19426. * Defines the touch sensibility for move.
  19427. * The higher the faster.
  19428. */
  19429. touchMoveSensibility: number;
  19430. private _offsetX;
  19431. private _offsetY;
  19432. private _pointerPressed;
  19433. private _pointerInput;
  19434. private _observer;
  19435. private _onLostFocus;
  19436. /**
  19437. * Manage the touch inputs to control the movement of a free camera.
  19438. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19439. * @param allowMouse Defines if mouse events can be treated as touch events
  19440. */
  19441. constructor(
  19442. /**
  19443. * Define if mouse events can be treated as touch events
  19444. */
  19445. allowMouse?: boolean);
  19446. /**
  19447. * Attach the input controls to a specific dom element to get the input from.
  19448. * @param element Defines the element the controls should be listened from
  19449. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19450. */
  19451. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19452. /**
  19453. * Detach the current controls from the specified dom element.
  19454. * @param element Defines the element to stop listening the inputs from
  19455. */
  19456. detachControl(element: Nullable<HTMLElement>): void;
  19457. /**
  19458. * Update the current camera state depending on the inputs that have been used this frame.
  19459. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19460. */
  19461. checkInputs(): void;
  19462. /**
  19463. * Gets the class name of the current intput.
  19464. * @returns the class name
  19465. */
  19466. getClassName(): string;
  19467. /**
  19468. * Get the friendly name associated with the input class.
  19469. * @returns the input friendly name
  19470. */
  19471. getSimpleName(): string;
  19472. }
  19473. }
  19474. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19475. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19476. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19477. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19478. import { Nullable } from "babylonjs/types";
  19479. /**
  19480. * Default Inputs manager for the FreeCamera.
  19481. * It groups all the default supported inputs for ease of use.
  19482. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19483. */
  19484. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19485. /**
  19486. * @hidden
  19487. */
  19488. _mouseInput: Nullable<FreeCameraMouseInput>;
  19489. /**
  19490. * Instantiates a new FreeCameraInputsManager.
  19491. * @param camera Defines the camera the inputs belong to
  19492. */
  19493. constructor(camera: FreeCamera);
  19494. /**
  19495. * Add keyboard input support to the input manager.
  19496. * @returns the current input manager
  19497. */
  19498. addKeyboard(): FreeCameraInputsManager;
  19499. /**
  19500. * Add mouse input support to the input manager.
  19501. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19502. * @returns the current input manager
  19503. */
  19504. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19505. /**
  19506. * Removes the mouse input support from the manager
  19507. * @returns the current input manager
  19508. */
  19509. removeMouse(): FreeCameraInputsManager;
  19510. /**
  19511. * Add touch input support to the input manager.
  19512. * @returns the current input manager
  19513. */
  19514. addTouch(): FreeCameraInputsManager;
  19515. /**
  19516. * Remove all attached input methods from a camera
  19517. */
  19518. clear(): void;
  19519. }
  19520. }
  19521. declare module "babylonjs/Cameras/freeCamera" {
  19522. import { Vector3 } from "babylonjs/Maths/math.vector";
  19523. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19524. import { Scene } from "babylonjs/scene";
  19525. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19526. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19527. /**
  19528. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19529. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19530. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19531. */
  19532. export class FreeCamera extends TargetCamera {
  19533. /**
  19534. * Define the collision ellipsoid of the camera.
  19535. * This is helpful to simulate a camera body like the player body around the camera
  19536. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19537. */
  19538. ellipsoid: Vector3;
  19539. /**
  19540. * Define an offset for the position of the ellipsoid around the camera.
  19541. * This can be helpful to determine the center of the body near the gravity center of the body
  19542. * instead of its head.
  19543. */
  19544. ellipsoidOffset: Vector3;
  19545. /**
  19546. * Enable or disable collisions of the camera with the rest of the scene objects.
  19547. */
  19548. checkCollisions: boolean;
  19549. /**
  19550. * Enable or disable gravity on the camera.
  19551. */
  19552. applyGravity: boolean;
  19553. /**
  19554. * Define the input manager associated to the camera.
  19555. */
  19556. inputs: FreeCameraInputsManager;
  19557. /**
  19558. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19559. * Higher values reduce sensitivity.
  19560. */
  19561. get angularSensibility(): number;
  19562. /**
  19563. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19564. * Higher values reduce sensitivity.
  19565. */
  19566. set angularSensibility(value: number);
  19567. /**
  19568. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19569. */
  19570. get keysUp(): number[];
  19571. set keysUp(value: number[]);
  19572. /**
  19573. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19574. */
  19575. get keysUpward(): number[];
  19576. set keysUpward(value: number[]);
  19577. /**
  19578. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19579. */
  19580. get keysDown(): number[];
  19581. set keysDown(value: number[]);
  19582. /**
  19583. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19584. */
  19585. get keysDownward(): number[];
  19586. set keysDownward(value: number[]);
  19587. /**
  19588. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19589. */
  19590. get keysLeft(): number[];
  19591. set keysLeft(value: number[]);
  19592. /**
  19593. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19594. */
  19595. get keysRight(): number[];
  19596. set keysRight(value: number[]);
  19597. /**
  19598. * Event raised when the camera collide with a mesh in the scene.
  19599. */
  19600. onCollide: (collidedMesh: AbstractMesh) => void;
  19601. private _collider;
  19602. private _needMoveForGravity;
  19603. private _oldPosition;
  19604. private _diffPosition;
  19605. private _newPosition;
  19606. /** @hidden */
  19607. _localDirection: Vector3;
  19608. /** @hidden */
  19609. _transformedDirection: Vector3;
  19610. /**
  19611. * Instantiates a Free Camera.
  19612. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19613. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19614. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19615. * @param name Define the name of the camera in the scene
  19616. * @param position Define the start position of the camera in the scene
  19617. * @param scene Define the scene the camera belongs to
  19618. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19619. */
  19620. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19621. /**
  19622. * Attached controls to the current camera.
  19623. * @param element Defines the element the controls should be listened from
  19624. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19625. */
  19626. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19627. /**
  19628. * Detach the current controls from the camera.
  19629. * The camera will stop reacting to inputs.
  19630. * @param element Defines the element to stop listening the inputs from
  19631. */
  19632. detachControl(element: HTMLElement): void;
  19633. private _collisionMask;
  19634. /**
  19635. * Define a collision mask to limit the list of object the camera can collide with
  19636. */
  19637. get collisionMask(): number;
  19638. set collisionMask(mask: number);
  19639. /** @hidden */
  19640. _collideWithWorld(displacement: Vector3): void;
  19641. private _onCollisionPositionChange;
  19642. /** @hidden */
  19643. _checkInputs(): void;
  19644. /** @hidden */
  19645. _decideIfNeedsToMove(): boolean;
  19646. /** @hidden */
  19647. _updatePosition(): void;
  19648. /**
  19649. * Destroy the camera and release the current resources hold by it.
  19650. */
  19651. dispose(): void;
  19652. /**
  19653. * Gets the current object class name.
  19654. * @return the class name
  19655. */
  19656. getClassName(): string;
  19657. }
  19658. }
  19659. declare module "babylonjs/Gamepads/gamepad" {
  19660. import { Observable } from "babylonjs/Misc/observable";
  19661. /**
  19662. * Represents a gamepad control stick position
  19663. */
  19664. export class StickValues {
  19665. /**
  19666. * The x component of the control stick
  19667. */
  19668. x: number;
  19669. /**
  19670. * The y component of the control stick
  19671. */
  19672. y: number;
  19673. /**
  19674. * Initializes the gamepad x and y control stick values
  19675. * @param x The x component of the gamepad control stick value
  19676. * @param y The y component of the gamepad control stick value
  19677. */
  19678. constructor(
  19679. /**
  19680. * The x component of the control stick
  19681. */
  19682. x: number,
  19683. /**
  19684. * The y component of the control stick
  19685. */
  19686. y: number);
  19687. }
  19688. /**
  19689. * An interface which manages callbacks for gamepad button changes
  19690. */
  19691. export interface GamepadButtonChanges {
  19692. /**
  19693. * Called when a gamepad has been changed
  19694. */
  19695. changed: boolean;
  19696. /**
  19697. * Called when a gamepad press event has been triggered
  19698. */
  19699. pressChanged: boolean;
  19700. /**
  19701. * Called when a touch event has been triggered
  19702. */
  19703. touchChanged: boolean;
  19704. /**
  19705. * Called when a value has changed
  19706. */
  19707. valueChanged: boolean;
  19708. }
  19709. /**
  19710. * Represents a gamepad
  19711. */
  19712. export class Gamepad {
  19713. /**
  19714. * The id of the gamepad
  19715. */
  19716. id: string;
  19717. /**
  19718. * The index of the gamepad
  19719. */
  19720. index: number;
  19721. /**
  19722. * The browser gamepad
  19723. */
  19724. browserGamepad: any;
  19725. /**
  19726. * Specifies what type of gamepad this represents
  19727. */
  19728. type: number;
  19729. private _leftStick;
  19730. private _rightStick;
  19731. /** @hidden */
  19732. _isConnected: boolean;
  19733. private _leftStickAxisX;
  19734. private _leftStickAxisY;
  19735. private _rightStickAxisX;
  19736. private _rightStickAxisY;
  19737. /**
  19738. * Triggered when the left control stick has been changed
  19739. */
  19740. private _onleftstickchanged;
  19741. /**
  19742. * Triggered when the right control stick has been changed
  19743. */
  19744. private _onrightstickchanged;
  19745. /**
  19746. * Represents a gamepad controller
  19747. */
  19748. static GAMEPAD: number;
  19749. /**
  19750. * Represents a generic controller
  19751. */
  19752. static GENERIC: number;
  19753. /**
  19754. * Represents an XBox controller
  19755. */
  19756. static XBOX: number;
  19757. /**
  19758. * Represents a pose-enabled controller
  19759. */
  19760. static POSE_ENABLED: number;
  19761. /**
  19762. * Represents an Dual Shock controller
  19763. */
  19764. static DUALSHOCK: number;
  19765. /**
  19766. * Specifies whether the left control stick should be Y-inverted
  19767. */
  19768. protected _invertLeftStickY: boolean;
  19769. /**
  19770. * Specifies if the gamepad has been connected
  19771. */
  19772. get isConnected(): boolean;
  19773. /**
  19774. * Initializes the gamepad
  19775. * @param id The id of the gamepad
  19776. * @param index The index of the gamepad
  19777. * @param browserGamepad The browser gamepad
  19778. * @param leftStickX The x component of the left joystick
  19779. * @param leftStickY The y component of the left joystick
  19780. * @param rightStickX The x component of the right joystick
  19781. * @param rightStickY The y component of the right joystick
  19782. */
  19783. constructor(
  19784. /**
  19785. * The id of the gamepad
  19786. */
  19787. id: string,
  19788. /**
  19789. * The index of the gamepad
  19790. */
  19791. index: number,
  19792. /**
  19793. * The browser gamepad
  19794. */
  19795. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19796. /**
  19797. * Callback triggered when the left joystick has changed
  19798. * @param callback
  19799. */
  19800. onleftstickchanged(callback: (values: StickValues) => void): void;
  19801. /**
  19802. * Callback triggered when the right joystick has changed
  19803. * @param callback
  19804. */
  19805. onrightstickchanged(callback: (values: StickValues) => void): void;
  19806. /**
  19807. * Gets the left joystick
  19808. */
  19809. get leftStick(): StickValues;
  19810. /**
  19811. * Sets the left joystick values
  19812. */
  19813. set leftStick(newValues: StickValues);
  19814. /**
  19815. * Gets the right joystick
  19816. */
  19817. get rightStick(): StickValues;
  19818. /**
  19819. * Sets the right joystick value
  19820. */
  19821. set rightStick(newValues: StickValues);
  19822. /**
  19823. * Updates the gamepad joystick positions
  19824. */
  19825. update(): void;
  19826. /**
  19827. * Disposes the gamepad
  19828. */
  19829. dispose(): void;
  19830. }
  19831. /**
  19832. * Represents a generic gamepad
  19833. */
  19834. export class GenericPad extends Gamepad {
  19835. private _buttons;
  19836. private _onbuttondown;
  19837. private _onbuttonup;
  19838. /**
  19839. * Observable triggered when a button has been pressed
  19840. */
  19841. onButtonDownObservable: Observable<number>;
  19842. /**
  19843. * Observable triggered when a button has been released
  19844. */
  19845. onButtonUpObservable: Observable<number>;
  19846. /**
  19847. * Callback triggered when a button has been pressed
  19848. * @param callback Called when a button has been pressed
  19849. */
  19850. onbuttondown(callback: (buttonPressed: number) => void): void;
  19851. /**
  19852. * Callback triggered when a button has been released
  19853. * @param callback Called when a button has been released
  19854. */
  19855. onbuttonup(callback: (buttonReleased: number) => void): void;
  19856. /**
  19857. * Initializes the generic gamepad
  19858. * @param id The id of the generic gamepad
  19859. * @param index The index of the generic gamepad
  19860. * @param browserGamepad The browser gamepad
  19861. */
  19862. constructor(id: string, index: number, browserGamepad: any);
  19863. private _setButtonValue;
  19864. /**
  19865. * Updates the generic gamepad
  19866. */
  19867. update(): void;
  19868. /**
  19869. * Disposes the generic gamepad
  19870. */
  19871. dispose(): void;
  19872. }
  19873. }
  19874. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19875. import { Observable } from "babylonjs/Misc/observable";
  19876. import { Nullable } from "babylonjs/types";
  19877. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19878. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19879. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19880. import { Ray } from "babylonjs/Culling/ray";
  19881. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19882. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19883. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19884. /**
  19885. * Defines the types of pose enabled controllers that are supported
  19886. */
  19887. export enum PoseEnabledControllerType {
  19888. /**
  19889. * HTC Vive
  19890. */
  19891. VIVE = 0,
  19892. /**
  19893. * Oculus Rift
  19894. */
  19895. OCULUS = 1,
  19896. /**
  19897. * Windows mixed reality
  19898. */
  19899. WINDOWS = 2,
  19900. /**
  19901. * Samsung gear VR
  19902. */
  19903. GEAR_VR = 3,
  19904. /**
  19905. * Google Daydream
  19906. */
  19907. DAYDREAM = 4,
  19908. /**
  19909. * Generic
  19910. */
  19911. GENERIC = 5
  19912. }
  19913. /**
  19914. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19915. */
  19916. export interface MutableGamepadButton {
  19917. /**
  19918. * Value of the button/trigger
  19919. */
  19920. value: number;
  19921. /**
  19922. * If the button/trigger is currently touched
  19923. */
  19924. touched: boolean;
  19925. /**
  19926. * If the button/trigger is currently pressed
  19927. */
  19928. pressed: boolean;
  19929. }
  19930. /**
  19931. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  19932. * @hidden
  19933. */
  19934. export interface ExtendedGamepadButton extends GamepadButton {
  19935. /**
  19936. * If the button/trigger is currently pressed
  19937. */
  19938. readonly pressed: boolean;
  19939. /**
  19940. * If the button/trigger is currently touched
  19941. */
  19942. readonly touched: boolean;
  19943. /**
  19944. * Value of the button/trigger
  19945. */
  19946. readonly value: number;
  19947. }
  19948. /** @hidden */
  19949. export interface _GamePadFactory {
  19950. /**
  19951. * Returns whether or not the current gamepad can be created for this type of controller.
  19952. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19953. * @returns true if it can be created, otherwise false
  19954. */
  19955. canCreate(gamepadInfo: any): boolean;
  19956. /**
  19957. * Creates a new instance of the Gamepad.
  19958. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19959. * @returns the new gamepad instance
  19960. */
  19961. create(gamepadInfo: any): Gamepad;
  19962. }
  19963. /**
  19964. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19965. */
  19966. export class PoseEnabledControllerHelper {
  19967. /** @hidden */
  19968. static _ControllerFactories: _GamePadFactory[];
  19969. /** @hidden */
  19970. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  19971. /**
  19972. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19973. * @param vrGamepad the gamepad to initialized
  19974. * @returns a vr controller of the type the gamepad identified as
  19975. */
  19976. static InitiateController(vrGamepad: any): Gamepad;
  19977. }
  19978. /**
  19979. * Defines the PoseEnabledController object that contains state of a vr capable controller
  19980. */
  19981. export class PoseEnabledController extends Gamepad implements PoseControlled {
  19982. /**
  19983. * If the controller is used in a webXR session
  19984. */
  19985. isXR: boolean;
  19986. private _deviceRoomPosition;
  19987. private _deviceRoomRotationQuaternion;
  19988. /**
  19989. * The device position in babylon space
  19990. */
  19991. devicePosition: Vector3;
  19992. /**
  19993. * The device rotation in babylon space
  19994. */
  19995. deviceRotationQuaternion: Quaternion;
  19996. /**
  19997. * The scale factor of the device in babylon space
  19998. */
  19999. deviceScaleFactor: number;
  20000. /**
  20001. * (Likely devicePosition should be used instead) The device position in its room space
  20002. */
  20003. position: Vector3;
  20004. /**
  20005. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  20006. */
  20007. rotationQuaternion: Quaternion;
  20008. /**
  20009. * The type of controller (Eg. Windows mixed reality)
  20010. */
  20011. controllerType: PoseEnabledControllerType;
  20012. protected _calculatedPosition: Vector3;
  20013. private _calculatedRotation;
  20014. /**
  20015. * The raw pose from the device
  20016. */
  20017. rawPose: DevicePose;
  20018. private _trackPosition;
  20019. private _maxRotationDistFromHeadset;
  20020. private _draggedRoomRotation;
  20021. /**
  20022. * @hidden
  20023. */
  20024. _disableTrackPosition(fixedPosition: Vector3): void;
  20025. /**
  20026. * Internal, the mesh attached to the controller
  20027. * @hidden
  20028. */
  20029. _mesh: Nullable<AbstractMesh>;
  20030. private _poseControlledCamera;
  20031. private _leftHandSystemQuaternion;
  20032. /**
  20033. * Internal, matrix used to convert room space to babylon space
  20034. * @hidden
  20035. */
  20036. _deviceToWorld: Matrix;
  20037. /**
  20038. * Node to be used when casting a ray from the controller
  20039. * @hidden
  20040. */
  20041. _pointingPoseNode: Nullable<TransformNode>;
  20042. /**
  20043. * Name of the child mesh that can be used to cast a ray from the controller
  20044. */
  20045. static readonly POINTING_POSE: string;
  20046. /**
  20047. * Creates a new PoseEnabledController from a gamepad
  20048. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  20049. */
  20050. constructor(browserGamepad: any);
  20051. private _workingMatrix;
  20052. /**
  20053. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  20054. */
  20055. update(): void;
  20056. /**
  20057. * Updates only the pose device and mesh without doing any button event checking
  20058. */
  20059. protected _updatePoseAndMesh(): void;
  20060. /**
  20061. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  20062. * @param poseData raw pose fromthe device
  20063. */
  20064. updateFromDevice(poseData: DevicePose): void;
  20065. /**
  20066. * @hidden
  20067. */
  20068. _meshAttachedObservable: Observable<AbstractMesh>;
  20069. /**
  20070. * Attaches a mesh to the controller
  20071. * @param mesh the mesh to be attached
  20072. */
  20073. attachToMesh(mesh: AbstractMesh): void;
  20074. /**
  20075. * Attaches the controllers mesh to a camera
  20076. * @param camera the camera the mesh should be attached to
  20077. */
  20078. attachToPoseControlledCamera(camera: TargetCamera): void;
  20079. /**
  20080. * Disposes of the controller
  20081. */
  20082. dispose(): void;
  20083. /**
  20084. * The mesh that is attached to the controller
  20085. */
  20086. get mesh(): Nullable<AbstractMesh>;
  20087. /**
  20088. * Gets the ray of the controller in the direction the controller is pointing
  20089. * @param length the length the resulting ray should be
  20090. * @returns a ray in the direction the controller is pointing
  20091. */
  20092. getForwardRay(length?: number): Ray;
  20093. }
  20094. }
  20095. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  20096. import { Observable } from "babylonjs/Misc/observable";
  20097. import { Scene } from "babylonjs/scene";
  20098. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20099. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  20100. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  20101. import { Nullable } from "babylonjs/types";
  20102. /**
  20103. * Defines the WebVRController object that represents controllers tracked in 3D space
  20104. */
  20105. export abstract class WebVRController extends PoseEnabledController {
  20106. /**
  20107. * Internal, the default controller model for the controller
  20108. */
  20109. protected _defaultModel: Nullable<AbstractMesh>;
  20110. /**
  20111. * Fired when the trigger state has changed
  20112. */
  20113. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  20114. /**
  20115. * Fired when the main button state has changed
  20116. */
  20117. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20118. /**
  20119. * Fired when the secondary button state has changed
  20120. */
  20121. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20122. /**
  20123. * Fired when the pad state has changed
  20124. */
  20125. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  20126. /**
  20127. * Fired when controllers stick values have changed
  20128. */
  20129. onPadValuesChangedObservable: Observable<StickValues>;
  20130. /**
  20131. * Array of button availible on the controller
  20132. */
  20133. protected _buttons: Array<MutableGamepadButton>;
  20134. private _onButtonStateChange;
  20135. /**
  20136. * Fired when a controller button's state has changed
  20137. * @param callback the callback containing the button that was modified
  20138. */
  20139. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  20140. /**
  20141. * X and Y axis corresponding to the controllers joystick
  20142. */
  20143. pad: StickValues;
  20144. /**
  20145. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  20146. */
  20147. hand: string;
  20148. /**
  20149. * The default controller model for the controller
  20150. */
  20151. get defaultModel(): Nullable<AbstractMesh>;
  20152. /**
  20153. * Creates a new WebVRController from a gamepad
  20154. * @param vrGamepad the gamepad that the WebVRController should be created from
  20155. */
  20156. constructor(vrGamepad: any);
  20157. /**
  20158. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  20159. */
  20160. update(): void;
  20161. /**
  20162. * Function to be called when a button is modified
  20163. */
  20164. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  20165. /**
  20166. * Loads a mesh and attaches it to the controller
  20167. * @param scene the scene the mesh should be added to
  20168. * @param meshLoaded callback for when the mesh has been loaded
  20169. */
  20170. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  20171. private _setButtonValue;
  20172. private _changes;
  20173. private _checkChanges;
  20174. /**
  20175. * Disposes of th webVRCOntroller
  20176. */
  20177. dispose(): void;
  20178. }
  20179. }
  20180. declare module "babylonjs/Lights/hemisphericLight" {
  20181. import { Nullable } from "babylonjs/types";
  20182. import { Scene } from "babylonjs/scene";
  20183. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20184. import { Color3 } from "babylonjs/Maths/math.color";
  20185. import { Effect } from "babylonjs/Materials/effect";
  20186. import { Light } from "babylonjs/Lights/light";
  20187. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20188. /**
  20189. * The HemisphericLight simulates the ambient environment light,
  20190. * so the passed direction is the light reflection direction, not the incoming direction.
  20191. */
  20192. export class HemisphericLight extends Light {
  20193. /**
  20194. * The groundColor is the light in the opposite direction to the one specified during creation.
  20195. * 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.
  20196. */
  20197. groundColor: Color3;
  20198. /**
  20199. * The light reflection direction, not the incoming direction.
  20200. */
  20201. direction: Vector3;
  20202. /**
  20203. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20204. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20205. * The HemisphericLight can't cast shadows.
  20206. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20207. * @param name The friendly name of the light
  20208. * @param direction The direction of the light reflection
  20209. * @param scene The scene the light belongs to
  20210. */
  20211. constructor(name: string, direction: Vector3, scene: Scene);
  20212. protected _buildUniformLayout(): void;
  20213. /**
  20214. * Returns the string "HemisphericLight".
  20215. * @return The class name
  20216. */
  20217. getClassName(): string;
  20218. /**
  20219. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20220. * Returns the updated direction.
  20221. * @param target The target the direction should point to
  20222. * @return The computed direction
  20223. */
  20224. setDirectionToTarget(target: Vector3): Vector3;
  20225. /**
  20226. * Returns the shadow generator associated to the light.
  20227. * @returns Always null for hemispheric lights because it does not support shadows.
  20228. */
  20229. getShadowGenerator(): Nullable<IShadowGenerator>;
  20230. /**
  20231. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20232. * @param effect The effect to update
  20233. * @param lightIndex The index of the light in the effect to update
  20234. * @returns The hemispheric light
  20235. */
  20236. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20237. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20238. /**
  20239. * Computes the world matrix of the node
  20240. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20241. * @param useWasUpdatedFlag defines a reserved property
  20242. * @returns the world matrix
  20243. */
  20244. computeWorldMatrix(): Matrix;
  20245. /**
  20246. * Returns the integer 3.
  20247. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20248. */
  20249. getTypeID(): number;
  20250. /**
  20251. * Prepares the list of defines specific to the light type.
  20252. * @param defines the list of defines
  20253. * @param lightIndex defines the index of the light for the effect
  20254. */
  20255. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20256. }
  20257. }
  20258. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20259. /** @hidden */
  20260. export var vrMultiviewToSingleviewPixelShader: {
  20261. name: string;
  20262. shader: string;
  20263. };
  20264. }
  20265. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20266. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20267. import { Scene } from "babylonjs/scene";
  20268. /**
  20269. * Renders to multiple views with a single draw call
  20270. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20271. */
  20272. export class MultiviewRenderTarget extends RenderTargetTexture {
  20273. /**
  20274. * Creates a multiview render target
  20275. * @param scene scene used with the render target
  20276. * @param size the size of the render target (used for each view)
  20277. */
  20278. constructor(scene: Scene, size?: number | {
  20279. width: number;
  20280. height: number;
  20281. } | {
  20282. ratio: number;
  20283. });
  20284. /**
  20285. * @hidden
  20286. * @param faceIndex the face index, if its a cube texture
  20287. */
  20288. _bindFrameBuffer(faceIndex?: number): void;
  20289. /**
  20290. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20291. * @returns the view count
  20292. */
  20293. getViewCount(): number;
  20294. }
  20295. }
  20296. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20297. import { Camera } from "babylonjs/Cameras/camera";
  20298. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20299. import { Nullable } from "babylonjs/types";
  20300. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20301. import { Matrix } from "babylonjs/Maths/math.vector";
  20302. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20303. module "babylonjs/Engines/engine" {
  20304. interface Engine {
  20305. /**
  20306. * Creates a new multiview render target
  20307. * @param width defines the width of the texture
  20308. * @param height defines the height of the texture
  20309. * @returns the created multiview texture
  20310. */
  20311. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20312. /**
  20313. * Binds a multiview framebuffer to be drawn to
  20314. * @param multiviewTexture texture to bind
  20315. */
  20316. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20317. }
  20318. }
  20319. module "babylonjs/Cameras/camera" {
  20320. interface Camera {
  20321. /**
  20322. * @hidden
  20323. * 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)
  20324. */
  20325. _useMultiviewToSingleView: boolean;
  20326. /**
  20327. * @hidden
  20328. * 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)
  20329. */
  20330. _multiviewTexture: Nullable<RenderTargetTexture>;
  20331. /**
  20332. * @hidden
  20333. * ensures the multiview texture of the camera exists and has the specified width/height
  20334. * @param width height to set on the multiview texture
  20335. * @param height width to set on the multiview texture
  20336. */
  20337. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20338. }
  20339. }
  20340. module "babylonjs/scene" {
  20341. interface Scene {
  20342. /** @hidden */
  20343. _transformMatrixR: Matrix;
  20344. /** @hidden */
  20345. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20346. /** @hidden */
  20347. _createMultiviewUbo(): void;
  20348. /** @hidden */
  20349. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20350. /** @hidden */
  20351. _renderMultiviewToSingleView(camera: Camera): void;
  20352. }
  20353. }
  20354. }
  20355. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20356. import { Camera } from "babylonjs/Cameras/camera";
  20357. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20358. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20359. import "babylonjs/Engines/Extensions/engine.multiview";
  20360. /**
  20361. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20362. * This will not be used for webXR as it supports displaying texture arrays directly
  20363. */
  20364. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20365. /**
  20366. * Gets a string identifying the name of the class
  20367. * @returns "VRMultiviewToSingleviewPostProcess" string
  20368. */
  20369. getClassName(): string;
  20370. /**
  20371. * Initializes a VRMultiviewToSingleview
  20372. * @param name name of the post process
  20373. * @param camera camera to be applied to
  20374. * @param scaleFactor scaling factor to the size of the output texture
  20375. */
  20376. constructor(name: string, camera: Camera, scaleFactor: number);
  20377. }
  20378. }
  20379. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20380. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20381. import { Nullable } from "babylonjs/types";
  20382. import { Size } from "babylonjs/Maths/math.size";
  20383. import { Observable } from "babylonjs/Misc/observable";
  20384. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20385. /**
  20386. * Interface used to define additional presentation attributes
  20387. */
  20388. export interface IVRPresentationAttributes {
  20389. /**
  20390. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20391. */
  20392. highRefreshRate: boolean;
  20393. /**
  20394. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20395. */
  20396. foveationLevel: number;
  20397. }
  20398. module "babylonjs/Engines/engine" {
  20399. interface Engine {
  20400. /** @hidden */
  20401. _vrDisplay: any;
  20402. /** @hidden */
  20403. _vrSupported: boolean;
  20404. /** @hidden */
  20405. _oldSize: Size;
  20406. /** @hidden */
  20407. _oldHardwareScaleFactor: number;
  20408. /** @hidden */
  20409. _vrExclusivePointerMode: boolean;
  20410. /** @hidden */
  20411. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20412. /** @hidden */
  20413. _onVRDisplayPointerRestricted: () => void;
  20414. /** @hidden */
  20415. _onVRDisplayPointerUnrestricted: () => void;
  20416. /** @hidden */
  20417. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20418. /** @hidden */
  20419. _onVrDisplayDisconnect: Nullable<() => void>;
  20420. /** @hidden */
  20421. _onVrDisplayPresentChange: Nullable<() => void>;
  20422. /**
  20423. * Observable signaled when VR display mode changes
  20424. */
  20425. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20426. /**
  20427. * Observable signaled when VR request present is complete
  20428. */
  20429. onVRRequestPresentComplete: Observable<boolean>;
  20430. /**
  20431. * Observable signaled when VR request present starts
  20432. */
  20433. onVRRequestPresentStart: Observable<Engine>;
  20434. /**
  20435. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20436. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20437. */
  20438. isInVRExclusivePointerMode: boolean;
  20439. /**
  20440. * Gets a boolean indicating if a webVR device was detected
  20441. * @returns true if a webVR device was detected
  20442. */
  20443. isVRDevicePresent(): boolean;
  20444. /**
  20445. * Gets the current webVR device
  20446. * @returns the current webVR device (or null)
  20447. */
  20448. getVRDevice(): any;
  20449. /**
  20450. * Initializes a webVR display and starts listening to display change events
  20451. * The onVRDisplayChangedObservable will be notified upon these changes
  20452. * @returns A promise containing a VRDisplay and if vr is supported
  20453. */
  20454. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20455. /** @hidden */
  20456. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20457. /**
  20458. * Gets or sets the presentation attributes used to configure VR rendering
  20459. */
  20460. vrPresentationAttributes?: IVRPresentationAttributes;
  20461. /**
  20462. * Call this function to switch to webVR mode
  20463. * Will do nothing if webVR is not supported or if there is no webVR device
  20464. * @param options the webvr options provided to the camera. mainly used for multiview
  20465. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20466. */
  20467. enableVR(options: WebVROptions): void;
  20468. /** @hidden */
  20469. _onVRFullScreenTriggered(): void;
  20470. }
  20471. }
  20472. }
  20473. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20474. import { Nullable } from "babylonjs/types";
  20475. import { Observable } from "babylonjs/Misc/observable";
  20476. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20477. import { Scene } from "babylonjs/scene";
  20478. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20479. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20480. import { Node } from "babylonjs/node";
  20481. import { Ray } from "babylonjs/Culling/ray";
  20482. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20483. import "babylonjs/Engines/Extensions/engine.webVR";
  20484. /**
  20485. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20486. * IMPORTANT!! The data is right-hand data.
  20487. * @export
  20488. * @interface DevicePose
  20489. */
  20490. export interface DevicePose {
  20491. /**
  20492. * The position of the device, values in array are [x,y,z].
  20493. */
  20494. readonly position: Nullable<Float32Array>;
  20495. /**
  20496. * The linearVelocity of the device, values in array are [x,y,z].
  20497. */
  20498. readonly linearVelocity: Nullable<Float32Array>;
  20499. /**
  20500. * The linearAcceleration of the device, values in array are [x,y,z].
  20501. */
  20502. readonly linearAcceleration: Nullable<Float32Array>;
  20503. /**
  20504. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20505. */
  20506. readonly orientation: Nullable<Float32Array>;
  20507. /**
  20508. * The angularVelocity of the device, values in array are [x,y,z].
  20509. */
  20510. readonly angularVelocity: Nullable<Float32Array>;
  20511. /**
  20512. * The angularAcceleration of the device, values in array are [x,y,z].
  20513. */
  20514. readonly angularAcceleration: Nullable<Float32Array>;
  20515. }
  20516. /**
  20517. * Interface representing a pose controlled object in Babylon.
  20518. * A pose controlled object has both regular pose values as well as pose values
  20519. * from an external device such as a VR head mounted display
  20520. */
  20521. export interface PoseControlled {
  20522. /**
  20523. * The position of the object in babylon space.
  20524. */
  20525. position: Vector3;
  20526. /**
  20527. * The rotation quaternion of the object in babylon space.
  20528. */
  20529. rotationQuaternion: Quaternion;
  20530. /**
  20531. * The position of the device in babylon space.
  20532. */
  20533. devicePosition?: Vector3;
  20534. /**
  20535. * The rotation quaternion of the device in babylon space.
  20536. */
  20537. deviceRotationQuaternion: Quaternion;
  20538. /**
  20539. * The raw pose coming from the device.
  20540. */
  20541. rawPose: Nullable<DevicePose>;
  20542. /**
  20543. * The scale of the device to be used when translating from device space to babylon space.
  20544. */
  20545. deviceScaleFactor: number;
  20546. /**
  20547. * Updates the poseControlled values based on the input device pose.
  20548. * @param poseData the pose data to update the object with
  20549. */
  20550. updateFromDevice(poseData: DevicePose): void;
  20551. }
  20552. /**
  20553. * Set of options to customize the webVRCamera
  20554. */
  20555. export interface WebVROptions {
  20556. /**
  20557. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20558. */
  20559. trackPosition?: boolean;
  20560. /**
  20561. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20562. */
  20563. positionScale?: number;
  20564. /**
  20565. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20566. */
  20567. displayName?: string;
  20568. /**
  20569. * Should the native controller meshes be initialized. (default: true)
  20570. */
  20571. controllerMeshes?: boolean;
  20572. /**
  20573. * Creating a default HemiLight only on controllers. (default: true)
  20574. */
  20575. defaultLightingOnControllers?: boolean;
  20576. /**
  20577. * If you don't want to use the default VR button of the helper. (default: false)
  20578. */
  20579. useCustomVRButton?: boolean;
  20580. /**
  20581. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20582. */
  20583. customVRButton?: HTMLButtonElement;
  20584. /**
  20585. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20586. */
  20587. rayLength?: number;
  20588. /**
  20589. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20590. */
  20591. defaultHeight?: number;
  20592. /**
  20593. * If multiview should be used if availible (default: false)
  20594. */
  20595. useMultiview?: boolean;
  20596. }
  20597. /**
  20598. * This represents a WebVR camera.
  20599. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20600. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20601. */
  20602. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20603. private webVROptions;
  20604. /**
  20605. * @hidden
  20606. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20607. */
  20608. _vrDevice: any;
  20609. /**
  20610. * The rawPose of the vrDevice.
  20611. */
  20612. rawPose: Nullable<DevicePose>;
  20613. private _onVREnabled;
  20614. private _specsVersion;
  20615. private _attached;
  20616. private _frameData;
  20617. protected _descendants: Array<Node>;
  20618. private _deviceRoomPosition;
  20619. /** @hidden */
  20620. _deviceRoomRotationQuaternion: Quaternion;
  20621. private _standingMatrix;
  20622. /**
  20623. * Represents device position in babylon space.
  20624. */
  20625. devicePosition: Vector3;
  20626. /**
  20627. * Represents device rotation in babylon space.
  20628. */
  20629. deviceRotationQuaternion: Quaternion;
  20630. /**
  20631. * The scale of the device to be used when translating from device space to babylon space.
  20632. */
  20633. deviceScaleFactor: number;
  20634. private _deviceToWorld;
  20635. private _worldToDevice;
  20636. /**
  20637. * References to the webVR controllers for the vrDevice.
  20638. */
  20639. controllers: Array<WebVRController>;
  20640. /**
  20641. * Emits an event when a controller is attached.
  20642. */
  20643. onControllersAttachedObservable: Observable<WebVRController[]>;
  20644. /**
  20645. * Emits an event when a controller's mesh has been loaded;
  20646. */
  20647. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20648. /**
  20649. * Emits an event when the HMD's pose has been updated.
  20650. */
  20651. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20652. private _poseSet;
  20653. /**
  20654. * If the rig cameras be used as parent instead of this camera.
  20655. */
  20656. rigParenting: boolean;
  20657. private _lightOnControllers;
  20658. private _defaultHeight?;
  20659. /**
  20660. * Instantiates a WebVRFreeCamera.
  20661. * @param name The name of the WebVRFreeCamera
  20662. * @param position The starting anchor position for the camera
  20663. * @param scene The scene the camera belongs to
  20664. * @param webVROptions a set of customizable options for the webVRCamera
  20665. */
  20666. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20667. /**
  20668. * Gets the device distance from the ground in meters.
  20669. * @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.
  20670. */
  20671. deviceDistanceToRoomGround(): number;
  20672. /**
  20673. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20674. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20675. */
  20676. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20677. /**
  20678. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20679. * @returns A promise with a boolean set to if the standing matrix is supported.
  20680. */
  20681. useStandingMatrixAsync(): Promise<boolean>;
  20682. /**
  20683. * Disposes the camera
  20684. */
  20685. dispose(): void;
  20686. /**
  20687. * Gets a vrController by name.
  20688. * @param name The name of the controller to retreive
  20689. * @returns the controller matching the name specified or null if not found
  20690. */
  20691. getControllerByName(name: string): Nullable<WebVRController>;
  20692. private _leftController;
  20693. /**
  20694. * The controller corresponding to the users left hand.
  20695. */
  20696. get leftController(): Nullable<WebVRController>;
  20697. private _rightController;
  20698. /**
  20699. * The controller corresponding to the users right hand.
  20700. */
  20701. get rightController(): Nullable<WebVRController>;
  20702. /**
  20703. * Casts a ray forward from the vrCamera's gaze.
  20704. * @param length Length of the ray (default: 100)
  20705. * @returns the ray corresponding to the gaze
  20706. */
  20707. getForwardRay(length?: number): Ray;
  20708. /**
  20709. * @hidden
  20710. * Updates the camera based on device's frame data
  20711. */
  20712. _checkInputs(): void;
  20713. /**
  20714. * Updates the poseControlled values based on the input device pose.
  20715. * @param poseData Pose coming from the device
  20716. */
  20717. updateFromDevice(poseData: DevicePose): void;
  20718. private _htmlElementAttached;
  20719. private _detachIfAttached;
  20720. /**
  20721. * WebVR's attach control will start broadcasting frames to the device.
  20722. * Note that in certain browsers (chrome for example) this function must be called
  20723. * within a user-interaction callback. Example:
  20724. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20725. *
  20726. * @param element html element to attach the vrDevice to
  20727. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20728. */
  20729. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20730. /**
  20731. * Detaches the camera from the html element and disables VR
  20732. *
  20733. * @param element html element to detach from
  20734. */
  20735. detachControl(element: HTMLElement): void;
  20736. /**
  20737. * @returns the name of this class
  20738. */
  20739. getClassName(): string;
  20740. /**
  20741. * Calls resetPose on the vrDisplay
  20742. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20743. */
  20744. resetToCurrentRotation(): void;
  20745. /**
  20746. * @hidden
  20747. * Updates the rig cameras (left and right eye)
  20748. */
  20749. _updateRigCameras(): void;
  20750. private _workingVector;
  20751. private _oneVector;
  20752. private _workingMatrix;
  20753. private updateCacheCalled;
  20754. private _correctPositionIfNotTrackPosition;
  20755. /**
  20756. * @hidden
  20757. * Updates the cached values of the camera
  20758. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20759. */
  20760. _updateCache(ignoreParentClass?: boolean): void;
  20761. /**
  20762. * @hidden
  20763. * Get current device position in babylon world
  20764. */
  20765. _computeDevicePosition(): void;
  20766. /**
  20767. * Updates the current device position and rotation in the babylon world
  20768. */
  20769. update(): void;
  20770. /**
  20771. * @hidden
  20772. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20773. * @returns an identity matrix
  20774. */
  20775. _getViewMatrix(): Matrix;
  20776. private _tmpMatrix;
  20777. /**
  20778. * This function is called by the two RIG cameras.
  20779. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20780. * @hidden
  20781. */
  20782. _getWebVRViewMatrix(): Matrix;
  20783. /** @hidden */
  20784. _getWebVRProjectionMatrix(): Matrix;
  20785. private _onGamepadConnectedObserver;
  20786. private _onGamepadDisconnectedObserver;
  20787. private _updateCacheWhenTrackingDisabledObserver;
  20788. /**
  20789. * Initializes the controllers and their meshes
  20790. */
  20791. initControllers(): void;
  20792. }
  20793. }
  20794. declare module "babylonjs/Materials/materialHelper" {
  20795. import { Nullable } from "babylonjs/types";
  20796. import { Scene } from "babylonjs/scene";
  20797. import { Engine } from "babylonjs/Engines/engine";
  20798. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20799. import { Light } from "babylonjs/Lights/light";
  20800. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20801. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20802. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20803. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20804. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20805. /**
  20806. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  20807. *
  20808. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20809. *
  20810. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20811. */
  20812. export class MaterialHelper {
  20813. /**
  20814. * Bind the current view position to an effect.
  20815. * @param effect The effect to be bound
  20816. * @param scene The scene the eyes position is used from
  20817. * @param variableName name of the shader variable that will hold the eye position
  20818. */
  20819. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20820. /**
  20821. * Helps preparing the defines values about the UVs in used in the effect.
  20822. * UVs are shared as much as we can accross channels in the shaders.
  20823. * @param texture The texture we are preparing the UVs for
  20824. * @param defines The defines to update
  20825. * @param key The channel key "diffuse", "specular"... used in the shader
  20826. */
  20827. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20828. /**
  20829. * Binds a texture matrix value to its corrsponding uniform
  20830. * @param texture The texture to bind the matrix for
  20831. * @param uniformBuffer The uniform buffer receivin the data
  20832. * @param key The channel key "diffuse", "specular"... used in the shader
  20833. */
  20834. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20835. /**
  20836. * Gets the current status of the fog (should it be enabled?)
  20837. * @param mesh defines the mesh to evaluate for fog support
  20838. * @param scene defines the hosting scene
  20839. * @returns true if fog must be enabled
  20840. */
  20841. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20842. /**
  20843. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20844. * @param mesh defines the current mesh
  20845. * @param scene defines the current scene
  20846. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20847. * @param pointsCloud defines if point cloud rendering has to be turned on
  20848. * @param fogEnabled defines if fog has to be turned on
  20849. * @param alphaTest defines if alpha testing has to be turned on
  20850. * @param defines defines the current list of defines
  20851. */
  20852. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20853. /**
  20854. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20855. * @param scene defines the current scene
  20856. * @param engine defines the current engine
  20857. * @param defines specifies the list of active defines
  20858. * @param useInstances defines if instances have to be turned on
  20859. * @param useClipPlane defines if clip plane have to be turned on
  20860. * @param useInstances defines if instances have to be turned on
  20861. * @param useThinInstances defines if thin instances have to be turned on
  20862. */
  20863. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20864. /**
  20865. * Prepares the defines for bones
  20866. * @param mesh The mesh containing the geometry data we will draw
  20867. * @param defines The defines to update
  20868. */
  20869. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20870. /**
  20871. * Prepares the defines for morph targets
  20872. * @param mesh The mesh containing the geometry data we will draw
  20873. * @param defines The defines to update
  20874. */
  20875. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20876. /**
  20877. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20878. * @param mesh The mesh containing the geometry data we will draw
  20879. * @param defines The defines to update
  20880. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20881. * @param useBones Precise whether bones should be used or not (override mesh info)
  20882. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20883. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20884. * @returns false if defines are considered not dirty and have not been checked
  20885. */
  20886. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20887. /**
  20888. * Prepares the defines related to multiview
  20889. * @param scene The scene we are intending to draw
  20890. * @param defines The defines to update
  20891. */
  20892. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20893. /**
  20894. * Prepares the defines related to the prepass
  20895. * @param scene The scene we are intending to draw
  20896. * @param defines The defines to update
  20897. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20898. */
  20899. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20900. /**
  20901. * Prepares the defines related to the light information passed in parameter
  20902. * @param scene The scene we are intending to draw
  20903. * @param mesh The mesh the effect is compiling for
  20904. * @param light The light the effect is compiling for
  20905. * @param lightIndex The index of the light
  20906. * @param defines The defines to update
  20907. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20908. * @param state Defines the current state regarding what is needed (normals, etc...)
  20909. */
  20910. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20911. needNormals: boolean;
  20912. needRebuild: boolean;
  20913. shadowEnabled: boolean;
  20914. specularEnabled: boolean;
  20915. lightmapMode: boolean;
  20916. }): void;
  20917. /**
  20918. * Prepares the defines related to the light information passed in parameter
  20919. * @param scene The scene we are intending to draw
  20920. * @param mesh The mesh the effect is compiling for
  20921. * @param defines The defines to update
  20922. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20923. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  20924. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  20925. * @returns true if normals will be required for the rest of the effect
  20926. */
  20927. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  20928. /**
  20929. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  20930. * @param lightIndex defines the light index
  20931. * @param uniformsList The uniform list
  20932. * @param samplersList The sampler list
  20933. * @param projectedLightTexture defines if projected texture must be used
  20934. * @param uniformBuffersList defines an optional list of uniform buffers
  20935. */
  20936. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  20937. /**
  20938. * Prepares the uniforms and samplers list to be used in the effect
  20939. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  20940. * @param samplersList The sampler list
  20941. * @param defines The defines helping in the list generation
  20942. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  20943. */
  20944. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  20945. /**
  20946. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  20947. * @param defines The defines to update while falling back
  20948. * @param fallbacks The authorized effect fallbacks
  20949. * @param maxSimultaneousLights The maximum number of lights allowed
  20950. * @param rank the current rank of the Effect
  20951. * @returns The newly affected rank
  20952. */
  20953. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  20954. private static _TmpMorphInfluencers;
  20955. /**
  20956. * Prepares the list of attributes required for morph targets according to the effect defines.
  20957. * @param attribs The current list of supported attribs
  20958. * @param mesh The mesh to prepare the morph targets attributes for
  20959. * @param influencers The number of influencers
  20960. */
  20961. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  20962. /**
  20963. * Prepares the list of attributes required for morph targets according to the effect defines.
  20964. * @param attribs The current list of supported attribs
  20965. * @param mesh The mesh to prepare the morph targets attributes for
  20966. * @param defines The current Defines of the effect
  20967. */
  20968. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  20969. /**
  20970. * Prepares the list of attributes required for bones according to the effect defines.
  20971. * @param attribs The current list of supported attribs
  20972. * @param mesh The mesh to prepare the bones attributes for
  20973. * @param defines The current Defines of the effect
  20974. * @param fallbacks The current efffect fallback strategy
  20975. */
  20976. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  20977. /**
  20978. * Check and prepare the list of attributes required for instances according to the effect defines.
  20979. * @param attribs The current list of supported attribs
  20980. * @param defines The current MaterialDefines of the effect
  20981. */
  20982. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  20983. /**
  20984. * Add the list of attributes required for instances to the attribs array.
  20985. * @param attribs The current list of supported attribs
  20986. */
  20987. static PushAttributesForInstances(attribs: string[]): void;
  20988. /**
  20989. * Binds the light information to the effect.
  20990. * @param light The light containing the generator
  20991. * @param effect The effect we are binding the data to
  20992. * @param lightIndex The light index in the effect used to render
  20993. */
  20994. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  20995. /**
  20996. * Binds the lights information from the scene to the effect for the given mesh.
  20997. * @param light Light to bind
  20998. * @param lightIndex Light index
  20999. * @param scene The scene where the light belongs to
  21000. * @param effect The effect we are binding the data to
  21001. * @param useSpecular Defines if specular is supported
  21002. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21003. */
  21004. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  21005. /**
  21006. * Binds the lights information from the scene to the effect for the given mesh.
  21007. * @param scene The scene the lights belongs to
  21008. * @param mesh The mesh we are binding the information to render
  21009. * @param effect The effect we are binding the data to
  21010. * @param defines The generated defines for the effect
  21011. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  21012. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21013. */
  21014. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  21015. private static _tempFogColor;
  21016. /**
  21017. * Binds the fog information from the scene to the effect for the given mesh.
  21018. * @param scene The scene the lights belongs to
  21019. * @param mesh The mesh we are binding the information to render
  21020. * @param effect The effect we are binding the data to
  21021. * @param linearSpace Defines if the fog effect is applied in linear space
  21022. */
  21023. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  21024. /**
  21025. * Binds the bones information from the mesh to the effect.
  21026. * @param mesh The mesh we are binding the information to render
  21027. * @param effect The effect we are binding the data to
  21028. */
  21029. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  21030. /**
  21031. * Binds the morph targets information from the mesh to the effect.
  21032. * @param abstractMesh The mesh we are binding the information to render
  21033. * @param effect The effect we are binding the data to
  21034. */
  21035. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  21036. /**
  21037. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  21038. * @param defines The generated defines used in the effect
  21039. * @param effect The effect we are binding the data to
  21040. * @param scene The scene we are willing to render with logarithmic scale for
  21041. */
  21042. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  21043. /**
  21044. * Binds the clip plane information from the scene to the effect.
  21045. * @param scene The scene the clip plane information are extracted from
  21046. * @param effect The effect we are binding the data to
  21047. */
  21048. static BindClipPlane(effect: Effect, scene: Scene): void;
  21049. }
  21050. }
  21051. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  21052. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21053. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21054. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  21055. import { Nullable } from "babylonjs/types";
  21056. import { Effect } from "babylonjs/Materials/effect";
  21057. import { Matrix } from "babylonjs/Maths/math.vector";
  21058. import { Scene } from "babylonjs/scene";
  21059. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21060. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21061. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21062. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  21063. import { Observable } from "babylonjs/Misc/observable";
  21064. /**
  21065. * Block used to expose an input value
  21066. */
  21067. export class InputBlock extends NodeMaterialBlock {
  21068. private _mode;
  21069. private _associatedVariableName;
  21070. private _storedValue;
  21071. private _valueCallback;
  21072. private _type;
  21073. private _animationType;
  21074. /** Gets or set a value used to limit the range of float values */
  21075. min: number;
  21076. /** Gets or set a value used to limit the range of float values */
  21077. max: number;
  21078. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  21079. isBoolean: boolean;
  21080. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  21081. matrixMode: number;
  21082. /** @hidden */
  21083. _systemValue: Nullable<NodeMaterialSystemValues>;
  21084. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  21085. visibleInInspector: boolean;
  21086. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  21087. isConstant: boolean;
  21088. /** Gets or sets the group to use to display this block in the Inspector */
  21089. groupInInspector: string;
  21090. /** Gets an observable raised when the value is changed */
  21091. onValueChangedObservable: Observable<InputBlock>;
  21092. /**
  21093. * Gets or sets the connection point type (default is float)
  21094. */
  21095. get type(): NodeMaterialBlockConnectionPointTypes;
  21096. /**
  21097. * Creates a new InputBlock
  21098. * @param name defines the block name
  21099. * @param target defines the target of that block (Vertex by default)
  21100. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  21101. */
  21102. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  21103. /**
  21104. * Validates if a name is a reserve word.
  21105. * @param newName the new name to be given to the node.
  21106. * @returns false if the name is a reserve word, else true.
  21107. */
  21108. validateBlockName(newName: string): boolean;
  21109. /**
  21110. * Gets the output component
  21111. */
  21112. get output(): NodeMaterialConnectionPoint;
  21113. /**
  21114. * Set the source of this connection point to a vertex attribute
  21115. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  21116. * @returns the current connection point
  21117. */
  21118. setAsAttribute(attributeName?: string): InputBlock;
  21119. /**
  21120. * Set the source of this connection point to a system value
  21121. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  21122. * @returns the current connection point
  21123. */
  21124. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  21125. /**
  21126. * Gets or sets the value of that point.
  21127. * Please note that this value will be ignored if valueCallback is defined
  21128. */
  21129. get value(): any;
  21130. set value(value: any);
  21131. /**
  21132. * Gets or sets a callback used to get the value of that point.
  21133. * Please note that setting this value will force the connection point to ignore the value property
  21134. */
  21135. get valueCallback(): () => any;
  21136. set valueCallback(value: () => any);
  21137. /**
  21138. * Gets or sets the associated variable name in the shader
  21139. */
  21140. get associatedVariableName(): string;
  21141. set associatedVariableName(value: string);
  21142. /** Gets or sets the type of animation applied to the input */
  21143. get animationType(): AnimatedInputBlockTypes;
  21144. set animationType(value: AnimatedInputBlockTypes);
  21145. /**
  21146. * Gets a boolean indicating that this connection point not defined yet
  21147. */
  21148. get isUndefined(): boolean;
  21149. /**
  21150. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  21151. * In this case the connection point name must be the name of the uniform to use.
  21152. * Can only be set on inputs
  21153. */
  21154. get isUniform(): boolean;
  21155. set isUniform(value: boolean);
  21156. /**
  21157. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  21158. * In this case the connection point name must be the name of the attribute to use
  21159. * Can only be set on inputs
  21160. */
  21161. get isAttribute(): boolean;
  21162. set isAttribute(value: boolean);
  21163. /**
  21164. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  21165. * Can only be set on exit points
  21166. */
  21167. get isVarying(): boolean;
  21168. set isVarying(value: boolean);
  21169. /**
  21170. * Gets a boolean indicating that the current connection point is a system value
  21171. */
  21172. get isSystemValue(): boolean;
  21173. /**
  21174. * Gets or sets the current well known value or null if not defined as a system value
  21175. */
  21176. get systemValue(): Nullable<NodeMaterialSystemValues>;
  21177. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  21178. /**
  21179. * Gets the current class name
  21180. * @returns the class name
  21181. */
  21182. getClassName(): string;
  21183. /**
  21184. * Animate the input if animationType !== None
  21185. * @param scene defines the rendering scene
  21186. */
  21187. animate(scene: Scene): void;
  21188. private _emitDefine;
  21189. initialize(state: NodeMaterialBuildState): void;
  21190. /**
  21191. * Set the input block to its default value (based on its type)
  21192. */
  21193. setDefaultValue(): void;
  21194. private _emitConstant;
  21195. /** @hidden */
  21196. get _noContextSwitch(): boolean;
  21197. private _emit;
  21198. /** @hidden */
  21199. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21200. /** @hidden */
  21201. _transmit(effect: Effect, scene: Scene): void;
  21202. protected _buildBlock(state: NodeMaterialBuildState): void;
  21203. protected _dumpPropertiesCode(): string;
  21204. dispose(): void;
  21205. serialize(): any;
  21206. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21207. }
  21208. }
  21209. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21210. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21211. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21212. import { Nullable } from "babylonjs/types";
  21213. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21214. import { Observable } from "babylonjs/Misc/observable";
  21215. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21216. /**
  21217. * Enum used to define the compatibility state between two connection points
  21218. */
  21219. export enum NodeMaterialConnectionPointCompatibilityStates {
  21220. /** Points are compatibles */
  21221. Compatible = 0,
  21222. /** Points are incompatible because of their types */
  21223. TypeIncompatible = 1,
  21224. /** Points are incompatible because of their targets (vertex vs fragment) */
  21225. TargetIncompatible = 2
  21226. }
  21227. /**
  21228. * Defines the direction of a connection point
  21229. */
  21230. export enum NodeMaterialConnectionPointDirection {
  21231. /** Input */
  21232. Input = 0,
  21233. /** Output */
  21234. Output = 1
  21235. }
  21236. /**
  21237. * Defines a connection point for a block
  21238. */
  21239. export class NodeMaterialConnectionPoint {
  21240. /** @hidden */
  21241. _ownerBlock: NodeMaterialBlock;
  21242. /** @hidden */
  21243. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21244. private _endpoints;
  21245. private _associatedVariableName;
  21246. private _direction;
  21247. /** @hidden */
  21248. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21249. /** @hidden */
  21250. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21251. private _type;
  21252. /** @hidden */
  21253. _enforceAssociatedVariableName: boolean;
  21254. /** Gets the direction of the point */
  21255. get direction(): NodeMaterialConnectionPointDirection;
  21256. /** Indicates that this connection point needs dual validation before being connected to another point */
  21257. needDualDirectionValidation: boolean;
  21258. /**
  21259. * Gets or sets the additional types supported by this connection point
  21260. */
  21261. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21262. /**
  21263. * Gets or sets the additional types excluded by this connection point
  21264. */
  21265. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21266. /**
  21267. * Observable triggered when this point is connected
  21268. */
  21269. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21270. /**
  21271. * Gets or sets the associated variable name in the shader
  21272. */
  21273. get associatedVariableName(): string;
  21274. set associatedVariableName(value: string);
  21275. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21276. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21277. /**
  21278. * Gets or sets the connection point type (default is float)
  21279. */
  21280. get type(): NodeMaterialBlockConnectionPointTypes;
  21281. set type(value: NodeMaterialBlockConnectionPointTypes);
  21282. /**
  21283. * Gets or sets the connection point name
  21284. */
  21285. name: string;
  21286. /**
  21287. * Gets or sets the connection point name
  21288. */
  21289. displayName: string;
  21290. /**
  21291. * Gets or sets a boolean indicating that this connection point can be omitted
  21292. */
  21293. isOptional: boolean;
  21294. /**
  21295. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21296. */
  21297. isExposedOnFrame: boolean;
  21298. /**
  21299. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21300. */
  21301. define: string;
  21302. /** @hidden */
  21303. _prioritizeVertex: boolean;
  21304. private _target;
  21305. /** Gets or sets the target of that connection point */
  21306. get target(): NodeMaterialBlockTargets;
  21307. set target(value: NodeMaterialBlockTargets);
  21308. /**
  21309. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21310. */
  21311. get isConnected(): boolean;
  21312. /**
  21313. * Gets a boolean indicating that the current point is connected to an input block
  21314. */
  21315. get isConnectedToInputBlock(): boolean;
  21316. /**
  21317. * Gets a the connected input block (if any)
  21318. */
  21319. get connectInputBlock(): Nullable<InputBlock>;
  21320. /** Get the other side of the connection (if any) */
  21321. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21322. /** Get the block that owns this connection point */
  21323. get ownerBlock(): NodeMaterialBlock;
  21324. /** Get the block connected on the other side of this connection (if any) */
  21325. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21326. /** Get the block connected on the endpoints of this connection (if any) */
  21327. get connectedBlocks(): Array<NodeMaterialBlock>;
  21328. /** Gets the list of connected endpoints */
  21329. get endpoints(): NodeMaterialConnectionPoint[];
  21330. /** Gets a boolean indicating if that output point is connected to at least one input */
  21331. get hasEndpoints(): boolean;
  21332. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21333. get isConnectedInVertexShader(): boolean;
  21334. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21335. get isConnectedInFragmentShader(): boolean;
  21336. /**
  21337. * Creates a block suitable to be used as an input for this input point.
  21338. * If null is returned, a block based on the point type will be created.
  21339. * @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
  21340. */
  21341. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21342. /**
  21343. * Creates a new connection point
  21344. * @param name defines the connection point name
  21345. * @param ownerBlock defines the block hosting this connection point
  21346. * @param direction defines the direction of the connection point
  21347. */
  21348. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21349. /**
  21350. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21351. * @returns the class name
  21352. */
  21353. getClassName(): string;
  21354. /**
  21355. * Gets a boolean indicating if the current point can be connected to another point
  21356. * @param connectionPoint defines the other connection point
  21357. * @returns a boolean
  21358. */
  21359. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21360. /**
  21361. * Gets a number indicating if the current point can be connected to another point
  21362. * @param connectionPoint defines the other connection point
  21363. * @returns a number defining the compatibility state
  21364. */
  21365. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21366. /**
  21367. * Connect this point to another connection point
  21368. * @param connectionPoint defines the other connection point
  21369. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21370. * @returns the current connection point
  21371. */
  21372. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21373. /**
  21374. * Disconnect this point from one of his endpoint
  21375. * @param endpoint defines the other connection point
  21376. * @returns the current connection point
  21377. */
  21378. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21379. /**
  21380. * Serializes this point in a JSON representation
  21381. * @param isInput defines if the connection point is an input (default is true)
  21382. * @returns the serialized point object
  21383. */
  21384. serialize(isInput?: boolean): any;
  21385. /**
  21386. * Release resources
  21387. */
  21388. dispose(): void;
  21389. }
  21390. }
  21391. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21392. /**
  21393. * Enum used to define the material modes
  21394. */
  21395. export enum NodeMaterialModes {
  21396. /** Regular material */
  21397. Material = 0,
  21398. /** For post process */
  21399. PostProcess = 1,
  21400. /** For particle system */
  21401. Particle = 2
  21402. }
  21403. }
  21404. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21405. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21406. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21407. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21408. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21409. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21410. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21411. import { Effect } from "babylonjs/Materials/effect";
  21412. import { Mesh } from "babylonjs/Meshes/mesh";
  21413. import { Nullable } from "babylonjs/types";
  21414. import { Texture } from "babylonjs/Materials/Textures/texture";
  21415. import { Scene } from "babylonjs/scene";
  21416. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21417. /**
  21418. * Block used to read a texture from a sampler
  21419. */
  21420. export class TextureBlock extends NodeMaterialBlock {
  21421. private _defineName;
  21422. private _linearDefineName;
  21423. private _gammaDefineName;
  21424. private _tempTextureRead;
  21425. private _samplerName;
  21426. private _transformedUVName;
  21427. private _textureTransformName;
  21428. private _textureInfoName;
  21429. private _mainUVName;
  21430. private _mainUVDefineName;
  21431. private _fragmentOnly;
  21432. /**
  21433. * Gets or sets the texture associated with the node
  21434. */
  21435. texture: Nullable<Texture>;
  21436. /**
  21437. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21438. */
  21439. convertToGammaSpace: boolean;
  21440. /**
  21441. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21442. */
  21443. convertToLinearSpace: boolean;
  21444. /**
  21445. * Create a new TextureBlock
  21446. * @param name defines the block name
  21447. */
  21448. constructor(name: string, fragmentOnly?: boolean);
  21449. /**
  21450. * Gets the current class name
  21451. * @returns the class name
  21452. */
  21453. getClassName(): string;
  21454. /**
  21455. * Gets the uv input component
  21456. */
  21457. get uv(): NodeMaterialConnectionPoint;
  21458. /**
  21459. * Gets the rgba output component
  21460. */
  21461. get rgba(): NodeMaterialConnectionPoint;
  21462. /**
  21463. * Gets the rgb output component
  21464. */
  21465. get rgb(): NodeMaterialConnectionPoint;
  21466. /**
  21467. * Gets the r output component
  21468. */
  21469. get r(): NodeMaterialConnectionPoint;
  21470. /**
  21471. * Gets the g output component
  21472. */
  21473. get g(): NodeMaterialConnectionPoint;
  21474. /**
  21475. * Gets the b output component
  21476. */
  21477. get b(): NodeMaterialConnectionPoint;
  21478. /**
  21479. * Gets the a output component
  21480. */
  21481. get a(): NodeMaterialConnectionPoint;
  21482. get target(): NodeMaterialBlockTargets;
  21483. autoConfigure(material: NodeMaterial): void;
  21484. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21485. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21486. isReady(): boolean;
  21487. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21488. private get _isMixed();
  21489. private _injectVertexCode;
  21490. private _writeTextureRead;
  21491. private _writeOutput;
  21492. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21493. protected _dumpPropertiesCode(): string;
  21494. serialize(): any;
  21495. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21496. }
  21497. }
  21498. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21499. /** @hidden */
  21500. export var reflectionFunction: {
  21501. name: string;
  21502. shader: string;
  21503. };
  21504. }
  21505. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21506. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21507. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21508. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21509. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21510. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21511. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21512. import { Effect } from "babylonjs/Materials/effect";
  21513. import { Mesh } from "babylonjs/Meshes/mesh";
  21514. import { Nullable } from "babylonjs/types";
  21515. import { Scene } from "babylonjs/scene";
  21516. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21517. /**
  21518. * Base block used to read a reflection texture from a sampler
  21519. */
  21520. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21521. /** @hidden */
  21522. _define3DName: string;
  21523. /** @hidden */
  21524. _defineCubicName: string;
  21525. /** @hidden */
  21526. _defineExplicitName: string;
  21527. /** @hidden */
  21528. _defineProjectionName: string;
  21529. /** @hidden */
  21530. _defineLocalCubicName: string;
  21531. /** @hidden */
  21532. _defineSphericalName: string;
  21533. /** @hidden */
  21534. _definePlanarName: string;
  21535. /** @hidden */
  21536. _defineEquirectangularName: string;
  21537. /** @hidden */
  21538. _defineMirroredEquirectangularFixedName: string;
  21539. /** @hidden */
  21540. _defineEquirectangularFixedName: string;
  21541. /** @hidden */
  21542. _defineSkyboxName: string;
  21543. /** @hidden */
  21544. _defineOppositeZ: string;
  21545. /** @hidden */
  21546. _cubeSamplerName: string;
  21547. /** @hidden */
  21548. _2DSamplerName: string;
  21549. protected _positionUVWName: string;
  21550. protected _directionWName: string;
  21551. protected _reflectionVectorName: string;
  21552. /** @hidden */
  21553. _reflectionCoordsName: string;
  21554. /** @hidden */
  21555. _reflectionMatrixName: string;
  21556. protected _reflectionColorName: string;
  21557. /**
  21558. * Gets or sets the texture associated with the node
  21559. */
  21560. texture: Nullable<BaseTexture>;
  21561. /**
  21562. * Create a new ReflectionTextureBaseBlock
  21563. * @param name defines the block name
  21564. */
  21565. constructor(name: string);
  21566. /**
  21567. * Gets the current class name
  21568. * @returns the class name
  21569. */
  21570. getClassName(): string;
  21571. /**
  21572. * Gets the world position input component
  21573. */
  21574. abstract get position(): NodeMaterialConnectionPoint;
  21575. /**
  21576. * Gets the world position input component
  21577. */
  21578. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21579. /**
  21580. * Gets the world normal input component
  21581. */
  21582. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21583. /**
  21584. * Gets the world input component
  21585. */
  21586. abstract get world(): NodeMaterialConnectionPoint;
  21587. /**
  21588. * Gets the camera (or eye) position component
  21589. */
  21590. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21591. /**
  21592. * Gets the view input component
  21593. */
  21594. abstract get view(): NodeMaterialConnectionPoint;
  21595. protected _getTexture(): Nullable<BaseTexture>;
  21596. autoConfigure(material: NodeMaterial): void;
  21597. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21598. isReady(): boolean;
  21599. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21600. /**
  21601. * Gets the code to inject in the vertex shader
  21602. * @param state current state of the node material building
  21603. * @returns the shader code
  21604. */
  21605. handleVertexSide(state: NodeMaterialBuildState): string;
  21606. /**
  21607. * Handles the inits for the fragment code path
  21608. * @param state node material build state
  21609. */
  21610. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21611. /**
  21612. * Generates the reflection coords code for the fragment code path
  21613. * @param worldNormalVarName name of the world normal variable
  21614. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21615. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21616. * @returns the shader code
  21617. */
  21618. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21619. /**
  21620. * Generates the reflection color code for the fragment code path
  21621. * @param lodVarName name of the lod variable
  21622. * @param swizzleLookupTexture swizzle to use for the final color variable
  21623. * @returns the shader code
  21624. */
  21625. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21626. /**
  21627. * Generates the code corresponding to the connected output points
  21628. * @param state node material build state
  21629. * @param varName name of the variable to output
  21630. * @returns the shader code
  21631. */
  21632. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21633. protected _buildBlock(state: NodeMaterialBuildState): this;
  21634. protected _dumpPropertiesCode(): string;
  21635. serialize(): any;
  21636. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21637. }
  21638. }
  21639. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21640. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21641. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21642. import { Nullable } from "babylonjs/types";
  21643. /**
  21644. * Defines a connection point to be used for points with a custom object type
  21645. */
  21646. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21647. private _blockType;
  21648. private _blockName;
  21649. private _nameForCheking?;
  21650. /**
  21651. * Creates a new connection point
  21652. * @param name defines the connection point name
  21653. * @param ownerBlock defines the block hosting this connection point
  21654. * @param direction defines the direction of the connection point
  21655. */
  21656. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21657. /**
  21658. * Gets a number indicating if the current point can be connected to another point
  21659. * @param connectionPoint defines the other connection point
  21660. * @returns a number defining the compatibility state
  21661. */
  21662. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21663. /**
  21664. * Creates a block suitable to be used as an input for this input point.
  21665. * If null is returned, a block based on the point type will be created.
  21666. * @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
  21667. */
  21668. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21669. }
  21670. }
  21671. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21672. /**
  21673. * Enum defining the type of properties that can be edited in the property pages in the NME
  21674. */
  21675. export enum PropertyTypeForEdition {
  21676. /** property is a boolean */
  21677. Boolean = 0,
  21678. /** property is a float */
  21679. Float = 1,
  21680. /** property is a Vector2 */
  21681. Vector2 = 2,
  21682. /** property is a list of values */
  21683. List = 3
  21684. }
  21685. /**
  21686. * Interface that defines an option in a variable of type list
  21687. */
  21688. export interface IEditablePropertyListOption {
  21689. /** label of the option */
  21690. "label": string;
  21691. /** value of the option */
  21692. "value": number;
  21693. }
  21694. /**
  21695. * Interface that defines the options available for an editable property
  21696. */
  21697. export interface IEditablePropertyOption {
  21698. /** min value */
  21699. "min"?: number;
  21700. /** max value */
  21701. "max"?: number;
  21702. /** notifiers: indicates which actions to take when the property is changed */
  21703. "notifiers"?: {
  21704. /** the material should be rebuilt */
  21705. "rebuild"?: boolean;
  21706. /** the preview should be updated */
  21707. "update"?: boolean;
  21708. };
  21709. /** list of the options for a variable of type list */
  21710. "options"?: IEditablePropertyListOption[];
  21711. }
  21712. /**
  21713. * Interface that describes an editable property
  21714. */
  21715. export interface IPropertyDescriptionForEdition {
  21716. /** name of the property */
  21717. "propertyName": string;
  21718. /** display name of the property */
  21719. "displayName": string;
  21720. /** type of the property */
  21721. "type": PropertyTypeForEdition;
  21722. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21723. "groupName": string;
  21724. /** options for the property */
  21725. "options": IEditablePropertyOption;
  21726. }
  21727. /**
  21728. * Decorator that flags a property in a node material block as being editable
  21729. */
  21730. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21731. }
  21732. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21733. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21734. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21735. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21736. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21737. import { Nullable } from "babylonjs/types";
  21738. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21739. import { Mesh } from "babylonjs/Meshes/mesh";
  21740. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21741. import { Effect } from "babylonjs/Materials/effect";
  21742. import { Scene } from "babylonjs/scene";
  21743. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21744. /**
  21745. * Block used to implement the refraction part of the sub surface module of the PBR material
  21746. */
  21747. export class RefractionBlock extends NodeMaterialBlock {
  21748. /** @hidden */
  21749. _define3DName: string;
  21750. /** @hidden */
  21751. _refractionMatrixName: string;
  21752. /** @hidden */
  21753. _defineLODRefractionAlpha: string;
  21754. /** @hidden */
  21755. _defineLinearSpecularRefraction: string;
  21756. /** @hidden */
  21757. _defineOppositeZ: string;
  21758. /** @hidden */
  21759. _cubeSamplerName: string;
  21760. /** @hidden */
  21761. _2DSamplerName: string;
  21762. /** @hidden */
  21763. _vRefractionMicrosurfaceInfosName: string;
  21764. /** @hidden */
  21765. _vRefractionInfosName: string;
  21766. private _scene;
  21767. /**
  21768. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21769. * Materials half opaque for instance using refraction could benefit from this control.
  21770. */
  21771. linkRefractionWithTransparency: boolean;
  21772. /**
  21773. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21774. */
  21775. invertRefractionY: boolean;
  21776. /**
  21777. * Gets or sets the texture associated with the node
  21778. */
  21779. texture: Nullable<BaseTexture>;
  21780. /**
  21781. * Create a new RefractionBlock
  21782. * @param name defines the block name
  21783. */
  21784. constructor(name: string);
  21785. /**
  21786. * Gets the current class name
  21787. * @returns the class name
  21788. */
  21789. getClassName(): string;
  21790. /**
  21791. * Gets the intensity input component
  21792. */
  21793. get intensity(): NodeMaterialConnectionPoint;
  21794. /**
  21795. * Gets the index of refraction input component
  21796. */
  21797. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21798. /**
  21799. * Gets the tint at distance input component
  21800. */
  21801. get tintAtDistance(): NodeMaterialConnectionPoint;
  21802. /**
  21803. * Gets the view input component
  21804. */
  21805. get view(): NodeMaterialConnectionPoint;
  21806. /**
  21807. * Gets the refraction object output component
  21808. */
  21809. get refraction(): NodeMaterialConnectionPoint;
  21810. /**
  21811. * Returns true if the block has a texture
  21812. */
  21813. get hasTexture(): boolean;
  21814. protected _getTexture(): Nullable<BaseTexture>;
  21815. autoConfigure(material: NodeMaterial): void;
  21816. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21817. isReady(): boolean;
  21818. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21819. /**
  21820. * Gets the main code of the block (fragment side)
  21821. * @param state current state of the node material building
  21822. * @returns the shader code
  21823. */
  21824. getCode(state: NodeMaterialBuildState): string;
  21825. protected _buildBlock(state: NodeMaterialBuildState): this;
  21826. protected _dumpPropertiesCode(): string;
  21827. serialize(): any;
  21828. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21829. }
  21830. }
  21831. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21832. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21833. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21834. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21835. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21836. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21837. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21838. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21839. import { Nullable } from "babylonjs/types";
  21840. import { Scene } from "babylonjs/scene";
  21841. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21842. /**
  21843. * Base block used as input for post process
  21844. */
  21845. export class CurrentScreenBlock extends NodeMaterialBlock {
  21846. private _samplerName;
  21847. private _linearDefineName;
  21848. private _gammaDefineName;
  21849. private _mainUVName;
  21850. private _tempTextureRead;
  21851. /**
  21852. * Gets or sets the texture associated with the node
  21853. */
  21854. texture: Nullable<BaseTexture>;
  21855. /**
  21856. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21857. */
  21858. convertToGammaSpace: boolean;
  21859. /**
  21860. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21861. */
  21862. convertToLinearSpace: boolean;
  21863. /**
  21864. * Create a new CurrentScreenBlock
  21865. * @param name defines the block name
  21866. */
  21867. constructor(name: string);
  21868. /**
  21869. * Gets the current class name
  21870. * @returns the class name
  21871. */
  21872. getClassName(): string;
  21873. /**
  21874. * Gets the uv input component
  21875. */
  21876. get uv(): NodeMaterialConnectionPoint;
  21877. /**
  21878. * Gets the rgba output component
  21879. */
  21880. get rgba(): NodeMaterialConnectionPoint;
  21881. /**
  21882. * Gets the rgb output component
  21883. */
  21884. get rgb(): NodeMaterialConnectionPoint;
  21885. /**
  21886. * Gets the r output component
  21887. */
  21888. get r(): NodeMaterialConnectionPoint;
  21889. /**
  21890. * Gets the g output component
  21891. */
  21892. get g(): NodeMaterialConnectionPoint;
  21893. /**
  21894. * Gets the b output component
  21895. */
  21896. get b(): NodeMaterialConnectionPoint;
  21897. /**
  21898. * Gets the a output component
  21899. */
  21900. get a(): NodeMaterialConnectionPoint;
  21901. /**
  21902. * Initialize the block and prepare the context for build
  21903. * @param state defines the state that will be used for the build
  21904. */
  21905. initialize(state: NodeMaterialBuildState): void;
  21906. get target(): NodeMaterialBlockTargets;
  21907. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21908. isReady(): boolean;
  21909. private _injectVertexCode;
  21910. private _writeTextureRead;
  21911. private _writeOutput;
  21912. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21913. serialize(): any;
  21914. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21915. }
  21916. }
  21917. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21918. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21919. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21920. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21921. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21922. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21923. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21924. import { Nullable } from "babylonjs/types";
  21925. import { Scene } from "babylonjs/scene";
  21926. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21927. /**
  21928. * Base block used for the particle texture
  21929. */
  21930. export class ParticleTextureBlock extends NodeMaterialBlock {
  21931. private _samplerName;
  21932. private _linearDefineName;
  21933. private _gammaDefineName;
  21934. private _tempTextureRead;
  21935. /**
  21936. * Gets or sets the texture associated with the node
  21937. */
  21938. texture: Nullable<BaseTexture>;
  21939. /**
  21940. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21941. */
  21942. convertToGammaSpace: boolean;
  21943. /**
  21944. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21945. */
  21946. convertToLinearSpace: boolean;
  21947. /**
  21948. * Create a new ParticleTextureBlock
  21949. * @param name defines the block name
  21950. */
  21951. constructor(name: string);
  21952. /**
  21953. * Gets the current class name
  21954. * @returns the class name
  21955. */
  21956. getClassName(): string;
  21957. /**
  21958. * Gets the uv input component
  21959. */
  21960. get uv(): NodeMaterialConnectionPoint;
  21961. /**
  21962. * Gets the rgba output component
  21963. */
  21964. get rgba(): NodeMaterialConnectionPoint;
  21965. /**
  21966. * Gets the rgb output component
  21967. */
  21968. get rgb(): NodeMaterialConnectionPoint;
  21969. /**
  21970. * Gets the r output component
  21971. */
  21972. get r(): NodeMaterialConnectionPoint;
  21973. /**
  21974. * Gets the g output component
  21975. */
  21976. get g(): NodeMaterialConnectionPoint;
  21977. /**
  21978. * Gets the b output component
  21979. */
  21980. get b(): NodeMaterialConnectionPoint;
  21981. /**
  21982. * Gets the a output component
  21983. */
  21984. get a(): NodeMaterialConnectionPoint;
  21985. /**
  21986. * Initialize the block and prepare the context for build
  21987. * @param state defines the state that will be used for the build
  21988. */
  21989. initialize(state: NodeMaterialBuildState): void;
  21990. autoConfigure(material: NodeMaterial): void;
  21991. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21992. isReady(): boolean;
  21993. private _writeOutput;
  21994. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21995. serialize(): any;
  21996. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21997. }
  21998. }
  21999. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  22000. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22001. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22002. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22003. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22004. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22005. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22006. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22007. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22008. import { Scene } from "babylonjs/scene";
  22009. /**
  22010. * Class used to store shared data between 2 NodeMaterialBuildState
  22011. */
  22012. export class NodeMaterialBuildStateSharedData {
  22013. /**
  22014. * Gets the list of emitted varyings
  22015. */
  22016. temps: string[];
  22017. /**
  22018. * Gets the list of emitted varyings
  22019. */
  22020. varyings: string[];
  22021. /**
  22022. * Gets the varying declaration string
  22023. */
  22024. varyingDeclaration: string;
  22025. /**
  22026. * Input blocks
  22027. */
  22028. inputBlocks: InputBlock[];
  22029. /**
  22030. * Input blocks
  22031. */
  22032. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22033. /**
  22034. * Bindable blocks (Blocks that need to set data to the effect)
  22035. */
  22036. bindableBlocks: NodeMaterialBlock[];
  22037. /**
  22038. * List of blocks that can provide a compilation fallback
  22039. */
  22040. blocksWithFallbacks: NodeMaterialBlock[];
  22041. /**
  22042. * List of blocks that can provide a define update
  22043. */
  22044. blocksWithDefines: NodeMaterialBlock[];
  22045. /**
  22046. * List of blocks that can provide a repeatable content
  22047. */
  22048. repeatableContentBlocks: NodeMaterialBlock[];
  22049. /**
  22050. * List of blocks that can provide a dynamic list of uniforms
  22051. */
  22052. dynamicUniformBlocks: NodeMaterialBlock[];
  22053. /**
  22054. * List of blocks that can block the isReady function for the material
  22055. */
  22056. blockingBlocks: NodeMaterialBlock[];
  22057. /**
  22058. * Gets the list of animated inputs
  22059. */
  22060. animatedInputs: InputBlock[];
  22061. /**
  22062. * Build Id used to avoid multiple recompilations
  22063. */
  22064. buildId: number;
  22065. /** List of emitted variables */
  22066. variableNames: {
  22067. [key: string]: number;
  22068. };
  22069. /** List of emitted defines */
  22070. defineNames: {
  22071. [key: string]: number;
  22072. };
  22073. /** Should emit comments? */
  22074. emitComments: boolean;
  22075. /** Emit build activity */
  22076. verbose: boolean;
  22077. /** Gets or sets the hosting scene */
  22078. scene: Scene;
  22079. /**
  22080. * Gets the compilation hints emitted at compilation time
  22081. */
  22082. hints: {
  22083. needWorldViewMatrix: boolean;
  22084. needWorldViewProjectionMatrix: boolean;
  22085. needAlphaBlending: boolean;
  22086. needAlphaTesting: boolean;
  22087. };
  22088. /**
  22089. * List of compilation checks
  22090. */
  22091. checks: {
  22092. emitVertex: boolean;
  22093. emitFragment: boolean;
  22094. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  22095. };
  22096. /**
  22097. * Is vertex program allowed to be empty?
  22098. */
  22099. allowEmptyVertexProgram: boolean;
  22100. /** Creates a new shared data */
  22101. constructor();
  22102. /**
  22103. * Emits console errors and exceptions if there is a failing check
  22104. */
  22105. emitErrors(): void;
  22106. }
  22107. }
  22108. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  22109. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22110. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22111. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  22112. /**
  22113. * Class used to store node based material build state
  22114. */
  22115. export class NodeMaterialBuildState {
  22116. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  22117. supportUniformBuffers: boolean;
  22118. /**
  22119. * Gets the list of emitted attributes
  22120. */
  22121. attributes: string[];
  22122. /**
  22123. * Gets the list of emitted uniforms
  22124. */
  22125. uniforms: string[];
  22126. /**
  22127. * Gets the list of emitted constants
  22128. */
  22129. constants: string[];
  22130. /**
  22131. * Gets the list of emitted samplers
  22132. */
  22133. samplers: string[];
  22134. /**
  22135. * Gets the list of emitted functions
  22136. */
  22137. functions: {
  22138. [key: string]: string;
  22139. };
  22140. /**
  22141. * Gets the list of emitted extensions
  22142. */
  22143. extensions: {
  22144. [key: string]: string;
  22145. };
  22146. /**
  22147. * Gets the target of the compilation state
  22148. */
  22149. target: NodeMaterialBlockTargets;
  22150. /**
  22151. * Gets the list of emitted counters
  22152. */
  22153. counters: {
  22154. [key: string]: number;
  22155. };
  22156. /**
  22157. * Shared data between multiple NodeMaterialBuildState instances
  22158. */
  22159. sharedData: NodeMaterialBuildStateSharedData;
  22160. /** @hidden */
  22161. _vertexState: NodeMaterialBuildState;
  22162. /** @hidden */
  22163. _attributeDeclaration: string;
  22164. /** @hidden */
  22165. _uniformDeclaration: string;
  22166. /** @hidden */
  22167. _constantDeclaration: string;
  22168. /** @hidden */
  22169. _samplerDeclaration: string;
  22170. /** @hidden */
  22171. _varyingTransfer: string;
  22172. /** @hidden */
  22173. _injectAtEnd: string;
  22174. private _repeatableContentAnchorIndex;
  22175. /** @hidden */
  22176. _builtCompilationString: string;
  22177. /**
  22178. * Gets the emitted compilation strings
  22179. */
  22180. compilationString: string;
  22181. /**
  22182. * Finalize the compilation strings
  22183. * @param state defines the current compilation state
  22184. */
  22185. finalize(state: NodeMaterialBuildState): void;
  22186. /** @hidden */
  22187. get _repeatableContentAnchor(): string;
  22188. /** @hidden */
  22189. _getFreeVariableName(prefix: string): string;
  22190. /** @hidden */
  22191. _getFreeDefineName(prefix: string): string;
  22192. /** @hidden */
  22193. _excludeVariableName(name: string): void;
  22194. /** @hidden */
  22195. _emit2DSampler(name: string): void;
  22196. /** @hidden */
  22197. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22198. /** @hidden */
  22199. _emitExtension(name: string, extension: string, define?: string): void;
  22200. /** @hidden */
  22201. _emitFunction(name: string, code: string, comments: string): void;
  22202. /** @hidden */
  22203. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22204. replaceStrings?: {
  22205. search: RegExp;
  22206. replace: string;
  22207. }[];
  22208. repeatKey?: string;
  22209. }): string;
  22210. /** @hidden */
  22211. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22212. repeatKey?: string;
  22213. removeAttributes?: boolean;
  22214. removeUniforms?: boolean;
  22215. removeVaryings?: boolean;
  22216. removeIfDef?: boolean;
  22217. replaceStrings?: {
  22218. search: RegExp;
  22219. replace: string;
  22220. }[];
  22221. }, storeKey?: string): void;
  22222. /** @hidden */
  22223. _registerTempVariable(name: string): boolean;
  22224. /** @hidden */
  22225. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22226. /** @hidden */
  22227. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22228. /** @hidden */
  22229. _emitFloat(value: number): string;
  22230. }
  22231. }
  22232. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22233. /**
  22234. * Helper class used to generate session unique ID
  22235. */
  22236. export class UniqueIdGenerator {
  22237. private static _UniqueIdCounter;
  22238. /**
  22239. * Gets an unique (relatively to the current scene) Id
  22240. */
  22241. static get UniqueId(): number;
  22242. }
  22243. }
  22244. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22245. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22246. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22247. import { Nullable } from "babylonjs/types";
  22248. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22249. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22250. import { Effect } from "babylonjs/Materials/effect";
  22251. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22252. import { Mesh } from "babylonjs/Meshes/mesh";
  22253. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22254. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22255. import { Scene } from "babylonjs/scene";
  22256. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22257. /**
  22258. * Defines a block that can be used inside a node based material
  22259. */
  22260. export class NodeMaterialBlock {
  22261. private _buildId;
  22262. private _buildTarget;
  22263. private _target;
  22264. private _isFinalMerger;
  22265. private _isInput;
  22266. private _name;
  22267. protected _isUnique: boolean;
  22268. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22269. inputsAreExclusive: boolean;
  22270. /** @hidden */
  22271. _codeVariableName: string;
  22272. /** @hidden */
  22273. _inputs: NodeMaterialConnectionPoint[];
  22274. /** @hidden */
  22275. _outputs: NodeMaterialConnectionPoint[];
  22276. /** @hidden */
  22277. _preparationId: number;
  22278. /**
  22279. * Gets the name of the block
  22280. */
  22281. get name(): string;
  22282. /**
  22283. * Sets the name of the block. Will check if the name is valid.
  22284. */
  22285. set name(newName: string);
  22286. /**
  22287. * Gets or sets the unique id of the node
  22288. */
  22289. uniqueId: number;
  22290. /**
  22291. * Gets or sets the comments associated with this block
  22292. */
  22293. comments: string;
  22294. /**
  22295. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22296. */
  22297. get isUnique(): boolean;
  22298. /**
  22299. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22300. */
  22301. get isFinalMerger(): boolean;
  22302. /**
  22303. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22304. */
  22305. get isInput(): boolean;
  22306. /**
  22307. * Gets or sets the build Id
  22308. */
  22309. get buildId(): number;
  22310. set buildId(value: number);
  22311. /**
  22312. * Gets or sets the target of the block
  22313. */
  22314. get target(): NodeMaterialBlockTargets;
  22315. set target(value: NodeMaterialBlockTargets);
  22316. /**
  22317. * Gets the list of input points
  22318. */
  22319. get inputs(): NodeMaterialConnectionPoint[];
  22320. /** Gets the list of output points */
  22321. get outputs(): NodeMaterialConnectionPoint[];
  22322. /**
  22323. * Find an input by its name
  22324. * @param name defines the name of the input to look for
  22325. * @returns the input or null if not found
  22326. */
  22327. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22328. /**
  22329. * Find an output by its name
  22330. * @param name defines the name of the outputto look for
  22331. * @returns the output or null if not found
  22332. */
  22333. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22334. /**
  22335. * Creates a new NodeMaterialBlock
  22336. * @param name defines the block name
  22337. * @param target defines the target of that block (Vertex by default)
  22338. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22339. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22340. */
  22341. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22342. /**
  22343. * Initialize the block and prepare the context for build
  22344. * @param state defines the state that will be used for the build
  22345. */
  22346. initialize(state: NodeMaterialBuildState): void;
  22347. /**
  22348. * Bind data to effect. Will only be called for blocks with isBindable === true
  22349. * @param effect defines the effect to bind data to
  22350. * @param nodeMaterial defines the hosting NodeMaterial
  22351. * @param mesh defines the mesh that will be rendered
  22352. * @param subMesh defines the submesh that will be rendered
  22353. */
  22354. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22355. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22356. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22357. protected _writeFloat(value: number): string;
  22358. /**
  22359. * Gets the current class name e.g. "NodeMaterialBlock"
  22360. * @returns the class name
  22361. */
  22362. getClassName(): string;
  22363. /**
  22364. * Register a new input. Must be called inside a block constructor
  22365. * @param name defines the connection point name
  22366. * @param type defines the connection point type
  22367. * @param isOptional defines a boolean indicating that this input can be omitted
  22368. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22369. * @param point an already created connection point. If not provided, create a new one
  22370. * @returns the current block
  22371. */
  22372. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22373. /**
  22374. * Register a new output. Must be called inside a block constructor
  22375. * @param name defines the connection point name
  22376. * @param type defines the connection point type
  22377. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22378. * @param point an already created connection point. If not provided, create a new one
  22379. * @returns the current block
  22380. */
  22381. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22382. /**
  22383. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22384. * @param forOutput defines an optional connection point to check compatibility with
  22385. * @returns the first available input or null
  22386. */
  22387. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22388. /**
  22389. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22390. * @param forBlock defines an optional block to check compatibility with
  22391. * @returns the first available input or null
  22392. */
  22393. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22394. /**
  22395. * Gets the sibling of the given output
  22396. * @param current defines the current output
  22397. * @returns the next output in the list or null
  22398. */
  22399. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22400. /**
  22401. * Connect current block with another block
  22402. * @param other defines the block to connect with
  22403. * @param options define the various options to help pick the right connections
  22404. * @returns the current block
  22405. */
  22406. connectTo(other: NodeMaterialBlock, options?: {
  22407. input?: string;
  22408. output?: string;
  22409. outputSwizzle?: string;
  22410. }): this | undefined;
  22411. protected _buildBlock(state: NodeMaterialBuildState): void;
  22412. /**
  22413. * Add uniforms, samplers and uniform buffers at compilation time
  22414. * @param state defines the state to update
  22415. * @param nodeMaterial defines the node material requesting the update
  22416. * @param defines defines the material defines to update
  22417. * @param uniformBuffers defines the list of uniform buffer names
  22418. */
  22419. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22420. /**
  22421. * Add potential fallbacks if shader compilation fails
  22422. * @param mesh defines the mesh to be rendered
  22423. * @param fallbacks defines the current prioritized list of fallbacks
  22424. */
  22425. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22426. /**
  22427. * Initialize defines for shader compilation
  22428. * @param mesh defines the mesh to be rendered
  22429. * @param nodeMaterial defines the node material requesting the update
  22430. * @param defines defines the material defines to update
  22431. * @param useInstances specifies that instances should be used
  22432. */
  22433. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22434. /**
  22435. * Update defines for shader compilation
  22436. * @param mesh defines the mesh to be rendered
  22437. * @param nodeMaterial defines the node material requesting the update
  22438. * @param defines defines the material defines to update
  22439. * @param useInstances specifies that instances should be used
  22440. * @param subMesh defines which submesh to render
  22441. */
  22442. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22443. /**
  22444. * Lets the block try to connect some inputs automatically
  22445. * @param material defines the hosting NodeMaterial
  22446. */
  22447. autoConfigure(material: NodeMaterial): void;
  22448. /**
  22449. * Function called when a block is declared as repeatable content generator
  22450. * @param vertexShaderState defines the current compilation state for the vertex shader
  22451. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22452. * @param mesh defines the mesh to be rendered
  22453. * @param defines defines the material defines to update
  22454. */
  22455. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22456. /**
  22457. * Checks if the block is ready
  22458. * @param mesh defines the mesh to be rendered
  22459. * @param nodeMaterial defines the node material requesting the update
  22460. * @param defines defines the material defines to update
  22461. * @param useInstances specifies that instances should be used
  22462. * @returns true if the block is ready
  22463. */
  22464. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22465. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22466. private _processBuild;
  22467. /**
  22468. * Validates the new name for the block node.
  22469. * @param newName the new name to be given to the node.
  22470. * @returns false if the name is a reserve word, else true.
  22471. */
  22472. validateBlockName(newName: string): boolean;
  22473. /**
  22474. * Compile the current node and generate the shader code
  22475. * @param state defines the current compilation state (uniforms, samplers, current string)
  22476. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22477. * @returns true if already built
  22478. */
  22479. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22480. protected _inputRename(name: string): string;
  22481. protected _outputRename(name: string): string;
  22482. protected _dumpPropertiesCode(): string;
  22483. /** @hidden */
  22484. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22485. /** @hidden */
  22486. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22487. /**
  22488. * Clone the current block to a new identical block
  22489. * @param scene defines the hosting scene
  22490. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22491. * @returns a copy of the current block
  22492. */
  22493. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22494. /**
  22495. * Serializes this block in a JSON representation
  22496. * @returns the serialized block object
  22497. */
  22498. serialize(): any;
  22499. /** @hidden */
  22500. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22501. private _deserializePortDisplayNamesAndExposedOnFrame;
  22502. /**
  22503. * Release resources
  22504. */
  22505. dispose(): void;
  22506. }
  22507. }
  22508. declare module "babylonjs/Materials/pushMaterial" {
  22509. import { Nullable } from "babylonjs/types";
  22510. import { Scene } from "babylonjs/scene";
  22511. import { Matrix } from "babylonjs/Maths/math.vector";
  22512. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22513. import { Mesh } from "babylonjs/Meshes/mesh";
  22514. import { Material } from "babylonjs/Materials/material";
  22515. import { Effect } from "babylonjs/Materials/effect";
  22516. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22517. /**
  22518. * Base class of materials working in push mode in babylon JS
  22519. * @hidden
  22520. */
  22521. export class PushMaterial extends Material {
  22522. protected _activeEffect: Effect;
  22523. protected _normalMatrix: Matrix;
  22524. constructor(name: string, scene: Scene);
  22525. getEffect(): Effect;
  22526. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22527. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22528. /**
  22529. * Binds the given world matrix to the active effect
  22530. *
  22531. * @param world the matrix to bind
  22532. */
  22533. bindOnlyWorldMatrix(world: Matrix): void;
  22534. /**
  22535. * Binds the given normal matrix to the active effect
  22536. *
  22537. * @param normalMatrix the matrix to bind
  22538. */
  22539. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22540. bind(world: Matrix, mesh?: Mesh): void;
  22541. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22542. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22543. }
  22544. }
  22545. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22546. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22547. /**
  22548. * Root class for all node material optimizers
  22549. */
  22550. export class NodeMaterialOptimizer {
  22551. /**
  22552. * Function used to optimize a NodeMaterial graph
  22553. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22554. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22555. */
  22556. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22557. }
  22558. }
  22559. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22560. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22561. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22562. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22563. import { Scene } from "babylonjs/scene";
  22564. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22565. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22566. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22567. /**
  22568. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22569. */
  22570. export class TransformBlock extends NodeMaterialBlock {
  22571. /**
  22572. * Defines the value to use to complement W value to transform it to a Vector4
  22573. */
  22574. complementW: number;
  22575. /**
  22576. * Defines the value to use to complement z value to transform it to a Vector4
  22577. */
  22578. complementZ: number;
  22579. /**
  22580. * Creates a new TransformBlock
  22581. * @param name defines the block name
  22582. */
  22583. constructor(name: string);
  22584. /**
  22585. * Gets the current class name
  22586. * @returns the class name
  22587. */
  22588. getClassName(): string;
  22589. /**
  22590. * Gets the vector input
  22591. */
  22592. get vector(): NodeMaterialConnectionPoint;
  22593. /**
  22594. * Gets the output component
  22595. */
  22596. get output(): NodeMaterialConnectionPoint;
  22597. /**
  22598. * Gets the xyz output component
  22599. */
  22600. get xyz(): NodeMaterialConnectionPoint;
  22601. /**
  22602. * Gets the matrix transform input
  22603. */
  22604. get transform(): NodeMaterialConnectionPoint;
  22605. protected _buildBlock(state: NodeMaterialBuildState): this;
  22606. /**
  22607. * Update defines for shader compilation
  22608. * @param mesh defines the mesh to be rendered
  22609. * @param nodeMaterial defines the node material requesting the update
  22610. * @param defines defines the material defines to update
  22611. * @param useInstances specifies that instances should be used
  22612. * @param subMesh defines which submesh to render
  22613. */
  22614. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22615. serialize(): any;
  22616. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22617. protected _dumpPropertiesCode(): string;
  22618. }
  22619. }
  22620. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22621. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22622. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22623. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22624. /**
  22625. * Block used to output the vertex position
  22626. */
  22627. export class VertexOutputBlock extends NodeMaterialBlock {
  22628. /**
  22629. * Creates a new VertexOutputBlock
  22630. * @param name defines the block name
  22631. */
  22632. constructor(name: string);
  22633. /**
  22634. * Gets the current class name
  22635. * @returns the class name
  22636. */
  22637. getClassName(): string;
  22638. /**
  22639. * Gets the vector input component
  22640. */
  22641. get vector(): NodeMaterialConnectionPoint;
  22642. protected _buildBlock(state: NodeMaterialBuildState): this;
  22643. }
  22644. }
  22645. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22646. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22647. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22648. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22649. /**
  22650. * Block used to output the final color
  22651. */
  22652. export class FragmentOutputBlock extends NodeMaterialBlock {
  22653. /**
  22654. * Create a new FragmentOutputBlock
  22655. * @param name defines the block name
  22656. */
  22657. constructor(name: string);
  22658. /**
  22659. * Gets the current class name
  22660. * @returns the class name
  22661. */
  22662. getClassName(): string;
  22663. /**
  22664. * Gets the rgba input component
  22665. */
  22666. get rgba(): NodeMaterialConnectionPoint;
  22667. /**
  22668. * Gets the rgb input component
  22669. */
  22670. get rgb(): NodeMaterialConnectionPoint;
  22671. /**
  22672. * Gets the a input component
  22673. */
  22674. get a(): NodeMaterialConnectionPoint;
  22675. protected _buildBlock(state: NodeMaterialBuildState): this;
  22676. }
  22677. }
  22678. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22679. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22680. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22681. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22682. /**
  22683. * Block used for the particle ramp gradient section
  22684. */
  22685. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22686. /**
  22687. * Create a new ParticleRampGradientBlock
  22688. * @param name defines the block name
  22689. */
  22690. constructor(name: string);
  22691. /**
  22692. * Gets the current class name
  22693. * @returns the class name
  22694. */
  22695. getClassName(): string;
  22696. /**
  22697. * Gets the color input component
  22698. */
  22699. get color(): NodeMaterialConnectionPoint;
  22700. /**
  22701. * Gets the rampColor output component
  22702. */
  22703. get rampColor(): NodeMaterialConnectionPoint;
  22704. /**
  22705. * Initialize the block and prepare the context for build
  22706. * @param state defines the state that will be used for the build
  22707. */
  22708. initialize(state: NodeMaterialBuildState): void;
  22709. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22710. }
  22711. }
  22712. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22713. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22714. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22715. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22716. /**
  22717. * Block used for the particle blend multiply section
  22718. */
  22719. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22720. /**
  22721. * Create a new ParticleBlendMultiplyBlock
  22722. * @param name defines the block name
  22723. */
  22724. constructor(name: string);
  22725. /**
  22726. * Gets the current class name
  22727. * @returns the class name
  22728. */
  22729. getClassName(): string;
  22730. /**
  22731. * Gets the color input component
  22732. */
  22733. get color(): NodeMaterialConnectionPoint;
  22734. /**
  22735. * Gets the alphaTexture input component
  22736. */
  22737. get alphaTexture(): NodeMaterialConnectionPoint;
  22738. /**
  22739. * Gets the alphaColor input component
  22740. */
  22741. get alphaColor(): NodeMaterialConnectionPoint;
  22742. /**
  22743. * Gets the blendColor output component
  22744. */
  22745. get blendColor(): NodeMaterialConnectionPoint;
  22746. /**
  22747. * Initialize the block and prepare the context for build
  22748. * @param state defines the state that will be used for the build
  22749. */
  22750. initialize(state: NodeMaterialBuildState): void;
  22751. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22752. }
  22753. }
  22754. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22755. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22756. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22757. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22758. /**
  22759. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22760. */
  22761. export class VectorMergerBlock extends NodeMaterialBlock {
  22762. /**
  22763. * Create a new VectorMergerBlock
  22764. * @param name defines the block name
  22765. */
  22766. constructor(name: string);
  22767. /**
  22768. * Gets the current class name
  22769. * @returns the class name
  22770. */
  22771. getClassName(): string;
  22772. /**
  22773. * Gets the xyz component (input)
  22774. */
  22775. get xyzIn(): NodeMaterialConnectionPoint;
  22776. /**
  22777. * Gets the xy component (input)
  22778. */
  22779. get xyIn(): NodeMaterialConnectionPoint;
  22780. /**
  22781. * Gets the x component (input)
  22782. */
  22783. get x(): NodeMaterialConnectionPoint;
  22784. /**
  22785. * Gets the y component (input)
  22786. */
  22787. get y(): NodeMaterialConnectionPoint;
  22788. /**
  22789. * Gets the z component (input)
  22790. */
  22791. get z(): NodeMaterialConnectionPoint;
  22792. /**
  22793. * Gets the w component (input)
  22794. */
  22795. get w(): NodeMaterialConnectionPoint;
  22796. /**
  22797. * Gets the xyzw component (output)
  22798. */
  22799. get xyzw(): NodeMaterialConnectionPoint;
  22800. /**
  22801. * Gets the xyz component (output)
  22802. */
  22803. get xyzOut(): NodeMaterialConnectionPoint;
  22804. /**
  22805. * Gets the xy component (output)
  22806. */
  22807. get xyOut(): NodeMaterialConnectionPoint;
  22808. /**
  22809. * Gets the xy component (output)
  22810. * @deprecated Please use xyOut instead.
  22811. */
  22812. get xy(): NodeMaterialConnectionPoint;
  22813. /**
  22814. * Gets the xyz component (output)
  22815. * @deprecated Please use xyzOut instead.
  22816. */
  22817. get xyz(): NodeMaterialConnectionPoint;
  22818. protected _buildBlock(state: NodeMaterialBuildState): this;
  22819. }
  22820. }
  22821. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22822. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22823. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22824. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22825. import { Vector2 } from "babylonjs/Maths/math.vector";
  22826. import { Scene } from "babylonjs/scene";
  22827. /**
  22828. * Block used to remap a float from a range to a new one
  22829. */
  22830. export class RemapBlock extends NodeMaterialBlock {
  22831. /**
  22832. * Gets or sets the source range
  22833. */
  22834. sourceRange: Vector2;
  22835. /**
  22836. * Gets or sets the target range
  22837. */
  22838. targetRange: Vector2;
  22839. /**
  22840. * Creates a new RemapBlock
  22841. * @param name defines the block name
  22842. */
  22843. constructor(name: string);
  22844. /**
  22845. * Gets the current class name
  22846. * @returns the class name
  22847. */
  22848. getClassName(): string;
  22849. /**
  22850. * Gets the input component
  22851. */
  22852. get input(): NodeMaterialConnectionPoint;
  22853. /**
  22854. * Gets the source min input component
  22855. */
  22856. get sourceMin(): NodeMaterialConnectionPoint;
  22857. /**
  22858. * Gets the source max input component
  22859. */
  22860. get sourceMax(): NodeMaterialConnectionPoint;
  22861. /**
  22862. * Gets the target min input component
  22863. */
  22864. get targetMin(): NodeMaterialConnectionPoint;
  22865. /**
  22866. * Gets the target max input component
  22867. */
  22868. get targetMax(): NodeMaterialConnectionPoint;
  22869. /**
  22870. * Gets the output component
  22871. */
  22872. get output(): NodeMaterialConnectionPoint;
  22873. protected _buildBlock(state: NodeMaterialBuildState): this;
  22874. protected _dumpPropertiesCode(): string;
  22875. serialize(): any;
  22876. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22877. }
  22878. }
  22879. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22880. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22881. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22882. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22883. /**
  22884. * Block used to multiply 2 values
  22885. */
  22886. export class MultiplyBlock extends NodeMaterialBlock {
  22887. /**
  22888. * Creates a new MultiplyBlock
  22889. * @param name defines the block name
  22890. */
  22891. constructor(name: string);
  22892. /**
  22893. * Gets the current class name
  22894. * @returns the class name
  22895. */
  22896. getClassName(): string;
  22897. /**
  22898. * Gets the left operand input component
  22899. */
  22900. get left(): NodeMaterialConnectionPoint;
  22901. /**
  22902. * Gets the right operand input component
  22903. */
  22904. get right(): NodeMaterialConnectionPoint;
  22905. /**
  22906. * Gets the output component
  22907. */
  22908. get output(): NodeMaterialConnectionPoint;
  22909. protected _buildBlock(state: NodeMaterialBuildState): this;
  22910. }
  22911. }
  22912. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22913. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22914. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22915. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22916. /**
  22917. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  22918. */
  22919. export class ColorSplitterBlock extends NodeMaterialBlock {
  22920. /**
  22921. * Create a new ColorSplitterBlock
  22922. * @param name defines the block name
  22923. */
  22924. constructor(name: string);
  22925. /**
  22926. * Gets the current class name
  22927. * @returns the class name
  22928. */
  22929. getClassName(): string;
  22930. /**
  22931. * Gets the rgba component (input)
  22932. */
  22933. get rgba(): NodeMaterialConnectionPoint;
  22934. /**
  22935. * Gets the rgb component (input)
  22936. */
  22937. get rgbIn(): NodeMaterialConnectionPoint;
  22938. /**
  22939. * Gets the rgb component (output)
  22940. */
  22941. get rgbOut(): NodeMaterialConnectionPoint;
  22942. /**
  22943. * Gets the r component (output)
  22944. */
  22945. get r(): NodeMaterialConnectionPoint;
  22946. /**
  22947. * Gets the g component (output)
  22948. */
  22949. get g(): NodeMaterialConnectionPoint;
  22950. /**
  22951. * Gets the b component (output)
  22952. */
  22953. get b(): NodeMaterialConnectionPoint;
  22954. /**
  22955. * Gets the a component (output)
  22956. */
  22957. get a(): NodeMaterialConnectionPoint;
  22958. protected _inputRename(name: string): string;
  22959. protected _outputRename(name: string): string;
  22960. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22961. }
  22962. }
  22963. declare module "babylonjs/Materials/Node/nodeMaterial" {
  22964. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22965. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  22966. import { Scene } from "babylonjs/scene";
  22967. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22968. import { Matrix } from "babylonjs/Maths/math.vector";
  22969. import { Mesh } from "babylonjs/Meshes/mesh";
  22970. import { Engine } from "babylonjs/Engines/engine";
  22971. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22972. import { Observable } from "babylonjs/Misc/observable";
  22973. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22974. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  22975. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  22976. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  22977. import { Nullable } from "babylonjs/types";
  22978. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22979. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22980. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22981. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22982. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22983. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22984. import { Effect } from "babylonjs/Materials/effect";
  22985. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  22986. import { Camera } from "babylonjs/Cameras/camera";
  22987. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  22988. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  22989. /**
  22990. * Interface used to configure the node material editor
  22991. */
  22992. export interface INodeMaterialEditorOptions {
  22993. /** Define the URl to load node editor script */
  22994. editorURL?: string;
  22995. }
  22996. /** @hidden */
  22997. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  22998. NORMAL: boolean;
  22999. TANGENT: boolean;
  23000. UV1: boolean;
  23001. /** BONES */
  23002. NUM_BONE_INFLUENCERS: number;
  23003. BonesPerMesh: number;
  23004. BONETEXTURE: boolean;
  23005. /** MORPH TARGETS */
  23006. MORPHTARGETS: boolean;
  23007. MORPHTARGETS_NORMAL: boolean;
  23008. MORPHTARGETS_TANGENT: boolean;
  23009. MORPHTARGETS_UV: boolean;
  23010. NUM_MORPH_INFLUENCERS: number;
  23011. /** IMAGE PROCESSING */
  23012. IMAGEPROCESSING: boolean;
  23013. VIGNETTE: boolean;
  23014. VIGNETTEBLENDMODEMULTIPLY: boolean;
  23015. VIGNETTEBLENDMODEOPAQUE: boolean;
  23016. TONEMAPPING: boolean;
  23017. TONEMAPPING_ACES: boolean;
  23018. CONTRAST: boolean;
  23019. EXPOSURE: boolean;
  23020. COLORCURVES: boolean;
  23021. COLORGRADING: boolean;
  23022. COLORGRADING3D: boolean;
  23023. SAMPLER3DGREENDEPTH: boolean;
  23024. SAMPLER3DBGRMAP: boolean;
  23025. IMAGEPROCESSINGPOSTPROCESS: boolean;
  23026. /** MISC. */
  23027. BUMPDIRECTUV: number;
  23028. constructor();
  23029. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  23030. }
  23031. /**
  23032. * Class used to configure NodeMaterial
  23033. */
  23034. export interface INodeMaterialOptions {
  23035. /**
  23036. * Defines if blocks should emit comments
  23037. */
  23038. emitComments: boolean;
  23039. }
  23040. /**
  23041. * Class used to create a node based material built by assembling shader blocks
  23042. */
  23043. export class NodeMaterial extends PushMaterial {
  23044. private static _BuildIdGenerator;
  23045. private _options;
  23046. private _vertexCompilationState;
  23047. private _fragmentCompilationState;
  23048. private _sharedData;
  23049. private _buildId;
  23050. private _buildWasSuccessful;
  23051. private _cachedWorldViewMatrix;
  23052. private _cachedWorldViewProjectionMatrix;
  23053. private _optimizers;
  23054. private _animationFrame;
  23055. /** Define the Url to load node editor script */
  23056. static EditorURL: string;
  23057. /** Define the Url to load snippets */
  23058. static SnippetUrl: string;
  23059. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  23060. static IgnoreTexturesAtLoadTime: boolean;
  23061. private BJSNODEMATERIALEDITOR;
  23062. /** Get the inspector from bundle or global */
  23063. private _getGlobalNodeMaterialEditor;
  23064. /**
  23065. * Snippet ID if the material was created from the snippet server
  23066. */
  23067. snippetId: string;
  23068. /**
  23069. * Gets or sets data used by visual editor
  23070. * @see https://nme.babylonjs.com
  23071. */
  23072. editorData: any;
  23073. /**
  23074. * 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)
  23075. */
  23076. ignoreAlpha: boolean;
  23077. /**
  23078. * Defines the maximum number of lights that can be used in the material
  23079. */
  23080. maxSimultaneousLights: number;
  23081. /**
  23082. * Observable raised when the material is built
  23083. */
  23084. onBuildObservable: Observable<NodeMaterial>;
  23085. /**
  23086. * Gets or sets the root nodes of the material vertex shader
  23087. */
  23088. _vertexOutputNodes: NodeMaterialBlock[];
  23089. /**
  23090. * Gets or sets the root nodes of the material fragment (pixel) shader
  23091. */
  23092. _fragmentOutputNodes: NodeMaterialBlock[];
  23093. /** Gets or sets options to control the node material overall behavior */
  23094. get options(): INodeMaterialOptions;
  23095. set options(options: INodeMaterialOptions);
  23096. /**
  23097. * Default configuration related to image processing available in the standard Material.
  23098. */
  23099. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23100. /**
  23101. * Gets the image processing configuration used either in this material.
  23102. */
  23103. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23104. /**
  23105. * Sets the Default image processing configuration used either in the this material.
  23106. *
  23107. * If sets to null, the scene one is in use.
  23108. */
  23109. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23110. /**
  23111. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  23112. */
  23113. attachedBlocks: NodeMaterialBlock[];
  23114. /**
  23115. * Specifies the mode of the node material
  23116. * @hidden
  23117. */
  23118. _mode: NodeMaterialModes;
  23119. /**
  23120. * Gets the mode property
  23121. */
  23122. get mode(): NodeMaterialModes;
  23123. /**
  23124. * Create a new node based material
  23125. * @param name defines the material name
  23126. * @param scene defines the hosting scene
  23127. * @param options defines creation option
  23128. */
  23129. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  23130. /**
  23131. * Gets the current class name of the material e.g. "NodeMaterial"
  23132. * @returns the class name
  23133. */
  23134. getClassName(): string;
  23135. /**
  23136. * Keep track of the image processing observer to allow dispose and replace.
  23137. */
  23138. private _imageProcessingObserver;
  23139. /**
  23140. * Attaches a new image processing configuration to the Standard Material.
  23141. * @param configuration
  23142. */
  23143. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  23144. /**
  23145. * Get a block by its name
  23146. * @param name defines the name of the block to retrieve
  23147. * @returns the required block or null if not found
  23148. */
  23149. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  23150. /**
  23151. * Get a block by its name
  23152. * @param predicate defines the predicate used to find the good candidate
  23153. * @returns the required block or null if not found
  23154. */
  23155. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  23156. /**
  23157. * Get an input block by its name
  23158. * @param predicate defines the predicate used to find the good candidate
  23159. * @returns the required input block or null if not found
  23160. */
  23161. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  23162. /**
  23163. * Gets the list of input blocks attached to this material
  23164. * @returns an array of InputBlocks
  23165. */
  23166. getInputBlocks(): InputBlock[];
  23167. /**
  23168. * Adds a new optimizer to the list of optimizers
  23169. * @param optimizer defines the optimizers to add
  23170. * @returns the current material
  23171. */
  23172. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23173. /**
  23174. * Remove an optimizer from the list of optimizers
  23175. * @param optimizer defines the optimizers to remove
  23176. * @returns the current material
  23177. */
  23178. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23179. /**
  23180. * Add a new block to the list of output nodes
  23181. * @param node defines the node to add
  23182. * @returns the current material
  23183. */
  23184. addOutputNode(node: NodeMaterialBlock): this;
  23185. /**
  23186. * Remove a block from the list of root nodes
  23187. * @param node defines the node to remove
  23188. * @returns the current material
  23189. */
  23190. removeOutputNode(node: NodeMaterialBlock): this;
  23191. private _addVertexOutputNode;
  23192. private _removeVertexOutputNode;
  23193. private _addFragmentOutputNode;
  23194. private _removeFragmentOutputNode;
  23195. /**
  23196. * Specifies if the material will require alpha blending
  23197. * @returns a boolean specifying if alpha blending is needed
  23198. */
  23199. needAlphaBlending(): boolean;
  23200. /**
  23201. * Specifies if this material should be rendered in alpha test mode
  23202. * @returns a boolean specifying if an alpha test is needed.
  23203. */
  23204. needAlphaTesting(): boolean;
  23205. private _initializeBlock;
  23206. private _resetDualBlocks;
  23207. /**
  23208. * Remove a block from the current node material
  23209. * @param block defines the block to remove
  23210. */
  23211. removeBlock(block: NodeMaterialBlock): void;
  23212. /**
  23213. * Build the material and generates the inner effect
  23214. * @param verbose defines if the build should log activity
  23215. */
  23216. build(verbose?: boolean): void;
  23217. /**
  23218. * Runs an otpimization phase to try to improve the shader code
  23219. */
  23220. optimize(): void;
  23221. private _prepareDefinesForAttributes;
  23222. /**
  23223. * Create a post process from the material
  23224. * @param camera The camera to apply the render pass to.
  23225. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23226. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23227. * @param engine The engine which the post process will be applied. (default: current engine)
  23228. * @param reusable If the post process can be reused on the same frame. (default: false)
  23229. * @param textureType Type of textures used when performing the post process. (default: 0)
  23230. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23231. * @returns the post process created
  23232. */
  23233. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  23234. /**
  23235. * Create the post process effect from the material
  23236. * @param postProcess The post process to create the effect for
  23237. */
  23238. createEffectForPostProcess(postProcess: PostProcess): void;
  23239. private _createEffectOrPostProcess;
  23240. private _createEffectForParticles;
  23241. /**
  23242. * Create the effect to be used as the custom effect for a particle system
  23243. * @param particleSystem Particle system to create the effect for
  23244. * @param onCompiled defines a function to call when the effect creation is successful
  23245. * @param onError defines a function to call when the effect creation has failed
  23246. */
  23247. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23248. private _processDefines;
  23249. /**
  23250. * Get if the submesh is ready to be used and all its information available.
  23251. * Child classes can use it to update shaders
  23252. * @param mesh defines the mesh to check
  23253. * @param subMesh defines which submesh to check
  23254. * @param useInstances specifies that instances should be used
  23255. * @returns a boolean indicating that the submesh is ready or not
  23256. */
  23257. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23258. /**
  23259. * Get a string representing the shaders built by the current node graph
  23260. */
  23261. get compiledShaders(): string;
  23262. /**
  23263. * Binds the world matrix to the material
  23264. * @param world defines the world transformation matrix
  23265. */
  23266. bindOnlyWorldMatrix(world: Matrix): void;
  23267. /**
  23268. * Binds the submesh to this material by preparing the effect and shader to draw
  23269. * @param world defines the world transformation matrix
  23270. * @param mesh defines the mesh containing the submesh
  23271. * @param subMesh defines the submesh to bind the material to
  23272. */
  23273. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23274. /**
  23275. * Gets the active textures from the material
  23276. * @returns an array of textures
  23277. */
  23278. getActiveTextures(): BaseTexture[];
  23279. /**
  23280. * Gets the list of texture blocks
  23281. * @returns an array of texture blocks
  23282. */
  23283. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23284. /**
  23285. * Specifies if the material uses a texture
  23286. * @param texture defines the texture to check against the material
  23287. * @returns a boolean specifying if the material uses the texture
  23288. */
  23289. hasTexture(texture: BaseTexture): boolean;
  23290. /**
  23291. * Disposes the material
  23292. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23293. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23294. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23295. */
  23296. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23297. /** Creates the node editor window. */
  23298. private _createNodeEditor;
  23299. /**
  23300. * Launch the node material editor
  23301. * @param config Define the configuration of the editor
  23302. * @return a promise fulfilled when the node editor is visible
  23303. */
  23304. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23305. /**
  23306. * Clear the current material
  23307. */
  23308. clear(): void;
  23309. /**
  23310. * Clear the current material and set it to a default state
  23311. */
  23312. setToDefault(): void;
  23313. /**
  23314. * Clear the current material and set it to a default state for post process
  23315. */
  23316. setToDefaultPostProcess(): void;
  23317. /**
  23318. * Clear the current material and set it to a default state for particle
  23319. */
  23320. setToDefaultParticle(): void;
  23321. /**
  23322. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23323. * @param url defines the url to load from
  23324. * @returns a promise that will fullfil when the material is fully loaded
  23325. */
  23326. loadAsync(url: string): Promise<void>;
  23327. private _gatherBlocks;
  23328. /**
  23329. * Generate a string containing the code declaration required to create an equivalent of this material
  23330. * @returns a string
  23331. */
  23332. generateCode(): string;
  23333. /**
  23334. * Serializes this material in a JSON representation
  23335. * @returns the serialized material object
  23336. */
  23337. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23338. private _restoreConnections;
  23339. /**
  23340. * Clear the current graph and load a new one from a serialization object
  23341. * @param source defines the JSON representation of the material
  23342. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23343. * @param merge defines whether or not the source must be merged or replace the current content
  23344. */
  23345. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23346. /**
  23347. * Makes a duplicate of the current material.
  23348. * @param name - name to use for the new material.
  23349. */
  23350. clone(name: string): NodeMaterial;
  23351. /**
  23352. * Creates a node material from parsed material data
  23353. * @param source defines the JSON representation of the material
  23354. * @param scene defines the hosting scene
  23355. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23356. * @returns a new node material
  23357. */
  23358. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23359. /**
  23360. * Creates a node material from a snippet saved in a remote file
  23361. * @param name defines the name of the material to create
  23362. * @param url defines the url to load from
  23363. * @param scene defines the hosting scene
  23364. * @returns a promise that will resolve to the new node material
  23365. */
  23366. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23367. /**
  23368. * Creates a node material from a snippet saved by the node material editor
  23369. * @param snippetId defines the snippet to load
  23370. * @param scene defines the hosting scene
  23371. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23372. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23373. * @returns a promise that will resolve to the new node material
  23374. */
  23375. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23376. /**
  23377. * Creates a new node material set to default basic configuration
  23378. * @param name defines the name of the material
  23379. * @param scene defines the hosting scene
  23380. * @returns a new NodeMaterial
  23381. */
  23382. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23383. }
  23384. }
  23385. declare module "babylonjs/PostProcesses/postProcess" {
  23386. import { Nullable } from "babylonjs/types";
  23387. import { SmartArray } from "babylonjs/Misc/smartArray";
  23388. import { Observable } from "babylonjs/Misc/observable";
  23389. import { Vector2 } from "babylonjs/Maths/math.vector";
  23390. import { Camera } from "babylonjs/Cameras/camera";
  23391. import { Effect } from "babylonjs/Materials/effect";
  23392. import "babylonjs/Shaders/postprocess.vertex";
  23393. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23394. import { Engine } from "babylonjs/Engines/engine";
  23395. import { Color4 } from "babylonjs/Maths/math.color";
  23396. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23397. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23398. import { Scene } from "babylonjs/scene";
  23399. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23400. /**
  23401. * Size options for a post process
  23402. */
  23403. export type PostProcessOptions = {
  23404. width: number;
  23405. height: number;
  23406. };
  23407. /**
  23408. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23409. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23410. */
  23411. export class PostProcess {
  23412. /**
  23413. * Gets or sets the unique id of the post process
  23414. */
  23415. uniqueId: number;
  23416. /** Name of the PostProcess. */
  23417. name: string;
  23418. /**
  23419. * Width of the texture to apply the post process on
  23420. */
  23421. width: number;
  23422. /**
  23423. * Height of the texture to apply the post process on
  23424. */
  23425. height: number;
  23426. /**
  23427. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23428. */
  23429. nodeMaterialSource: Nullable<NodeMaterial>;
  23430. /**
  23431. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23432. * @hidden
  23433. */
  23434. _outputTexture: Nullable<InternalTexture>;
  23435. /**
  23436. * Sampling mode used by the shader
  23437. * See https://doc.babylonjs.com/classes/3.1/texture
  23438. */
  23439. renderTargetSamplingMode: number;
  23440. /**
  23441. * Clear color to use when screen clearing
  23442. */
  23443. clearColor: Color4;
  23444. /**
  23445. * If the buffer needs to be cleared before applying the post process. (default: true)
  23446. * Should be set to false if shader will overwrite all previous pixels.
  23447. */
  23448. autoClear: boolean;
  23449. /**
  23450. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23451. */
  23452. alphaMode: number;
  23453. /**
  23454. * Sets the setAlphaBlendConstants of the babylon engine
  23455. */
  23456. alphaConstants: Color4;
  23457. /**
  23458. * Animations to be used for the post processing
  23459. */
  23460. animations: import("babylonjs/Animations/animation").Animation[];
  23461. /**
  23462. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23463. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23464. */
  23465. enablePixelPerfectMode: boolean;
  23466. /**
  23467. * Force the postprocess to be applied without taking in account viewport
  23468. */
  23469. forceFullscreenViewport: boolean;
  23470. /**
  23471. * List of inspectable custom properties (used by the Inspector)
  23472. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23473. */
  23474. inspectableCustomProperties: IInspectable[];
  23475. /**
  23476. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23477. *
  23478. * | Value | Type | Description |
  23479. * | ----- | ----------------------------------- | ----------- |
  23480. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23481. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23482. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23483. *
  23484. */
  23485. scaleMode: number;
  23486. /**
  23487. * Force textures to be a power of two (default: false)
  23488. */
  23489. alwaysForcePOT: boolean;
  23490. private _samples;
  23491. /**
  23492. * Number of sample textures (default: 1)
  23493. */
  23494. get samples(): number;
  23495. set samples(n: number);
  23496. /**
  23497. * Modify the scale of the post process to be the same as the viewport (default: false)
  23498. */
  23499. adaptScaleToCurrentViewport: boolean;
  23500. private _camera;
  23501. protected _scene: Scene;
  23502. private _engine;
  23503. private _options;
  23504. private _reusable;
  23505. private _textureType;
  23506. private _textureFormat;
  23507. /**
  23508. * Smart array of input and output textures for the post process.
  23509. * @hidden
  23510. */
  23511. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23512. /**
  23513. * The index in _textures that corresponds to the output texture.
  23514. * @hidden
  23515. */
  23516. _currentRenderTextureInd: number;
  23517. private _effect;
  23518. private _samplers;
  23519. private _fragmentUrl;
  23520. private _vertexUrl;
  23521. private _parameters;
  23522. private _scaleRatio;
  23523. protected _indexParameters: any;
  23524. private _shareOutputWithPostProcess;
  23525. private _texelSize;
  23526. private _forcedOutputTexture;
  23527. /**
  23528. * Returns the fragment url or shader name used in the post process.
  23529. * @returns the fragment url or name in the shader store.
  23530. */
  23531. getEffectName(): string;
  23532. /**
  23533. * An event triggered when the postprocess is activated.
  23534. */
  23535. onActivateObservable: Observable<Camera>;
  23536. private _onActivateObserver;
  23537. /**
  23538. * A function that is added to the onActivateObservable
  23539. */
  23540. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23541. /**
  23542. * An event triggered when the postprocess changes its size.
  23543. */
  23544. onSizeChangedObservable: Observable<PostProcess>;
  23545. private _onSizeChangedObserver;
  23546. /**
  23547. * A function that is added to the onSizeChangedObservable
  23548. */
  23549. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23550. /**
  23551. * An event triggered when the postprocess applies its effect.
  23552. */
  23553. onApplyObservable: Observable<Effect>;
  23554. private _onApplyObserver;
  23555. /**
  23556. * A function that is added to the onApplyObservable
  23557. */
  23558. set onApply(callback: (effect: Effect) => void);
  23559. /**
  23560. * An event triggered before rendering the postprocess
  23561. */
  23562. onBeforeRenderObservable: Observable<Effect>;
  23563. private _onBeforeRenderObserver;
  23564. /**
  23565. * A function that is added to the onBeforeRenderObservable
  23566. */
  23567. set onBeforeRender(callback: (effect: Effect) => void);
  23568. /**
  23569. * An event triggered after rendering the postprocess
  23570. */
  23571. onAfterRenderObservable: Observable<Effect>;
  23572. private _onAfterRenderObserver;
  23573. /**
  23574. * A function that is added to the onAfterRenderObservable
  23575. */
  23576. set onAfterRender(callback: (efect: Effect) => void);
  23577. /**
  23578. * 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
  23579. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23580. */
  23581. get inputTexture(): InternalTexture;
  23582. set inputTexture(value: InternalTexture);
  23583. /**
  23584. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23585. * the only way to unset it is to use this function to restore its internal state
  23586. */
  23587. restoreDefaultInputTexture(): void;
  23588. /**
  23589. * Gets the camera which post process is applied to.
  23590. * @returns The camera the post process is applied to.
  23591. */
  23592. getCamera(): Camera;
  23593. /**
  23594. * Gets the texel size of the postprocess.
  23595. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23596. */
  23597. get texelSize(): Vector2;
  23598. /**
  23599. * Creates a new instance PostProcess
  23600. * @param name The name of the PostProcess.
  23601. * @param fragmentUrl The url of the fragment shader to be used.
  23602. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23603. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23604. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23605. * @param camera The camera to apply the render pass to.
  23606. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23607. * @param engine The engine which the post process will be applied. (default: current engine)
  23608. * @param reusable If the post process can be reused on the same frame. (default: false)
  23609. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23610. * @param textureType Type of textures used when performing the post process. (default: 0)
  23611. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23612. * @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
  23613. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  23614. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23615. */
  23616. 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);
  23617. /**
  23618. * Gets a string identifying the name of the class
  23619. * @returns "PostProcess" string
  23620. */
  23621. getClassName(): string;
  23622. /**
  23623. * Gets the engine which this post process belongs to.
  23624. * @returns The engine the post process was enabled with.
  23625. */
  23626. getEngine(): Engine;
  23627. /**
  23628. * The effect that is created when initializing the post process.
  23629. * @returns The created effect corresponding the the postprocess.
  23630. */
  23631. getEffect(): Effect;
  23632. /**
  23633. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23634. * @param postProcess The post process to share the output with.
  23635. * @returns This post process.
  23636. */
  23637. shareOutputWith(postProcess: PostProcess): PostProcess;
  23638. /**
  23639. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23640. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23641. */
  23642. useOwnOutput(): void;
  23643. /**
  23644. * Updates the effect with the current post process compile time values and recompiles the shader.
  23645. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23646. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23647. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23648. * @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
  23649. * @param onCompiled Called when the shader has been compiled.
  23650. * @param onError Called if there is an error when compiling a shader.
  23651. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23652. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23653. */
  23654. 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;
  23655. /**
  23656. * The post process is reusable if it can be used multiple times within one frame.
  23657. * @returns If the post process is reusable
  23658. */
  23659. isReusable(): boolean;
  23660. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23661. markTextureDirty(): void;
  23662. /**
  23663. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23664. * 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.
  23665. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23666. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23667. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23668. * @returns The target texture that was bound to be written to.
  23669. */
  23670. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23671. /**
  23672. * If the post process is supported.
  23673. */
  23674. get isSupported(): boolean;
  23675. /**
  23676. * The aspect ratio of the output texture.
  23677. */
  23678. get aspectRatio(): number;
  23679. /**
  23680. * Get a value indicating if the post-process is ready to be used
  23681. * @returns true if the post-process is ready (shader is compiled)
  23682. */
  23683. isReady(): boolean;
  23684. /**
  23685. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23686. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23687. */
  23688. apply(): Nullable<Effect>;
  23689. private _disposeTextures;
  23690. /**
  23691. * Disposes the post process.
  23692. * @param camera The camera to dispose the post process on.
  23693. */
  23694. dispose(camera?: Camera): void;
  23695. /**
  23696. * Serializes the particle system to a JSON object
  23697. * @returns the JSON object
  23698. */
  23699. serialize(): any;
  23700. /**
  23701. * Creates a material from parsed material data
  23702. * @param parsedPostProcess defines parsed post process data
  23703. * @param scene defines the hosting scene
  23704. * @param rootUrl defines the root URL to use to load textures
  23705. * @returns a new post process
  23706. */
  23707. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  23708. }
  23709. }
  23710. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23711. /** @hidden */
  23712. export var kernelBlurVaryingDeclaration: {
  23713. name: string;
  23714. shader: string;
  23715. };
  23716. }
  23717. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23718. /** @hidden */
  23719. export var kernelBlurFragment: {
  23720. name: string;
  23721. shader: string;
  23722. };
  23723. }
  23724. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23725. /** @hidden */
  23726. export var kernelBlurFragment2: {
  23727. name: string;
  23728. shader: string;
  23729. };
  23730. }
  23731. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23732. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23733. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23734. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23735. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23736. /** @hidden */
  23737. export var kernelBlurPixelShader: {
  23738. name: string;
  23739. shader: string;
  23740. };
  23741. }
  23742. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23743. /** @hidden */
  23744. export var kernelBlurVertex: {
  23745. name: string;
  23746. shader: string;
  23747. };
  23748. }
  23749. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23750. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23751. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23752. /** @hidden */
  23753. export var kernelBlurVertexShader: {
  23754. name: string;
  23755. shader: string;
  23756. };
  23757. }
  23758. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23759. import { Vector2 } from "babylonjs/Maths/math.vector";
  23760. import { Nullable } from "babylonjs/types";
  23761. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23762. import { Camera } from "babylonjs/Cameras/camera";
  23763. import { Effect } from "babylonjs/Materials/effect";
  23764. import { Engine } from "babylonjs/Engines/engine";
  23765. import "babylonjs/Shaders/kernelBlur.fragment";
  23766. import "babylonjs/Shaders/kernelBlur.vertex";
  23767. import { Scene } from "babylonjs/scene";
  23768. /**
  23769. * The Blur Post Process which blurs an image based on a kernel and direction.
  23770. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23771. */
  23772. export class BlurPostProcess extends PostProcess {
  23773. private blockCompilation;
  23774. protected _kernel: number;
  23775. protected _idealKernel: number;
  23776. protected _packedFloat: boolean;
  23777. private _staticDefines;
  23778. /** The direction in which to blur the image. */
  23779. direction: Vector2;
  23780. /**
  23781. * Sets the length in pixels of the blur sample region
  23782. */
  23783. set kernel(v: number);
  23784. /**
  23785. * Gets the length in pixels of the blur sample region
  23786. */
  23787. get kernel(): number;
  23788. /**
  23789. * Sets wether or not the blur needs to unpack/repack floats
  23790. */
  23791. set packedFloat(v: boolean);
  23792. /**
  23793. * Gets wether or not the blur is unpacking/repacking floats
  23794. */
  23795. get packedFloat(): boolean;
  23796. /**
  23797. * Gets a string identifying the name of the class
  23798. * @returns "BlurPostProcess" string
  23799. */
  23800. getClassName(): string;
  23801. /**
  23802. * Creates a new instance BlurPostProcess
  23803. * @param name The name of the effect.
  23804. * @param direction The direction in which to blur the image.
  23805. * @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.
  23806. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23807. * @param camera The camera to apply the render pass to.
  23808. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23809. * @param engine The engine which the post process will be applied. (default: current engine)
  23810. * @param reusable If the post process can be reused on the same frame. (default: false)
  23811. * @param textureType Type of textures used when performing the post process. (default: 0)
  23812. * @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)
  23813. */
  23814. 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);
  23815. /**
  23816. * Updates the effect with the current post process compile time values and recompiles the shader.
  23817. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23818. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23819. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23820. * @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
  23821. * @param onCompiled Called when the shader has been compiled.
  23822. * @param onError Called if there is an error when compiling a shader.
  23823. */
  23824. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23825. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23826. /**
  23827. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  23828. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  23829. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  23830. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  23831. * The gaps between physical kernels are compensated for in the weighting of the samples
  23832. * @param idealKernel Ideal blur kernel.
  23833. * @return Nearest best kernel.
  23834. */
  23835. protected _nearestBestKernel(idealKernel: number): number;
  23836. /**
  23837. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  23838. * @param x The point on the Gaussian distribution to sample.
  23839. * @return the value of the Gaussian function at x.
  23840. */
  23841. protected _gaussianWeight(x: number): number;
  23842. /**
  23843. * Generates a string that can be used as a floating point number in GLSL.
  23844. * @param x Value to print.
  23845. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  23846. * @return GLSL float string.
  23847. */
  23848. protected _glslFloat(x: number, decimalFigures?: number): string;
  23849. /** @hidden */
  23850. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  23851. }
  23852. }
  23853. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  23854. import { Scene } from "babylonjs/scene";
  23855. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23856. import { Plane } from "babylonjs/Maths/math.plane";
  23857. /**
  23858. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23859. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23860. * You can then easily use it as a reflectionTexture on a flat surface.
  23861. * In case the surface is not a plane, please consider relying on reflection probes.
  23862. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23863. */
  23864. export class MirrorTexture extends RenderTargetTexture {
  23865. private scene;
  23866. /**
  23867. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  23868. * 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.
  23869. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23870. */
  23871. mirrorPlane: Plane;
  23872. /**
  23873. * Define the blur ratio used to blur the reflection if needed.
  23874. */
  23875. set blurRatio(value: number);
  23876. get blurRatio(): number;
  23877. /**
  23878. * Define the adaptive blur kernel used to blur the reflection if needed.
  23879. * This will autocompute the closest best match for the `blurKernel`
  23880. */
  23881. set adaptiveBlurKernel(value: number);
  23882. /**
  23883. * Define the blur kernel used to blur the reflection if needed.
  23884. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23885. */
  23886. set blurKernel(value: number);
  23887. /**
  23888. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  23889. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23890. */
  23891. set blurKernelX(value: number);
  23892. get blurKernelX(): number;
  23893. /**
  23894. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  23895. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23896. */
  23897. set blurKernelY(value: number);
  23898. get blurKernelY(): number;
  23899. private _autoComputeBlurKernel;
  23900. protected _onRatioRescale(): void;
  23901. private _updateGammaSpace;
  23902. private _imageProcessingConfigChangeObserver;
  23903. private _transformMatrix;
  23904. private _mirrorMatrix;
  23905. private _savedViewMatrix;
  23906. private _blurX;
  23907. private _blurY;
  23908. private _adaptiveBlurKernel;
  23909. private _blurKernelX;
  23910. private _blurKernelY;
  23911. private _blurRatio;
  23912. /**
  23913. * Instantiates a Mirror Texture.
  23914. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23915. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23916. * You can then easily use it as a reflectionTexture on a flat surface.
  23917. * In case the surface is not a plane, please consider relying on reflection probes.
  23918. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23919. * @param name
  23920. * @param size
  23921. * @param scene
  23922. * @param generateMipMaps
  23923. * @param type
  23924. * @param samplingMode
  23925. * @param generateDepthBuffer
  23926. */
  23927. constructor(name: string, size: number | {
  23928. width: number;
  23929. height: number;
  23930. } | {
  23931. ratio: number;
  23932. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  23933. private _preparePostProcesses;
  23934. /**
  23935. * Clone the mirror texture.
  23936. * @returns the cloned texture
  23937. */
  23938. clone(): MirrorTexture;
  23939. /**
  23940. * Serialize the texture to a JSON representation you could use in Parse later on
  23941. * @returns the serialized JSON representation
  23942. */
  23943. serialize(): any;
  23944. /**
  23945. * Dispose the texture and release its associated resources.
  23946. */
  23947. dispose(): void;
  23948. }
  23949. }
  23950. declare module "babylonjs/Materials/Textures/texture" {
  23951. import { Observable } from "babylonjs/Misc/observable";
  23952. import { Nullable } from "babylonjs/types";
  23953. import { Matrix } from "babylonjs/Maths/math.vector";
  23954. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23955. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23956. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  23957. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  23958. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  23959. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23960. import { Scene } from "babylonjs/scene";
  23961. /**
  23962. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23963. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23964. */
  23965. export class Texture extends BaseTexture {
  23966. /**
  23967. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  23968. */
  23969. static SerializeBuffers: boolean;
  23970. /** @hidden */
  23971. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  23972. /** @hidden */
  23973. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  23974. /** @hidden */
  23975. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  23976. /** nearest is mag = nearest and min = nearest and mip = linear */
  23977. static readonly NEAREST_SAMPLINGMODE: number;
  23978. /** nearest is mag = nearest and min = nearest and mip = linear */
  23979. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  23980. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23981. static readonly BILINEAR_SAMPLINGMODE: number;
  23982. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23983. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  23984. /** Trilinear is mag = linear and min = linear and mip = linear */
  23985. static readonly TRILINEAR_SAMPLINGMODE: number;
  23986. /** Trilinear is mag = linear and min = linear and mip = linear */
  23987. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  23988. /** mag = nearest and min = nearest and mip = nearest */
  23989. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  23990. /** mag = nearest and min = linear and mip = nearest */
  23991. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  23992. /** mag = nearest and min = linear and mip = linear */
  23993. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  23994. /** mag = nearest and min = linear and mip = none */
  23995. static readonly NEAREST_LINEAR: number;
  23996. /** mag = nearest and min = nearest and mip = none */
  23997. static readonly NEAREST_NEAREST: number;
  23998. /** mag = linear and min = nearest and mip = nearest */
  23999. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  24000. /** mag = linear and min = nearest and mip = linear */
  24001. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  24002. /** mag = linear and min = linear and mip = none */
  24003. static readonly LINEAR_LINEAR: number;
  24004. /** mag = linear and min = nearest and mip = none */
  24005. static readonly LINEAR_NEAREST: number;
  24006. /** Explicit coordinates mode */
  24007. static readonly EXPLICIT_MODE: number;
  24008. /** Spherical coordinates mode */
  24009. static readonly SPHERICAL_MODE: number;
  24010. /** Planar coordinates mode */
  24011. static readonly PLANAR_MODE: number;
  24012. /** Cubic coordinates mode */
  24013. static readonly CUBIC_MODE: number;
  24014. /** Projection coordinates mode */
  24015. static readonly PROJECTION_MODE: number;
  24016. /** Inverse Cubic coordinates mode */
  24017. static readonly SKYBOX_MODE: number;
  24018. /** Inverse Cubic coordinates mode */
  24019. static readonly INVCUBIC_MODE: number;
  24020. /** Equirectangular coordinates mode */
  24021. static readonly EQUIRECTANGULAR_MODE: number;
  24022. /** Equirectangular Fixed coordinates mode */
  24023. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  24024. /** Equirectangular Fixed Mirrored coordinates mode */
  24025. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  24026. /** Texture is not repeating outside of 0..1 UVs */
  24027. static readonly CLAMP_ADDRESSMODE: number;
  24028. /** Texture is repeating outside of 0..1 UVs */
  24029. static readonly WRAP_ADDRESSMODE: number;
  24030. /** Texture is repeating and mirrored */
  24031. static readonly MIRROR_ADDRESSMODE: number;
  24032. /**
  24033. * 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
  24034. */
  24035. static UseSerializedUrlIfAny: boolean;
  24036. /**
  24037. * Define the url of the texture.
  24038. */
  24039. url: Nullable<string>;
  24040. /**
  24041. * Define an offset on the texture to offset the u coordinates of the UVs
  24042. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24043. */
  24044. uOffset: number;
  24045. /**
  24046. * Define an offset on the texture to offset the v coordinates of the UVs
  24047. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24048. */
  24049. vOffset: number;
  24050. /**
  24051. * Define an offset on the texture to scale the u coordinates of the UVs
  24052. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24053. */
  24054. uScale: number;
  24055. /**
  24056. * Define an offset on the texture to scale the v coordinates of the UVs
  24057. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24058. */
  24059. vScale: number;
  24060. /**
  24061. * Define an offset on the texture to rotate around the u coordinates of the UVs
  24062. * @see https://doc.babylonjs.com/how_to/more_materials
  24063. */
  24064. uAng: number;
  24065. /**
  24066. * Define an offset on the texture to rotate around the v coordinates of the UVs
  24067. * @see https://doc.babylonjs.com/how_to/more_materials
  24068. */
  24069. vAng: number;
  24070. /**
  24071. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  24072. * @see https://doc.babylonjs.com/how_to/more_materials
  24073. */
  24074. wAng: number;
  24075. /**
  24076. * Defines the center of rotation (U)
  24077. */
  24078. uRotationCenter: number;
  24079. /**
  24080. * Defines the center of rotation (V)
  24081. */
  24082. vRotationCenter: number;
  24083. /**
  24084. * Defines the center of rotation (W)
  24085. */
  24086. wRotationCenter: number;
  24087. /**
  24088. * Are mip maps generated for this texture or not.
  24089. */
  24090. get noMipmap(): boolean;
  24091. /**
  24092. * List of inspectable custom properties (used by the Inspector)
  24093. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  24094. */
  24095. inspectableCustomProperties: Nullable<IInspectable[]>;
  24096. private _noMipmap;
  24097. /** @hidden */
  24098. _invertY: boolean;
  24099. private _rowGenerationMatrix;
  24100. private _cachedTextureMatrix;
  24101. private _projectionModeMatrix;
  24102. private _t0;
  24103. private _t1;
  24104. private _t2;
  24105. private _cachedUOffset;
  24106. private _cachedVOffset;
  24107. private _cachedUScale;
  24108. private _cachedVScale;
  24109. private _cachedUAng;
  24110. private _cachedVAng;
  24111. private _cachedWAng;
  24112. private _cachedProjectionMatrixId;
  24113. private _cachedCoordinatesMode;
  24114. /** @hidden */
  24115. protected _initialSamplingMode: number;
  24116. /** @hidden */
  24117. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  24118. private _deleteBuffer;
  24119. protected _format: Nullable<number>;
  24120. private _delayedOnLoad;
  24121. private _delayedOnError;
  24122. private _mimeType?;
  24123. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  24124. get mimeType(): string | undefined;
  24125. /**
  24126. * Observable triggered once the texture has been loaded.
  24127. */
  24128. onLoadObservable: Observable<Texture>;
  24129. protected _isBlocking: boolean;
  24130. /**
  24131. * Is the texture preventing material to render while loading.
  24132. * If false, a default texture will be used instead of the loading one during the preparation step.
  24133. */
  24134. set isBlocking(value: boolean);
  24135. get isBlocking(): boolean;
  24136. /**
  24137. * Get the current sampling mode associated with the texture.
  24138. */
  24139. get samplingMode(): number;
  24140. /**
  24141. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  24142. */
  24143. get invertY(): boolean;
  24144. /**
  24145. * Instantiates a new texture.
  24146. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24147. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24148. * @param url defines the url of the picture to load as a texture
  24149. * @param sceneOrEngine defines the scene or engine the texture will belong to
  24150. * @param noMipmap defines if the texture will require mip maps or not
  24151. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  24152. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24153. * @param onLoad defines a callback triggered when the texture has been loaded
  24154. * @param onError defines a callback triggered when an error occurred during the loading session
  24155. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  24156. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  24157. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24158. * @param mimeType defines an optional mime type information
  24159. */
  24160. 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);
  24161. /**
  24162. * Update the url (and optional buffer) of this texture if url was null during construction.
  24163. * @param url the url of the texture
  24164. * @param buffer the buffer of the texture (defaults to null)
  24165. * @param onLoad callback called when the texture is loaded (defaults to null)
  24166. */
  24167. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  24168. /**
  24169. * Finish the loading sequence of a texture flagged as delayed load.
  24170. * @hidden
  24171. */
  24172. delayLoad(): void;
  24173. private _prepareRowForTextureGeneration;
  24174. /**
  24175. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  24176. * @returns the transform matrix of the texture.
  24177. */
  24178. getTextureMatrix(uBase?: number): Matrix;
  24179. /**
  24180. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  24181. * @returns The reflection texture transform
  24182. */
  24183. getReflectionTextureMatrix(): Matrix;
  24184. /**
  24185. * Clones the texture.
  24186. * @returns the cloned texture
  24187. */
  24188. clone(): Texture;
  24189. /**
  24190. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24191. * @returns The JSON representation of the texture
  24192. */
  24193. serialize(): any;
  24194. /**
  24195. * Get the current class name of the texture useful for serialization or dynamic coding.
  24196. * @returns "Texture"
  24197. */
  24198. getClassName(): string;
  24199. /**
  24200. * Dispose the texture and release its associated resources.
  24201. */
  24202. dispose(): void;
  24203. /**
  24204. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  24205. * @param parsedTexture Define the JSON representation of the texture
  24206. * @param scene Define the scene the parsed texture should be instantiated in
  24207. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  24208. * @returns The parsed texture if successful
  24209. */
  24210. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  24211. /**
  24212. * Creates a texture from its base 64 representation.
  24213. * @param data Define the base64 payload without the data: prefix
  24214. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24215. * @param scene Define the scene the texture should belong to
  24216. * @param noMipmap Forces the texture to not create mip map information if true
  24217. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24218. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24219. * @param onLoad define a callback triggered when the texture has been loaded
  24220. * @param onError define a callback triggered when an error occurred during the loading session
  24221. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24222. * @returns the created texture
  24223. */
  24224. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  24225. /**
  24226. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  24227. * @param data Define the base64 payload without the data: prefix
  24228. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24229. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  24230. * @param scene Define the scene the texture should belong to
  24231. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  24232. * @param noMipmap Forces the texture to not create mip map information if true
  24233. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24234. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24235. * @param onLoad define a callback triggered when the texture has been loaded
  24236. * @param onError define a callback triggered when an error occurred during the loading session
  24237. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24238. * @returns the created texture
  24239. */
  24240. 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;
  24241. }
  24242. }
  24243. declare module "babylonjs/PostProcesses/postProcessManager" {
  24244. import { Nullable } from "babylonjs/types";
  24245. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24246. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24247. import { Scene } from "babylonjs/scene";
  24248. /**
  24249. * PostProcessManager is used to manage one or more post processes or post process pipelines
  24250. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  24251. */
  24252. export class PostProcessManager {
  24253. private _scene;
  24254. private _indexBuffer;
  24255. private _vertexBuffers;
  24256. /**
  24257. * Creates a new instance PostProcess
  24258. * @param scene The scene that the post process is associated with.
  24259. */
  24260. constructor(scene: Scene);
  24261. private _prepareBuffers;
  24262. private _buildIndexBuffer;
  24263. /**
  24264. * Rebuilds the vertex buffers of the manager.
  24265. * @hidden
  24266. */
  24267. _rebuild(): void;
  24268. /**
  24269. * Prepares a frame to be run through a post process.
  24270. * @param sourceTexture The input texture to the post procesess. (default: null)
  24271. * @param postProcesses An array of post processes to be run. (default: null)
  24272. * @returns True if the post processes were able to be run.
  24273. * @hidden
  24274. */
  24275. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24276. /**
  24277. * Manually render a set of post processes to a texture.
  24278. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24279. * @param postProcesses An array of post processes to be run.
  24280. * @param targetTexture The target texture to render to.
  24281. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24282. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24283. * @param lodLevel defines which lod of the texture to render to
  24284. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24285. */
  24286. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24287. /**
  24288. * Finalize the result of the output of the postprocesses.
  24289. * @param doNotPresent If true the result will not be displayed to the screen.
  24290. * @param targetTexture The target texture to render to.
  24291. * @param faceIndex The index of the face to bind the target texture to.
  24292. * @param postProcesses The array of post processes to render.
  24293. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24294. * @hidden
  24295. */
  24296. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24297. /**
  24298. * Disposes of the post process manager.
  24299. */
  24300. dispose(): void;
  24301. }
  24302. }
  24303. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24304. import { Observable } from "babylonjs/Misc/observable";
  24305. import { SmartArray } from "babylonjs/Misc/smartArray";
  24306. import { Nullable, Immutable } from "babylonjs/types";
  24307. import { Camera } from "babylonjs/Cameras/camera";
  24308. import { Scene } from "babylonjs/scene";
  24309. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24310. import { Color4 } from "babylonjs/Maths/math.color";
  24311. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24312. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24313. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24314. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24315. import { Texture } from "babylonjs/Materials/Textures/texture";
  24316. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24317. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24318. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24319. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24320. import { Engine } from "babylonjs/Engines/engine";
  24321. /**
  24322. * This Helps creating a texture that will be created from a camera in your scene.
  24323. * It is basically a dynamic texture that could be used to create special effects for instance.
  24324. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24325. */
  24326. export class RenderTargetTexture extends Texture {
  24327. /**
  24328. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24329. */
  24330. static readonly REFRESHRATE_RENDER_ONCE: number;
  24331. /**
  24332. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24333. */
  24334. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24335. /**
  24336. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24337. * the central point of your effect and can save a lot of performances.
  24338. */
  24339. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24340. /**
  24341. * Use this predicate to dynamically define the list of mesh you want to render.
  24342. * If set, the renderList property will be overwritten.
  24343. */
  24344. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24345. private _renderList;
  24346. /**
  24347. * Use this list to define the list of mesh you want to render.
  24348. */
  24349. get renderList(): Nullable<Array<AbstractMesh>>;
  24350. set renderList(value: Nullable<Array<AbstractMesh>>);
  24351. /**
  24352. * Use this function to overload the renderList array at rendering time.
  24353. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24354. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24355. * the cube (if the RTT is a cube, else layerOrFace=0).
  24356. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24357. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24358. * hold dummy elements!
  24359. */
  24360. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24361. private _hookArray;
  24362. /**
  24363. * Define if particles should be rendered in your texture.
  24364. */
  24365. renderParticles: boolean;
  24366. /**
  24367. * Define if sprites should be rendered in your texture.
  24368. */
  24369. renderSprites: boolean;
  24370. /**
  24371. * Define the camera used to render the texture.
  24372. */
  24373. activeCamera: Nullable<Camera>;
  24374. /**
  24375. * Override the mesh isReady function with your own one.
  24376. */
  24377. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24378. /**
  24379. * Override the render function of the texture with your own one.
  24380. */
  24381. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24382. /**
  24383. * Define if camera post processes should be use while rendering the texture.
  24384. */
  24385. useCameraPostProcesses: boolean;
  24386. /**
  24387. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24388. */
  24389. ignoreCameraViewport: boolean;
  24390. private _postProcessManager;
  24391. private _postProcesses;
  24392. private _resizeObserver;
  24393. /**
  24394. * An event triggered when the texture is unbind.
  24395. */
  24396. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24397. /**
  24398. * An event triggered when the texture is unbind.
  24399. */
  24400. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24401. private _onAfterUnbindObserver;
  24402. /**
  24403. * Set a after unbind callback in the texture.
  24404. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24405. */
  24406. set onAfterUnbind(callback: () => void);
  24407. /**
  24408. * An event triggered before rendering the texture
  24409. */
  24410. onBeforeRenderObservable: Observable<number>;
  24411. private _onBeforeRenderObserver;
  24412. /**
  24413. * Set a before render callback in the texture.
  24414. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24415. */
  24416. set onBeforeRender(callback: (faceIndex: number) => void);
  24417. /**
  24418. * An event triggered after rendering the texture
  24419. */
  24420. onAfterRenderObservable: Observable<number>;
  24421. private _onAfterRenderObserver;
  24422. /**
  24423. * Set a after render callback in the texture.
  24424. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24425. */
  24426. set onAfterRender(callback: (faceIndex: number) => void);
  24427. /**
  24428. * An event triggered after the texture clear
  24429. */
  24430. onClearObservable: Observable<Engine>;
  24431. private _onClearObserver;
  24432. /**
  24433. * Set a clear callback in the texture.
  24434. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24435. */
  24436. set onClear(callback: (Engine: Engine) => void);
  24437. /**
  24438. * An event triggered when the texture is resized.
  24439. */
  24440. onResizeObservable: Observable<RenderTargetTexture>;
  24441. /**
  24442. * Define the clear color of the Render Target if it should be different from the scene.
  24443. */
  24444. clearColor: Color4;
  24445. protected _size: number | {
  24446. width: number;
  24447. height: number;
  24448. layers?: number;
  24449. };
  24450. protected _initialSizeParameter: number | {
  24451. width: number;
  24452. height: number;
  24453. } | {
  24454. ratio: number;
  24455. };
  24456. protected _sizeRatio: Nullable<number>;
  24457. /** @hidden */
  24458. _generateMipMaps: boolean;
  24459. protected _renderingManager: RenderingManager;
  24460. /** @hidden */
  24461. _waitingRenderList?: string[];
  24462. protected _doNotChangeAspectRatio: boolean;
  24463. protected _currentRefreshId: number;
  24464. protected _refreshRate: number;
  24465. protected _textureMatrix: Matrix;
  24466. protected _samples: number;
  24467. protected _renderTargetOptions: RenderTargetCreationOptions;
  24468. /**
  24469. * Gets render target creation options that were used.
  24470. */
  24471. get renderTargetOptions(): RenderTargetCreationOptions;
  24472. protected _onRatioRescale(): void;
  24473. /**
  24474. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24475. * It must define where the camera used to render the texture is set
  24476. */
  24477. boundingBoxPosition: Vector3;
  24478. private _boundingBoxSize;
  24479. /**
  24480. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24481. * When defined, the cubemap will switch to local mode
  24482. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24483. * @example https://www.babylonjs-playground.com/#RNASML
  24484. */
  24485. set boundingBoxSize(value: Vector3);
  24486. get boundingBoxSize(): Vector3;
  24487. /**
  24488. * In case the RTT has been created with a depth texture, get the associated
  24489. * depth texture.
  24490. * Otherwise, return null.
  24491. */
  24492. get depthStencilTexture(): Nullable<InternalTexture>;
  24493. /**
  24494. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24495. * or used a shadow, depth texture...
  24496. * @param name The friendly name of the texture
  24497. * @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)
  24498. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24499. * @param generateMipMaps True if mip maps need to be generated after render.
  24500. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24501. * @param type The type of the buffer in the RTT (int, half float, float...)
  24502. * @param isCube True if a cube texture needs to be created
  24503. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24504. * @param generateDepthBuffer True to generate a depth buffer
  24505. * @param generateStencilBuffer True to generate a stencil buffer
  24506. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24507. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24508. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24509. */
  24510. constructor(name: string, size: number | {
  24511. width: number;
  24512. height: number;
  24513. layers?: number;
  24514. } | {
  24515. ratio: number;
  24516. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24517. /**
  24518. * Creates a depth stencil texture.
  24519. * This is only available in WebGL 2 or with the depth texture extension available.
  24520. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24521. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24522. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24523. */
  24524. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24525. private _processSizeParameter;
  24526. /**
  24527. * Define the number of samples to use in case of MSAA.
  24528. * It defaults to one meaning no MSAA has been enabled.
  24529. */
  24530. get samples(): number;
  24531. set samples(value: number);
  24532. /**
  24533. * Resets the refresh counter of the texture and start bak from scratch.
  24534. * Could be useful to regenerate the texture if it is setup to render only once.
  24535. */
  24536. resetRefreshCounter(): void;
  24537. /**
  24538. * Define the refresh rate of the texture or the rendering frequency.
  24539. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24540. */
  24541. get refreshRate(): number;
  24542. set refreshRate(value: number);
  24543. /**
  24544. * Adds a post process to the render target rendering passes.
  24545. * @param postProcess define the post process to add
  24546. */
  24547. addPostProcess(postProcess: PostProcess): void;
  24548. /**
  24549. * Clear all the post processes attached to the render target
  24550. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24551. */
  24552. clearPostProcesses(dispose?: boolean): void;
  24553. /**
  24554. * Remove one of the post process from the list of attached post processes to the texture
  24555. * @param postProcess define the post process to remove from the list
  24556. */
  24557. removePostProcess(postProcess: PostProcess): void;
  24558. /** @hidden */
  24559. _shouldRender(): boolean;
  24560. /**
  24561. * Gets the actual render size of the texture.
  24562. * @returns the width of the render size
  24563. */
  24564. getRenderSize(): number;
  24565. /**
  24566. * Gets the actual render width of the texture.
  24567. * @returns the width of the render size
  24568. */
  24569. getRenderWidth(): number;
  24570. /**
  24571. * Gets the actual render height of the texture.
  24572. * @returns the height of the render size
  24573. */
  24574. getRenderHeight(): number;
  24575. /**
  24576. * Gets the actual number of layers of the texture.
  24577. * @returns the number of layers
  24578. */
  24579. getRenderLayers(): number;
  24580. /**
  24581. * Get if the texture can be rescaled or not.
  24582. */
  24583. get canRescale(): boolean;
  24584. /**
  24585. * Resize the texture using a ratio.
  24586. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24587. */
  24588. scale(ratio: number): void;
  24589. /**
  24590. * Get the texture reflection matrix used to rotate/transform the reflection.
  24591. * @returns the reflection matrix
  24592. */
  24593. getReflectionTextureMatrix(): Matrix;
  24594. /**
  24595. * Resize the texture to a new desired size.
  24596. * Be carrefull as it will recreate all the data in the new texture.
  24597. * @param size Define the new size. It can be:
  24598. * - a number for squared texture,
  24599. * - an object containing { width: number, height: number }
  24600. * - or an object containing a ratio { ratio: number }
  24601. */
  24602. resize(size: number | {
  24603. width: number;
  24604. height: number;
  24605. } | {
  24606. ratio: number;
  24607. }): void;
  24608. private _defaultRenderListPrepared;
  24609. /**
  24610. * Renders all the objects from the render list into the texture.
  24611. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24612. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24613. */
  24614. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24615. private _bestReflectionRenderTargetDimension;
  24616. private _prepareRenderingManager;
  24617. /**
  24618. * @hidden
  24619. * @param faceIndex face index to bind to if this is a cubetexture
  24620. * @param layer defines the index of the texture to bind in the array
  24621. */
  24622. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24623. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24624. private renderToTarget;
  24625. /**
  24626. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24627. * This allowed control for front to back rendering or reversly depending of the special needs.
  24628. *
  24629. * @param renderingGroupId The rendering group id corresponding to its index
  24630. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24631. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24632. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24633. */
  24634. 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;
  24635. /**
  24636. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24637. *
  24638. * @param renderingGroupId The rendering group id corresponding to its index
  24639. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24640. */
  24641. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24642. /**
  24643. * Clones the texture.
  24644. * @returns the cloned texture
  24645. */
  24646. clone(): RenderTargetTexture;
  24647. /**
  24648. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24649. * @returns The JSON representation of the texture
  24650. */
  24651. serialize(): any;
  24652. /**
  24653. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24654. */
  24655. disposeFramebufferObjects(): void;
  24656. /**
  24657. * Dispose the texture and release its associated resources.
  24658. */
  24659. dispose(): void;
  24660. /** @hidden */
  24661. _rebuild(): void;
  24662. /**
  24663. * Clear the info related to rendering groups preventing retention point in material dispose.
  24664. */
  24665. freeRenderingGroups(): void;
  24666. /**
  24667. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24668. * @returns the view count
  24669. */
  24670. getViewCount(): number;
  24671. }
  24672. }
  24673. declare module "babylonjs/Misc/guid" {
  24674. /**
  24675. * Class used to manipulate GUIDs
  24676. */
  24677. export class GUID {
  24678. /**
  24679. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24680. * Be aware Math.random() could cause collisions, but:
  24681. * "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"
  24682. * @returns a pseudo random id
  24683. */
  24684. static RandomId(): string;
  24685. }
  24686. }
  24687. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24688. import { Nullable } from "babylonjs/types";
  24689. import { Scene } from "babylonjs/scene";
  24690. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24691. import { Material } from "babylonjs/Materials/material";
  24692. import { Effect } from "babylonjs/Materials/effect";
  24693. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24694. /**
  24695. * Options to be used when creating a shadow depth material
  24696. */
  24697. export interface IIOptionShadowDepthMaterial {
  24698. /** Variables in the vertex shader code that need to have their names remapped.
  24699. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24700. * "var_name" should be either: worldPos or vNormalW
  24701. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24702. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24703. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24704. */
  24705. remappedVariables?: string[];
  24706. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24707. standalone?: boolean;
  24708. }
  24709. /**
  24710. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24711. */
  24712. export class ShadowDepthWrapper {
  24713. private _scene;
  24714. private _options?;
  24715. private _baseMaterial;
  24716. private _onEffectCreatedObserver;
  24717. private _subMeshToEffect;
  24718. private _subMeshToDepthEffect;
  24719. private _meshes;
  24720. /** @hidden */
  24721. _matriceNames: any;
  24722. /** Gets the standalone status of the wrapper */
  24723. get standalone(): boolean;
  24724. /** Gets the base material the wrapper is built upon */
  24725. get baseMaterial(): Material;
  24726. /**
  24727. * Instantiate a new shadow depth wrapper.
  24728. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24729. * generate the shadow depth map. For more information, please refer to the documentation:
  24730. * https://doc.babylonjs.com/babylon101/shadows
  24731. * @param baseMaterial Material to wrap
  24732. * @param scene Define the scene the material belongs to
  24733. * @param options Options used to create the wrapper
  24734. */
  24735. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24736. /**
  24737. * Gets the effect to use to generate the depth map
  24738. * @param subMesh subMesh to get the effect for
  24739. * @param shadowGenerator shadow generator to get the effect for
  24740. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24741. */
  24742. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24743. /**
  24744. * Specifies that the submesh is ready to be used for depth rendering
  24745. * @param subMesh submesh to check
  24746. * @param defines the list of defines to take into account when checking the effect
  24747. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24748. * @param useInstances specifies that instances should be used
  24749. * @returns a boolean indicating that the submesh is ready or not
  24750. */
  24751. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24752. /**
  24753. * Disposes the resources
  24754. */
  24755. dispose(): void;
  24756. private _makeEffect;
  24757. }
  24758. }
  24759. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  24760. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24761. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  24762. import { Nullable } from "babylonjs/types";
  24763. module "babylonjs/Engines/thinEngine" {
  24764. interface ThinEngine {
  24765. /**
  24766. * Unbind a list of render target textures from the webGL context
  24767. * This is used only when drawBuffer extension or webGL2 are active
  24768. * @param textures defines the render target textures to unbind
  24769. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  24770. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  24771. */
  24772. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  24773. /**
  24774. * Create a multi render target texture
  24775. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  24776. * @param size defines the size of the texture
  24777. * @param options defines the creation options
  24778. * @returns the cube texture as an InternalTexture
  24779. */
  24780. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  24781. /**
  24782. * Update the sample count for a given multiple render target texture
  24783. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  24784. * @param textures defines the textures to update
  24785. * @param samples defines the sample count to set
  24786. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  24787. */
  24788. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  24789. /**
  24790. * Select a subsets of attachments to draw to.
  24791. * @param attachments gl attachments
  24792. */
  24793. bindAttachments(attachments: number[]): void;
  24794. }
  24795. }
  24796. }
  24797. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  24798. import { Scene } from "babylonjs/scene";
  24799. import { Engine } from "babylonjs/Engines/engine";
  24800. import { Texture } from "babylonjs/Materials/Textures/texture";
  24801. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24802. import "babylonjs/Engines/Extensions/engine.multiRender";
  24803. /**
  24804. * Creation options of the multi render target texture.
  24805. */
  24806. export interface IMultiRenderTargetOptions {
  24807. /**
  24808. * Define if the texture needs to create mip maps after render.
  24809. */
  24810. generateMipMaps?: boolean;
  24811. /**
  24812. * Define the types of all the draw buffers we want to create
  24813. */
  24814. types?: number[];
  24815. /**
  24816. * Define the sampling modes of all the draw buffers we want to create
  24817. */
  24818. samplingModes?: number[];
  24819. /**
  24820. * Define if a depth buffer is required
  24821. */
  24822. generateDepthBuffer?: boolean;
  24823. /**
  24824. * Define if a stencil buffer is required
  24825. */
  24826. generateStencilBuffer?: boolean;
  24827. /**
  24828. * Define if a depth texture is required instead of a depth buffer
  24829. */
  24830. generateDepthTexture?: boolean;
  24831. /**
  24832. * Define the number of desired draw buffers
  24833. */
  24834. textureCount?: number;
  24835. /**
  24836. * Define if aspect ratio should be adapted to the texture or stay the scene one
  24837. */
  24838. doNotChangeAspectRatio?: boolean;
  24839. /**
  24840. * Define the default type of the buffers we are creating
  24841. */
  24842. defaultType?: number;
  24843. }
  24844. /**
  24845. * A multi render target, like a render target provides the ability to render to a texture.
  24846. * Unlike the render target, it can render to several draw buffers in one draw.
  24847. * This is specially interesting in deferred rendering or for any effects requiring more than
  24848. * just one color from a single pass.
  24849. */
  24850. export class MultiRenderTarget extends RenderTargetTexture {
  24851. private _internalTextures;
  24852. private _textures;
  24853. private _multiRenderTargetOptions;
  24854. private _count;
  24855. /**
  24856. * Get if draw buffers are currently supported by the used hardware and browser.
  24857. */
  24858. get isSupported(): boolean;
  24859. /**
  24860. * Get the list of textures generated by the multi render target.
  24861. */
  24862. get textures(): Texture[];
  24863. /**
  24864. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  24865. */
  24866. get count(): number;
  24867. /**
  24868. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  24869. */
  24870. get depthTexture(): Texture;
  24871. /**
  24872. * Set the wrapping mode on U of all the textures we are rendering to.
  24873. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24874. */
  24875. set wrapU(wrap: number);
  24876. /**
  24877. * Set the wrapping mode on V of all the textures we are rendering to.
  24878. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24879. */
  24880. set wrapV(wrap: number);
  24881. /**
  24882. * Instantiate a new multi render target texture.
  24883. * A multi render target, like a render target provides the ability to render to a texture.
  24884. * Unlike the render target, it can render to several draw buffers in one draw.
  24885. * This is specially interesting in deferred rendering or for any effects requiring more than
  24886. * just one color from a single pass.
  24887. * @param name Define the name of the texture
  24888. * @param size Define the size of the buffers to render to
  24889. * @param count Define the number of target we are rendering into
  24890. * @param scene Define the scene the texture belongs to
  24891. * @param options Define the options used to create the multi render target
  24892. */
  24893. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  24894. /** @hidden */
  24895. _rebuild(): void;
  24896. private _createInternalTextures;
  24897. private _createTextures;
  24898. /**
  24899. * Define the number of samples used if MSAA is enabled.
  24900. */
  24901. get samples(): number;
  24902. set samples(value: number);
  24903. /**
  24904. * Resize all the textures in the multi render target.
  24905. * Be carrefull as it will recreate all the data in the new texture.
  24906. * @param size Define the new size
  24907. */
  24908. resize(size: any): void;
  24909. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24910. /**
  24911. * Dispose the render targets and their associated resources
  24912. */
  24913. dispose(): void;
  24914. /**
  24915. * Release all the underlying texture used as draw buffers.
  24916. */
  24917. releaseInternalTextures(): void;
  24918. }
  24919. }
  24920. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  24921. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  24922. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24923. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  24924. /** @hidden */
  24925. export var imageProcessingPixelShader: {
  24926. name: string;
  24927. shader: string;
  24928. };
  24929. }
  24930. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  24931. import { Nullable } from "babylonjs/types";
  24932. import { Color4 } from "babylonjs/Maths/math.color";
  24933. import { Camera } from "babylonjs/Cameras/camera";
  24934. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24935. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  24936. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  24937. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  24938. import { Engine } from "babylonjs/Engines/engine";
  24939. import "babylonjs/Shaders/imageProcessing.fragment";
  24940. import "babylonjs/Shaders/postprocess.vertex";
  24941. /**
  24942. * ImageProcessingPostProcess
  24943. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  24944. */
  24945. export class ImageProcessingPostProcess extends PostProcess {
  24946. /**
  24947. * Default configuration related to image processing available in the PBR Material.
  24948. */
  24949. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  24950. /**
  24951. * Gets the image processing configuration used either in this material.
  24952. */
  24953. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  24954. /**
  24955. * Sets the Default image processing configuration used either in the this material.
  24956. *
  24957. * If sets to null, the scene one is in use.
  24958. */
  24959. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  24960. /**
  24961. * Keep track of the image processing observer to allow dispose and replace.
  24962. */
  24963. private _imageProcessingObserver;
  24964. /**
  24965. * Attaches a new image processing configuration to the PBR Material.
  24966. * @param configuration
  24967. */
  24968. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  24969. /**
  24970. * If the post process is supported.
  24971. */
  24972. get isSupported(): boolean;
  24973. /**
  24974. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24975. */
  24976. get colorCurves(): Nullable<ColorCurves>;
  24977. /**
  24978. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24979. */
  24980. set colorCurves(value: Nullable<ColorCurves>);
  24981. /**
  24982. * Gets wether the color curves effect is enabled.
  24983. */
  24984. get colorCurvesEnabled(): boolean;
  24985. /**
  24986. * Sets wether the color curves effect is enabled.
  24987. */
  24988. set colorCurvesEnabled(value: boolean);
  24989. /**
  24990. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24991. */
  24992. get colorGradingTexture(): Nullable<BaseTexture>;
  24993. /**
  24994. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24995. */
  24996. set colorGradingTexture(value: Nullable<BaseTexture>);
  24997. /**
  24998. * Gets wether the color grading effect is enabled.
  24999. */
  25000. get colorGradingEnabled(): boolean;
  25001. /**
  25002. * Gets wether the color grading effect is enabled.
  25003. */
  25004. set colorGradingEnabled(value: boolean);
  25005. /**
  25006. * Gets exposure used in the effect.
  25007. */
  25008. get exposure(): number;
  25009. /**
  25010. * Sets exposure used in the effect.
  25011. */
  25012. set exposure(value: number);
  25013. /**
  25014. * Gets wether tonemapping is enabled or not.
  25015. */
  25016. get toneMappingEnabled(): boolean;
  25017. /**
  25018. * Sets wether tonemapping is enabled or not
  25019. */
  25020. set toneMappingEnabled(value: boolean);
  25021. /**
  25022. * Gets the type of tone mapping effect.
  25023. */
  25024. get toneMappingType(): number;
  25025. /**
  25026. * Sets the type of tone mapping effect.
  25027. */
  25028. set toneMappingType(value: number);
  25029. /**
  25030. * Gets contrast used in the effect.
  25031. */
  25032. get contrast(): number;
  25033. /**
  25034. * Sets contrast used in the effect.
  25035. */
  25036. set contrast(value: number);
  25037. /**
  25038. * Gets Vignette stretch size.
  25039. */
  25040. get vignetteStretch(): number;
  25041. /**
  25042. * Sets Vignette stretch size.
  25043. */
  25044. set vignetteStretch(value: number);
  25045. /**
  25046. * Gets Vignette centre X Offset.
  25047. */
  25048. get vignetteCentreX(): number;
  25049. /**
  25050. * Sets Vignette centre X Offset.
  25051. */
  25052. set vignetteCentreX(value: number);
  25053. /**
  25054. * Gets Vignette centre Y Offset.
  25055. */
  25056. get vignetteCentreY(): number;
  25057. /**
  25058. * Sets Vignette centre Y Offset.
  25059. */
  25060. set vignetteCentreY(value: number);
  25061. /**
  25062. * Gets Vignette weight or intensity of the vignette effect.
  25063. */
  25064. get vignetteWeight(): number;
  25065. /**
  25066. * Sets Vignette weight or intensity of the vignette effect.
  25067. */
  25068. set vignetteWeight(value: number);
  25069. /**
  25070. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25071. * if vignetteEnabled is set to true.
  25072. */
  25073. get vignetteColor(): Color4;
  25074. /**
  25075. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25076. * if vignetteEnabled is set to true.
  25077. */
  25078. set vignetteColor(value: Color4);
  25079. /**
  25080. * Gets Camera field of view used by the Vignette effect.
  25081. */
  25082. get vignetteCameraFov(): number;
  25083. /**
  25084. * Sets Camera field of view used by the Vignette effect.
  25085. */
  25086. set vignetteCameraFov(value: number);
  25087. /**
  25088. * Gets the vignette blend mode allowing different kind of effect.
  25089. */
  25090. get vignetteBlendMode(): number;
  25091. /**
  25092. * Sets the vignette blend mode allowing different kind of effect.
  25093. */
  25094. set vignetteBlendMode(value: number);
  25095. /**
  25096. * Gets wether the vignette effect is enabled.
  25097. */
  25098. get vignetteEnabled(): boolean;
  25099. /**
  25100. * Sets wether the vignette effect is enabled.
  25101. */
  25102. set vignetteEnabled(value: boolean);
  25103. private _fromLinearSpace;
  25104. /**
  25105. * Gets wether the input of the processing is in Gamma or Linear Space.
  25106. */
  25107. get fromLinearSpace(): boolean;
  25108. /**
  25109. * Sets wether the input of the processing is in Gamma or Linear Space.
  25110. */
  25111. set fromLinearSpace(value: boolean);
  25112. /**
  25113. * Defines cache preventing GC.
  25114. */
  25115. private _defines;
  25116. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  25117. /**
  25118. * "ImageProcessingPostProcess"
  25119. * @returns "ImageProcessingPostProcess"
  25120. */
  25121. getClassName(): string;
  25122. /**
  25123. * @hidden
  25124. */
  25125. _updateParameters(): void;
  25126. dispose(camera?: Camera): void;
  25127. }
  25128. }
  25129. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  25130. /** @hidden */
  25131. export var fibonacci: {
  25132. name: string;
  25133. shader: string;
  25134. };
  25135. }
  25136. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  25137. /** @hidden */
  25138. export var subSurfaceScatteringFunctions: {
  25139. name: string;
  25140. shader: string;
  25141. };
  25142. }
  25143. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  25144. /** @hidden */
  25145. export var diffusionProfile: {
  25146. name: string;
  25147. shader: string;
  25148. };
  25149. }
  25150. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  25151. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  25152. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  25153. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  25154. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  25155. /** @hidden */
  25156. export var subSurfaceScatteringPixelShader: {
  25157. name: string;
  25158. shader: string;
  25159. };
  25160. }
  25161. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  25162. import { Nullable } from "babylonjs/types";
  25163. import { Camera } from "babylonjs/Cameras/camera";
  25164. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  25165. import { Engine } from "babylonjs/Engines/engine";
  25166. import { Scene } from "babylonjs/scene";
  25167. import "babylonjs/Shaders/imageProcessing.fragment";
  25168. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  25169. import "babylonjs/Shaders/postprocess.vertex";
  25170. /**
  25171. * Sub surface scattering post process
  25172. */
  25173. export class SubSurfaceScatteringPostProcess extends PostProcess {
  25174. /**
  25175. * Gets a string identifying the name of the class
  25176. * @returns "SubSurfaceScatteringPostProcess" string
  25177. */
  25178. getClassName(): string;
  25179. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  25180. }
  25181. }
  25182. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  25183. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25184. /**
  25185. * Interface for defining prepass effects in the prepass post-process pipeline
  25186. */
  25187. export interface PrePassEffectConfiguration {
  25188. /**
  25189. * Post process to attach for this effect
  25190. */
  25191. postProcess: PostProcess;
  25192. /**
  25193. * Is the effect enabled
  25194. */
  25195. enabled: boolean;
  25196. /**
  25197. * Disposes the effect configuration
  25198. */
  25199. dispose(): void;
  25200. /**
  25201. * Disposes the effect configuration
  25202. */
  25203. createPostProcess: () => PostProcess;
  25204. }
  25205. }
  25206. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  25207. import { Scene } from "babylonjs/scene";
  25208. import { Color3 } from "babylonjs/Maths/math.color";
  25209. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  25210. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  25211. /**
  25212. * Contains all parameters needed for the prepass to perform
  25213. * screen space subsurface scattering
  25214. */
  25215. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  25216. private _ssDiffusionS;
  25217. private _ssFilterRadii;
  25218. private _ssDiffusionD;
  25219. /**
  25220. * Post process to attach for screen space subsurface scattering
  25221. */
  25222. postProcess: SubSurfaceScatteringPostProcess;
  25223. /**
  25224. * Diffusion profile color for subsurface scattering
  25225. */
  25226. get ssDiffusionS(): number[];
  25227. /**
  25228. * Diffusion profile max color channel value for subsurface scattering
  25229. */
  25230. get ssDiffusionD(): number[];
  25231. /**
  25232. * Diffusion profile filter radius for subsurface scattering
  25233. */
  25234. get ssFilterRadii(): number[];
  25235. /**
  25236. * Is subsurface enabled
  25237. */
  25238. enabled: boolean;
  25239. /**
  25240. * Diffusion profile colors for subsurface scattering
  25241. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  25242. * See ...
  25243. * Note that you can only store up to 5 of them
  25244. */
  25245. ssDiffusionProfileColors: Color3[];
  25246. /**
  25247. * Defines the ratio real world => scene units.
  25248. * Used for subsurface scattering
  25249. */
  25250. metersPerUnit: number;
  25251. private _scene;
  25252. /**
  25253. * Builds a subsurface configuration object
  25254. * @param scene The scene
  25255. */
  25256. constructor(scene: Scene);
  25257. /**
  25258. * Adds a new diffusion profile.
  25259. * Useful for more realistic subsurface scattering on diverse materials.
  25260. * @param color The color of the diffusion profile. Should be the average color of the material.
  25261. * @return The index of the diffusion profile for the material subsurface configuration
  25262. */
  25263. addDiffusionProfile(color: Color3): number;
  25264. /**
  25265. * Creates the sss post process
  25266. * @return The created post process
  25267. */
  25268. createPostProcess(): SubSurfaceScatteringPostProcess;
  25269. /**
  25270. * Deletes all diffusion profiles.
  25271. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  25272. */
  25273. clearAllDiffusionProfiles(): void;
  25274. /**
  25275. * Disposes this object
  25276. */
  25277. dispose(): void;
  25278. /**
  25279. * @hidden
  25280. * https://zero-radiance.github.io/post/sampling-diffusion/
  25281. *
  25282. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  25283. * ------------------------------------------------------------------------------------
  25284. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  25285. * PDF[r, phi, s] = r * R[r, phi, s]
  25286. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  25287. * ------------------------------------------------------------------------------------
  25288. * We importance sample the color channel with the widest scattering distance.
  25289. */
  25290. getDiffusionProfileParameters(color: Color3): number;
  25291. /**
  25292. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  25293. * 'u' is the random number (the value of the CDF): [0, 1).
  25294. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  25295. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  25296. */
  25297. private _sampleBurleyDiffusionProfile;
  25298. }
  25299. }
  25300. declare module "babylonjs/Rendering/prePassRenderer" {
  25301. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  25302. import { Scene } from "babylonjs/scene";
  25303. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  25304. import { Effect } from "babylonjs/Materials/effect";
  25305. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  25306. /**
  25307. * Renders a pre pass of the scene
  25308. * This means every mesh in the scene will be rendered to a render target texture
  25309. * And then this texture will be composited to the rendering canvas with post processes
  25310. * It is necessary for effects like subsurface scattering or deferred shading
  25311. */
  25312. export class PrePassRenderer {
  25313. /** @hidden */
  25314. static _SceneComponentInitialization: (scene: Scene) => void;
  25315. private _scene;
  25316. private _engine;
  25317. private _isDirty;
  25318. /**
  25319. * Number of textures in the multi render target texture where the scene is directly rendered
  25320. */
  25321. readonly mrtCount: number;
  25322. /**
  25323. * The render target where the scene is directly rendered
  25324. */
  25325. prePassRT: MultiRenderTarget;
  25326. private _mrtTypes;
  25327. private _multiRenderAttachments;
  25328. private _defaultAttachments;
  25329. private _clearAttachments;
  25330. private _postProcesses;
  25331. private readonly _clearColor;
  25332. /**
  25333. * Image processing post process for composition
  25334. */
  25335. imageProcessingPostProcess: ImageProcessingPostProcess;
  25336. /**
  25337. * Configuration for sub surface scattering post process
  25338. */
  25339. subSurfaceConfiguration: SubSurfaceConfiguration;
  25340. /**
  25341. * Should materials render their geometry on the MRT
  25342. */
  25343. materialsShouldRenderGeometry: boolean;
  25344. /**
  25345. * Should materials render the irradiance information on the MRT
  25346. */
  25347. materialsShouldRenderIrradiance: boolean;
  25348. private _enabled;
  25349. /**
  25350. * Indicates if the prepass is enabled
  25351. */
  25352. get enabled(): boolean;
  25353. /**
  25354. * How many samples are used for MSAA of the scene render target
  25355. */
  25356. get samples(): number;
  25357. set samples(n: number);
  25358. /**
  25359. * Instanciates a prepass renderer
  25360. * @param scene The scene
  25361. */
  25362. constructor(scene: Scene);
  25363. private _initializeAttachments;
  25364. private _createCompositionEffect;
  25365. /**
  25366. * Indicates if rendering a prepass is supported
  25367. */
  25368. get isSupported(): boolean;
  25369. /**
  25370. * Sets the proper output textures to draw in the engine.
  25371. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  25372. */
  25373. bindAttachmentsForEffect(effect: Effect): void;
  25374. /**
  25375. * @hidden
  25376. */
  25377. _beforeCameraDraw(): void;
  25378. /**
  25379. * @hidden
  25380. */
  25381. _afterCameraDraw(): void;
  25382. private _checkRTSize;
  25383. private _bindFrameBuffer;
  25384. /**
  25385. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  25386. */
  25387. clear(): void;
  25388. private _setState;
  25389. private _enable;
  25390. private _disable;
  25391. private _resetPostProcessChain;
  25392. private _bindPostProcessChain;
  25393. /**
  25394. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  25395. */
  25396. markAsDirty(): void;
  25397. private _update;
  25398. /**
  25399. * Disposes the prepass renderer.
  25400. */
  25401. dispose(): void;
  25402. }
  25403. }
  25404. declare module "babylonjs/Materials/material" {
  25405. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25406. import { SmartArray } from "babylonjs/Misc/smartArray";
  25407. import { Observable } from "babylonjs/Misc/observable";
  25408. import { Nullable } from "babylonjs/types";
  25409. import { Scene } from "babylonjs/scene";
  25410. import { Matrix } from "babylonjs/Maths/math.vector";
  25411. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25412. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25413. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25414. import { Effect } from "babylonjs/Materials/effect";
  25415. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25416. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25417. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25418. import { IInspectable } from "babylonjs/Misc/iInspectable";
  25419. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  25420. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  25421. import { Mesh } from "babylonjs/Meshes/mesh";
  25422. import { Animation } from "babylonjs/Animations/animation";
  25423. /**
  25424. * Options for compiling materials.
  25425. */
  25426. export interface IMaterialCompilationOptions {
  25427. /**
  25428. * Defines whether clip planes are enabled.
  25429. */
  25430. clipPlane: boolean;
  25431. /**
  25432. * Defines whether instances are enabled.
  25433. */
  25434. useInstances: boolean;
  25435. }
  25436. /**
  25437. * Options passed when calling customShaderNameResolve
  25438. */
  25439. export interface ICustomShaderNameResolveOptions {
  25440. /**
  25441. * 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
  25442. */
  25443. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  25444. }
  25445. /**
  25446. * Base class for the main features of a material in Babylon.js
  25447. */
  25448. export class Material implements IAnimatable {
  25449. /**
  25450. * Returns the triangle fill mode
  25451. */
  25452. static readonly TriangleFillMode: number;
  25453. /**
  25454. * Returns the wireframe mode
  25455. */
  25456. static readonly WireFrameFillMode: number;
  25457. /**
  25458. * Returns the point fill mode
  25459. */
  25460. static readonly PointFillMode: number;
  25461. /**
  25462. * Returns the point list draw mode
  25463. */
  25464. static readonly PointListDrawMode: number;
  25465. /**
  25466. * Returns the line list draw mode
  25467. */
  25468. static readonly LineListDrawMode: number;
  25469. /**
  25470. * Returns the line loop draw mode
  25471. */
  25472. static readonly LineLoopDrawMode: number;
  25473. /**
  25474. * Returns the line strip draw mode
  25475. */
  25476. static readonly LineStripDrawMode: number;
  25477. /**
  25478. * Returns the triangle strip draw mode
  25479. */
  25480. static readonly TriangleStripDrawMode: number;
  25481. /**
  25482. * Returns the triangle fan draw mode
  25483. */
  25484. static readonly TriangleFanDrawMode: number;
  25485. /**
  25486. * Stores the clock-wise side orientation
  25487. */
  25488. static readonly ClockWiseSideOrientation: number;
  25489. /**
  25490. * Stores the counter clock-wise side orientation
  25491. */
  25492. static readonly CounterClockWiseSideOrientation: number;
  25493. /**
  25494. * The dirty texture flag value
  25495. */
  25496. static readonly TextureDirtyFlag: number;
  25497. /**
  25498. * The dirty light flag value
  25499. */
  25500. static readonly LightDirtyFlag: number;
  25501. /**
  25502. * The dirty fresnel flag value
  25503. */
  25504. static readonly FresnelDirtyFlag: number;
  25505. /**
  25506. * The dirty attribute flag value
  25507. */
  25508. static readonly AttributesDirtyFlag: number;
  25509. /**
  25510. * The dirty misc flag value
  25511. */
  25512. static readonly MiscDirtyFlag: number;
  25513. /**
  25514. * The all dirty flag value
  25515. */
  25516. static readonly AllDirtyFlag: number;
  25517. /**
  25518. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  25519. */
  25520. static readonly MATERIAL_OPAQUE: number;
  25521. /**
  25522. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  25523. */
  25524. static readonly MATERIAL_ALPHATEST: number;
  25525. /**
  25526. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25527. */
  25528. static readonly MATERIAL_ALPHABLEND: number;
  25529. /**
  25530. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25531. * They are also discarded below the alpha cutoff threshold to improve performances.
  25532. */
  25533. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  25534. /**
  25535. * The Whiteout method is used to blend normals.
  25536. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25537. */
  25538. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  25539. /**
  25540. * The Reoriented Normal Mapping method is used to blend normals.
  25541. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25542. */
  25543. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  25544. /**
  25545. * Custom callback helping to override the default shader used in the material.
  25546. */
  25547. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  25548. /**
  25549. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  25550. */
  25551. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  25552. /**
  25553. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  25554. * This means that the material can keep using a previous shader while a new one is being compiled.
  25555. * This is mostly used when shader parallel compilation is supported (true by default)
  25556. */
  25557. allowShaderHotSwapping: boolean;
  25558. /**
  25559. * The ID of the material
  25560. */
  25561. id: string;
  25562. /**
  25563. * Gets or sets the unique id of the material
  25564. */
  25565. uniqueId: number;
  25566. /**
  25567. * The name of the material
  25568. */
  25569. name: string;
  25570. /**
  25571. * Gets or sets user defined metadata
  25572. */
  25573. metadata: any;
  25574. /**
  25575. * For internal use only. Please do not use.
  25576. */
  25577. reservedDataStore: any;
  25578. /**
  25579. * Specifies if the ready state should be checked on each call
  25580. */
  25581. checkReadyOnEveryCall: boolean;
  25582. /**
  25583. * Specifies if the ready state should be checked once
  25584. */
  25585. checkReadyOnlyOnce: boolean;
  25586. /**
  25587. * The state of the material
  25588. */
  25589. state: string;
  25590. /**
  25591. * If the material can be rendered to several textures with MRT extension
  25592. */
  25593. get canRenderToMRT(): boolean;
  25594. /**
  25595. * The alpha value of the material
  25596. */
  25597. protected _alpha: number;
  25598. /**
  25599. * List of inspectable custom properties (used by the Inspector)
  25600. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25601. */
  25602. inspectableCustomProperties: IInspectable[];
  25603. /**
  25604. * Sets the alpha value of the material
  25605. */
  25606. set alpha(value: number);
  25607. /**
  25608. * Gets the alpha value of the material
  25609. */
  25610. get alpha(): number;
  25611. /**
  25612. * Specifies if back face culling is enabled
  25613. */
  25614. protected _backFaceCulling: boolean;
  25615. /**
  25616. * Sets the back-face culling state
  25617. */
  25618. set backFaceCulling(value: boolean);
  25619. /**
  25620. * Gets the back-face culling state
  25621. */
  25622. get backFaceCulling(): boolean;
  25623. /**
  25624. * Stores the value for side orientation
  25625. */
  25626. sideOrientation: number;
  25627. /**
  25628. * Callback triggered when the material is compiled
  25629. */
  25630. onCompiled: Nullable<(effect: Effect) => void>;
  25631. /**
  25632. * Callback triggered when an error occurs
  25633. */
  25634. onError: Nullable<(effect: Effect, errors: string) => void>;
  25635. /**
  25636. * Callback triggered to get the render target textures
  25637. */
  25638. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  25639. /**
  25640. * Gets a boolean indicating that current material needs to register RTT
  25641. */
  25642. get hasRenderTargetTextures(): boolean;
  25643. /**
  25644. * Specifies if the material should be serialized
  25645. */
  25646. doNotSerialize: boolean;
  25647. /**
  25648. * @hidden
  25649. */
  25650. _storeEffectOnSubMeshes: boolean;
  25651. /**
  25652. * Stores the animations for the material
  25653. */
  25654. animations: Nullable<Array<Animation>>;
  25655. /**
  25656. * An event triggered when the material is disposed
  25657. */
  25658. onDisposeObservable: Observable<Material>;
  25659. /**
  25660. * An observer which watches for dispose events
  25661. */
  25662. private _onDisposeObserver;
  25663. private _onUnBindObservable;
  25664. /**
  25665. * Called during a dispose event
  25666. */
  25667. set onDispose(callback: () => void);
  25668. private _onBindObservable;
  25669. /**
  25670. * An event triggered when the material is bound
  25671. */
  25672. get onBindObservable(): Observable<AbstractMesh>;
  25673. /**
  25674. * An observer which watches for bind events
  25675. */
  25676. private _onBindObserver;
  25677. /**
  25678. * Called during a bind event
  25679. */
  25680. set onBind(callback: (Mesh: AbstractMesh) => void);
  25681. /**
  25682. * An event triggered when the material is unbound
  25683. */
  25684. get onUnBindObservable(): Observable<Material>;
  25685. protected _onEffectCreatedObservable: Nullable<Observable<{
  25686. effect: Effect;
  25687. subMesh: Nullable<SubMesh>;
  25688. }>>;
  25689. /**
  25690. * An event triggered when the effect is (re)created
  25691. */
  25692. get onEffectCreatedObservable(): Observable<{
  25693. effect: Effect;
  25694. subMesh: Nullable<SubMesh>;
  25695. }>;
  25696. /**
  25697. * Stores the value of the alpha mode
  25698. */
  25699. private _alphaMode;
  25700. /**
  25701. * Sets the value of the alpha mode.
  25702. *
  25703. * | Value | Type | Description |
  25704. * | --- | --- | --- |
  25705. * | 0 | ALPHA_DISABLE | |
  25706. * | 1 | ALPHA_ADD | |
  25707. * | 2 | ALPHA_COMBINE | |
  25708. * | 3 | ALPHA_SUBTRACT | |
  25709. * | 4 | ALPHA_MULTIPLY | |
  25710. * | 5 | ALPHA_MAXIMIZED | |
  25711. * | 6 | ALPHA_ONEONE | |
  25712. * | 7 | ALPHA_PREMULTIPLIED | |
  25713. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  25714. * | 9 | ALPHA_INTERPOLATE | |
  25715. * | 10 | ALPHA_SCREENMODE | |
  25716. *
  25717. */
  25718. set alphaMode(value: number);
  25719. /**
  25720. * Gets the value of the alpha mode
  25721. */
  25722. get alphaMode(): number;
  25723. /**
  25724. * Stores the state of the need depth pre-pass value
  25725. */
  25726. private _needDepthPrePass;
  25727. /**
  25728. * Sets the need depth pre-pass value
  25729. */
  25730. set needDepthPrePass(value: boolean);
  25731. /**
  25732. * Gets the depth pre-pass value
  25733. */
  25734. get needDepthPrePass(): boolean;
  25735. /**
  25736. * Specifies if depth writing should be disabled
  25737. */
  25738. disableDepthWrite: boolean;
  25739. /**
  25740. * Specifies if color writing should be disabled
  25741. */
  25742. disableColorWrite: boolean;
  25743. /**
  25744. * Specifies if depth writing should be forced
  25745. */
  25746. forceDepthWrite: boolean;
  25747. /**
  25748. * Specifies the depth function that should be used. 0 means the default engine function
  25749. */
  25750. depthFunction: number;
  25751. /**
  25752. * Specifies if there should be a separate pass for culling
  25753. */
  25754. separateCullingPass: boolean;
  25755. /**
  25756. * Stores the state specifing if fog should be enabled
  25757. */
  25758. private _fogEnabled;
  25759. /**
  25760. * Sets the state for enabling fog
  25761. */
  25762. set fogEnabled(value: boolean);
  25763. /**
  25764. * Gets the value of the fog enabled state
  25765. */
  25766. get fogEnabled(): boolean;
  25767. /**
  25768. * Stores the size of points
  25769. */
  25770. pointSize: number;
  25771. /**
  25772. * Stores the z offset value
  25773. */
  25774. zOffset: number;
  25775. get wireframe(): boolean;
  25776. /**
  25777. * Sets the state of wireframe mode
  25778. */
  25779. set wireframe(value: boolean);
  25780. /**
  25781. * Gets the value specifying if point clouds are enabled
  25782. */
  25783. get pointsCloud(): boolean;
  25784. /**
  25785. * Sets the state of point cloud mode
  25786. */
  25787. set pointsCloud(value: boolean);
  25788. /**
  25789. * Gets the material fill mode
  25790. */
  25791. get fillMode(): number;
  25792. /**
  25793. * Sets the material fill mode
  25794. */
  25795. set fillMode(value: number);
  25796. /**
  25797. * @hidden
  25798. * Stores the effects for the material
  25799. */
  25800. _effect: Nullable<Effect>;
  25801. /**
  25802. * Specifies if uniform buffers should be used
  25803. */
  25804. private _useUBO;
  25805. /**
  25806. * Stores a reference to the scene
  25807. */
  25808. private _scene;
  25809. /**
  25810. * Stores the fill mode state
  25811. */
  25812. private _fillMode;
  25813. /**
  25814. * Specifies if the depth write state should be cached
  25815. */
  25816. private _cachedDepthWriteState;
  25817. /**
  25818. * Specifies if the color write state should be cached
  25819. */
  25820. private _cachedColorWriteState;
  25821. /**
  25822. * Specifies if the depth function state should be cached
  25823. */
  25824. private _cachedDepthFunctionState;
  25825. /**
  25826. * Stores the uniform buffer
  25827. */
  25828. protected _uniformBuffer: UniformBuffer;
  25829. /** @hidden */
  25830. _indexInSceneMaterialArray: number;
  25831. /** @hidden */
  25832. meshMap: Nullable<{
  25833. [id: string]: AbstractMesh | undefined;
  25834. }>;
  25835. /**
  25836. * Creates a material instance
  25837. * @param name defines the name of the material
  25838. * @param scene defines the scene to reference
  25839. * @param doNotAdd specifies if the material should be added to the scene
  25840. */
  25841. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  25842. /**
  25843. * Returns a string representation of the current material
  25844. * @param fullDetails defines a boolean indicating which levels of logging is desired
  25845. * @returns a string with material information
  25846. */
  25847. toString(fullDetails?: boolean): string;
  25848. /**
  25849. * Gets the class name of the material
  25850. * @returns a string with the class name of the material
  25851. */
  25852. getClassName(): string;
  25853. /**
  25854. * Specifies if updates for the material been locked
  25855. */
  25856. get isFrozen(): boolean;
  25857. /**
  25858. * Locks updates for the material
  25859. */
  25860. freeze(): void;
  25861. /**
  25862. * Unlocks updates for the material
  25863. */
  25864. unfreeze(): void;
  25865. /**
  25866. * Specifies if the material is ready to be used
  25867. * @param mesh defines the mesh to check
  25868. * @param useInstances specifies if instances should be used
  25869. * @returns a boolean indicating if the material is ready to be used
  25870. */
  25871. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  25872. /**
  25873. * Specifies that the submesh is ready to be used
  25874. * @param mesh defines the mesh to check
  25875. * @param subMesh defines which submesh to check
  25876. * @param useInstances specifies that instances should be used
  25877. * @returns a boolean indicating that the submesh is ready or not
  25878. */
  25879. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25880. /**
  25881. * Returns the material effect
  25882. * @returns the effect associated with the material
  25883. */
  25884. getEffect(): Nullable<Effect>;
  25885. /**
  25886. * Returns the current scene
  25887. * @returns a Scene
  25888. */
  25889. getScene(): Scene;
  25890. /**
  25891. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  25892. */
  25893. protected _forceAlphaTest: boolean;
  25894. /**
  25895. * The transparency mode of the material.
  25896. */
  25897. protected _transparencyMode: Nullable<number>;
  25898. /**
  25899. * Gets the current transparency mode.
  25900. */
  25901. get transparencyMode(): Nullable<number>;
  25902. /**
  25903. * Sets the transparency mode of the material.
  25904. *
  25905. * | Value | Type | Description |
  25906. * | ----- | ----------------------------------- | ----------- |
  25907. * | 0 | OPAQUE | |
  25908. * | 1 | ALPHATEST | |
  25909. * | 2 | ALPHABLEND | |
  25910. * | 3 | ALPHATESTANDBLEND | |
  25911. *
  25912. */
  25913. set transparencyMode(value: Nullable<number>);
  25914. /**
  25915. * Returns true if alpha blending should be disabled.
  25916. */
  25917. protected get _disableAlphaBlending(): boolean;
  25918. /**
  25919. * Specifies whether or not this material should be rendered in alpha blend mode.
  25920. * @returns a boolean specifying if alpha blending is needed
  25921. */
  25922. needAlphaBlending(): boolean;
  25923. /**
  25924. * Specifies if the mesh will require alpha blending
  25925. * @param mesh defines the mesh to check
  25926. * @returns a boolean specifying if alpha blending is needed for the mesh
  25927. */
  25928. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  25929. /**
  25930. * Specifies whether or not this material should be rendered in alpha test mode.
  25931. * @returns a boolean specifying if an alpha test is needed.
  25932. */
  25933. needAlphaTesting(): boolean;
  25934. /**
  25935. * Specifies if material alpha testing should be turned on for the mesh
  25936. * @param mesh defines the mesh to check
  25937. */
  25938. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  25939. /**
  25940. * Gets the texture used for the alpha test
  25941. * @returns the texture to use for alpha testing
  25942. */
  25943. getAlphaTestTexture(): Nullable<BaseTexture>;
  25944. /**
  25945. * Marks the material to indicate that it needs to be re-calculated
  25946. */
  25947. markDirty(): void;
  25948. /** @hidden */
  25949. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  25950. /**
  25951. * Binds the material to the mesh
  25952. * @param world defines the world transformation matrix
  25953. * @param mesh defines the mesh to bind the material to
  25954. */
  25955. bind(world: Matrix, mesh?: Mesh): void;
  25956. /**
  25957. * Binds the submesh to the material
  25958. * @param world defines the world transformation matrix
  25959. * @param mesh defines the mesh containing the submesh
  25960. * @param subMesh defines the submesh to bind the material to
  25961. */
  25962. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  25963. /**
  25964. * Binds the world matrix to the material
  25965. * @param world defines the world transformation matrix
  25966. */
  25967. bindOnlyWorldMatrix(world: Matrix): void;
  25968. /**
  25969. * Binds the scene's uniform buffer to the effect.
  25970. * @param effect defines the effect to bind to the scene uniform buffer
  25971. * @param sceneUbo defines the uniform buffer storing scene data
  25972. */
  25973. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  25974. /**
  25975. * Binds the view matrix to the effect
  25976. * @param effect defines the effect to bind the view matrix to
  25977. */
  25978. bindView(effect: Effect): void;
  25979. /**
  25980. * Binds the view projection matrix to the effect
  25981. * @param effect defines the effect to bind the view projection matrix to
  25982. */
  25983. bindViewProjection(effect: Effect): void;
  25984. /**
  25985. * Processes to execute after binding the material to a mesh
  25986. * @param mesh defines the rendered mesh
  25987. */
  25988. protected _afterBind(mesh?: Mesh): void;
  25989. /**
  25990. * Unbinds the material from the mesh
  25991. */
  25992. unbind(): void;
  25993. /**
  25994. * Gets the active textures from the material
  25995. * @returns an array of textures
  25996. */
  25997. getActiveTextures(): BaseTexture[];
  25998. /**
  25999. * Specifies if the material uses a texture
  26000. * @param texture defines the texture to check against the material
  26001. * @returns a boolean specifying if the material uses the texture
  26002. */
  26003. hasTexture(texture: BaseTexture): boolean;
  26004. /**
  26005. * Makes a duplicate of the material, and gives it a new name
  26006. * @param name defines the new name for the duplicated material
  26007. * @returns the cloned material
  26008. */
  26009. clone(name: string): Nullable<Material>;
  26010. /**
  26011. * Gets the meshes bound to the material
  26012. * @returns an array of meshes bound to the material
  26013. */
  26014. getBindedMeshes(): AbstractMesh[];
  26015. /**
  26016. * Force shader compilation
  26017. * @param mesh defines the mesh associated with this material
  26018. * @param onCompiled defines a function to execute once the material is compiled
  26019. * @param options defines the options to configure the compilation
  26020. * @param onError defines a function to execute if the material fails compiling
  26021. */
  26022. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  26023. /**
  26024. * Force shader compilation
  26025. * @param mesh defines the mesh that will use this material
  26026. * @param options defines additional options for compiling the shaders
  26027. * @returns a promise that resolves when the compilation completes
  26028. */
  26029. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  26030. private static readonly _AllDirtyCallBack;
  26031. private static readonly _ImageProcessingDirtyCallBack;
  26032. private static readonly _TextureDirtyCallBack;
  26033. private static readonly _FresnelDirtyCallBack;
  26034. private static readonly _MiscDirtyCallBack;
  26035. private static readonly _LightsDirtyCallBack;
  26036. private static readonly _AttributeDirtyCallBack;
  26037. private static _FresnelAndMiscDirtyCallBack;
  26038. private static _TextureAndMiscDirtyCallBack;
  26039. private static readonly _DirtyCallbackArray;
  26040. private static readonly _RunDirtyCallBacks;
  26041. /**
  26042. * Marks a define in the material to indicate that it needs to be re-computed
  26043. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  26044. */
  26045. markAsDirty(flag: number): void;
  26046. /**
  26047. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  26048. * @param func defines a function which checks material defines against the submeshes
  26049. */
  26050. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  26051. /**
  26052. * Indicates that the scene should check if the rendering now needs a prepass
  26053. */
  26054. protected _markScenePrePassDirty(): void;
  26055. /**
  26056. * Indicates that we need to re-calculated for all submeshes
  26057. */
  26058. protected _markAllSubMeshesAsAllDirty(): void;
  26059. /**
  26060. * Indicates that image processing needs to be re-calculated for all submeshes
  26061. */
  26062. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  26063. /**
  26064. * Indicates that textures need to be re-calculated for all submeshes
  26065. */
  26066. protected _markAllSubMeshesAsTexturesDirty(): void;
  26067. /**
  26068. * Indicates that fresnel needs to be re-calculated for all submeshes
  26069. */
  26070. protected _markAllSubMeshesAsFresnelDirty(): void;
  26071. /**
  26072. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  26073. */
  26074. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  26075. /**
  26076. * Indicates that lights need to be re-calculated for all submeshes
  26077. */
  26078. protected _markAllSubMeshesAsLightsDirty(): void;
  26079. /**
  26080. * Indicates that attributes need to be re-calculated for all submeshes
  26081. */
  26082. protected _markAllSubMeshesAsAttributesDirty(): void;
  26083. /**
  26084. * Indicates that misc needs to be re-calculated for all submeshes
  26085. */
  26086. protected _markAllSubMeshesAsMiscDirty(): void;
  26087. /**
  26088. * Indicates that textures and misc need to be re-calculated for all submeshes
  26089. */
  26090. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  26091. /**
  26092. * Sets the required values to the prepass renderer.
  26093. * @param prePassRenderer defines the prepass renderer to setup.
  26094. * @returns true if the pre pass is needed.
  26095. */
  26096. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  26097. /**
  26098. * Disposes the material
  26099. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  26100. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  26101. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  26102. */
  26103. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  26104. /** @hidden */
  26105. private releaseVertexArrayObject;
  26106. /**
  26107. * Serializes this material
  26108. * @returns the serialized material object
  26109. */
  26110. serialize(): any;
  26111. /**
  26112. * Creates a material from parsed material data
  26113. * @param parsedMaterial defines parsed material data
  26114. * @param scene defines the hosting scene
  26115. * @param rootUrl defines the root URL to use to load textures
  26116. * @returns a new material
  26117. */
  26118. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  26119. }
  26120. }
  26121. declare module "babylonjs/Materials/multiMaterial" {
  26122. import { Nullable } from "babylonjs/types";
  26123. import { Scene } from "babylonjs/scene";
  26124. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26125. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26126. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26127. import { Material } from "babylonjs/Materials/material";
  26128. /**
  26129. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26130. * separate meshes. This can be use to improve performances.
  26131. * @see https://doc.babylonjs.com/how_to/multi_materials
  26132. */
  26133. export class MultiMaterial extends Material {
  26134. private _subMaterials;
  26135. /**
  26136. * Gets or Sets the list of Materials used within the multi material.
  26137. * They need to be ordered according to the submeshes order in the associated mesh
  26138. */
  26139. get subMaterials(): Nullable<Material>[];
  26140. set subMaterials(value: Nullable<Material>[]);
  26141. /**
  26142. * Function used to align with Node.getChildren()
  26143. * @returns the list of Materials used within the multi material
  26144. */
  26145. getChildren(): Nullable<Material>[];
  26146. /**
  26147. * Instantiates a new Multi Material
  26148. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26149. * separate meshes. This can be use to improve performances.
  26150. * @see https://doc.babylonjs.com/how_to/multi_materials
  26151. * @param name Define the name in the scene
  26152. * @param scene Define the scene the material belongs to
  26153. */
  26154. constructor(name: string, scene: Scene);
  26155. private _hookArray;
  26156. /**
  26157. * Get one of the submaterial by its index in the submaterials array
  26158. * @param index The index to look the sub material at
  26159. * @returns The Material if the index has been defined
  26160. */
  26161. getSubMaterial(index: number): Nullable<Material>;
  26162. /**
  26163. * Get the list of active textures for the whole sub materials list.
  26164. * @returns All the textures that will be used during the rendering
  26165. */
  26166. getActiveTextures(): BaseTexture[];
  26167. /**
  26168. * Gets the current class name of the material e.g. "MultiMaterial"
  26169. * Mainly use in serialization.
  26170. * @returns the class name
  26171. */
  26172. getClassName(): string;
  26173. /**
  26174. * Checks if the material is ready to render the requested sub mesh
  26175. * @param mesh Define the mesh the submesh belongs to
  26176. * @param subMesh Define the sub mesh to look readyness for
  26177. * @param useInstances Define whether or not the material is used with instances
  26178. * @returns true if ready, otherwise false
  26179. */
  26180. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  26181. /**
  26182. * Clones the current material and its related sub materials
  26183. * @param name Define the name of the newly cloned material
  26184. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  26185. * @returns the cloned material
  26186. */
  26187. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  26188. /**
  26189. * Serializes the materials into a JSON representation.
  26190. * @returns the JSON representation
  26191. */
  26192. serialize(): any;
  26193. /**
  26194. * Dispose the material and release its associated resources
  26195. * @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)
  26196. * @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)
  26197. * @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)
  26198. */
  26199. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  26200. /**
  26201. * Creates a MultiMaterial from parsed MultiMaterial data.
  26202. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  26203. * @param scene defines the hosting scene
  26204. * @returns a new MultiMaterial
  26205. */
  26206. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  26207. }
  26208. }
  26209. declare module "babylonjs/Meshes/subMesh" {
  26210. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  26211. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  26212. import { Engine } from "babylonjs/Engines/engine";
  26213. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  26214. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26215. import { Effect } from "babylonjs/Materials/effect";
  26216. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26217. import { Plane } from "babylonjs/Maths/math.plane";
  26218. import { Collider } from "babylonjs/Collisions/collider";
  26219. import { Material } from "babylonjs/Materials/material";
  26220. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  26221. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26222. import { Mesh } from "babylonjs/Meshes/mesh";
  26223. import { Ray } from "babylonjs/Culling/ray";
  26224. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26225. /**
  26226. * Defines a subdivision inside a mesh
  26227. */
  26228. export class SubMesh implements ICullable {
  26229. /** the material index to use */
  26230. materialIndex: number;
  26231. /** vertex index start */
  26232. verticesStart: number;
  26233. /** vertices count */
  26234. verticesCount: number;
  26235. /** index start */
  26236. indexStart: number;
  26237. /** indices count */
  26238. indexCount: number;
  26239. /** @hidden */
  26240. _materialDefines: Nullable<MaterialDefines>;
  26241. /** @hidden */
  26242. _materialEffect: Nullable<Effect>;
  26243. /** @hidden */
  26244. _effectOverride: Nullable<Effect>;
  26245. /**
  26246. * Gets material defines used by the effect associated to the sub mesh
  26247. */
  26248. get materialDefines(): Nullable<MaterialDefines>;
  26249. /**
  26250. * Sets material defines used by the effect associated to the sub mesh
  26251. */
  26252. set materialDefines(defines: Nullable<MaterialDefines>);
  26253. /**
  26254. * Gets associated effect
  26255. */
  26256. get effect(): Nullable<Effect>;
  26257. /**
  26258. * Sets associated effect (effect used to render this submesh)
  26259. * @param effect defines the effect to associate with
  26260. * @param defines defines the set of defines used to compile this effect
  26261. */
  26262. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  26263. /** @hidden */
  26264. _linesIndexCount: number;
  26265. private _mesh;
  26266. private _renderingMesh;
  26267. private _boundingInfo;
  26268. private _linesIndexBuffer;
  26269. /** @hidden */
  26270. _lastColliderWorldVertices: Nullable<Vector3[]>;
  26271. /** @hidden */
  26272. _trianglePlanes: Plane[];
  26273. /** @hidden */
  26274. _lastColliderTransformMatrix: Nullable<Matrix>;
  26275. /** @hidden */
  26276. _renderId: number;
  26277. /** @hidden */
  26278. _alphaIndex: number;
  26279. /** @hidden */
  26280. _distanceToCamera: number;
  26281. /** @hidden */
  26282. _id: number;
  26283. private _currentMaterial;
  26284. /**
  26285. * Add a new submesh to a mesh
  26286. * @param materialIndex defines the material index to use
  26287. * @param verticesStart defines vertex index start
  26288. * @param verticesCount defines vertices count
  26289. * @param indexStart defines index start
  26290. * @param indexCount defines indices count
  26291. * @param mesh defines the parent mesh
  26292. * @param renderingMesh defines an optional rendering mesh
  26293. * @param createBoundingBox defines if bounding box should be created for this submesh
  26294. * @returns the new submesh
  26295. */
  26296. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  26297. /**
  26298. * Creates a new submesh
  26299. * @param materialIndex defines the material index to use
  26300. * @param verticesStart defines vertex index start
  26301. * @param verticesCount defines vertices count
  26302. * @param indexStart defines index start
  26303. * @param indexCount defines indices count
  26304. * @param mesh defines the parent mesh
  26305. * @param renderingMesh defines an optional rendering mesh
  26306. * @param createBoundingBox defines if bounding box should be created for this submesh
  26307. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  26308. */
  26309. constructor(
  26310. /** the material index to use */
  26311. materialIndex: number,
  26312. /** vertex index start */
  26313. verticesStart: number,
  26314. /** vertices count */
  26315. verticesCount: number,
  26316. /** index start */
  26317. indexStart: number,
  26318. /** indices count */
  26319. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  26320. /**
  26321. * Returns true if this submesh covers the entire parent mesh
  26322. * @ignorenaming
  26323. */
  26324. get IsGlobal(): boolean;
  26325. /**
  26326. * Returns the submesh BoudingInfo object
  26327. * @returns current bounding info (or mesh's one if the submesh is global)
  26328. */
  26329. getBoundingInfo(): BoundingInfo;
  26330. /**
  26331. * Sets the submesh BoundingInfo
  26332. * @param boundingInfo defines the new bounding info to use
  26333. * @returns the SubMesh
  26334. */
  26335. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  26336. /**
  26337. * Returns the mesh of the current submesh
  26338. * @return the parent mesh
  26339. */
  26340. getMesh(): AbstractMesh;
  26341. /**
  26342. * Returns the rendering mesh of the submesh
  26343. * @returns the rendering mesh (could be different from parent mesh)
  26344. */
  26345. getRenderingMesh(): Mesh;
  26346. /**
  26347. * Returns the replacement mesh of the submesh
  26348. * @returns the replacement mesh (could be different from parent mesh)
  26349. */
  26350. getReplacementMesh(): Nullable<AbstractMesh>;
  26351. /**
  26352. * Returns the effective mesh of the submesh
  26353. * @returns the effective mesh (could be different from parent mesh)
  26354. */
  26355. getEffectiveMesh(): AbstractMesh;
  26356. /**
  26357. * Returns the submesh material
  26358. * @returns null or the current material
  26359. */
  26360. getMaterial(): Nullable<Material>;
  26361. private _IsMultiMaterial;
  26362. /**
  26363. * Sets a new updated BoundingInfo object to the submesh
  26364. * @param data defines an optional position array to use to determine the bounding info
  26365. * @returns the SubMesh
  26366. */
  26367. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  26368. /** @hidden */
  26369. _checkCollision(collider: Collider): boolean;
  26370. /**
  26371. * Updates the submesh BoundingInfo
  26372. * @param world defines the world matrix to use to update the bounding info
  26373. * @returns the submesh
  26374. */
  26375. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  26376. /**
  26377. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  26378. * @param frustumPlanes defines the frustum planes
  26379. * @returns true if the submesh is intersecting with the frustum
  26380. */
  26381. isInFrustum(frustumPlanes: Plane[]): boolean;
  26382. /**
  26383. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  26384. * @param frustumPlanes defines the frustum planes
  26385. * @returns true if the submesh is inside the frustum
  26386. */
  26387. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26388. /**
  26389. * Renders the submesh
  26390. * @param enableAlphaMode defines if alpha needs to be used
  26391. * @returns the submesh
  26392. */
  26393. render(enableAlphaMode: boolean): SubMesh;
  26394. /**
  26395. * @hidden
  26396. */
  26397. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  26398. /**
  26399. * Checks if the submesh intersects with a ray
  26400. * @param ray defines the ray to test
  26401. * @returns true is the passed ray intersects the submesh bounding box
  26402. */
  26403. canIntersects(ray: Ray): boolean;
  26404. /**
  26405. * Intersects current submesh with a ray
  26406. * @param ray defines the ray to test
  26407. * @param positions defines mesh's positions array
  26408. * @param indices defines mesh's indices array
  26409. * @param fastCheck defines if the first intersection will be used (and not the closest)
  26410. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26411. * @returns intersection info or null if no intersection
  26412. */
  26413. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  26414. /** @hidden */
  26415. private _intersectLines;
  26416. /** @hidden */
  26417. private _intersectUnIndexedLines;
  26418. /** @hidden */
  26419. private _intersectTriangles;
  26420. /** @hidden */
  26421. private _intersectUnIndexedTriangles;
  26422. /** @hidden */
  26423. _rebuild(): void;
  26424. /**
  26425. * Creates a new submesh from the passed mesh
  26426. * @param newMesh defines the new hosting mesh
  26427. * @param newRenderingMesh defines an optional rendering mesh
  26428. * @returns the new submesh
  26429. */
  26430. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  26431. /**
  26432. * Release associated resources
  26433. */
  26434. dispose(): void;
  26435. /**
  26436. * Gets the class name
  26437. * @returns the string "SubMesh".
  26438. */
  26439. getClassName(): string;
  26440. /**
  26441. * Creates a new submesh from indices data
  26442. * @param materialIndex the index of the main mesh material
  26443. * @param startIndex the index where to start the copy in the mesh indices array
  26444. * @param indexCount the number of indices to copy then from the startIndex
  26445. * @param mesh the main mesh to create the submesh from
  26446. * @param renderingMesh the optional rendering mesh
  26447. * @returns a new submesh
  26448. */
  26449. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  26450. }
  26451. }
  26452. declare module "babylonjs/Loading/sceneLoaderFlags" {
  26453. /**
  26454. * Class used to represent data loading progression
  26455. */
  26456. export class SceneLoaderFlags {
  26457. private static _ForceFullSceneLoadingForIncremental;
  26458. private static _ShowLoadingScreen;
  26459. private static _CleanBoneMatrixWeights;
  26460. private static _loggingLevel;
  26461. /**
  26462. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  26463. */
  26464. static get ForceFullSceneLoadingForIncremental(): boolean;
  26465. static set ForceFullSceneLoadingForIncremental(value: boolean);
  26466. /**
  26467. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  26468. */
  26469. static get ShowLoadingScreen(): boolean;
  26470. static set ShowLoadingScreen(value: boolean);
  26471. /**
  26472. * Defines the current logging level (while loading the scene)
  26473. * @ignorenaming
  26474. */
  26475. static get loggingLevel(): number;
  26476. static set loggingLevel(value: number);
  26477. /**
  26478. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  26479. */
  26480. static get CleanBoneMatrixWeights(): boolean;
  26481. static set CleanBoneMatrixWeights(value: boolean);
  26482. }
  26483. }
  26484. declare module "babylonjs/Meshes/geometry" {
  26485. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  26486. import { Scene } from "babylonjs/scene";
  26487. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26488. import { Engine } from "babylonjs/Engines/engine";
  26489. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  26490. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  26491. import { Effect } from "babylonjs/Materials/effect";
  26492. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26493. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26494. import { Mesh } from "babylonjs/Meshes/mesh";
  26495. /**
  26496. * Class used to store geometry data (vertex buffers + index buffer)
  26497. */
  26498. export class Geometry implements IGetSetVerticesData {
  26499. /**
  26500. * Gets or sets the ID of the geometry
  26501. */
  26502. id: string;
  26503. /**
  26504. * Gets or sets the unique ID of the geometry
  26505. */
  26506. uniqueId: number;
  26507. /**
  26508. * Gets the delay loading state of the geometry (none by default which means not delayed)
  26509. */
  26510. delayLoadState: number;
  26511. /**
  26512. * Gets the file containing the data to load when running in delay load state
  26513. */
  26514. delayLoadingFile: Nullable<string>;
  26515. /**
  26516. * Callback called when the geometry is updated
  26517. */
  26518. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  26519. private _scene;
  26520. private _engine;
  26521. private _meshes;
  26522. private _totalVertices;
  26523. /** @hidden */
  26524. _indices: IndicesArray;
  26525. /** @hidden */
  26526. _vertexBuffers: {
  26527. [key: string]: VertexBuffer;
  26528. };
  26529. private _isDisposed;
  26530. private _extend;
  26531. private _boundingBias;
  26532. /** @hidden */
  26533. _delayInfo: Array<string>;
  26534. private _indexBuffer;
  26535. private _indexBufferIsUpdatable;
  26536. /** @hidden */
  26537. _boundingInfo: Nullable<BoundingInfo>;
  26538. /** @hidden */
  26539. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  26540. /** @hidden */
  26541. _softwareSkinningFrameId: number;
  26542. private _vertexArrayObjects;
  26543. private _updatable;
  26544. /** @hidden */
  26545. _positions: Nullable<Vector3[]>;
  26546. /**
  26547. * 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
  26548. */
  26549. get boundingBias(): Vector2;
  26550. /**
  26551. * 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
  26552. */
  26553. set boundingBias(value: Vector2);
  26554. /**
  26555. * Static function used to attach a new empty geometry to a mesh
  26556. * @param mesh defines the mesh to attach the geometry to
  26557. * @returns the new Geometry
  26558. */
  26559. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  26560. /** Get the list of meshes using this geometry */
  26561. get meshes(): Mesh[];
  26562. /**
  26563. * 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
  26564. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  26565. */
  26566. useBoundingInfoFromGeometry: boolean;
  26567. /**
  26568. * Creates a new geometry
  26569. * @param id defines the unique ID
  26570. * @param scene defines the hosting scene
  26571. * @param vertexData defines the VertexData used to get geometry data
  26572. * @param updatable defines if geometry must be updatable (false by default)
  26573. * @param mesh defines the mesh that will be associated with the geometry
  26574. */
  26575. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  26576. /**
  26577. * Gets the current extend of the geometry
  26578. */
  26579. get extend(): {
  26580. minimum: Vector3;
  26581. maximum: Vector3;
  26582. };
  26583. /**
  26584. * Gets the hosting scene
  26585. * @returns the hosting Scene
  26586. */
  26587. getScene(): Scene;
  26588. /**
  26589. * Gets the hosting engine
  26590. * @returns the hosting Engine
  26591. */
  26592. getEngine(): Engine;
  26593. /**
  26594. * Defines if the geometry is ready to use
  26595. * @returns true if the geometry is ready to be used
  26596. */
  26597. isReady(): boolean;
  26598. /**
  26599. * Gets a value indicating that the geometry should not be serialized
  26600. */
  26601. get doNotSerialize(): boolean;
  26602. /** @hidden */
  26603. _rebuild(): void;
  26604. /**
  26605. * Affects all geometry data in one call
  26606. * @param vertexData defines the geometry data
  26607. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  26608. */
  26609. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  26610. /**
  26611. * Set specific vertex data
  26612. * @param kind defines the data kind (Position, normal, etc...)
  26613. * @param data defines the vertex data to use
  26614. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26615. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26616. */
  26617. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  26618. /**
  26619. * Removes a specific vertex data
  26620. * @param kind defines the data kind (Position, normal, etc...)
  26621. */
  26622. removeVerticesData(kind: string): void;
  26623. /**
  26624. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  26625. * @param buffer defines the vertex buffer to use
  26626. * @param totalVertices defines the total number of vertices for position kind (could be null)
  26627. */
  26628. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  26629. /**
  26630. * Update a specific vertex buffer
  26631. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  26632. * It will do nothing if the buffer is not updatable
  26633. * @param kind defines the data kind (Position, normal, etc...)
  26634. * @param data defines the data to use
  26635. * @param offset defines the offset in the target buffer where to store the data
  26636. * @param useBytes set to true if the offset is in bytes
  26637. */
  26638. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  26639. /**
  26640. * Update a specific vertex buffer
  26641. * This function will create a new buffer if the current one is not updatable
  26642. * @param kind defines the data kind (Position, normal, etc...)
  26643. * @param data defines the data to use
  26644. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  26645. */
  26646. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  26647. private _updateBoundingInfo;
  26648. /** @hidden */
  26649. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  26650. /**
  26651. * Gets total number of vertices
  26652. * @returns the total number of vertices
  26653. */
  26654. getTotalVertices(): number;
  26655. /**
  26656. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26657. * @param kind defines the data kind (Position, normal, etc...)
  26658. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26659. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26660. * @returns a float array containing vertex data
  26661. */
  26662. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26663. /**
  26664. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  26665. * @param kind defines the data kind (Position, normal, etc...)
  26666. * @returns true if the vertex buffer with the specified kind is updatable
  26667. */
  26668. isVertexBufferUpdatable(kind: string): boolean;
  26669. /**
  26670. * Gets a specific vertex buffer
  26671. * @param kind defines the data kind (Position, normal, etc...)
  26672. * @returns a VertexBuffer
  26673. */
  26674. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  26675. /**
  26676. * Returns all vertex buffers
  26677. * @return an object holding all vertex buffers indexed by kind
  26678. */
  26679. getVertexBuffers(): Nullable<{
  26680. [key: string]: VertexBuffer;
  26681. }>;
  26682. /**
  26683. * Gets a boolean indicating if specific vertex buffer is present
  26684. * @param kind defines the data kind (Position, normal, etc...)
  26685. * @returns true if data is present
  26686. */
  26687. isVerticesDataPresent(kind: string): boolean;
  26688. /**
  26689. * Gets a list of all attached data kinds (Position, normal, etc...)
  26690. * @returns a list of string containing all kinds
  26691. */
  26692. getVerticesDataKinds(): string[];
  26693. /**
  26694. * Update index buffer
  26695. * @param indices defines the indices to store in the index buffer
  26696. * @param offset defines the offset in the target buffer where to store the data
  26697. * @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)
  26698. */
  26699. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  26700. /**
  26701. * Creates a new index buffer
  26702. * @param indices defines the indices to store in the index buffer
  26703. * @param totalVertices defines the total number of vertices (could be null)
  26704. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26705. */
  26706. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  26707. /**
  26708. * Return the total number of indices
  26709. * @returns the total number of indices
  26710. */
  26711. getTotalIndices(): number;
  26712. /**
  26713. * Gets the index buffer array
  26714. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26715. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26716. * @returns the index buffer array
  26717. */
  26718. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26719. /**
  26720. * Gets the index buffer
  26721. * @return the index buffer
  26722. */
  26723. getIndexBuffer(): Nullable<DataBuffer>;
  26724. /** @hidden */
  26725. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  26726. /**
  26727. * Release the associated resources for a specific mesh
  26728. * @param mesh defines the source mesh
  26729. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  26730. */
  26731. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  26732. /**
  26733. * Apply current geometry to a given mesh
  26734. * @param mesh defines the mesh to apply geometry to
  26735. */
  26736. applyToMesh(mesh: Mesh): void;
  26737. private _updateExtend;
  26738. private _applyToMesh;
  26739. private notifyUpdate;
  26740. /**
  26741. * Load the geometry if it was flagged as delay loaded
  26742. * @param scene defines the hosting scene
  26743. * @param onLoaded defines a callback called when the geometry is loaded
  26744. */
  26745. load(scene: Scene, onLoaded?: () => void): void;
  26746. private _queueLoad;
  26747. /**
  26748. * Invert the geometry to move from a right handed system to a left handed one.
  26749. */
  26750. toLeftHanded(): void;
  26751. /** @hidden */
  26752. _resetPointsArrayCache(): void;
  26753. /** @hidden */
  26754. _generatePointsArray(): boolean;
  26755. /**
  26756. * Gets a value indicating if the geometry is disposed
  26757. * @returns true if the geometry was disposed
  26758. */
  26759. isDisposed(): boolean;
  26760. private _disposeVertexArrayObjects;
  26761. /**
  26762. * Free all associated resources
  26763. */
  26764. dispose(): void;
  26765. /**
  26766. * Clone the current geometry into a new geometry
  26767. * @param id defines the unique ID of the new geometry
  26768. * @returns a new geometry object
  26769. */
  26770. copy(id: string): Geometry;
  26771. /**
  26772. * Serialize the current geometry info (and not the vertices data) into a JSON object
  26773. * @return a JSON representation of the current geometry data (without the vertices data)
  26774. */
  26775. serialize(): any;
  26776. private toNumberArray;
  26777. /**
  26778. * Serialize all vertices data into a JSON oject
  26779. * @returns a JSON representation of the current geometry data
  26780. */
  26781. serializeVerticeData(): any;
  26782. /**
  26783. * Extracts a clone of a mesh geometry
  26784. * @param mesh defines the source mesh
  26785. * @param id defines the unique ID of the new geometry object
  26786. * @returns the new geometry object
  26787. */
  26788. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  26789. /**
  26790. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  26791. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  26792. * Be aware Math.random() could cause collisions, but:
  26793. * "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"
  26794. * @returns a string containing a new GUID
  26795. */
  26796. static RandomId(): string;
  26797. /** @hidden */
  26798. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  26799. private static _CleanMatricesWeights;
  26800. /**
  26801. * Create a new geometry from persisted data (Using .babylon file format)
  26802. * @param parsedVertexData defines the persisted data
  26803. * @param scene defines the hosting scene
  26804. * @param rootUrl defines the root url to use to load assets (like delayed data)
  26805. * @returns the new geometry object
  26806. */
  26807. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  26808. }
  26809. }
  26810. declare module "babylonjs/Meshes/mesh.vertexData" {
  26811. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  26812. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  26813. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  26814. import { Geometry } from "babylonjs/Meshes/geometry";
  26815. import { Mesh } from "babylonjs/Meshes/mesh";
  26816. /**
  26817. * Define an interface for all classes that will get and set the data on vertices
  26818. */
  26819. export interface IGetSetVerticesData {
  26820. /**
  26821. * Gets a boolean indicating if specific vertex data is present
  26822. * @param kind defines the vertex data kind to use
  26823. * @returns true is data kind is present
  26824. */
  26825. isVerticesDataPresent(kind: string): boolean;
  26826. /**
  26827. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26828. * @param kind defines the data kind (Position, normal, etc...)
  26829. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26830. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26831. * @returns a float array containing vertex data
  26832. */
  26833. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26834. /**
  26835. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  26836. * @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.
  26837. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26838. * @returns the indices array or an empty array if the mesh has no geometry
  26839. */
  26840. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26841. /**
  26842. * Set specific vertex data
  26843. * @param kind defines the data kind (Position, normal, etc...)
  26844. * @param data defines the vertex data to use
  26845. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26846. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26847. */
  26848. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  26849. /**
  26850. * Update a specific associated vertex buffer
  26851. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  26852. * - VertexBuffer.PositionKind
  26853. * - VertexBuffer.UVKind
  26854. * - VertexBuffer.UV2Kind
  26855. * - VertexBuffer.UV3Kind
  26856. * - VertexBuffer.UV4Kind
  26857. * - VertexBuffer.UV5Kind
  26858. * - VertexBuffer.UV6Kind
  26859. * - VertexBuffer.ColorKind
  26860. * - VertexBuffer.MatricesIndicesKind
  26861. * - VertexBuffer.MatricesIndicesExtraKind
  26862. * - VertexBuffer.MatricesWeightsKind
  26863. * - VertexBuffer.MatricesWeightsExtraKind
  26864. * @param data defines the data source
  26865. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  26866. * @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)
  26867. */
  26868. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  26869. /**
  26870. * Creates a new index buffer
  26871. * @param indices defines the indices to store in the index buffer
  26872. * @param totalVertices defines the total number of vertices (could be null)
  26873. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26874. */
  26875. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  26876. }
  26877. /**
  26878. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  26879. */
  26880. export class VertexData {
  26881. /**
  26882. * Mesh side orientation : usually the external or front surface
  26883. */
  26884. static readonly FRONTSIDE: number;
  26885. /**
  26886. * Mesh side orientation : usually the internal or back surface
  26887. */
  26888. static readonly BACKSIDE: number;
  26889. /**
  26890. * Mesh side orientation : both internal and external or front and back surfaces
  26891. */
  26892. static readonly DOUBLESIDE: number;
  26893. /**
  26894. * Mesh side orientation : by default, `FRONTSIDE`
  26895. */
  26896. static readonly DEFAULTSIDE: number;
  26897. /**
  26898. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  26899. */
  26900. positions: Nullable<FloatArray>;
  26901. /**
  26902. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  26903. */
  26904. normals: Nullable<FloatArray>;
  26905. /**
  26906. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  26907. */
  26908. tangents: Nullable<FloatArray>;
  26909. /**
  26910. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26911. */
  26912. uvs: Nullable<FloatArray>;
  26913. /**
  26914. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26915. */
  26916. uvs2: Nullable<FloatArray>;
  26917. /**
  26918. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26919. */
  26920. uvs3: Nullable<FloatArray>;
  26921. /**
  26922. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26923. */
  26924. uvs4: Nullable<FloatArray>;
  26925. /**
  26926. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26927. */
  26928. uvs5: Nullable<FloatArray>;
  26929. /**
  26930. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26931. */
  26932. uvs6: Nullable<FloatArray>;
  26933. /**
  26934. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  26935. */
  26936. colors: Nullable<FloatArray>;
  26937. /**
  26938. * 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).
  26939. */
  26940. matricesIndices: Nullable<FloatArray>;
  26941. /**
  26942. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  26943. */
  26944. matricesWeights: Nullable<FloatArray>;
  26945. /**
  26946. * An array extending the number of possible indices
  26947. */
  26948. matricesIndicesExtra: Nullable<FloatArray>;
  26949. /**
  26950. * An array extending the number of possible weights when the number of indices is extended
  26951. */
  26952. matricesWeightsExtra: Nullable<FloatArray>;
  26953. /**
  26954. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  26955. */
  26956. indices: Nullable<IndicesArray>;
  26957. /**
  26958. * Uses the passed data array to set the set the values for the specified kind of data
  26959. * @param data a linear array of floating numbers
  26960. * @param kind the type of data that is being set, eg positions, colors etc
  26961. */
  26962. set(data: FloatArray, kind: string): void;
  26963. /**
  26964. * Associates the vertexData to the passed Mesh.
  26965. * Sets it as updatable or not (default `false`)
  26966. * @param mesh the mesh the vertexData is applied to
  26967. * @param updatable when used and having the value true allows new data to update the vertexData
  26968. * @returns the VertexData
  26969. */
  26970. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  26971. /**
  26972. * Associates the vertexData to the passed Geometry.
  26973. * Sets it as updatable or not (default `false`)
  26974. * @param geometry the geometry the vertexData is applied to
  26975. * @param updatable when used and having the value true allows new data to update the vertexData
  26976. * @returns VertexData
  26977. */
  26978. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  26979. /**
  26980. * Updates the associated mesh
  26981. * @param mesh the mesh to be updated
  26982. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26983. * @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
  26984. * @returns VertexData
  26985. */
  26986. updateMesh(mesh: Mesh): VertexData;
  26987. /**
  26988. * Updates the associated geometry
  26989. * @param geometry the geometry to be updated
  26990. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26991. * @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
  26992. * @returns VertexData.
  26993. */
  26994. updateGeometry(geometry: Geometry): VertexData;
  26995. private _applyTo;
  26996. private _update;
  26997. /**
  26998. * Transforms each position and each normal of the vertexData according to the passed Matrix
  26999. * @param matrix the transforming matrix
  27000. * @returns the VertexData
  27001. */
  27002. transform(matrix: Matrix): VertexData;
  27003. /**
  27004. * Merges the passed VertexData into the current one
  27005. * @param other the VertexData to be merged into the current one
  27006. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  27007. * @returns the modified VertexData
  27008. */
  27009. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  27010. private _mergeElement;
  27011. private _validate;
  27012. /**
  27013. * Serializes the VertexData
  27014. * @returns a serialized object
  27015. */
  27016. serialize(): any;
  27017. /**
  27018. * Extracts the vertexData from a mesh
  27019. * @param mesh the mesh from which to extract the VertexData
  27020. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  27021. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27022. * @returns the object VertexData associated to the passed mesh
  27023. */
  27024. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27025. /**
  27026. * Extracts the vertexData from the geometry
  27027. * @param geometry the geometry from which to extract the VertexData
  27028. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  27029. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27030. * @returns the object VertexData associated to the passed mesh
  27031. */
  27032. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27033. private static _ExtractFrom;
  27034. /**
  27035. * Creates the VertexData for a Ribbon
  27036. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  27037. * * pathArray array of paths, each of which an array of successive Vector3
  27038. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  27039. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  27040. * * 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
  27041. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27042. * * 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)
  27043. * * 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)
  27044. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  27045. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  27046. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  27047. * @returns the VertexData of the ribbon
  27048. */
  27049. static CreateRibbon(options: {
  27050. pathArray: Vector3[][];
  27051. closeArray?: boolean;
  27052. closePath?: boolean;
  27053. offset?: number;
  27054. sideOrientation?: number;
  27055. frontUVs?: Vector4;
  27056. backUVs?: Vector4;
  27057. invertUV?: boolean;
  27058. uvs?: Vector2[];
  27059. colors?: Color4[];
  27060. }): VertexData;
  27061. /**
  27062. * Creates the VertexData for a box
  27063. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27064. * * size sets the width, height and depth of the box to the value of size, optional default 1
  27065. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  27066. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  27067. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  27068. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27069. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27070. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27071. * * 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)
  27072. * * 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)
  27073. * @returns the VertexData of the box
  27074. */
  27075. static CreateBox(options: {
  27076. size?: number;
  27077. width?: number;
  27078. height?: number;
  27079. depth?: number;
  27080. faceUV?: Vector4[];
  27081. faceColors?: Color4[];
  27082. sideOrientation?: number;
  27083. frontUVs?: Vector4;
  27084. backUVs?: Vector4;
  27085. }): VertexData;
  27086. /**
  27087. * Creates the VertexData for a tiled box
  27088. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27089. * * faceTiles sets the pattern, tile size and number of tiles for a face
  27090. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27091. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27092. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27093. * @returns the VertexData of the box
  27094. */
  27095. static CreateTiledBox(options: {
  27096. pattern?: number;
  27097. width?: number;
  27098. height?: number;
  27099. depth?: number;
  27100. tileSize?: number;
  27101. tileWidth?: number;
  27102. tileHeight?: number;
  27103. alignHorizontal?: number;
  27104. alignVertical?: number;
  27105. faceUV?: Vector4[];
  27106. faceColors?: Color4[];
  27107. sideOrientation?: number;
  27108. }): VertexData;
  27109. /**
  27110. * Creates the VertexData for a tiled plane
  27111. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27112. * * pattern a limited pattern arrangement depending on the number
  27113. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  27114. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  27115. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  27116. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27117. * * 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)
  27118. * * 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)
  27119. * @returns the VertexData of the tiled plane
  27120. */
  27121. static CreateTiledPlane(options: {
  27122. pattern?: number;
  27123. tileSize?: number;
  27124. tileWidth?: number;
  27125. tileHeight?: number;
  27126. size?: number;
  27127. width?: number;
  27128. height?: number;
  27129. alignHorizontal?: number;
  27130. alignVertical?: number;
  27131. sideOrientation?: number;
  27132. frontUVs?: Vector4;
  27133. backUVs?: Vector4;
  27134. }): VertexData;
  27135. /**
  27136. * Creates the VertexData for an ellipsoid, defaults to a sphere
  27137. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27138. * * segments sets the number of horizontal strips optional, default 32
  27139. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  27140. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  27141. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  27142. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  27143. * * 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
  27144. * * 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
  27145. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27146. * * 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)
  27147. * * 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)
  27148. * @returns the VertexData of the ellipsoid
  27149. */
  27150. static CreateSphere(options: {
  27151. segments?: number;
  27152. diameter?: number;
  27153. diameterX?: number;
  27154. diameterY?: number;
  27155. diameterZ?: number;
  27156. arc?: number;
  27157. slice?: number;
  27158. sideOrientation?: number;
  27159. frontUVs?: Vector4;
  27160. backUVs?: Vector4;
  27161. }): VertexData;
  27162. /**
  27163. * Creates the VertexData for a cylinder, cone or prism
  27164. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27165. * * height sets the height (y direction) of the cylinder, optional, default 2
  27166. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  27167. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  27168. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  27169. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27170. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  27171. * * 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
  27172. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27173. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27174. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  27175. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  27176. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27177. * * 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)
  27178. * * 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)
  27179. * @returns the VertexData of the cylinder, cone or prism
  27180. */
  27181. static CreateCylinder(options: {
  27182. height?: number;
  27183. diameterTop?: number;
  27184. diameterBottom?: number;
  27185. diameter?: number;
  27186. tessellation?: number;
  27187. subdivisions?: number;
  27188. arc?: number;
  27189. faceColors?: Color4[];
  27190. faceUV?: Vector4[];
  27191. hasRings?: boolean;
  27192. enclose?: boolean;
  27193. sideOrientation?: number;
  27194. frontUVs?: Vector4;
  27195. backUVs?: Vector4;
  27196. }): VertexData;
  27197. /**
  27198. * Creates the VertexData for a torus
  27199. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27200. * * diameter the diameter of the torus, optional default 1
  27201. * * thickness the diameter of the tube forming the torus, optional default 0.5
  27202. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27203. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27204. * * 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)
  27205. * * 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)
  27206. * @returns the VertexData of the torus
  27207. */
  27208. static CreateTorus(options: {
  27209. diameter?: number;
  27210. thickness?: number;
  27211. tessellation?: number;
  27212. sideOrientation?: number;
  27213. frontUVs?: Vector4;
  27214. backUVs?: Vector4;
  27215. }): VertexData;
  27216. /**
  27217. * Creates the VertexData of the LineSystem
  27218. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  27219. * - lines an array of lines, each line being an array of successive Vector3
  27220. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  27221. * @returns the VertexData of the LineSystem
  27222. */
  27223. static CreateLineSystem(options: {
  27224. lines: Vector3[][];
  27225. colors?: Nullable<Color4[][]>;
  27226. }): VertexData;
  27227. /**
  27228. * Create the VertexData for a DashedLines
  27229. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  27230. * - points an array successive Vector3
  27231. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  27232. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  27233. * - dashNb the intended total number of dashes, optional, default 200
  27234. * @returns the VertexData for the DashedLines
  27235. */
  27236. static CreateDashedLines(options: {
  27237. points: Vector3[];
  27238. dashSize?: number;
  27239. gapSize?: number;
  27240. dashNb?: number;
  27241. }): VertexData;
  27242. /**
  27243. * Creates the VertexData for a Ground
  27244. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27245. * - width the width (x direction) of the ground, optional, default 1
  27246. * - height the height (z direction) of the ground, optional, default 1
  27247. * - subdivisions the number of subdivisions per side, optional, default 1
  27248. * @returns the VertexData of the Ground
  27249. */
  27250. static CreateGround(options: {
  27251. width?: number;
  27252. height?: number;
  27253. subdivisions?: number;
  27254. subdivisionsX?: number;
  27255. subdivisionsY?: number;
  27256. }): VertexData;
  27257. /**
  27258. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  27259. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27260. * * xmin the ground minimum X coordinate, optional, default -1
  27261. * * zmin the ground minimum Z coordinate, optional, default -1
  27262. * * xmax the ground maximum X coordinate, optional, default 1
  27263. * * zmax the ground maximum Z coordinate, optional, default 1
  27264. * * 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}
  27265. * * 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}
  27266. * @returns the VertexData of the TiledGround
  27267. */
  27268. static CreateTiledGround(options: {
  27269. xmin: number;
  27270. zmin: number;
  27271. xmax: number;
  27272. zmax: number;
  27273. subdivisions?: {
  27274. w: number;
  27275. h: number;
  27276. };
  27277. precision?: {
  27278. w: number;
  27279. h: number;
  27280. };
  27281. }): VertexData;
  27282. /**
  27283. * Creates the VertexData of the Ground designed from a heightmap
  27284. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  27285. * * width the width (x direction) of the ground
  27286. * * height the height (z direction) of the ground
  27287. * * subdivisions the number of subdivisions per side
  27288. * * minHeight the minimum altitude on the ground, optional, default 0
  27289. * * maxHeight the maximum altitude on the ground, optional default 1
  27290. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  27291. * * buffer the array holding the image color data
  27292. * * bufferWidth the width of image
  27293. * * bufferHeight the height of image
  27294. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  27295. * @returns the VertexData of the Ground designed from a heightmap
  27296. */
  27297. static CreateGroundFromHeightMap(options: {
  27298. width: number;
  27299. height: number;
  27300. subdivisions: number;
  27301. minHeight: number;
  27302. maxHeight: number;
  27303. colorFilter: Color3;
  27304. buffer: Uint8Array;
  27305. bufferWidth: number;
  27306. bufferHeight: number;
  27307. alphaFilter: number;
  27308. }): VertexData;
  27309. /**
  27310. * Creates the VertexData for a Plane
  27311. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  27312. * * size sets the width and height of the plane to the value of size, optional default 1
  27313. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  27314. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  27315. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27316. * * 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)
  27317. * * 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)
  27318. * @returns the VertexData of the box
  27319. */
  27320. static CreatePlane(options: {
  27321. size?: number;
  27322. width?: number;
  27323. height?: number;
  27324. sideOrientation?: number;
  27325. frontUVs?: Vector4;
  27326. backUVs?: Vector4;
  27327. }): VertexData;
  27328. /**
  27329. * Creates the VertexData of the Disc or regular Polygon
  27330. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  27331. * * radius the radius of the disc, optional default 0.5
  27332. * * tessellation the number of polygon sides, optional, default 64
  27333. * * 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
  27334. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27335. * * 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)
  27336. * * 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)
  27337. * @returns the VertexData of the box
  27338. */
  27339. static CreateDisc(options: {
  27340. radius?: number;
  27341. tessellation?: number;
  27342. arc?: number;
  27343. sideOrientation?: number;
  27344. frontUVs?: Vector4;
  27345. backUVs?: Vector4;
  27346. }): VertexData;
  27347. /**
  27348. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  27349. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  27350. * @param polygon a mesh built from polygonTriangulation.build()
  27351. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27352. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27353. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27354. * @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)
  27355. * @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)
  27356. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  27357. * @returns the VertexData of the Polygon
  27358. */
  27359. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  27360. /**
  27361. * Creates the VertexData of the IcoSphere
  27362. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  27363. * * radius the radius of the IcoSphere, optional default 1
  27364. * * radiusX allows stretching in the x direction, optional, default radius
  27365. * * radiusY allows stretching in the y direction, optional, default radius
  27366. * * radiusZ allows stretching in the z direction, optional, default radius
  27367. * * flat when true creates a flat shaded mesh, optional, default true
  27368. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27369. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27370. * * 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)
  27371. * * 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)
  27372. * @returns the VertexData of the IcoSphere
  27373. */
  27374. static CreateIcoSphere(options: {
  27375. radius?: number;
  27376. radiusX?: number;
  27377. radiusY?: number;
  27378. radiusZ?: number;
  27379. flat?: boolean;
  27380. subdivisions?: number;
  27381. sideOrientation?: number;
  27382. frontUVs?: Vector4;
  27383. backUVs?: Vector4;
  27384. }): VertexData;
  27385. /**
  27386. * Creates the VertexData for a Polyhedron
  27387. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  27388. * * type provided types are:
  27389. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  27390. * * 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)
  27391. * * size the size of the IcoSphere, optional default 1
  27392. * * sizeX allows stretching in the x direction, optional, default size
  27393. * * sizeY allows stretching in the y direction, optional, default size
  27394. * * sizeZ allows stretching in the z direction, optional, default size
  27395. * * 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
  27396. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27397. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27398. * * flat when true creates a flat shaded mesh, optional, default true
  27399. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27400. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27401. * * 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)
  27402. * * 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)
  27403. * @returns the VertexData of the Polyhedron
  27404. */
  27405. static CreatePolyhedron(options: {
  27406. type?: number;
  27407. size?: number;
  27408. sizeX?: number;
  27409. sizeY?: number;
  27410. sizeZ?: number;
  27411. custom?: any;
  27412. faceUV?: Vector4[];
  27413. faceColors?: Color4[];
  27414. flat?: boolean;
  27415. sideOrientation?: number;
  27416. frontUVs?: Vector4;
  27417. backUVs?: Vector4;
  27418. }): VertexData;
  27419. /**
  27420. * Creates the VertexData for a TorusKnot
  27421. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  27422. * * radius the radius of the torus knot, optional, default 2
  27423. * * tube the thickness of the tube, optional, default 0.5
  27424. * * radialSegments the number of sides on each tube segments, optional, default 32
  27425. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  27426. * * p the number of windings around the z axis, optional, default 2
  27427. * * q the number of windings around the x axis, optional, default 3
  27428. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27429. * * 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)
  27430. * * 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)
  27431. * @returns the VertexData of the Torus Knot
  27432. */
  27433. static CreateTorusKnot(options: {
  27434. radius?: number;
  27435. tube?: number;
  27436. radialSegments?: number;
  27437. tubularSegments?: number;
  27438. p?: number;
  27439. q?: number;
  27440. sideOrientation?: number;
  27441. frontUVs?: Vector4;
  27442. backUVs?: Vector4;
  27443. }): VertexData;
  27444. /**
  27445. * Compute normals for given positions and indices
  27446. * @param positions an array of vertex positions, [...., x, y, z, ......]
  27447. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  27448. * @param normals an array of vertex normals, [...., x, y, z, ......]
  27449. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  27450. * * facetNormals : optional array of facet normals (vector3)
  27451. * * facetPositions : optional array of facet positions (vector3)
  27452. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  27453. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  27454. * * bInfo : optional bounding info, required for facetPartitioning computation
  27455. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  27456. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  27457. * * useRightHandedSystem: optional boolean to for right handed system computation
  27458. * * depthSort : optional boolean to enable the facet depth sort computation
  27459. * * distanceTo : optional Vector3 to compute the facet depth from this location
  27460. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  27461. */
  27462. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  27463. facetNormals?: any;
  27464. facetPositions?: any;
  27465. facetPartitioning?: any;
  27466. ratio?: number;
  27467. bInfo?: any;
  27468. bbSize?: Vector3;
  27469. subDiv?: any;
  27470. useRightHandedSystem?: boolean;
  27471. depthSort?: boolean;
  27472. distanceTo?: Vector3;
  27473. depthSortedFacets?: any;
  27474. }): void;
  27475. /** @hidden */
  27476. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  27477. /**
  27478. * Applies VertexData created from the imported parameters to the geometry
  27479. * @param parsedVertexData the parsed data from an imported file
  27480. * @param geometry the geometry to apply the VertexData to
  27481. */
  27482. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  27483. }
  27484. }
  27485. declare module "babylonjs/Morph/morphTarget" {
  27486. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27487. import { Observable } from "babylonjs/Misc/observable";
  27488. import { Nullable, FloatArray } from "babylonjs/types";
  27489. import { Scene } from "babylonjs/scene";
  27490. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27491. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27492. /**
  27493. * Defines a target to use with MorphTargetManager
  27494. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27495. */
  27496. export class MorphTarget implements IAnimatable {
  27497. /** defines the name of the target */
  27498. name: string;
  27499. /**
  27500. * Gets or sets the list of animations
  27501. */
  27502. animations: import("babylonjs/Animations/animation").Animation[];
  27503. private _scene;
  27504. private _positions;
  27505. private _normals;
  27506. private _tangents;
  27507. private _uvs;
  27508. private _influence;
  27509. private _uniqueId;
  27510. /**
  27511. * Observable raised when the influence changes
  27512. */
  27513. onInfluenceChanged: Observable<boolean>;
  27514. /** @hidden */
  27515. _onDataLayoutChanged: Observable<void>;
  27516. /**
  27517. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  27518. */
  27519. get influence(): number;
  27520. set influence(influence: number);
  27521. /**
  27522. * Gets or sets the id of the morph Target
  27523. */
  27524. id: string;
  27525. private _animationPropertiesOverride;
  27526. /**
  27527. * Gets or sets the animation properties override
  27528. */
  27529. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  27530. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  27531. /**
  27532. * Creates a new MorphTarget
  27533. * @param name defines the name of the target
  27534. * @param influence defines the influence to use
  27535. * @param scene defines the scene the morphtarget belongs to
  27536. */
  27537. constructor(
  27538. /** defines the name of the target */
  27539. name: string, influence?: number, scene?: Nullable<Scene>);
  27540. /**
  27541. * Gets the unique ID of this manager
  27542. */
  27543. get uniqueId(): number;
  27544. /**
  27545. * Gets a boolean defining if the target contains position data
  27546. */
  27547. get hasPositions(): boolean;
  27548. /**
  27549. * Gets a boolean defining if the target contains normal data
  27550. */
  27551. get hasNormals(): boolean;
  27552. /**
  27553. * Gets a boolean defining if the target contains tangent data
  27554. */
  27555. get hasTangents(): boolean;
  27556. /**
  27557. * Gets a boolean defining if the target contains texture coordinates data
  27558. */
  27559. get hasUVs(): boolean;
  27560. /**
  27561. * Affects position data to this target
  27562. * @param data defines the position data to use
  27563. */
  27564. setPositions(data: Nullable<FloatArray>): void;
  27565. /**
  27566. * Gets the position data stored in this target
  27567. * @returns a FloatArray containing the position data (or null if not present)
  27568. */
  27569. getPositions(): Nullable<FloatArray>;
  27570. /**
  27571. * Affects normal data to this target
  27572. * @param data defines the normal data to use
  27573. */
  27574. setNormals(data: Nullable<FloatArray>): void;
  27575. /**
  27576. * Gets the normal data stored in this target
  27577. * @returns a FloatArray containing the normal data (or null if not present)
  27578. */
  27579. getNormals(): Nullable<FloatArray>;
  27580. /**
  27581. * Affects tangent data to this target
  27582. * @param data defines the tangent data to use
  27583. */
  27584. setTangents(data: Nullable<FloatArray>): void;
  27585. /**
  27586. * Gets the tangent data stored in this target
  27587. * @returns a FloatArray containing the tangent data (or null if not present)
  27588. */
  27589. getTangents(): Nullable<FloatArray>;
  27590. /**
  27591. * Affects texture coordinates data to this target
  27592. * @param data defines the texture coordinates data to use
  27593. */
  27594. setUVs(data: Nullable<FloatArray>): void;
  27595. /**
  27596. * Gets the texture coordinates data stored in this target
  27597. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  27598. */
  27599. getUVs(): Nullable<FloatArray>;
  27600. /**
  27601. * Clone the current target
  27602. * @returns a new MorphTarget
  27603. */
  27604. clone(): MorphTarget;
  27605. /**
  27606. * Serializes the current target into a Serialization object
  27607. * @returns the serialized object
  27608. */
  27609. serialize(): any;
  27610. /**
  27611. * Returns the string "MorphTarget"
  27612. * @returns "MorphTarget"
  27613. */
  27614. getClassName(): string;
  27615. /**
  27616. * Creates a new target from serialized data
  27617. * @param serializationObject defines the serialized data to use
  27618. * @returns a new MorphTarget
  27619. */
  27620. static Parse(serializationObject: any): MorphTarget;
  27621. /**
  27622. * Creates a MorphTarget from mesh data
  27623. * @param mesh defines the source mesh
  27624. * @param name defines the name to use for the new target
  27625. * @param influence defines the influence to attach to the target
  27626. * @returns a new MorphTarget
  27627. */
  27628. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  27629. }
  27630. }
  27631. declare module "babylonjs/Morph/morphTargetManager" {
  27632. import { Nullable } from "babylonjs/types";
  27633. import { Scene } from "babylonjs/scene";
  27634. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  27635. /**
  27636. * This class is used to deform meshes using morphing between different targets
  27637. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27638. */
  27639. export class MorphTargetManager {
  27640. private _targets;
  27641. private _targetInfluenceChangedObservers;
  27642. private _targetDataLayoutChangedObservers;
  27643. private _activeTargets;
  27644. private _scene;
  27645. private _influences;
  27646. private _supportsNormals;
  27647. private _supportsTangents;
  27648. private _supportsUVs;
  27649. private _vertexCount;
  27650. private _uniqueId;
  27651. private _tempInfluences;
  27652. /**
  27653. * Gets or sets a boolean indicating if normals must be morphed
  27654. */
  27655. enableNormalMorphing: boolean;
  27656. /**
  27657. * Gets or sets a boolean indicating if tangents must be morphed
  27658. */
  27659. enableTangentMorphing: boolean;
  27660. /**
  27661. * Gets or sets a boolean indicating if UV must be morphed
  27662. */
  27663. enableUVMorphing: boolean;
  27664. /**
  27665. * Creates a new MorphTargetManager
  27666. * @param scene defines the current scene
  27667. */
  27668. constructor(scene?: Nullable<Scene>);
  27669. /**
  27670. * Gets the unique ID of this manager
  27671. */
  27672. get uniqueId(): number;
  27673. /**
  27674. * Gets the number of vertices handled by this manager
  27675. */
  27676. get vertexCount(): number;
  27677. /**
  27678. * Gets a boolean indicating if this manager supports morphing of normals
  27679. */
  27680. get supportsNormals(): boolean;
  27681. /**
  27682. * Gets a boolean indicating if this manager supports morphing of tangents
  27683. */
  27684. get supportsTangents(): boolean;
  27685. /**
  27686. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  27687. */
  27688. get supportsUVs(): boolean;
  27689. /**
  27690. * Gets the number of targets stored in this manager
  27691. */
  27692. get numTargets(): number;
  27693. /**
  27694. * Gets the number of influencers (ie. the number of targets with influences > 0)
  27695. */
  27696. get numInfluencers(): number;
  27697. /**
  27698. * Gets the list of influences (one per target)
  27699. */
  27700. get influences(): Float32Array;
  27701. /**
  27702. * Gets the active target at specified index. An active target is a target with an influence > 0
  27703. * @param index defines the index to check
  27704. * @returns the requested target
  27705. */
  27706. getActiveTarget(index: number): MorphTarget;
  27707. /**
  27708. * Gets the target at specified index
  27709. * @param index defines the index to check
  27710. * @returns the requested target
  27711. */
  27712. getTarget(index: number): MorphTarget;
  27713. /**
  27714. * Add a new target to this manager
  27715. * @param target defines the target to add
  27716. */
  27717. addTarget(target: MorphTarget): void;
  27718. /**
  27719. * Removes a target from the manager
  27720. * @param target defines the target to remove
  27721. */
  27722. removeTarget(target: MorphTarget): void;
  27723. /**
  27724. * Clone the current manager
  27725. * @returns a new MorphTargetManager
  27726. */
  27727. clone(): MorphTargetManager;
  27728. /**
  27729. * Serializes the current manager into a Serialization object
  27730. * @returns the serialized object
  27731. */
  27732. serialize(): any;
  27733. private _syncActiveTargets;
  27734. /**
  27735. * Syncrhonize the targets with all the meshes using this morph target manager
  27736. */
  27737. synchronize(): void;
  27738. /**
  27739. * Creates a new MorphTargetManager from serialized data
  27740. * @param serializationObject defines the serialized data
  27741. * @param scene defines the hosting scene
  27742. * @returns the new MorphTargetManager
  27743. */
  27744. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  27745. }
  27746. }
  27747. declare module "babylonjs/Meshes/meshLODLevel" {
  27748. import { Mesh } from "babylonjs/Meshes/mesh";
  27749. import { Nullable } from "babylonjs/types";
  27750. /**
  27751. * Class used to represent a specific level of detail of a mesh
  27752. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  27753. */
  27754. export class MeshLODLevel {
  27755. /** Defines the distance where this level should start being displayed */
  27756. distance: number;
  27757. /** Defines the mesh to use to render this level */
  27758. mesh: Nullable<Mesh>;
  27759. /**
  27760. * Creates a new LOD level
  27761. * @param distance defines the distance where this level should star being displayed
  27762. * @param mesh defines the mesh to use to render this level
  27763. */
  27764. constructor(
  27765. /** Defines the distance where this level should start being displayed */
  27766. distance: number,
  27767. /** Defines the mesh to use to render this level */
  27768. mesh: Nullable<Mesh>);
  27769. }
  27770. }
  27771. declare module "babylonjs/Misc/canvasGenerator" {
  27772. /**
  27773. * Helper class used to generate a canvas to manipulate images
  27774. */
  27775. export class CanvasGenerator {
  27776. /**
  27777. * Create a new canvas (or offscreen canvas depending on the context)
  27778. * @param width defines the expected width
  27779. * @param height defines the expected height
  27780. * @return a new canvas or offscreen canvas
  27781. */
  27782. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  27783. }
  27784. }
  27785. declare module "babylonjs/Meshes/groundMesh" {
  27786. import { Scene } from "babylonjs/scene";
  27787. import { Vector3 } from "babylonjs/Maths/math.vector";
  27788. import { Mesh } from "babylonjs/Meshes/mesh";
  27789. /**
  27790. * Mesh representing the gorund
  27791. */
  27792. export class GroundMesh extends Mesh {
  27793. /** If octree should be generated */
  27794. generateOctree: boolean;
  27795. private _heightQuads;
  27796. /** @hidden */
  27797. _subdivisionsX: number;
  27798. /** @hidden */
  27799. _subdivisionsY: number;
  27800. /** @hidden */
  27801. _width: number;
  27802. /** @hidden */
  27803. _height: number;
  27804. /** @hidden */
  27805. _minX: number;
  27806. /** @hidden */
  27807. _maxX: number;
  27808. /** @hidden */
  27809. _minZ: number;
  27810. /** @hidden */
  27811. _maxZ: number;
  27812. constructor(name: string, scene: Scene);
  27813. /**
  27814. * "GroundMesh"
  27815. * @returns "GroundMesh"
  27816. */
  27817. getClassName(): string;
  27818. /**
  27819. * The minimum of x and y subdivisions
  27820. */
  27821. get subdivisions(): number;
  27822. /**
  27823. * X subdivisions
  27824. */
  27825. get subdivisionsX(): number;
  27826. /**
  27827. * Y subdivisions
  27828. */
  27829. get subdivisionsY(): number;
  27830. /**
  27831. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  27832. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  27833. * @param chunksCount the number of subdivisions for x and y
  27834. * @param octreeBlocksSize (Default: 32)
  27835. */
  27836. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  27837. /**
  27838. * Returns a height (y) value in the Worl system :
  27839. * the ground altitude at the coordinates (x, z) expressed in the World system.
  27840. * @param x x coordinate
  27841. * @param z z coordinate
  27842. * @returns the ground y position if (x, z) are outside the ground surface.
  27843. */
  27844. getHeightAtCoordinates(x: number, z: number): number;
  27845. /**
  27846. * Returns a normalized vector (Vector3) orthogonal to the ground
  27847. * at the ground coordinates (x, z) expressed in the World system.
  27848. * @param x x coordinate
  27849. * @param z z coordinate
  27850. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  27851. */
  27852. getNormalAtCoordinates(x: number, z: number): Vector3;
  27853. /**
  27854. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  27855. * at the ground coordinates (x, z) expressed in the World system.
  27856. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  27857. * @param x x coordinate
  27858. * @param z z coordinate
  27859. * @param ref vector to store the result
  27860. * @returns the GroundMesh.
  27861. */
  27862. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  27863. /**
  27864. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  27865. * if the ground has been updated.
  27866. * This can be used in the render loop.
  27867. * @returns the GroundMesh.
  27868. */
  27869. updateCoordinateHeights(): GroundMesh;
  27870. private _getFacetAt;
  27871. private _initHeightQuads;
  27872. private _computeHeightQuads;
  27873. /**
  27874. * Serializes this ground mesh
  27875. * @param serializationObject object to write serialization to
  27876. */
  27877. serialize(serializationObject: any): void;
  27878. /**
  27879. * Parses a serialized ground mesh
  27880. * @param parsedMesh the serialized mesh
  27881. * @param scene the scene to create the ground mesh in
  27882. * @returns the created ground mesh
  27883. */
  27884. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  27885. }
  27886. }
  27887. declare module "babylonjs/Physics/physicsJoint" {
  27888. import { Vector3 } from "babylonjs/Maths/math.vector";
  27889. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  27890. /**
  27891. * Interface for Physics-Joint data
  27892. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27893. */
  27894. export interface PhysicsJointData {
  27895. /**
  27896. * The main pivot of the joint
  27897. */
  27898. mainPivot?: Vector3;
  27899. /**
  27900. * The connected pivot of the joint
  27901. */
  27902. connectedPivot?: Vector3;
  27903. /**
  27904. * The main axis of the joint
  27905. */
  27906. mainAxis?: Vector3;
  27907. /**
  27908. * The connected axis of the joint
  27909. */
  27910. connectedAxis?: Vector3;
  27911. /**
  27912. * The collision of the joint
  27913. */
  27914. collision?: boolean;
  27915. /**
  27916. * Native Oimo/Cannon/Energy data
  27917. */
  27918. nativeParams?: any;
  27919. }
  27920. /**
  27921. * This is a holder class for the physics joint created by the physics plugin
  27922. * It holds a set of functions to control the underlying joint
  27923. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27924. */
  27925. export class PhysicsJoint {
  27926. /**
  27927. * The type of the physics joint
  27928. */
  27929. type: number;
  27930. /**
  27931. * The data for the physics joint
  27932. */
  27933. jointData: PhysicsJointData;
  27934. private _physicsJoint;
  27935. protected _physicsPlugin: IPhysicsEnginePlugin;
  27936. /**
  27937. * Initializes the physics joint
  27938. * @param type The type of the physics joint
  27939. * @param jointData The data for the physics joint
  27940. */
  27941. constructor(
  27942. /**
  27943. * The type of the physics joint
  27944. */
  27945. type: number,
  27946. /**
  27947. * The data for the physics joint
  27948. */
  27949. jointData: PhysicsJointData);
  27950. /**
  27951. * Gets the physics joint
  27952. */
  27953. get physicsJoint(): any;
  27954. /**
  27955. * Sets the physics joint
  27956. */
  27957. set physicsJoint(newJoint: any);
  27958. /**
  27959. * Sets the physics plugin
  27960. */
  27961. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  27962. /**
  27963. * Execute a function that is physics-plugin specific.
  27964. * @param {Function} func the function that will be executed.
  27965. * It accepts two parameters: the physics world and the physics joint
  27966. */
  27967. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  27968. /**
  27969. * Distance-Joint type
  27970. */
  27971. static DistanceJoint: number;
  27972. /**
  27973. * Hinge-Joint type
  27974. */
  27975. static HingeJoint: number;
  27976. /**
  27977. * Ball-and-Socket joint type
  27978. */
  27979. static BallAndSocketJoint: number;
  27980. /**
  27981. * Wheel-Joint type
  27982. */
  27983. static WheelJoint: number;
  27984. /**
  27985. * Slider-Joint type
  27986. */
  27987. static SliderJoint: number;
  27988. /**
  27989. * Prismatic-Joint type
  27990. */
  27991. static PrismaticJoint: number;
  27992. /**
  27993. * Universal-Joint type
  27994. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  27995. */
  27996. static UniversalJoint: number;
  27997. /**
  27998. * Hinge-Joint 2 type
  27999. */
  28000. static Hinge2Joint: number;
  28001. /**
  28002. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  28003. */
  28004. static PointToPointJoint: number;
  28005. /**
  28006. * Spring-Joint type
  28007. */
  28008. static SpringJoint: number;
  28009. /**
  28010. * Lock-Joint type
  28011. */
  28012. static LockJoint: number;
  28013. }
  28014. /**
  28015. * A class representing a physics distance joint
  28016. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28017. */
  28018. export class DistanceJoint extends PhysicsJoint {
  28019. /**
  28020. *
  28021. * @param jointData The data for the Distance-Joint
  28022. */
  28023. constructor(jointData: DistanceJointData);
  28024. /**
  28025. * Update the predefined distance.
  28026. * @param maxDistance The maximum preferred distance
  28027. * @param minDistance The minimum preferred distance
  28028. */
  28029. updateDistance(maxDistance: number, minDistance?: number): void;
  28030. }
  28031. /**
  28032. * Represents a Motor-Enabled Joint
  28033. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28034. */
  28035. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  28036. /**
  28037. * Initializes the Motor-Enabled Joint
  28038. * @param type The type of the joint
  28039. * @param jointData The physica joint data for the joint
  28040. */
  28041. constructor(type: number, jointData: PhysicsJointData);
  28042. /**
  28043. * Set the motor values.
  28044. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28045. * @param force the force to apply
  28046. * @param maxForce max force for this motor.
  28047. */
  28048. setMotor(force?: number, maxForce?: number): void;
  28049. /**
  28050. * Set the motor's limits.
  28051. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28052. * @param upperLimit The upper limit of the motor
  28053. * @param lowerLimit The lower limit of the motor
  28054. */
  28055. setLimit(upperLimit: number, lowerLimit?: number): void;
  28056. }
  28057. /**
  28058. * This class represents a single physics Hinge-Joint
  28059. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28060. */
  28061. export class HingeJoint extends MotorEnabledJoint {
  28062. /**
  28063. * Initializes the Hinge-Joint
  28064. * @param jointData The joint data for the Hinge-Joint
  28065. */
  28066. constructor(jointData: PhysicsJointData);
  28067. /**
  28068. * Set the motor values.
  28069. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28070. * @param {number} force the force to apply
  28071. * @param {number} maxForce max force for this motor.
  28072. */
  28073. setMotor(force?: number, maxForce?: number): void;
  28074. /**
  28075. * Set the motor's limits.
  28076. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28077. * @param upperLimit The upper limit of the motor
  28078. * @param lowerLimit The lower limit of the motor
  28079. */
  28080. setLimit(upperLimit: number, lowerLimit?: number): void;
  28081. }
  28082. /**
  28083. * This class represents a dual hinge physics joint (same as wheel joint)
  28084. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28085. */
  28086. export class Hinge2Joint extends MotorEnabledJoint {
  28087. /**
  28088. * Initializes the Hinge2-Joint
  28089. * @param jointData The joint data for the Hinge2-Joint
  28090. */
  28091. constructor(jointData: PhysicsJointData);
  28092. /**
  28093. * Set the motor values.
  28094. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28095. * @param {number} targetSpeed the speed the motor is to reach
  28096. * @param {number} maxForce max force for this motor.
  28097. * @param {motorIndex} the motor's index, 0 or 1.
  28098. */
  28099. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  28100. /**
  28101. * Set the motor limits.
  28102. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28103. * @param {number} upperLimit the upper limit
  28104. * @param {number} lowerLimit lower limit
  28105. * @param {motorIndex} the motor's index, 0 or 1.
  28106. */
  28107. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28108. }
  28109. /**
  28110. * Interface for a motor enabled joint
  28111. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28112. */
  28113. export interface IMotorEnabledJoint {
  28114. /**
  28115. * Physics joint
  28116. */
  28117. physicsJoint: any;
  28118. /**
  28119. * Sets the motor of the motor-enabled joint
  28120. * @param force The force of the motor
  28121. * @param maxForce The maximum force of the motor
  28122. * @param motorIndex The index of the motor
  28123. */
  28124. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  28125. /**
  28126. * Sets the limit of the motor
  28127. * @param upperLimit The upper limit of the motor
  28128. * @param lowerLimit The lower limit of the motor
  28129. * @param motorIndex The index of the motor
  28130. */
  28131. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28132. }
  28133. /**
  28134. * Joint data for a Distance-Joint
  28135. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28136. */
  28137. export interface DistanceJointData extends PhysicsJointData {
  28138. /**
  28139. * Max distance the 2 joint objects can be apart
  28140. */
  28141. maxDistance: number;
  28142. }
  28143. /**
  28144. * Joint data from a spring joint
  28145. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28146. */
  28147. export interface SpringJointData extends PhysicsJointData {
  28148. /**
  28149. * Length of the spring
  28150. */
  28151. length: number;
  28152. /**
  28153. * Stiffness of the spring
  28154. */
  28155. stiffness: number;
  28156. /**
  28157. * Damping of the spring
  28158. */
  28159. damping: number;
  28160. /** this callback will be called when applying the force to the impostors. */
  28161. forceApplicationCallback: () => void;
  28162. }
  28163. }
  28164. declare module "babylonjs/Physics/physicsRaycastResult" {
  28165. import { Vector3 } from "babylonjs/Maths/math.vector";
  28166. /**
  28167. * Holds the data for the raycast result
  28168. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28169. */
  28170. export class PhysicsRaycastResult {
  28171. private _hasHit;
  28172. private _hitDistance;
  28173. private _hitNormalWorld;
  28174. private _hitPointWorld;
  28175. private _rayFromWorld;
  28176. private _rayToWorld;
  28177. /**
  28178. * Gets if there was a hit
  28179. */
  28180. get hasHit(): boolean;
  28181. /**
  28182. * Gets the distance from the hit
  28183. */
  28184. get hitDistance(): number;
  28185. /**
  28186. * Gets the hit normal/direction in the world
  28187. */
  28188. get hitNormalWorld(): Vector3;
  28189. /**
  28190. * Gets the hit point in the world
  28191. */
  28192. get hitPointWorld(): Vector3;
  28193. /**
  28194. * Gets the ray "start point" of the ray in the world
  28195. */
  28196. get rayFromWorld(): Vector3;
  28197. /**
  28198. * Gets the ray "end point" of the ray in the world
  28199. */
  28200. get rayToWorld(): Vector3;
  28201. /**
  28202. * Sets the hit data (normal & point in world space)
  28203. * @param hitNormalWorld defines the normal in world space
  28204. * @param hitPointWorld defines the point in world space
  28205. */
  28206. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  28207. /**
  28208. * Sets the distance from the start point to the hit point
  28209. * @param distance
  28210. */
  28211. setHitDistance(distance: number): void;
  28212. /**
  28213. * Calculates the distance manually
  28214. */
  28215. calculateHitDistance(): void;
  28216. /**
  28217. * Resets all the values to default
  28218. * @param from The from point on world space
  28219. * @param to The to point on world space
  28220. */
  28221. reset(from?: Vector3, to?: Vector3): void;
  28222. }
  28223. /**
  28224. * Interface for the size containing width and height
  28225. */
  28226. interface IXYZ {
  28227. /**
  28228. * X
  28229. */
  28230. x: number;
  28231. /**
  28232. * Y
  28233. */
  28234. y: number;
  28235. /**
  28236. * Z
  28237. */
  28238. z: number;
  28239. }
  28240. }
  28241. declare module "babylonjs/Physics/IPhysicsEngine" {
  28242. import { Nullable } from "babylonjs/types";
  28243. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  28244. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28245. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28246. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  28247. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  28248. /**
  28249. * Interface used to describe a physics joint
  28250. */
  28251. export interface PhysicsImpostorJoint {
  28252. /** Defines the main impostor to which the joint is linked */
  28253. mainImpostor: PhysicsImpostor;
  28254. /** Defines the impostor that is connected to the main impostor using this joint */
  28255. connectedImpostor: PhysicsImpostor;
  28256. /** Defines the joint itself */
  28257. joint: PhysicsJoint;
  28258. }
  28259. /** @hidden */
  28260. export interface IPhysicsEnginePlugin {
  28261. world: any;
  28262. name: string;
  28263. setGravity(gravity: Vector3): void;
  28264. setTimeStep(timeStep: number): void;
  28265. getTimeStep(): number;
  28266. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  28267. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28268. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28269. generatePhysicsBody(impostor: PhysicsImpostor): void;
  28270. removePhysicsBody(impostor: PhysicsImpostor): void;
  28271. generateJoint(joint: PhysicsImpostorJoint): void;
  28272. removeJoint(joint: PhysicsImpostorJoint): void;
  28273. isSupported(): boolean;
  28274. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  28275. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  28276. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28277. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28278. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28279. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28280. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  28281. getBodyMass(impostor: PhysicsImpostor): number;
  28282. getBodyFriction(impostor: PhysicsImpostor): number;
  28283. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  28284. getBodyRestitution(impostor: PhysicsImpostor): number;
  28285. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  28286. getBodyPressure?(impostor: PhysicsImpostor): number;
  28287. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  28288. getBodyStiffness?(impostor: PhysicsImpostor): number;
  28289. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  28290. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  28291. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  28292. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  28293. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  28294. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28295. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28296. sleepBody(impostor: PhysicsImpostor): void;
  28297. wakeUpBody(impostor: PhysicsImpostor): void;
  28298. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28299. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  28300. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  28301. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28302. getRadius(impostor: PhysicsImpostor): number;
  28303. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  28304. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  28305. dispose(): void;
  28306. }
  28307. /**
  28308. * Interface used to define a physics engine
  28309. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28310. */
  28311. export interface IPhysicsEngine {
  28312. /**
  28313. * Gets the gravity vector used by the simulation
  28314. */
  28315. gravity: Vector3;
  28316. /**
  28317. * Sets the gravity vector used by the simulation
  28318. * @param gravity defines the gravity vector to use
  28319. */
  28320. setGravity(gravity: Vector3): void;
  28321. /**
  28322. * Set the time step of the physics engine.
  28323. * Default is 1/60.
  28324. * To slow it down, enter 1/600 for example.
  28325. * To speed it up, 1/30
  28326. * @param newTimeStep the new timestep to apply to this world.
  28327. */
  28328. setTimeStep(newTimeStep: number): void;
  28329. /**
  28330. * Get the time step of the physics engine.
  28331. * @returns the current time step
  28332. */
  28333. getTimeStep(): number;
  28334. /**
  28335. * Set the sub time step of the physics engine.
  28336. * Default is 0 meaning there is no sub steps
  28337. * To increase physics resolution precision, set a small value (like 1 ms)
  28338. * @param subTimeStep defines the new sub timestep used for physics resolution.
  28339. */
  28340. setSubTimeStep(subTimeStep: number): void;
  28341. /**
  28342. * Get the sub time step of the physics engine.
  28343. * @returns the current sub time step
  28344. */
  28345. getSubTimeStep(): number;
  28346. /**
  28347. * Release all resources
  28348. */
  28349. dispose(): void;
  28350. /**
  28351. * Gets the name of the current physics plugin
  28352. * @returns the name of the plugin
  28353. */
  28354. getPhysicsPluginName(): string;
  28355. /**
  28356. * Adding a new impostor for the impostor tracking.
  28357. * This will be done by the impostor itself.
  28358. * @param impostor the impostor to add
  28359. */
  28360. addImpostor(impostor: PhysicsImpostor): void;
  28361. /**
  28362. * Remove an impostor from the engine.
  28363. * This impostor and its mesh will not longer be updated by the physics engine.
  28364. * @param impostor the impostor to remove
  28365. */
  28366. removeImpostor(impostor: PhysicsImpostor): void;
  28367. /**
  28368. * Add a joint to the physics engine
  28369. * @param mainImpostor defines the main impostor to which the joint is added.
  28370. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  28371. * @param joint defines the joint that will connect both impostors.
  28372. */
  28373. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28374. /**
  28375. * Removes a joint from the simulation
  28376. * @param mainImpostor defines the impostor used with the joint
  28377. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  28378. * @param joint defines the joint to remove
  28379. */
  28380. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28381. /**
  28382. * Gets the current plugin used to run the simulation
  28383. * @returns current plugin
  28384. */
  28385. getPhysicsPlugin(): IPhysicsEnginePlugin;
  28386. /**
  28387. * Gets the list of physic impostors
  28388. * @returns an array of PhysicsImpostor
  28389. */
  28390. getImpostors(): Array<PhysicsImpostor>;
  28391. /**
  28392. * Gets the impostor for a physics enabled object
  28393. * @param object defines the object impersonated by the impostor
  28394. * @returns the PhysicsImpostor or null if not found
  28395. */
  28396. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28397. /**
  28398. * Gets the impostor for a physics body object
  28399. * @param body defines physics body used by the impostor
  28400. * @returns the PhysicsImpostor or null if not found
  28401. */
  28402. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  28403. /**
  28404. * Does a raycast in the physics world
  28405. * @param from when should the ray start?
  28406. * @param to when should the ray end?
  28407. * @returns PhysicsRaycastResult
  28408. */
  28409. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28410. /**
  28411. * Called by the scene. No need to call it.
  28412. * @param delta defines the timespam between frames
  28413. */
  28414. _step(delta: number): void;
  28415. }
  28416. }
  28417. declare module "babylonjs/Physics/physicsImpostor" {
  28418. import { Nullable, IndicesArray } from "babylonjs/types";
  28419. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  28420. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28421. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28422. import { Scene } from "babylonjs/scene";
  28423. import { Bone } from "babylonjs/Bones/bone";
  28424. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  28425. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  28426. import { Space } from "babylonjs/Maths/math.axis";
  28427. /**
  28428. * The interface for the physics imposter parameters
  28429. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28430. */
  28431. export interface PhysicsImpostorParameters {
  28432. /**
  28433. * The mass of the physics imposter
  28434. */
  28435. mass: number;
  28436. /**
  28437. * The friction of the physics imposter
  28438. */
  28439. friction?: number;
  28440. /**
  28441. * The coefficient of restitution of the physics imposter
  28442. */
  28443. restitution?: number;
  28444. /**
  28445. * The native options of the physics imposter
  28446. */
  28447. nativeOptions?: any;
  28448. /**
  28449. * Specifies if the parent should be ignored
  28450. */
  28451. ignoreParent?: boolean;
  28452. /**
  28453. * Specifies if bi-directional transformations should be disabled
  28454. */
  28455. disableBidirectionalTransformation?: boolean;
  28456. /**
  28457. * The pressure inside the physics imposter, soft object only
  28458. */
  28459. pressure?: number;
  28460. /**
  28461. * The stiffness the physics imposter, soft object only
  28462. */
  28463. stiffness?: number;
  28464. /**
  28465. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  28466. */
  28467. velocityIterations?: number;
  28468. /**
  28469. * The number of iterations used in maintaining consistent vertex positions, soft object only
  28470. */
  28471. positionIterations?: number;
  28472. /**
  28473. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  28474. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  28475. * Add to fix multiple points
  28476. */
  28477. fixedPoints?: number;
  28478. /**
  28479. * The collision margin around a soft object
  28480. */
  28481. margin?: number;
  28482. /**
  28483. * The collision margin around a soft object
  28484. */
  28485. damping?: number;
  28486. /**
  28487. * The path for a rope based on an extrusion
  28488. */
  28489. path?: any;
  28490. /**
  28491. * The shape of an extrusion used for a rope based on an extrusion
  28492. */
  28493. shape?: any;
  28494. }
  28495. /**
  28496. * Interface for a physics-enabled object
  28497. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28498. */
  28499. export interface IPhysicsEnabledObject {
  28500. /**
  28501. * The position of the physics-enabled object
  28502. */
  28503. position: Vector3;
  28504. /**
  28505. * The rotation of the physics-enabled object
  28506. */
  28507. rotationQuaternion: Nullable<Quaternion>;
  28508. /**
  28509. * The scale of the physics-enabled object
  28510. */
  28511. scaling: Vector3;
  28512. /**
  28513. * The rotation of the physics-enabled object
  28514. */
  28515. rotation?: Vector3;
  28516. /**
  28517. * The parent of the physics-enabled object
  28518. */
  28519. parent?: any;
  28520. /**
  28521. * The bounding info of the physics-enabled object
  28522. * @returns The bounding info of the physics-enabled object
  28523. */
  28524. getBoundingInfo(): BoundingInfo;
  28525. /**
  28526. * Computes the world matrix
  28527. * @param force Specifies if the world matrix should be computed by force
  28528. * @returns A world matrix
  28529. */
  28530. computeWorldMatrix(force: boolean): Matrix;
  28531. /**
  28532. * Gets the world matrix
  28533. * @returns A world matrix
  28534. */
  28535. getWorldMatrix?(): Matrix;
  28536. /**
  28537. * Gets the child meshes
  28538. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  28539. * @returns An array of abstract meshes
  28540. */
  28541. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  28542. /**
  28543. * Gets the vertex data
  28544. * @param kind The type of vertex data
  28545. * @returns A nullable array of numbers, or a float32 array
  28546. */
  28547. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  28548. /**
  28549. * Gets the indices from the mesh
  28550. * @returns A nullable array of index arrays
  28551. */
  28552. getIndices?(): Nullable<IndicesArray>;
  28553. /**
  28554. * Gets the scene from the mesh
  28555. * @returns the indices array or null
  28556. */
  28557. getScene?(): Scene;
  28558. /**
  28559. * Gets the absolute position from the mesh
  28560. * @returns the absolute position
  28561. */
  28562. getAbsolutePosition(): Vector3;
  28563. /**
  28564. * Gets the absolute pivot point from the mesh
  28565. * @returns the absolute pivot point
  28566. */
  28567. getAbsolutePivotPoint(): Vector3;
  28568. /**
  28569. * Rotates the mesh
  28570. * @param axis The axis of rotation
  28571. * @param amount The amount of rotation
  28572. * @param space The space of the rotation
  28573. * @returns The rotation transform node
  28574. */
  28575. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  28576. /**
  28577. * Translates the mesh
  28578. * @param axis The axis of translation
  28579. * @param distance The distance of translation
  28580. * @param space The space of the translation
  28581. * @returns The transform node
  28582. */
  28583. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  28584. /**
  28585. * Sets the absolute position of the mesh
  28586. * @param absolutePosition The absolute position of the mesh
  28587. * @returns The transform node
  28588. */
  28589. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  28590. /**
  28591. * Gets the class name of the mesh
  28592. * @returns The class name
  28593. */
  28594. getClassName(): string;
  28595. }
  28596. /**
  28597. * Represents a physics imposter
  28598. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28599. */
  28600. export class PhysicsImpostor {
  28601. /**
  28602. * The physics-enabled object used as the physics imposter
  28603. */
  28604. object: IPhysicsEnabledObject;
  28605. /**
  28606. * The type of the physics imposter
  28607. */
  28608. type: number;
  28609. private _options;
  28610. private _scene?;
  28611. /**
  28612. * The default object size of the imposter
  28613. */
  28614. static DEFAULT_OBJECT_SIZE: Vector3;
  28615. /**
  28616. * The identity quaternion of the imposter
  28617. */
  28618. static IDENTITY_QUATERNION: Quaternion;
  28619. /** @hidden */
  28620. _pluginData: any;
  28621. private _physicsEngine;
  28622. private _physicsBody;
  28623. private _bodyUpdateRequired;
  28624. private _onBeforePhysicsStepCallbacks;
  28625. private _onAfterPhysicsStepCallbacks;
  28626. /** @hidden */
  28627. _onPhysicsCollideCallbacks: Array<{
  28628. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  28629. otherImpostors: Array<PhysicsImpostor>;
  28630. }>;
  28631. private _deltaPosition;
  28632. private _deltaRotation;
  28633. private _deltaRotationConjugated;
  28634. /** @hidden */
  28635. _isFromLine: boolean;
  28636. private _parent;
  28637. private _isDisposed;
  28638. private static _tmpVecs;
  28639. private static _tmpQuat;
  28640. /**
  28641. * Specifies if the physics imposter is disposed
  28642. */
  28643. get isDisposed(): boolean;
  28644. /**
  28645. * Gets the mass of the physics imposter
  28646. */
  28647. get mass(): number;
  28648. set mass(value: number);
  28649. /**
  28650. * Gets the coefficient of friction
  28651. */
  28652. get friction(): number;
  28653. /**
  28654. * Sets the coefficient of friction
  28655. */
  28656. set friction(value: number);
  28657. /**
  28658. * Gets the coefficient of restitution
  28659. */
  28660. get restitution(): number;
  28661. /**
  28662. * Sets the coefficient of restitution
  28663. */
  28664. set restitution(value: number);
  28665. /**
  28666. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  28667. */
  28668. get pressure(): number;
  28669. /**
  28670. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  28671. */
  28672. set pressure(value: number);
  28673. /**
  28674. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28675. */
  28676. get stiffness(): number;
  28677. /**
  28678. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28679. */
  28680. set stiffness(value: number);
  28681. /**
  28682. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28683. */
  28684. get velocityIterations(): number;
  28685. /**
  28686. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28687. */
  28688. set velocityIterations(value: number);
  28689. /**
  28690. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28691. */
  28692. get positionIterations(): number;
  28693. /**
  28694. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28695. */
  28696. set positionIterations(value: number);
  28697. /**
  28698. * The unique id of the physics imposter
  28699. * set by the physics engine when adding this impostor to the array
  28700. */
  28701. uniqueId: number;
  28702. /**
  28703. * @hidden
  28704. */
  28705. soft: boolean;
  28706. /**
  28707. * @hidden
  28708. */
  28709. segments: number;
  28710. private _joints;
  28711. /**
  28712. * Initializes the physics imposter
  28713. * @param object The physics-enabled object used as the physics imposter
  28714. * @param type The type of the physics imposter
  28715. * @param _options The options for the physics imposter
  28716. * @param _scene The Babylon scene
  28717. */
  28718. constructor(
  28719. /**
  28720. * The physics-enabled object used as the physics imposter
  28721. */
  28722. object: IPhysicsEnabledObject,
  28723. /**
  28724. * The type of the physics imposter
  28725. */
  28726. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  28727. /**
  28728. * This function will completly initialize this impostor.
  28729. * It will create a new body - but only if this mesh has no parent.
  28730. * If it has, this impostor will not be used other than to define the impostor
  28731. * of the child mesh.
  28732. * @hidden
  28733. */
  28734. _init(): void;
  28735. private _getPhysicsParent;
  28736. /**
  28737. * Should a new body be generated.
  28738. * @returns boolean specifying if body initialization is required
  28739. */
  28740. isBodyInitRequired(): boolean;
  28741. /**
  28742. * Sets the updated scaling
  28743. * @param updated Specifies if the scaling is updated
  28744. */
  28745. setScalingUpdated(): void;
  28746. /**
  28747. * Force a regeneration of this or the parent's impostor's body.
  28748. * Use under cautious - This will remove all joints already implemented.
  28749. */
  28750. forceUpdate(): void;
  28751. /**
  28752. * Gets the body that holds this impostor. Either its own, or its parent.
  28753. */
  28754. get physicsBody(): any;
  28755. /**
  28756. * Get the parent of the physics imposter
  28757. * @returns Physics imposter or null
  28758. */
  28759. get parent(): Nullable<PhysicsImpostor>;
  28760. /**
  28761. * Sets the parent of the physics imposter
  28762. */
  28763. set parent(value: Nullable<PhysicsImpostor>);
  28764. /**
  28765. * Set the physics body. Used mainly by the physics engine/plugin
  28766. */
  28767. set physicsBody(physicsBody: any);
  28768. /**
  28769. * Resets the update flags
  28770. */
  28771. resetUpdateFlags(): void;
  28772. /**
  28773. * Gets the object extend size
  28774. * @returns the object extend size
  28775. */
  28776. getObjectExtendSize(): Vector3;
  28777. /**
  28778. * Gets the object center
  28779. * @returns The object center
  28780. */
  28781. getObjectCenter(): Vector3;
  28782. /**
  28783. * Get a specific parameter from the options parameters
  28784. * @param paramName The object parameter name
  28785. * @returns The object parameter
  28786. */
  28787. getParam(paramName: string): any;
  28788. /**
  28789. * Sets a specific parameter in the options given to the physics plugin
  28790. * @param paramName The parameter name
  28791. * @param value The value of the parameter
  28792. */
  28793. setParam(paramName: string, value: number): void;
  28794. /**
  28795. * Specifically change the body's mass option. Won't recreate the physics body object
  28796. * @param mass The mass of the physics imposter
  28797. */
  28798. setMass(mass: number): void;
  28799. /**
  28800. * Gets the linear velocity
  28801. * @returns linear velocity or null
  28802. */
  28803. getLinearVelocity(): Nullable<Vector3>;
  28804. /**
  28805. * Sets the linear velocity
  28806. * @param velocity linear velocity or null
  28807. */
  28808. setLinearVelocity(velocity: Nullable<Vector3>): void;
  28809. /**
  28810. * Gets the angular velocity
  28811. * @returns angular velocity or null
  28812. */
  28813. getAngularVelocity(): Nullable<Vector3>;
  28814. /**
  28815. * Sets the angular velocity
  28816. * @param velocity The velocity or null
  28817. */
  28818. setAngularVelocity(velocity: Nullable<Vector3>): void;
  28819. /**
  28820. * Execute a function with the physics plugin native code
  28821. * Provide a function the will have two variables - the world object and the physics body object
  28822. * @param func The function to execute with the physics plugin native code
  28823. */
  28824. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  28825. /**
  28826. * Register a function that will be executed before the physics world is stepping forward
  28827. * @param func The function to execute before the physics world is stepped forward
  28828. */
  28829. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28830. /**
  28831. * Unregister a function that will be executed before the physics world is stepping forward
  28832. * @param func The function to execute before the physics world is stepped forward
  28833. */
  28834. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28835. /**
  28836. * Register a function that will be executed after the physics step
  28837. * @param func The function to execute after physics step
  28838. */
  28839. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28840. /**
  28841. * Unregisters a function that will be executed after the physics step
  28842. * @param func The function to execute after physics step
  28843. */
  28844. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28845. /**
  28846. * register a function that will be executed when this impostor collides against a different body
  28847. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  28848. * @param func Callback that is executed on collision
  28849. */
  28850. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  28851. /**
  28852. * Unregisters the physics imposter on contact
  28853. * @param collideAgainst The physics object to collide against
  28854. * @param func Callback to execute on collision
  28855. */
  28856. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  28857. private _tmpQuat;
  28858. private _tmpQuat2;
  28859. /**
  28860. * Get the parent rotation
  28861. * @returns The parent rotation
  28862. */
  28863. getParentsRotation(): Quaternion;
  28864. /**
  28865. * this function is executed by the physics engine.
  28866. */
  28867. beforeStep: () => void;
  28868. /**
  28869. * this function is executed by the physics engine
  28870. */
  28871. afterStep: () => void;
  28872. /**
  28873. * Legacy collision detection event support
  28874. */
  28875. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  28876. /**
  28877. * event and body object due to cannon's event-based architecture.
  28878. */
  28879. onCollide: (e: {
  28880. body: any;
  28881. }) => void;
  28882. /**
  28883. * Apply a force
  28884. * @param force The force to apply
  28885. * @param contactPoint The contact point for the force
  28886. * @returns The physics imposter
  28887. */
  28888. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28889. /**
  28890. * Apply an impulse
  28891. * @param force The impulse force
  28892. * @param contactPoint The contact point for the impulse force
  28893. * @returns The physics imposter
  28894. */
  28895. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28896. /**
  28897. * A help function to create a joint
  28898. * @param otherImpostor A physics imposter used to create a joint
  28899. * @param jointType The type of joint
  28900. * @param jointData The data for the joint
  28901. * @returns The physics imposter
  28902. */
  28903. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  28904. /**
  28905. * Add a joint to this impostor with a different impostor
  28906. * @param otherImpostor A physics imposter used to add a joint
  28907. * @param joint The joint to add
  28908. * @returns The physics imposter
  28909. */
  28910. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  28911. /**
  28912. * Add an anchor to a cloth impostor
  28913. * @param otherImpostor rigid impostor to anchor to
  28914. * @param width ratio across width from 0 to 1
  28915. * @param height ratio up height from 0 to 1
  28916. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  28917. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  28918. * @returns impostor the soft imposter
  28919. */
  28920. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28921. /**
  28922. * Add a hook to a rope impostor
  28923. * @param otherImpostor rigid impostor to anchor to
  28924. * @param length ratio across rope from 0 to 1
  28925. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  28926. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  28927. * @returns impostor the rope imposter
  28928. */
  28929. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28930. /**
  28931. * Will keep this body still, in a sleep mode.
  28932. * @returns the physics imposter
  28933. */
  28934. sleep(): PhysicsImpostor;
  28935. /**
  28936. * Wake the body up.
  28937. * @returns The physics imposter
  28938. */
  28939. wakeUp(): PhysicsImpostor;
  28940. /**
  28941. * Clones the physics imposter
  28942. * @param newObject The physics imposter clones to this physics-enabled object
  28943. * @returns A nullable physics imposter
  28944. */
  28945. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28946. /**
  28947. * Disposes the physics imposter
  28948. */
  28949. dispose(): void;
  28950. /**
  28951. * Sets the delta position
  28952. * @param position The delta position amount
  28953. */
  28954. setDeltaPosition(position: Vector3): void;
  28955. /**
  28956. * Sets the delta rotation
  28957. * @param rotation The delta rotation amount
  28958. */
  28959. setDeltaRotation(rotation: Quaternion): void;
  28960. /**
  28961. * Gets the box size of the physics imposter and stores the result in the input parameter
  28962. * @param result Stores the box size
  28963. * @returns The physics imposter
  28964. */
  28965. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  28966. /**
  28967. * Gets the radius of the physics imposter
  28968. * @returns Radius of the physics imposter
  28969. */
  28970. getRadius(): number;
  28971. /**
  28972. * Sync a bone with this impostor
  28973. * @param bone The bone to sync to the impostor.
  28974. * @param boneMesh The mesh that the bone is influencing.
  28975. * @param jointPivot The pivot of the joint / bone in local space.
  28976. * @param distToJoint Optional distance from the impostor to the joint.
  28977. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28978. */
  28979. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  28980. /**
  28981. * Sync impostor to a bone
  28982. * @param bone The bone that the impostor will be synced to.
  28983. * @param boneMesh The mesh that the bone is influencing.
  28984. * @param jointPivot The pivot of the joint / bone in local space.
  28985. * @param distToJoint Optional distance from the impostor to the joint.
  28986. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28987. * @param boneAxis Optional vector3 axis the bone is aligned with
  28988. */
  28989. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  28990. /**
  28991. * No-Imposter type
  28992. */
  28993. static NoImpostor: number;
  28994. /**
  28995. * Sphere-Imposter type
  28996. */
  28997. static SphereImpostor: number;
  28998. /**
  28999. * Box-Imposter type
  29000. */
  29001. static BoxImpostor: number;
  29002. /**
  29003. * Plane-Imposter type
  29004. */
  29005. static PlaneImpostor: number;
  29006. /**
  29007. * Mesh-imposter type
  29008. */
  29009. static MeshImpostor: number;
  29010. /**
  29011. * Capsule-Impostor type (Ammo.js plugin only)
  29012. */
  29013. static CapsuleImpostor: number;
  29014. /**
  29015. * Cylinder-Imposter type
  29016. */
  29017. static CylinderImpostor: number;
  29018. /**
  29019. * Particle-Imposter type
  29020. */
  29021. static ParticleImpostor: number;
  29022. /**
  29023. * Heightmap-Imposter type
  29024. */
  29025. static HeightmapImpostor: number;
  29026. /**
  29027. * ConvexHull-Impostor type (Ammo.js plugin only)
  29028. */
  29029. static ConvexHullImpostor: number;
  29030. /**
  29031. * Custom-Imposter type (Ammo.js plugin only)
  29032. */
  29033. static CustomImpostor: number;
  29034. /**
  29035. * Rope-Imposter type
  29036. */
  29037. static RopeImpostor: number;
  29038. /**
  29039. * Cloth-Imposter type
  29040. */
  29041. static ClothImpostor: number;
  29042. /**
  29043. * Softbody-Imposter type
  29044. */
  29045. static SoftbodyImpostor: number;
  29046. }
  29047. }
  29048. declare module "babylonjs/Meshes/mesh" {
  29049. import { Observable } from "babylonjs/Misc/observable";
  29050. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  29051. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  29052. import { Camera } from "babylonjs/Cameras/camera";
  29053. import { Scene } from "babylonjs/scene";
  29054. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  29055. import { Color4 } from "babylonjs/Maths/math.color";
  29056. import { Engine } from "babylonjs/Engines/engine";
  29057. import { Node } from "babylonjs/node";
  29058. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  29059. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  29060. import { Buffer } from "babylonjs/Meshes/buffer";
  29061. import { Geometry } from "babylonjs/Meshes/geometry";
  29062. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29063. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29064. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  29065. import { Effect } from "babylonjs/Materials/effect";
  29066. import { Material } from "babylonjs/Materials/material";
  29067. import { Skeleton } from "babylonjs/Bones/skeleton";
  29068. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  29069. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  29070. import { Path3D } from "babylonjs/Maths/math.path";
  29071. import { Plane } from "babylonjs/Maths/math.plane";
  29072. import { TransformNode } from "babylonjs/Meshes/transformNode";
  29073. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  29074. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  29075. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  29076. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  29077. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  29078. /**
  29079. * @hidden
  29080. **/
  29081. export class _CreationDataStorage {
  29082. closePath?: boolean;
  29083. closeArray?: boolean;
  29084. idx: number[];
  29085. dashSize: number;
  29086. gapSize: number;
  29087. path3D: Path3D;
  29088. pathArray: Vector3[][];
  29089. arc: number;
  29090. radius: number;
  29091. cap: number;
  29092. tessellation: number;
  29093. }
  29094. /**
  29095. * @hidden
  29096. **/
  29097. class _InstanceDataStorage {
  29098. visibleInstances: any;
  29099. batchCache: _InstancesBatch;
  29100. instancesBufferSize: number;
  29101. instancesBuffer: Nullable<Buffer>;
  29102. instancesData: Float32Array;
  29103. overridenInstanceCount: number;
  29104. isFrozen: boolean;
  29105. previousBatch: Nullable<_InstancesBatch>;
  29106. hardwareInstancedRendering: boolean;
  29107. sideOrientation: number;
  29108. manualUpdate: boolean;
  29109. }
  29110. /**
  29111. * @hidden
  29112. **/
  29113. export class _InstancesBatch {
  29114. mustReturn: boolean;
  29115. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  29116. renderSelf: boolean[];
  29117. hardwareInstancedRendering: boolean[];
  29118. }
  29119. /**
  29120. * @hidden
  29121. **/
  29122. class _ThinInstanceDataStorage {
  29123. instancesCount: number;
  29124. matrixBuffer: Nullable<Buffer>;
  29125. matrixBufferSize: number;
  29126. matrixData: Nullable<Float32Array>;
  29127. boundingVectors: Array<Vector3>;
  29128. worldMatrices: Nullable<Matrix[]>;
  29129. }
  29130. /**
  29131. * Class used to represent renderable models
  29132. */
  29133. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  29134. /**
  29135. * Mesh side orientation : usually the external or front surface
  29136. */
  29137. static readonly FRONTSIDE: number;
  29138. /**
  29139. * Mesh side orientation : usually the internal or back surface
  29140. */
  29141. static readonly BACKSIDE: number;
  29142. /**
  29143. * Mesh side orientation : both internal and external or front and back surfaces
  29144. */
  29145. static readonly DOUBLESIDE: number;
  29146. /**
  29147. * Mesh side orientation : by default, `FRONTSIDE`
  29148. */
  29149. static readonly DEFAULTSIDE: number;
  29150. /**
  29151. * Mesh cap setting : no cap
  29152. */
  29153. static readonly NO_CAP: number;
  29154. /**
  29155. * Mesh cap setting : one cap at the beginning of the mesh
  29156. */
  29157. static readonly CAP_START: number;
  29158. /**
  29159. * Mesh cap setting : one cap at the end of the mesh
  29160. */
  29161. static readonly CAP_END: number;
  29162. /**
  29163. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  29164. */
  29165. static readonly CAP_ALL: number;
  29166. /**
  29167. * Mesh pattern setting : no flip or rotate
  29168. */
  29169. static readonly NO_FLIP: number;
  29170. /**
  29171. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  29172. */
  29173. static readonly FLIP_TILE: number;
  29174. /**
  29175. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  29176. */
  29177. static readonly ROTATE_TILE: number;
  29178. /**
  29179. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  29180. */
  29181. static readonly FLIP_ROW: number;
  29182. /**
  29183. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  29184. */
  29185. static readonly ROTATE_ROW: number;
  29186. /**
  29187. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  29188. */
  29189. static readonly FLIP_N_ROTATE_TILE: number;
  29190. /**
  29191. * Mesh pattern setting : rotate pattern and rotate
  29192. */
  29193. static readonly FLIP_N_ROTATE_ROW: number;
  29194. /**
  29195. * Mesh tile positioning : part tiles same on left/right or top/bottom
  29196. */
  29197. static readonly CENTER: number;
  29198. /**
  29199. * Mesh tile positioning : part tiles on left
  29200. */
  29201. static readonly LEFT: number;
  29202. /**
  29203. * Mesh tile positioning : part tiles on right
  29204. */
  29205. static readonly RIGHT: number;
  29206. /**
  29207. * Mesh tile positioning : part tiles on top
  29208. */
  29209. static readonly TOP: number;
  29210. /**
  29211. * Mesh tile positioning : part tiles on bottom
  29212. */
  29213. static readonly BOTTOM: number;
  29214. /**
  29215. * Gets the default side orientation.
  29216. * @param orientation the orientation to value to attempt to get
  29217. * @returns the default orientation
  29218. * @hidden
  29219. */
  29220. static _GetDefaultSideOrientation(orientation?: number): number;
  29221. private _internalMeshDataInfo;
  29222. get computeBonesUsingShaders(): boolean;
  29223. set computeBonesUsingShaders(value: boolean);
  29224. /**
  29225. * An event triggered before rendering the mesh
  29226. */
  29227. get onBeforeRenderObservable(): Observable<Mesh>;
  29228. /**
  29229. * An event triggered before binding the mesh
  29230. */
  29231. get onBeforeBindObservable(): Observable<Mesh>;
  29232. /**
  29233. * An event triggered after rendering the mesh
  29234. */
  29235. get onAfterRenderObservable(): Observable<Mesh>;
  29236. /**
  29237. * An event triggered before drawing the mesh
  29238. */
  29239. get onBeforeDrawObservable(): Observable<Mesh>;
  29240. private _onBeforeDrawObserver;
  29241. /**
  29242. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  29243. */
  29244. set onBeforeDraw(callback: () => void);
  29245. get hasInstances(): boolean;
  29246. get hasThinInstances(): boolean;
  29247. /**
  29248. * Gets the delay loading state of the mesh (when delay loading is turned on)
  29249. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  29250. */
  29251. delayLoadState: number;
  29252. /**
  29253. * Gets the list of instances created from this mesh
  29254. * it is not supposed to be modified manually.
  29255. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  29256. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29257. */
  29258. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  29259. /**
  29260. * Gets the file containing delay loading data for this mesh
  29261. */
  29262. delayLoadingFile: string;
  29263. /** @hidden */
  29264. _binaryInfo: any;
  29265. /**
  29266. * User defined function used to change how LOD level selection is done
  29267. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29268. */
  29269. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  29270. /**
  29271. * Gets or sets the morph target manager
  29272. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  29273. */
  29274. get morphTargetManager(): Nullable<MorphTargetManager>;
  29275. set morphTargetManager(value: Nullable<MorphTargetManager>);
  29276. /** @hidden */
  29277. _creationDataStorage: Nullable<_CreationDataStorage>;
  29278. /** @hidden */
  29279. _geometry: Nullable<Geometry>;
  29280. /** @hidden */
  29281. _delayInfo: Array<string>;
  29282. /** @hidden */
  29283. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  29284. /** @hidden */
  29285. _instanceDataStorage: _InstanceDataStorage;
  29286. /** @hidden */
  29287. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  29288. private _effectiveMaterial;
  29289. /** @hidden */
  29290. _shouldGenerateFlatShading: boolean;
  29291. /** @hidden */
  29292. _originalBuilderSideOrientation: number;
  29293. /**
  29294. * Use this property to change the original side orientation defined at construction time
  29295. */
  29296. overrideMaterialSideOrientation: Nullable<number>;
  29297. /**
  29298. * Gets the source mesh (the one used to clone this one from)
  29299. */
  29300. get source(): Nullable<Mesh>;
  29301. /**
  29302. * Gets the list of clones of this mesh
  29303. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  29304. * Note that useClonedMeshMap=true is the default setting
  29305. */
  29306. get cloneMeshMap(): Nullable<{
  29307. [id: string]: Mesh | undefined;
  29308. }>;
  29309. /**
  29310. * Gets or sets a boolean indicating that this mesh does not use index buffer
  29311. */
  29312. get isUnIndexed(): boolean;
  29313. set isUnIndexed(value: boolean);
  29314. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29315. get worldMatrixInstancedBuffer(): Float32Array;
  29316. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29317. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29318. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29319. /**
  29320. * @constructor
  29321. * @param name The value used by scene.getMeshByName() to do a lookup.
  29322. * @param scene The scene to add this mesh to.
  29323. * @param parent The parent of this mesh, if it has one
  29324. * @param source An optional Mesh from which geometry is shared, cloned.
  29325. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29326. * When false, achieved by calling a clone(), also passing False.
  29327. * This will make creation of children, recursive.
  29328. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29329. */
  29330. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29331. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29332. doNotInstantiate: boolean;
  29333. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29334. /**
  29335. * Gets the class name
  29336. * @returns the string "Mesh".
  29337. */
  29338. getClassName(): string;
  29339. /** @hidden */
  29340. get _isMesh(): boolean;
  29341. /**
  29342. * Returns a description of this mesh
  29343. * @param fullDetails define if full details about this mesh must be used
  29344. * @returns a descriptive string representing this mesh
  29345. */
  29346. toString(fullDetails?: boolean): string;
  29347. /** @hidden */
  29348. _unBindEffect(): void;
  29349. /**
  29350. * Gets a boolean indicating if this mesh has LOD
  29351. */
  29352. get hasLODLevels(): boolean;
  29353. /**
  29354. * Gets the list of MeshLODLevel associated with the current mesh
  29355. * @returns an array of MeshLODLevel
  29356. */
  29357. getLODLevels(): MeshLODLevel[];
  29358. private _sortLODLevels;
  29359. /**
  29360. * Add a mesh as LOD level triggered at the given distance.
  29361. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29362. * @param distance The distance from the center of the object to show this level
  29363. * @param mesh The mesh to be added as LOD level (can be null)
  29364. * @return This mesh (for chaining)
  29365. */
  29366. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29367. /**
  29368. * Returns the LOD level mesh at the passed distance or null if not found.
  29369. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29370. * @param distance The distance from the center of the object to show this level
  29371. * @returns a Mesh or `null`
  29372. */
  29373. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29374. /**
  29375. * Remove a mesh from the LOD array
  29376. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29377. * @param mesh defines the mesh to be removed
  29378. * @return This mesh (for chaining)
  29379. */
  29380. removeLODLevel(mesh: Mesh): Mesh;
  29381. /**
  29382. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29383. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29384. * @param camera defines the camera to use to compute distance
  29385. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29386. * @return This mesh (for chaining)
  29387. */
  29388. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29389. /**
  29390. * Gets the mesh internal Geometry object
  29391. */
  29392. get geometry(): Nullable<Geometry>;
  29393. /**
  29394. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29395. * @returns the total number of vertices
  29396. */
  29397. getTotalVertices(): number;
  29398. /**
  29399. * Returns the content of an associated vertex buffer
  29400. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29401. * - VertexBuffer.PositionKind
  29402. * - VertexBuffer.UVKind
  29403. * - VertexBuffer.UV2Kind
  29404. * - VertexBuffer.UV3Kind
  29405. * - VertexBuffer.UV4Kind
  29406. * - VertexBuffer.UV5Kind
  29407. * - VertexBuffer.UV6Kind
  29408. * - VertexBuffer.ColorKind
  29409. * - VertexBuffer.MatricesIndicesKind
  29410. * - VertexBuffer.MatricesIndicesExtraKind
  29411. * - VertexBuffer.MatricesWeightsKind
  29412. * - VertexBuffer.MatricesWeightsExtraKind
  29413. * @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
  29414. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29415. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29416. */
  29417. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29418. /**
  29419. * Returns the mesh VertexBuffer object from the requested `kind`
  29420. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29421. * - VertexBuffer.PositionKind
  29422. * - VertexBuffer.NormalKind
  29423. * - VertexBuffer.UVKind
  29424. * - VertexBuffer.UV2Kind
  29425. * - VertexBuffer.UV3Kind
  29426. * - VertexBuffer.UV4Kind
  29427. * - VertexBuffer.UV5Kind
  29428. * - VertexBuffer.UV6Kind
  29429. * - VertexBuffer.ColorKind
  29430. * - VertexBuffer.MatricesIndicesKind
  29431. * - VertexBuffer.MatricesIndicesExtraKind
  29432. * - VertexBuffer.MatricesWeightsKind
  29433. * - VertexBuffer.MatricesWeightsExtraKind
  29434. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29435. */
  29436. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29437. /**
  29438. * Tests if a specific vertex buffer is associated with this mesh
  29439. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29440. * - VertexBuffer.PositionKind
  29441. * - VertexBuffer.NormalKind
  29442. * - VertexBuffer.UVKind
  29443. * - VertexBuffer.UV2Kind
  29444. * - VertexBuffer.UV3Kind
  29445. * - VertexBuffer.UV4Kind
  29446. * - VertexBuffer.UV5Kind
  29447. * - VertexBuffer.UV6Kind
  29448. * - VertexBuffer.ColorKind
  29449. * - VertexBuffer.MatricesIndicesKind
  29450. * - VertexBuffer.MatricesIndicesExtraKind
  29451. * - VertexBuffer.MatricesWeightsKind
  29452. * - VertexBuffer.MatricesWeightsExtraKind
  29453. * @returns a boolean
  29454. */
  29455. isVerticesDataPresent(kind: string): boolean;
  29456. /**
  29457. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29458. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29459. * - VertexBuffer.PositionKind
  29460. * - VertexBuffer.UVKind
  29461. * - VertexBuffer.UV2Kind
  29462. * - VertexBuffer.UV3Kind
  29463. * - VertexBuffer.UV4Kind
  29464. * - VertexBuffer.UV5Kind
  29465. * - VertexBuffer.UV6Kind
  29466. * - VertexBuffer.ColorKind
  29467. * - VertexBuffer.MatricesIndicesKind
  29468. * - VertexBuffer.MatricesIndicesExtraKind
  29469. * - VertexBuffer.MatricesWeightsKind
  29470. * - VertexBuffer.MatricesWeightsExtraKind
  29471. * @returns a boolean
  29472. */
  29473. isVertexBufferUpdatable(kind: string): boolean;
  29474. /**
  29475. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29476. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29477. * - VertexBuffer.PositionKind
  29478. * - VertexBuffer.NormalKind
  29479. * - VertexBuffer.UVKind
  29480. * - VertexBuffer.UV2Kind
  29481. * - VertexBuffer.UV3Kind
  29482. * - VertexBuffer.UV4Kind
  29483. * - VertexBuffer.UV5Kind
  29484. * - VertexBuffer.UV6Kind
  29485. * - VertexBuffer.ColorKind
  29486. * - VertexBuffer.MatricesIndicesKind
  29487. * - VertexBuffer.MatricesIndicesExtraKind
  29488. * - VertexBuffer.MatricesWeightsKind
  29489. * - VertexBuffer.MatricesWeightsExtraKind
  29490. * @returns an array of strings
  29491. */
  29492. getVerticesDataKinds(): string[];
  29493. /**
  29494. * Returns a positive integer : the total number of indices in this mesh geometry.
  29495. * @returns the numner of indices or zero if the mesh has no geometry.
  29496. */
  29497. getTotalIndices(): number;
  29498. /**
  29499. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29500. * @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.
  29501. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29502. * @returns the indices array or an empty array if the mesh has no geometry
  29503. */
  29504. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29505. get isBlocked(): boolean;
  29506. /**
  29507. * Determine if the current mesh is ready to be rendered
  29508. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29509. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29510. * @returns true if all associated assets are ready (material, textures, shaders)
  29511. */
  29512. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29513. /**
  29514. * 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.
  29515. */
  29516. get areNormalsFrozen(): boolean;
  29517. /**
  29518. * 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.
  29519. * @returns the current mesh
  29520. */
  29521. freezeNormals(): Mesh;
  29522. /**
  29523. * 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
  29524. * @returns the current mesh
  29525. */
  29526. unfreezeNormals(): Mesh;
  29527. /**
  29528. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29529. */
  29530. set overridenInstanceCount(count: number);
  29531. /** @hidden */
  29532. _preActivate(): Mesh;
  29533. /** @hidden */
  29534. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29535. /** @hidden */
  29536. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29537. protected _afterComputeWorldMatrix(): void;
  29538. /** @hidden */
  29539. _postActivate(): void;
  29540. /**
  29541. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29542. * This means the mesh underlying bounding box and sphere are recomputed.
  29543. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29544. * @returns the current mesh
  29545. */
  29546. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29547. /** @hidden */
  29548. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29549. /**
  29550. * This function will subdivide the mesh into multiple submeshes
  29551. * @param count defines the expected number of submeshes
  29552. */
  29553. subdivide(count: number): void;
  29554. /**
  29555. * Copy a FloatArray into a specific associated vertex buffer
  29556. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29557. * - VertexBuffer.PositionKind
  29558. * - VertexBuffer.UVKind
  29559. * - VertexBuffer.UV2Kind
  29560. * - VertexBuffer.UV3Kind
  29561. * - VertexBuffer.UV4Kind
  29562. * - VertexBuffer.UV5Kind
  29563. * - VertexBuffer.UV6Kind
  29564. * - VertexBuffer.ColorKind
  29565. * - VertexBuffer.MatricesIndicesKind
  29566. * - VertexBuffer.MatricesIndicesExtraKind
  29567. * - VertexBuffer.MatricesWeightsKind
  29568. * - VertexBuffer.MatricesWeightsExtraKind
  29569. * @param data defines the data source
  29570. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29571. * @param stride defines the data stride size (can be null)
  29572. * @returns the current mesh
  29573. */
  29574. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29575. /**
  29576. * Delete a vertex buffer associated with this mesh
  29577. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29578. * - VertexBuffer.PositionKind
  29579. * - VertexBuffer.UVKind
  29580. * - VertexBuffer.UV2Kind
  29581. * - VertexBuffer.UV3Kind
  29582. * - VertexBuffer.UV4Kind
  29583. * - VertexBuffer.UV5Kind
  29584. * - VertexBuffer.UV6Kind
  29585. * - VertexBuffer.ColorKind
  29586. * - VertexBuffer.MatricesIndicesKind
  29587. * - VertexBuffer.MatricesIndicesExtraKind
  29588. * - VertexBuffer.MatricesWeightsKind
  29589. * - VertexBuffer.MatricesWeightsExtraKind
  29590. */
  29591. removeVerticesData(kind: string): void;
  29592. /**
  29593. * Flags an associated vertex buffer as updatable
  29594. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29595. * - VertexBuffer.PositionKind
  29596. * - VertexBuffer.UVKind
  29597. * - VertexBuffer.UV2Kind
  29598. * - VertexBuffer.UV3Kind
  29599. * - VertexBuffer.UV4Kind
  29600. * - VertexBuffer.UV5Kind
  29601. * - VertexBuffer.UV6Kind
  29602. * - VertexBuffer.ColorKind
  29603. * - VertexBuffer.MatricesIndicesKind
  29604. * - VertexBuffer.MatricesIndicesExtraKind
  29605. * - VertexBuffer.MatricesWeightsKind
  29606. * - VertexBuffer.MatricesWeightsExtraKind
  29607. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29608. */
  29609. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29610. /**
  29611. * Sets the mesh global Vertex Buffer
  29612. * @param buffer defines the buffer to use
  29613. * @returns the current mesh
  29614. */
  29615. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29616. /**
  29617. * Update a specific associated vertex buffer
  29618. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29619. * - VertexBuffer.PositionKind
  29620. * - VertexBuffer.UVKind
  29621. * - VertexBuffer.UV2Kind
  29622. * - VertexBuffer.UV3Kind
  29623. * - VertexBuffer.UV4Kind
  29624. * - VertexBuffer.UV5Kind
  29625. * - VertexBuffer.UV6Kind
  29626. * - VertexBuffer.ColorKind
  29627. * - VertexBuffer.MatricesIndicesKind
  29628. * - VertexBuffer.MatricesIndicesExtraKind
  29629. * - VertexBuffer.MatricesWeightsKind
  29630. * - VertexBuffer.MatricesWeightsExtraKind
  29631. * @param data defines the data source
  29632. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29633. * @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)
  29634. * @returns the current mesh
  29635. */
  29636. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29637. /**
  29638. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29639. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29640. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29641. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29642. * @returns the current mesh
  29643. */
  29644. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29645. /**
  29646. * Creates a un-shared specific occurence of the geometry for the mesh.
  29647. * @returns the current mesh
  29648. */
  29649. makeGeometryUnique(): Mesh;
  29650. /**
  29651. * Set the index buffer of this mesh
  29652. * @param indices defines the source data
  29653. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29654. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29655. * @returns the current mesh
  29656. */
  29657. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29658. /**
  29659. * Update the current index buffer
  29660. * @param indices defines the source data
  29661. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29662. * @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)
  29663. * @returns the current mesh
  29664. */
  29665. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29666. /**
  29667. * Invert the geometry to move from a right handed system to a left handed one.
  29668. * @returns the current mesh
  29669. */
  29670. toLeftHanded(): Mesh;
  29671. /** @hidden */
  29672. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29673. /** @hidden */
  29674. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29675. /**
  29676. * Registers for this mesh a javascript function called just before the rendering process
  29677. * @param func defines the function to call before rendering this mesh
  29678. * @returns the current mesh
  29679. */
  29680. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29681. /**
  29682. * Disposes a previously registered javascript function called before the rendering
  29683. * @param func defines the function to remove
  29684. * @returns the current mesh
  29685. */
  29686. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29687. /**
  29688. * Registers for this mesh a javascript function called just after the rendering is complete
  29689. * @param func defines the function to call after rendering this mesh
  29690. * @returns the current mesh
  29691. */
  29692. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29693. /**
  29694. * Disposes a previously registered javascript function called after the rendering.
  29695. * @param func defines the function to remove
  29696. * @returns the current mesh
  29697. */
  29698. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29699. /** @hidden */
  29700. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29701. /** @hidden */
  29702. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29703. /** @hidden */
  29704. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29705. /** @hidden */
  29706. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29707. /** @hidden */
  29708. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29709. /** @hidden */
  29710. _rebuild(): void;
  29711. /** @hidden */
  29712. _freeze(): void;
  29713. /** @hidden */
  29714. _unFreeze(): void;
  29715. /**
  29716. * 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
  29717. * @param subMesh defines the subMesh to render
  29718. * @param enableAlphaMode defines if alpha mode can be changed
  29719. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29720. * @returns the current mesh
  29721. */
  29722. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29723. private _onBeforeDraw;
  29724. /**
  29725. * Renormalize the mesh and patch it up if there are no weights
  29726. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29727. * However in the case of zero weights then we set just a single influence to 1.
  29728. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29729. */
  29730. cleanMatrixWeights(): void;
  29731. private normalizeSkinFourWeights;
  29732. private normalizeSkinWeightsAndExtra;
  29733. /**
  29734. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29735. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29736. * the user know there was an issue with importing the mesh
  29737. * @returns a validation object with skinned, valid and report string
  29738. */
  29739. validateSkinning(): {
  29740. skinned: boolean;
  29741. valid: boolean;
  29742. report: string;
  29743. };
  29744. /** @hidden */
  29745. _checkDelayState(): Mesh;
  29746. private _queueLoad;
  29747. /**
  29748. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29749. * A mesh is in the frustum if its bounding box intersects the frustum
  29750. * @param frustumPlanes defines the frustum to test
  29751. * @returns true if the mesh is in the frustum planes
  29752. */
  29753. isInFrustum(frustumPlanes: Plane[]): boolean;
  29754. /**
  29755. * Sets the mesh material by the material or multiMaterial `id` property
  29756. * @param id is a string identifying the material or the multiMaterial
  29757. * @returns the current mesh
  29758. */
  29759. setMaterialByID(id: string): Mesh;
  29760. /**
  29761. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29762. * @returns an array of IAnimatable
  29763. */
  29764. getAnimatables(): IAnimatable[];
  29765. /**
  29766. * Modifies the mesh geometry according to the passed transformation matrix.
  29767. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29768. * The mesh normals are modified using the same transformation.
  29769. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29770. * @param transform defines the transform matrix to use
  29771. * @see https://doc.babylonjs.com/resources/baking_transformations
  29772. * @returns the current mesh
  29773. */
  29774. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29775. /**
  29776. * Modifies the mesh geometry according to its own current World Matrix.
  29777. * The mesh World Matrix is then reset.
  29778. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29779. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29780. * @see https://doc.babylonjs.com/resources/baking_transformations
  29781. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29782. * @returns the current mesh
  29783. */
  29784. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29785. /** @hidden */
  29786. get _positions(): Nullable<Vector3[]>;
  29787. /** @hidden */
  29788. _resetPointsArrayCache(): Mesh;
  29789. /** @hidden */
  29790. _generatePointsArray(): boolean;
  29791. /**
  29792. * Returns a new Mesh object generated from the current mesh properties.
  29793. * This method must not get confused with createInstance()
  29794. * @param name is a string, the name given to the new mesh
  29795. * @param newParent can be any Node object (default `null`)
  29796. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29797. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29798. * @returns a new mesh
  29799. */
  29800. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29801. /**
  29802. * Releases resources associated with this mesh.
  29803. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29804. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29805. */
  29806. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29807. /** @hidden */
  29808. _disposeInstanceSpecificData(): void;
  29809. /** @hidden */
  29810. _disposeThinInstanceSpecificData(): void;
  29811. /**
  29812. * Modifies the mesh geometry according to a displacement map.
  29813. * 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.
  29814. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29815. * @param url is a string, the URL from the image file is to be downloaded.
  29816. * @param minHeight is the lower limit of the displacement.
  29817. * @param maxHeight is the upper limit of the displacement.
  29818. * @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.
  29819. * @param uvOffset is an optional vector2 used to offset UV.
  29820. * @param uvScale is an optional vector2 used to scale UV.
  29821. * @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.
  29822. * @returns the Mesh.
  29823. */
  29824. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29825. /**
  29826. * Modifies the mesh geometry according to a displacementMap buffer.
  29827. * 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.
  29828. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29829. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29830. * @param heightMapWidth is the width of the buffer image.
  29831. * @param heightMapHeight is the height of the buffer image.
  29832. * @param minHeight is the lower limit of the displacement.
  29833. * @param maxHeight is the upper limit of the displacement.
  29834. * @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.
  29835. * @param uvOffset is an optional vector2 used to offset UV.
  29836. * @param uvScale is an optional vector2 used to scale UV.
  29837. * @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.
  29838. * @returns the Mesh.
  29839. */
  29840. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29841. /**
  29842. * Modify the mesh to get a flat shading rendering.
  29843. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29844. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29845. * @returns current mesh
  29846. */
  29847. convertToFlatShadedMesh(): Mesh;
  29848. /**
  29849. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29850. * In other words, more vertices, no more indices and a single bigger VBO.
  29851. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29852. * @returns current mesh
  29853. */
  29854. convertToUnIndexedMesh(): Mesh;
  29855. /**
  29856. * Inverses facet orientations.
  29857. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29858. * @param flipNormals will also inverts the normals
  29859. * @returns current mesh
  29860. */
  29861. flipFaces(flipNormals?: boolean): Mesh;
  29862. /**
  29863. * Increase the number of facets and hence vertices in a mesh
  29864. * Vertex normals are interpolated from existing vertex normals
  29865. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29866. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29867. */
  29868. increaseVertices(numberPerEdge: number): void;
  29869. /**
  29870. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29871. * This will undo any application of covertToFlatShadedMesh
  29872. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29873. */
  29874. forceSharedVertices(): void;
  29875. /** @hidden */
  29876. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29877. /** @hidden */
  29878. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29879. /**
  29880. * Creates a new InstancedMesh object from the mesh model.
  29881. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29882. * @param name defines the name of the new instance
  29883. * @returns a new InstancedMesh
  29884. */
  29885. createInstance(name: string): InstancedMesh;
  29886. /**
  29887. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29888. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29889. * @returns the current mesh
  29890. */
  29891. synchronizeInstances(): Mesh;
  29892. /**
  29893. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29894. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29895. * This should be used together with the simplification to avoid disappearing triangles.
  29896. * @param successCallback an optional success callback to be called after the optimization finished.
  29897. * @returns the current mesh
  29898. */
  29899. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29900. /**
  29901. * Serialize current mesh
  29902. * @param serializationObject defines the object which will receive the serialization data
  29903. */
  29904. serialize(serializationObject: any): void;
  29905. /** @hidden */
  29906. _syncGeometryWithMorphTargetManager(): void;
  29907. /** @hidden */
  29908. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29909. /**
  29910. * Returns a new Mesh object parsed from the source provided.
  29911. * @param parsedMesh is the source
  29912. * @param scene defines the hosting scene
  29913. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29914. * @returns a new Mesh
  29915. */
  29916. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29917. /**
  29918. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29919. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29920. * @param name defines the name of the mesh to create
  29921. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  29922. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  29923. * @param closePath creates a seam between the first and the last points of each path of the path array
  29924. * @param offset is taken in account only if the `pathArray` is containing a single path
  29925. * @param scene defines the hosting scene
  29926. * @param updatable defines if the mesh must be flagged as updatable
  29927. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29928. * @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)
  29929. * @returns a new Mesh
  29930. */
  29931. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29932. /**
  29933. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  29934. * @param name defines the name of the mesh to create
  29935. * @param radius sets the radius size (float) of the polygon (default 0.5)
  29936. * @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
  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 CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29943. /**
  29944. * Creates a box 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 size sets the size (float) of each box side (default 1)
  29947. * @param scene defines the hosting scene
  29948. * @param updatable defines if the mesh must be flagged as updatable
  29949. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29950. * @returns a new Mesh
  29951. */
  29952. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29953. /**
  29954. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  29955. * @param name defines the name of the mesh to create
  29956. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29957. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29958. * @param scene defines the hosting scene
  29959. * @param updatable defines if the mesh must be flagged as updatable
  29960. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29961. * @returns a new Mesh
  29962. */
  29963. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29964. /**
  29965. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  29966. * @param name defines the name of the mesh to create
  29967. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29968. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29969. * @param scene defines the hosting scene
  29970. * @returns a new Mesh
  29971. */
  29972. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  29973. /**
  29974. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  29975. * @param name defines the name of the mesh to create
  29976. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  29977. * @param diameterTop set the top cap diameter (floats, default 1)
  29978. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  29979. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  29980. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  29981. * @param scene defines the hosting scene
  29982. * @param updatable defines if the mesh must be flagged as updatable
  29983. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29984. * @returns a new Mesh
  29985. */
  29986. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  29987. /**
  29988. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  29989. * @param name defines the name of the mesh to create
  29990. * @param diameter sets the diameter size (float) of the torus (default 1)
  29991. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  29992. * @param tessellation sets the number of torus sides (postive integer, default 16)
  29993. * @param scene defines the hosting scene
  29994. * @param updatable defines if the mesh must be flagged as updatable
  29995. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29996. * @returns a new Mesh
  29997. */
  29998. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29999. /**
  30000. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  30001. * @param name defines the name of the mesh to create
  30002. * @param radius sets the global radius size (float) of the torus knot (default 2)
  30003. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  30004. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  30005. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  30006. * @param p the number of windings on X axis (positive integers, default 2)
  30007. * @param q the number of windings on Y axis (positive integers, default 3)
  30008. * @param scene defines the hosting scene
  30009. * @param updatable defines if the mesh must be flagged as updatable
  30010. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30011. * @returns a new Mesh
  30012. */
  30013. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30014. /**
  30015. * Creates a 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 scene defines the hosting scene
  30019. * @param updatable defines if the mesh must be flagged as updatable
  30020. * @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).
  30021. * @returns a new Mesh
  30022. */
  30023. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  30024. /**
  30025. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  30026. * @param name defines the name of the mesh to create
  30027. * @param points is an array successive Vector3
  30028. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  30029. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  30030. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  30031. * @param scene defines the hosting scene
  30032. * @param updatable defines if the mesh must be flagged as updatable
  30033. * @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)
  30034. * @returns a new Mesh
  30035. */
  30036. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  30037. /**
  30038. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  30039. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  30040. * 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.
  30041. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30042. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  30043. * Remember you can only change the shape positions, not their number when updating a polygon.
  30044. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  30045. * @param name defines the name of the mesh to create
  30046. * @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
  30047. * @param scene defines the hosting scene
  30048. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30049. * @param updatable defines if the mesh must be flagged as updatable
  30050. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30051. * @param earcutInjection can be used to inject your own earcut reference
  30052. * @returns a new Mesh
  30053. */
  30054. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30055. /**
  30056. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  30057. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  30058. * @param name defines the name of the mesh to create
  30059. * @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
  30060. * @param depth defines the height of extrusion
  30061. * @param scene defines the hosting scene
  30062. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30063. * @param updatable defines if the mesh must be flagged as updatable
  30064. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30065. * @param earcutInjection can be used to inject your own earcut reference
  30066. * @returns a new Mesh
  30067. */
  30068. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30069. /**
  30070. * Creates an extruded shape mesh.
  30071. * 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
  30072. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30073. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30074. * @param name defines the name of the mesh to create
  30075. * @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
  30076. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30077. * @param scale is the value to scale the shape
  30078. * @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
  30079. * @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
  30080. * @param scene defines the hosting scene
  30081. * @param updatable defines if the mesh must be flagged as updatable
  30082. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30083. * @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)
  30084. * @returns a new Mesh
  30085. */
  30086. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30087. /**
  30088. * Creates an custom extruded shape mesh.
  30089. * The custom extrusion is a parametric shape.
  30090. * It has no predefined shape. Its final shape will depend on the input parameters.
  30091. * Please consider using the same method from the MeshBuilder class instead
  30092. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30093. * @param name defines the name of the mesh to create
  30094. * @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
  30095. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30096. * @param scaleFunction is a custom Javascript function called on each path point
  30097. * @param rotationFunction is a custom Javascript function called on each path point
  30098. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  30099. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  30100. * @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
  30101. * @param scene defines the hosting scene
  30102. * @param updatable defines if the mesh must be flagged as updatable
  30103. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30104. * @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)
  30105. * @returns a new Mesh
  30106. */
  30107. 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;
  30108. /**
  30109. * Creates lathe mesh.
  30110. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  30111. * Please consider using the same method from the MeshBuilder class instead
  30112. * @param name defines the name of the mesh to create
  30113. * @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
  30114. * @param radius is the radius value of the lathe
  30115. * @param tessellation is the side number of the lathe.
  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 CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30122. /**
  30123. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  30124. * @param name defines the name of the mesh to create
  30125. * @param size sets the size (float) of both sides of the plane at once (default 1)
  30126. * @param scene defines the hosting scene
  30127. * @param updatable defines if the mesh must be flagged as updatable
  30128. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30129. * @returns a new Mesh
  30130. */
  30131. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30132. /**
  30133. * Creates a ground mesh.
  30134. * Please consider using the same method from the MeshBuilder class instead
  30135. * @param name defines the name of the mesh to create
  30136. * @param width set the width of the ground
  30137. * @param height set the height of the ground
  30138. * @param subdivisions sets the number of subdivisions per side
  30139. * @param scene defines the hosting scene
  30140. * @param updatable defines if the mesh must be flagged as updatable
  30141. * @returns a new Mesh
  30142. */
  30143. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  30144. /**
  30145. * Creates a tiled ground mesh.
  30146. * Please consider using the same method from the MeshBuilder class instead
  30147. * @param name defines the name of the mesh to create
  30148. * @param xmin set the ground minimum X coordinate
  30149. * @param zmin set the ground minimum Y coordinate
  30150. * @param xmax set the ground maximum X coordinate
  30151. * @param zmax set the ground maximum Z coordinate
  30152. * @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
  30153. * @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
  30154. * @param scene defines the hosting scene
  30155. * @param updatable defines if the mesh must be flagged as updatable
  30156. * @returns a new Mesh
  30157. */
  30158. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  30159. w: number;
  30160. h: number;
  30161. }, precision: {
  30162. w: number;
  30163. h: number;
  30164. }, scene: Scene, updatable?: boolean): Mesh;
  30165. /**
  30166. * Creates a ground mesh from a height map.
  30167. * Please consider using the same method from the MeshBuilder class instead
  30168. * @see https://doc.babylonjs.com/babylon101/height_map
  30169. * @param name defines the name of the mesh to create
  30170. * @param url sets the URL of the height map image resource
  30171. * @param width set the ground width size
  30172. * @param height set the ground height size
  30173. * @param subdivisions sets the number of subdivision per side
  30174. * @param minHeight is the minimum altitude on the ground
  30175. * @param maxHeight is the maximum altitude on the ground
  30176. * @param scene defines the hosting scene
  30177. * @param updatable defines if the mesh must be flagged as updatable
  30178. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  30179. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  30180. * @returns a new Mesh
  30181. */
  30182. 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;
  30183. /**
  30184. * Creates a tube mesh.
  30185. * The tube is a parametric shape.
  30186. * It has no predefined shape. Its final shape will depend on the input parameters.
  30187. * Please consider using the same method from the MeshBuilder class instead
  30188. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30189. * @param name defines the name of the mesh to create
  30190. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  30191. * @param radius sets the tube radius size
  30192. * @param tessellation is the number of sides on the tubular surface
  30193. * @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
  30194. * @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
  30195. * @param scene defines the hosting scene
  30196. * @param updatable defines if the mesh must be flagged as updatable
  30197. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30198. * @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)
  30199. * @returns a new Mesh
  30200. */
  30201. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  30202. (i: number, distance: number): number;
  30203. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30204. /**
  30205. * Creates a polyhedron mesh.
  30206. * Please consider using the same method from the MeshBuilder class instead.
  30207. * * 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
  30208. * * The parameter `size` (positive float, default 1) sets the polygon size
  30209. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  30210. * * 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`
  30211. * * 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
  30212. * * 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)`)
  30213. * * 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
  30214. * * 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
  30215. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30216. * * 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
  30217. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30218. * @param name defines the name of the mesh to create
  30219. * @param options defines the options used to create the mesh
  30220. * @param scene defines the hosting scene
  30221. * @returns a new Mesh
  30222. */
  30223. static CreatePolyhedron(name: string, options: {
  30224. type?: number;
  30225. size?: number;
  30226. sizeX?: number;
  30227. sizeY?: number;
  30228. sizeZ?: number;
  30229. custom?: any;
  30230. faceUV?: Vector4[];
  30231. faceColors?: Color4[];
  30232. updatable?: boolean;
  30233. sideOrientation?: number;
  30234. }, scene: Scene): Mesh;
  30235. /**
  30236. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  30237. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  30238. * * 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`)
  30239. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  30240. * * 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
  30241. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30242. * * 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
  30243. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30244. * @param name defines the name of the mesh
  30245. * @param options defines the options used to create the mesh
  30246. * @param scene defines the hosting scene
  30247. * @returns a new Mesh
  30248. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  30249. */
  30250. static CreateIcoSphere(name: string, options: {
  30251. radius?: number;
  30252. flat?: boolean;
  30253. subdivisions?: number;
  30254. sideOrientation?: number;
  30255. updatable?: boolean;
  30256. }, scene: Scene): Mesh;
  30257. /**
  30258. * Creates a decal mesh.
  30259. * Please consider using the same method from the MeshBuilder class instead.
  30260. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30261. * @param name defines the name of the mesh
  30262. * @param sourceMesh defines the mesh receiving the decal
  30263. * @param position sets the position of the decal in world coordinates
  30264. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30265. * @param size sets the decal scaling
  30266. * @param angle sets the angle to rotate the decal
  30267. * @returns a new Mesh
  30268. */
  30269. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30270. /**
  30271. * Prepare internal position array for software CPU skinning
  30272. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30273. */
  30274. setPositionsForCPUSkinning(): Float32Array;
  30275. /**
  30276. * Prepare internal normal array for software CPU skinning
  30277. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30278. */
  30279. setNormalsForCPUSkinning(): Float32Array;
  30280. /**
  30281. * Updates the vertex buffer by applying transformation from the bones
  30282. * @param skeleton defines the skeleton to apply to current mesh
  30283. * @returns the current mesh
  30284. */
  30285. applySkeleton(skeleton: Skeleton): Mesh;
  30286. /**
  30287. * 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
  30288. * @param meshes defines the list of meshes to scan
  30289. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30290. */
  30291. static MinMax(meshes: AbstractMesh[]): {
  30292. min: Vector3;
  30293. max: Vector3;
  30294. };
  30295. /**
  30296. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30297. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30298. * @returns a vector3
  30299. */
  30300. static Center(meshesOrMinMaxVector: {
  30301. min: Vector3;
  30302. max: Vector3;
  30303. } | AbstractMesh[]): Vector3;
  30304. /**
  30305. * Merge the array of meshes into a single mesh for performance reasons.
  30306. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30307. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30308. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30309. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30310. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30311. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30312. * @returns a new mesh
  30313. */
  30314. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30315. /** @hidden */
  30316. addInstance(instance: InstancedMesh): void;
  30317. /** @hidden */
  30318. removeInstance(instance: InstancedMesh): void;
  30319. }
  30320. }
  30321. declare module "babylonjs/Cameras/camera" {
  30322. import { SmartArray } from "babylonjs/Misc/smartArray";
  30323. import { Observable } from "babylonjs/Misc/observable";
  30324. import { Nullable } from "babylonjs/types";
  30325. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30326. import { Scene } from "babylonjs/scene";
  30327. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30328. import { Node } from "babylonjs/node";
  30329. import { Mesh } from "babylonjs/Meshes/mesh";
  30330. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30331. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30332. import { Viewport } from "babylonjs/Maths/math.viewport";
  30333. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30334. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30335. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30336. import { Ray } from "babylonjs/Culling/ray";
  30337. /**
  30338. * This is the base class of all the camera used in the application.
  30339. * @see https://doc.babylonjs.com/features/cameras
  30340. */
  30341. export class Camera extends Node {
  30342. /** @hidden */
  30343. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30344. /**
  30345. * This is the default projection mode used by the cameras.
  30346. * It helps recreating a feeling of perspective and better appreciate depth.
  30347. * This is the best way to simulate real life cameras.
  30348. */
  30349. static readonly PERSPECTIVE_CAMERA: number;
  30350. /**
  30351. * This helps creating camera with an orthographic mode.
  30352. * 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.
  30353. */
  30354. static readonly ORTHOGRAPHIC_CAMERA: number;
  30355. /**
  30356. * This is the default FOV mode for perspective cameras.
  30357. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30358. */
  30359. static readonly FOVMODE_VERTICAL_FIXED: number;
  30360. /**
  30361. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30362. */
  30363. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30364. /**
  30365. * This specifies ther is no need for a camera rig.
  30366. * Basically only one eye is rendered corresponding to the camera.
  30367. */
  30368. static readonly RIG_MODE_NONE: number;
  30369. /**
  30370. * Simulates a camera Rig with one blue eye and one red eye.
  30371. * This can be use with 3d blue and red glasses.
  30372. */
  30373. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30374. /**
  30375. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30376. */
  30377. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30378. /**
  30379. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30380. */
  30381. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30382. /**
  30383. * Defines that both eyes of the camera will be rendered over under each other.
  30384. */
  30385. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30386. /**
  30387. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30388. */
  30389. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30390. /**
  30391. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30392. */
  30393. static readonly RIG_MODE_VR: number;
  30394. /**
  30395. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30396. */
  30397. static readonly RIG_MODE_WEBVR: number;
  30398. /**
  30399. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30400. */
  30401. static readonly RIG_MODE_CUSTOM: number;
  30402. /**
  30403. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30404. */
  30405. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30406. /**
  30407. * Define the input manager associated with the camera.
  30408. */
  30409. inputs: CameraInputsManager<Camera>;
  30410. /** @hidden */
  30411. _position: Vector3;
  30412. /**
  30413. * Define the current local position of the camera in the scene
  30414. */
  30415. get position(): Vector3;
  30416. set position(newPosition: Vector3);
  30417. protected _upVector: Vector3;
  30418. /**
  30419. * The vector the camera should consider as up.
  30420. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30421. */
  30422. set upVector(vec: Vector3);
  30423. get upVector(): Vector3;
  30424. /**
  30425. * Define the current limit on the left side for an orthographic camera
  30426. * In scene unit
  30427. */
  30428. orthoLeft: Nullable<number>;
  30429. /**
  30430. * Define the current limit on the right side for an orthographic camera
  30431. * In scene unit
  30432. */
  30433. orthoRight: Nullable<number>;
  30434. /**
  30435. * Define the current limit on the bottom side for an orthographic camera
  30436. * In scene unit
  30437. */
  30438. orthoBottom: Nullable<number>;
  30439. /**
  30440. * Define the current limit on the top side for an orthographic camera
  30441. * In scene unit
  30442. */
  30443. orthoTop: Nullable<number>;
  30444. /**
  30445. * Field Of View is set in Radians. (default is 0.8)
  30446. */
  30447. fov: number;
  30448. /**
  30449. * Define the minimum distance the camera can see from.
  30450. * This is important to note that the depth buffer are not infinite and the closer it starts
  30451. * the more your scene might encounter depth fighting issue.
  30452. */
  30453. minZ: number;
  30454. /**
  30455. * Define the maximum distance the camera can see to.
  30456. * This is important to note that the depth buffer are not infinite and the further it end
  30457. * the more your scene might encounter depth fighting issue.
  30458. */
  30459. maxZ: number;
  30460. /**
  30461. * Define the default inertia of the camera.
  30462. * This helps giving a smooth feeling to the camera movement.
  30463. */
  30464. inertia: number;
  30465. /**
  30466. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30467. */
  30468. mode: number;
  30469. /**
  30470. * Define whether the camera is intermediate.
  30471. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30472. */
  30473. isIntermediate: boolean;
  30474. /**
  30475. * Define the viewport of the camera.
  30476. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30477. */
  30478. viewport: Viewport;
  30479. /**
  30480. * Restricts the camera to viewing objects with the same layerMask.
  30481. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30482. */
  30483. layerMask: number;
  30484. /**
  30485. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30486. */
  30487. fovMode: number;
  30488. /**
  30489. * Rig mode of the camera.
  30490. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30491. * This is normally controlled byt the camera themselves as internal use.
  30492. */
  30493. cameraRigMode: number;
  30494. /**
  30495. * Defines the distance between both "eyes" in case of a RIG
  30496. */
  30497. interaxialDistance: number;
  30498. /**
  30499. * Defines if stereoscopic rendering is done side by side or over under.
  30500. */
  30501. isStereoscopicSideBySide: boolean;
  30502. /**
  30503. * 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
  30504. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30505. * else in the scene. (Eg. security camera)
  30506. *
  30507. * 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)
  30508. */
  30509. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30510. /**
  30511. * When set, the camera will render to this render target instead of the default canvas
  30512. *
  30513. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30514. */
  30515. outputRenderTarget: Nullable<RenderTargetTexture>;
  30516. /**
  30517. * Observable triggered when the camera view matrix has changed.
  30518. */
  30519. onViewMatrixChangedObservable: Observable<Camera>;
  30520. /**
  30521. * Observable triggered when the camera Projection matrix has changed.
  30522. */
  30523. onProjectionMatrixChangedObservable: Observable<Camera>;
  30524. /**
  30525. * Observable triggered when the inputs have been processed.
  30526. */
  30527. onAfterCheckInputsObservable: Observable<Camera>;
  30528. /**
  30529. * Observable triggered when reset has been called and applied to the camera.
  30530. */
  30531. onRestoreStateObservable: Observable<Camera>;
  30532. /**
  30533. * Is this camera a part of a rig system?
  30534. */
  30535. isRigCamera: boolean;
  30536. /**
  30537. * If isRigCamera set to true this will be set with the parent camera.
  30538. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30539. */
  30540. rigParent?: Camera;
  30541. /** @hidden */
  30542. _cameraRigParams: any;
  30543. /** @hidden */
  30544. _rigCameras: Camera[];
  30545. /** @hidden */
  30546. _rigPostProcess: Nullable<PostProcess>;
  30547. protected _webvrViewMatrix: Matrix;
  30548. /** @hidden */
  30549. _skipRendering: boolean;
  30550. /** @hidden */
  30551. _projectionMatrix: Matrix;
  30552. /** @hidden */
  30553. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30554. /** @hidden */
  30555. _activeMeshes: SmartArray<AbstractMesh>;
  30556. protected _globalPosition: Vector3;
  30557. /** @hidden */
  30558. _computedViewMatrix: Matrix;
  30559. private _doNotComputeProjectionMatrix;
  30560. private _transformMatrix;
  30561. private _frustumPlanes;
  30562. private _refreshFrustumPlanes;
  30563. private _storedFov;
  30564. private _stateStored;
  30565. /**
  30566. * Instantiates a new camera object.
  30567. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30568. * @see https://doc.babylonjs.com/features/cameras
  30569. * @param name Defines the name of the camera in the scene
  30570. * @param position Defines the position of the camera
  30571. * @param scene Defines the scene the camera belongs too
  30572. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30573. */
  30574. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30575. /**
  30576. * Store current camera state (fov, position, etc..)
  30577. * @returns the camera
  30578. */
  30579. storeState(): Camera;
  30580. /**
  30581. * Restores the camera state values if it has been stored. You must call storeState() first
  30582. */
  30583. protected _restoreStateValues(): boolean;
  30584. /**
  30585. * Restored camera state. You must call storeState() first.
  30586. * @returns true if restored and false otherwise
  30587. */
  30588. restoreState(): boolean;
  30589. /**
  30590. * Gets the class name of the camera.
  30591. * @returns the class name
  30592. */
  30593. getClassName(): string;
  30594. /** @hidden */
  30595. readonly _isCamera: boolean;
  30596. /**
  30597. * Gets a string representation of the camera useful for debug purpose.
  30598. * @param fullDetails Defines that a more verboe level of logging is required
  30599. * @returns the string representation
  30600. */
  30601. toString(fullDetails?: boolean): string;
  30602. /**
  30603. * Gets the current world space position of the camera.
  30604. */
  30605. get globalPosition(): Vector3;
  30606. /**
  30607. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30608. * @returns the active meshe list
  30609. */
  30610. getActiveMeshes(): SmartArray<AbstractMesh>;
  30611. /**
  30612. * Check whether a mesh is part of the current active mesh list of the camera
  30613. * @param mesh Defines the mesh to check
  30614. * @returns true if active, false otherwise
  30615. */
  30616. isActiveMesh(mesh: Mesh): boolean;
  30617. /**
  30618. * Is this camera ready to be used/rendered
  30619. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30620. * @return true if the camera is ready
  30621. */
  30622. isReady(completeCheck?: boolean): boolean;
  30623. /** @hidden */
  30624. _initCache(): void;
  30625. /** @hidden */
  30626. _updateCache(ignoreParentClass?: boolean): void;
  30627. /** @hidden */
  30628. _isSynchronized(): boolean;
  30629. /** @hidden */
  30630. _isSynchronizedViewMatrix(): boolean;
  30631. /** @hidden */
  30632. _isSynchronizedProjectionMatrix(): boolean;
  30633. /**
  30634. * Attach the input controls to a specific dom element to get the input from.
  30635. * @param element Defines the element the controls should be listened from
  30636. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30637. */
  30638. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30639. /**
  30640. * Detach the current controls from the specified dom element.
  30641. * @param element Defines the element to stop listening the inputs from
  30642. */
  30643. detachControl(element: HTMLElement): void;
  30644. /**
  30645. * Update the camera state according to the different inputs gathered during the frame.
  30646. */
  30647. update(): void;
  30648. /** @hidden */
  30649. _checkInputs(): void;
  30650. /** @hidden */
  30651. get rigCameras(): Camera[];
  30652. /**
  30653. * Gets the post process used by the rig cameras
  30654. */
  30655. get rigPostProcess(): Nullable<PostProcess>;
  30656. /**
  30657. * Internal, gets the first post proces.
  30658. * @returns the first post process to be run on this camera.
  30659. */
  30660. _getFirstPostProcess(): Nullable<PostProcess>;
  30661. private _cascadePostProcessesToRigCams;
  30662. /**
  30663. * Attach a post process to the camera.
  30664. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30665. * @param postProcess The post process to attach to the camera
  30666. * @param insertAt The position of the post process in case several of them are in use in the scene
  30667. * @returns the position the post process has been inserted at
  30668. */
  30669. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30670. /**
  30671. * Detach a post process to the camera.
  30672. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30673. * @param postProcess The post process to detach from the camera
  30674. */
  30675. detachPostProcess(postProcess: PostProcess): void;
  30676. /**
  30677. * Gets the current world matrix of the camera
  30678. */
  30679. getWorldMatrix(): Matrix;
  30680. /** @hidden */
  30681. _getViewMatrix(): Matrix;
  30682. /**
  30683. * Gets the current view matrix of the camera.
  30684. * @param force forces the camera to recompute the matrix without looking at the cached state
  30685. * @returns the view matrix
  30686. */
  30687. getViewMatrix(force?: boolean): Matrix;
  30688. /**
  30689. * Freeze the projection matrix.
  30690. * It will prevent the cache check of the camera projection compute and can speed up perf
  30691. * if no parameter of the camera are meant to change
  30692. * @param projection Defines manually a projection if necessary
  30693. */
  30694. freezeProjectionMatrix(projection?: Matrix): void;
  30695. /**
  30696. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30697. */
  30698. unfreezeProjectionMatrix(): void;
  30699. /**
  30700. * Gets the current projection matrix of the camera.
  30701. * @param force forces the camera to recompute the matrix without looking at the cached state
  30702. * @returns the projection matrix
  30703. */
  30704. getProjectionMatrix(force?: boolean): Matrix;
  30705. /**
  30706. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30707. * @returns a Matrix
  30708. */
  30709. getTransformationMatrix(): Matrix;
  30710. private _updateFrustumPlanes;
  30711. /**
  30712. * Checks if a cullable object (mesh...) is in the camera frustum
  30713. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30714. * @param target The object to check
  30715. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30716. * @returns true if the object is in frustum otherwise false
  30717. */
  30718. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30719. /**
  30720. * Checks if a cullable object (mesh...) is in the camera frustum
  30721. * Unlike isInFrustum this cheks the full bounding box
  30722. * @param target The object to check
  30723. * @returns true if the object is in frustum otherwise false
  30724. */
  30725. isCompletelyInFrustum(target: ICullable): boolean;
  30726. /**
  30727. * Gets a ray in the forward direction from the camera.
  30728. * @param length Defines the length of the ray to create
  30729. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30730. * @param origin Defines the start point of the ray which defaults to the camera position
  30731. * @returns the forward ray
  30732. */
  30733. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30734. /**
  30735. * Gets a ray in the forward direction from the camera.
  30736. * @param refRay the ray to (re)use when setting the values
  30737. * @param length Defines the length of the ray to create
  30738. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30739. * @param origin Defines the start point of the ray which defaults to the camera position
  30740. * @returns the forward ray
  30741. */
  30742. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30743. /**
  30744. * Releases resources associated with this node.
  30745. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30746. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30747. */
  30748. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30749. /** @hidden */
  30750. _isLeftCamera: boolean;
  30751. /**
  30752. * Gets the left camera of a rig setup in case of Rigged Camera
  30753. */
  30754. get isLeftCamera(): boolean;
  30755. /** @hidden */
  30756. _isRightCamera: boolean;
  30757. /**
  30758. * Gets the right camera of a rig setup in case of Rigged Camera
  30759. */
  30760. get isRightCamera(): boolean;
  30761. /**
  30762. * Gets the left camera of a rig setup in case of Rigged Camera
  30763. */
  30764. get leftCamera(): Nullable<FreeCamera>;
  30765. /**
  30766. * Gets the right camera of a rig setup in case of Rigged Camera
  30767. */
  30768. get rightCamera(): Nullable<FreeCamera>;
  30769. /**
  30770. * Gets the left camera target of a rig setup in case of Rigged Camera
  30771. * @returns the target position
  30772. */
  30773. getLeftTarget(): Nullable<Vector3>;
  30774. /**
  30775. * Gets the right camera target of a rig setup in case of Rigged Camera
  30776. * @returns the target position
  30777. */
  30778. getRightTarget(): Nullable<Vector3>;
  30779. /**
  30780. * @hidden
  30781. */
  30782. setCameraRigMode(mode: number, rigParams: any): void;
  30783. /** @hidden */
  30784. static _setStereoscopicRigMode(camera: Camera): void;
  30785. /** @hidden */
  30786. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30787. /** @hidden */
  30788. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30789. /** @hidden */
  30790. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30791. /** @hidden */
  30792. _getVRProjectionMatrix(): Matrix;
  30793. protected _updateCameraRotationMatrix(): void;
  30794. protected _updateWebVRCameraRotationMatrix(): void;
  30795. /**
  30796. * This function MUST be overwritten by the different WebVR cameras available.
  30797. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30798. * @hidden
  30799. */
  30800. _getWebVRProjectionMatrix(): Matrix;
  30801. /**
  30802. * This function MUST be overwritten by the different WebVR cameras available.
  30803. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30804. * @hidden
  30805. */
  30806. _getWebVRViewMatrix(): Matrix;
  30807. /** @hidden */
  30808. setCameraRigParameter(name: string, value: any): void;
  30809. /**
  30810. * needs to be overridden by children so sub has required properties to be copied
  30811. * @hidden
  30812. */
  30813. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30814. /**
  30815. * May need to be overridden by children
  30816. * @hidden
  30817. */
  30818. _updateRigCameras(): void;
  30819. /** @hidden */
  30820. _setupInputs(): void;
  30821. /**
  30822. * Serialiaze the camera setup to a json represention
  30823. * @returns the JSON representation
  30824. */
  30825. serialize(): any;
  30826. /**
  30827. * Clones the current camera.
  30828. * @param name The cloned camera name
  30829. * @returns the cloned camera
  30830. */
  30831. clone(name: string): Camera;
  30832. /**
  30833. * Gets the direction of the camera relative to a given local axis.
  30834. * @param localAxis Defines the reference axis to provide a relative direction.
  30835. * @return the direction
  30836. */
  30837. getDirection(localAxis: Vector3): Vector3;
  30838. /**
  30839. * Returns the current camera absolute rotation
  30840. */
  30841. get absoluteRotation(): Quaternion;
  30842. /**
  30843. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30844. * @param localAxis Defines the reference axis to provide a relative direction.
  30845. * @param result Defines the vector to store the result in
  30846. */
  30847. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30848. /**
  30849. * Gets a camera constructor for a given camera type
  30850. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30851. * @param name The name of the camera the result will be able to instantiate
  30852. * @param scene The scene the result will construct the camera in
  30853. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30854. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30855. * @returns a factory method to construc the camera
  30856. */
  30857. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30858. /**
  30859. * Compute the world matrix of the camera.
  30860. * @returns the camera world matrix
  30861. */
  30862. computeWorldMatrix(): Matrix;
  30863. /**
  30864. * Parse a JSON and creates the camera from the parsed information
  30865. * @param parsedCamera The JSON to parse
  30866. * @param scene The scene to instantiate the camera in
  30867. * @returns the newly constructed camera
  30868. */
  30869. static Parse(parsedCamera: any, scene: Scene): Camera;
  30870. }
  30871. }
  30872. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30873. import { Nullable } from "babylonjs/types";
  30874. import { Scene } from "babylonjs/scene";
  30875. import { Vector4 } from "babylonjs/Maths/math.vector";
  30876. import { Mesh } from "babylonjs/Meshes/mesh";
  30877. /**
  30878. * Class containing static functions to help procedurally build meshes
  30879. */
  30880. export class DiscBuilder {
  30881. /**
  30882. * Creates a plane polygonal mesh. By default, this is a disc
  30883. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30884. * * 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
  30885. * * 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
  30886. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30887. * * 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
  30888. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30889. * @param name defines the name of the mesh
  30890. * @param options defines the options used to create the mesh
  30891. * @param scene defines the hosting scene
  30892. * @returns the plane polygonal mesh
  30893. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30894. */
  30895. static CreateDisc(name: string, options: {
  30896. radius?: number;
  30897. tessellation?: number;
  30898. arc?: number;
  30899. updatable?: boolean;
  30900. sideOrientation?: number;
  30901. frontUVs?: Vector4;
  30902. backUVs?: Vector4;
  30903. }, scene?: Nullable<Scene>): Mesh;
  30904. }
  30905. }
  30906. declare module "babylonjs/Materials/fresnelParameters" {
  30907. import { DeepImmutable } from "babylonjs/types";
  30908. import { Color3 } from "babylonjs/Maths/math.color";
  30909. /**
  30910. * Options to be used when creating a FresnelParameters.
  30911. */
  30912. export type IFresnelParametersCreationOptions = {
  30913. /**
  30914. * Define the color used on edges (grazing angle)
  30915. */
  30916. leftColor?: Color3;
  30917. /**
  30918. * Define the color used on center
  30919. */
  30920. rightColor?: Color3;
  30921. /**
  30922. * Define bias applied to computed fresnel term
  30923. */
  30924. bias?: number;
  30925. /**
  30926. * Defined the power exponent applied to fresnel term
  30927. */
  30928. power?: number;
  30929. /**
  30930. * Define if the fresnel effect is enable or not.
  30931. */
  30932. isEnabled?: boolean;
  30933. };
  30934. /**
  30935. * Serialized format for FresnelParameters.
  30936. */
  30937. export type IFresnelParametersSerialized = {
  30938. /**
  30939. * Define the color used on edges (grazing angle) [as an array]
  30940. */
  30941. leftColor: number[];
  30942. /**
  30943. * Define the color used on center [as an array]
  30944. */
  30945. rightColor: number[];
  30946. /**
  30947. * Define bias applied to computed fresnel term
  30948. */
  30949. bias: number;
  30950. /**
  30951. * Defined the power exponent applied to fresnel term
  30952. */
  30953. power?: number;
  30954. /**
  30955. * Define if the fresnel effect is enable or not.
  30956. */
  30957. isEnabled: boolean;
  30958. };
  30959. /**
  30960. * This represents all the required information to add a fresnel effect on a material:
  30961. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30962. */
  30963. export class FresnelParameters {
  30964. private _isEnabled;
  30965. /**
  30966. * Define if the fresnel effect is enable or not.
  30967. */
  30968. get isEnabled(): boolean;
  30969. set isEnabled(value: boolean);
  30970. /**
  30971. * Define the color used on edges (grazing angle)
  30972. */
  30973. leftColor: Color3;
  30974. /**
  30975. * Define the color used on center
  30976. */
  30977. rightColor: Color3;
  30978. /**
  30979. * Define bias applied to computed fresnel term
  30980. */
  30981. bias: number;
  30982. /**
  30983. * Defined the power exponent applied to fresnel term
  30984. */
  30985. power: number;
  30986. /**
  30987. * Creates a new FresnelParameters object.
  30988. *
  30989. * @param options provide your own settings to optionally to override defaults
  30990. */
  30991. constructor(options?: IFresnelParametersCreationOptions);
  30992. /**
  30993. * Clones the current fresnel and its valuues
  30994. * @returns a clone fresnel configuration
  30995. */
  30996. clone(): FresnelParameters;
  30997. /**
  30998. * Determines equality between FresnelParameters objects
  30999. * @param otherFresnelParameters defines the second operand
  31000. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  31001. */
  31002. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  31003. /**
  31004. * Serializes the current fresnel parameters to a JSON representation.
  31005. * @return the JSON serialization
  31006. */
  31007. serialize(): IFresnelParametersSerialized;
  31008. /**
  31009. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  31010. * @param parsedFresnelParameters Define the JSON representation
  31011. * @returns the parsed parameters
  31012. */
  31013. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  31014. }
  31015. }
  31016. declare module "babylonjs/Materials/materialFlags" {
  31017. /**
  31018. * This groups all the flags used to control the materials channel.
  31019. */
  31020. export class MaterialFlags {
  31021. private static _DiffuseTextureEnabled;
  31022. /**
  31023. * Are diffuse textures enabled in the application.
  31024. */
  31025. static get DiffuseTextureEnabled(): boolean;
  31026. static set DiffuseTextureEnabled(value: boolean);
  31027. private static _DetailTextureEnabled;
  31028. /**
  31029. * Are detail textures enabled in the application.
  31030. */
  31031. static get DetailTextureEnabled(): boolean;
  31032. static set DetailTextureEnabled(value: boolean);
  31033. private static _AmbientTextureEnabled;
  31034. /**
  31035. * Are ambient textures enabled in the application.
  31036. */
  31037. static get AmbientTextureEnabled(): boolean;
  31038. static set AmbientTextureEnabled(value: boolean);
  31039. private static _OpacityTextureEnabled;
  31040. /**
  31041. * Are opacity textures enabled in the application.
  31042. */
  31043. static get OpacityTextureEnabled(): boolean;
  31044. static set OpacityTextureEnabled(value: boolean);
  31045. private static _ReflectionTextureEnabled;
  31046. /**
  31047. * Are reflection textures enabled in the application.
  31048. */
  31049. static get ReflectionTextureEnabled(): boolean;
  31050. static set ReflectionTextureEnabled(value: boolean);
  31051. private static _EmissiveTextureEnabled;
  31052. /**
  31053. * Are emissive textures enabled in the application.
  31054. */
  31055. static get EmissiveTextureEnabled(): boolean;
  31056. static set EmissiveTextureEnabled(value: boolean);
  31057. private static _SpecularTextureEnabled;
  31058. /**
  31059. * Are specular textures enabled in the application.
  31060. */
  31061. static get SpecularTextureEnabled(): boolean;
  31062. static set SpecularTextureEnabled(value: boolean);
  31063. private static _BumpTextureEnabled;
  31064. /**
  31065. * Are bump textures enabled in the application.
  31066. */
  31067. static get BumpTextureEnabled(): boolean;
  31068. static set BumpTextureEnabled(value: boolean);
  31069. private static _LightmapTextureEnabled;
  31070. /**
  31071. * Are lightmap textures enabled in the application.
  31072. */
  31073. static get LightmapTextureEnabled(): boolean;
  31074. static set LightmapTextureEnabled(value: boolean);
  31075. private static _RefractionTextureEnabled;
  31076. /**
  31077. * Are refraction textures enabled in the application.
  31078. */
  31079. static get RefractionTextureEnabled(): boolean;
  31080. static set RefractionTextureEnabled(value: boolean);
  31081. private static _ColorGradingTextureEnabled;
  31082. /**
  31083. * Are color grading textures enabled in the application.
  31084. */
  31085. static get ColorGradingTextureEnabled(): boolean;
  31086. static set ColorGradingTextureEnabled(value: boolean);
  31087. private static _FresnelEnabled;
  31088. /**
  31089. * Are fresnels enabled in the application.
  31090. */
  31091. static get FresnelEnabled(): boolean;
  31092. static set FresnelEnabled(value: boolean);
  31093. private static _ClearCoatTextureEnabled;
  31094. /**
  31095. * Are clear coat textures enabled in the application.
  31096. */
  31097. static get ClearCoatTextureEnabled(): boolean;
  31098. static set ClearCoatTextureEnabled(value: boolean);
  31099. private static _ClearCoatBumpTextureEnabled;
  31100. /**
  31101. * Are clear coat bump textures enabled in the application.
  31102. */
  31103. static get ClearCoatBumpTextureEnabled(): boolean;
  31104. static set ClearCoatBumpTextureEnabled(value: boolean);
  31105. private static _ClearCoatTintTextureEnabled;
  31106. /**
  31107. * Are clear coat tint textures enabled in the application.
  31108. */
  31109. static get ClearCoatTintTextureEnabled(): boolean;
  31110. static set ClearCoatTintTextureEnabled(value: boolean);
  31111. private static _SheenTextureEnabled;
  31112. /**
  31113. * Are sheen textures enabled in the application.
  31114. */
  31115. static get SheenTextureEnabled(): boolean;
  31116. static set SheenTextureEnabled(value: boolean);
  31117. private static _AnisotropicTextureEnabled;
  31118. /**
  31119. * Are anisotropic textures enabled in the application.
  31120. */
  31121. static get AnisotropicTextureEnabled(): boolean;
  31122. static set AnisotropicTextureEnabled(value: boolean);
  31123. private static _ThicknessTextureEnabled;
  31124. /**
  31125. * Are thickness textures enabled in the application.
  31126. */
  31127. static get ThicknessTextureEnabled(): boolean;
  31128. static set ThicknessTextureEnabled(value: boolean);
  31129. }
  31130. }
  31131. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  31132. /** @hidden */
  31133. export var defaultFragmentDeclaration: {
  31134. name: string;
  31135. shader: string;
  31136. };
  31137. }
  31138. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  31139. /** @hidden */
  31140. export var defaultUboDeclaration: {
  31141. name: string;
  31142. shader: string;
  31143. };
  31144. }
  31145. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  31146. /** @hidden */
  31147. export var prePassDeclaration: {
  31148. name: string;
  31149. shader: string;
  31150. };
  31151. }
  31152. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  31153. /** @hidden */
  31154. export var lightFragmentDeclaration: {
  31155. name: string;
  31156. shader: string;
  31157. };
  31158. }
  31159. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  31160. /** @hidden */
  31161. export var lightUboDeclaration: {
  31162. name: string;
  31163. shader: string;
  31164. };
  31165. }
  31166. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  31167. /** @hidden */
  31168. export var lightsFragmentFunctions: {
  31169. name: string;
  31170. shader: string;
  31171. };
  31172. }
  31173. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  31174. /** @hidden */
  31175. export var shadowsFragmentFunctions: {
  31176. name: string;
  31177. shader: string;
  31178. };
  31179. }
  31180. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  31181. /** @hidden */
  31182. export var fresnelFunction: {
  31183. name: string;
  31184. shader: string;
  31185. };
  31186. }
  31187. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  31188. /** @hidden */
  31189. export var bumpFragmentMainFunctions: {
  31190. name: string;
  31191. shader: string;
  31192. };
  31193. }
  31194. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  31195. /** @hidden */
  31196. export var bumpFragmentFunctions: {
  31197. name: string;
  31198. shader: string;
  31199. };
  31200. }
  31201. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  31202. /** @hidden */
  31203. export var logDepthDeclaration: {
  31204. name: string;
  31205. shader: string;
  31206. };
  31207. }
  31208. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  31209. /** @hidden */
  31210. export var bumpFragment: {
  31211. name: string;
  31212. shader: string;
  31213. };
  31214. }
  31215. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  31216. /** @hidden */
  31217. export var depthPrePass: {
  31218. name: string;
  31219. shader: string;
  31220. };
  31221. }
  31222. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  31223. /** @hidden */
  31224. export var lightFragment: {
  31225. name: string;
  31226. shader: string;
  31227. };
  31228. }
  31229. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  31230. /** @hidden */
  31231. export var logDepthFragment: {
  31232. name: string;
  31233. shader: string;
  31234. };
  31235. }
  31236. declare module "babylonjs/Shaders/default.fragment" {
  31237. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  31238. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31239. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  31240. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31241. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31242. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31243. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  31244. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  31245. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  31246. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  31247. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  31248. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  31249. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  31250. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  31251. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  31252. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31253. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  31254. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  31255. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  31256. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  31257. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  31258. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  31259. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  31260. /** @hidden */
  31261. export var defaultPixelShader: {
  31262. name: string;
  31263. shader: string;
  31264. };
  31265. }
  31266. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  31267. /** @hidden */
  31268. export var defaultVertexDeclaration: {
  31269. name: string;
  31270. shader: string;
  31271. };
  31272. }
  31273. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31274. /** @hidden */
  31275. export var bumpVertexDeclaration: {
  31276. name: string;
  31277. shader: string;
  31278. };
  31279. }
  31280. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31281. /** @hidden */
  31282. export var bumpVertex: {
  31283. name: string;
  31284. shader: string;
  31285. };
  31286. }
  31287. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31288. /** @hidden */
  31289. export var fogVertex: {
  31290. name: string;
  31291. shader: string;
  31292. };
  31293. }
  31294. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31295. /** @hidden */
  31296. export var shadowsVertex: {
  31297. name: string;
  31298. shader: string;
  31299. };
  31300. }
  31301. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31302. /** @hidden */
  31303. export var pointCloudVertex: {
  31304. name: string;
  31305. shader: string;
  31306. };
  31307. }
  31308. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31309. /** @hidden */
  31310. export var logDepthVertex: {
  31311. name: string;
  31312. shader: string;
  31313. };
  31314. }
  31315. declare module "babylonjs/Shaders/default.vertex" {
  31316. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31317. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31318. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31319. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31320. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31321. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31322. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31323. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31324. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31325. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31326. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31327. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31328. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31329. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31330. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31331. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31332. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31333. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31334. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31335. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31336. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31337. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31338. /** @hidden */
  31339. export var defaultVertexShader: {
  31340. name: string;
  31341. shader: string;
  31342. };
  31343. }
  31344. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31345. import { Nullable } from "babylonjs/types";
  31346. import { Scene } from "babylonjs/scene";
  31347. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31348. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31349. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31350. /**
  31351. * @hidden
  31352. */
  31353. export interface IMaterialDetailMapDefines {
  31354. DETAIL: boolean;
  31355. DETAILDIRECTUV: number;
  31356. DETAIL_NORMALBLENDMETHOD: number;
  31357. /** @hidden */
  31358. _areTexturesDirty: boolean;
  31359. }
  31360. /**
  31361. * Define the code related to the detail map parameters of a material
  31362. *
  31363. * Inspired from:
  31364. * 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
  31365. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31366. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31367. */
  31368. export class DetailMapConfiguration {
  31369. private _texture;
  31370. /**
  31371. * The detail texture of the material.
  31372. */
  31373. texture: Nullable<BaseTexture>;
  31374. /**
  31375. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31376. * Bigger values mean stronger blending
  31377. */
  31378. diffuseBlendLevel: number;
  31379. /**
  31380. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31381. * Bigger values mean stronger blending. Only used with PBR materials
  31382. */
  31383. roughnessBlendLevel: number;
  31384. /**
  31385. * Defines how strong the bump effect from the detail map is
  31386. * Bigger values mean stronger effect
  31387. */
  31388. bumpLevel: number;
  31389. private _normalBlendMethod;
  31390. /**
  31391. * The method used to blend the bump and detail normals together
  31392. */
  31393. normalBlendMethod: number;
  31394. private _isEnabled;
  31395. /**
  31396. * Enable or disable the detail map on this material
  31397. */
  31398. isEnabled: boolean;
  31399. /** @hidden */
  31400. private _internalMarkAllSubMeshesAsTexturesDirty;
  31401. /** @hidden */
  31402. _markAllSubMeshesAsTexturesDirty(): void;
  31403. /**
  31404. * Instantiate a new detail map
  31405. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31406. */
  31407. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31408. /**
  31409. * Gets whether the submesh is ready to be used or not.
  31410. * @param defines the list of "defines" to update.
  31411. * @param scene defines the scene the material belongs to.
  31412. * @returns - boolean indicating that the submesh is ready or not.
  31413. */
  31414. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31415. /**
  31416. * Update the defines for detail map usage
  31417. * @param defines the list of "defines" to update.
  31418. * @param scene defines the scene the material belongs to.
  31419. */
  31420. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31421. /**
  31422. * Binds the material data.
  31423. * @param uniformBuffer defines the Uniform buffer to fill in.
  31424. * @param scene defines the scene the material belongs to.
  31425. * @param isFrozen defines whether the material is frozen or not.
  31426. */
  31427. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31428. /**
  31429. * Checks to see if a texture is used in the material.
  31430. * @param texture - Base texture to use.
  31431. * @returns - Boolean specifying if a texture is used in the material.
  31432. */
  31433. hasTexture(texture: BaseTexture): boolean;
  31434. /**
  31435. * Returns an array of the actively used textures.
  31436. * @param activeTextures Array of BaseTextures
  31437. */
  31438. getActiveTextures(activeTextures: BaseTexture[]): void;
  31439. /**
  31440. * Returns the animatable textures.
  31441. * @param animatables Array of animatable textures.
  31442. */
  31443. getAnimatables(animatables: IAnimatable[]): void;
  31444. /**
  31445. * Disposes the resources of the material.
  31446. * @param forceDisposeTextures - Forces the disposal of all textures.
  31447. */
  31448. dispose(forceDisposeTextures?: boolean): void;
  31449. /**
  31450. * Get the current class name useful for serialization or dynamic coding.
  31451. * @returns "DetailMap"
  31452. */
  31453. getClassName(): string;
  31454. /**
  31455. * Add the required uniforms to the current list.
  31456. * @param uniforms defines the current uniform list.
  31457. */
  31458. static AddUniforms(uniforms: string[]): void;
  31459. /**
  31460. * Add the required samplers to the current list.
  31461. * @param samplers defines the current sampler list.
  31462. */
  31463. static AddSamplers(samplers: string[]): void;
  31464. /**
  31465. * Add the required uniforms to the current buffer.
  31466. * @param uniformBuffer defines the current uniform buffer.
  31467. */
  31468. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31469. /**
  31470. * Makes a duplicate of the current instance into another one.
  31471. * @param detailMap define the instance where to copy the info
  31472. */
  31473. copyTo(detailMap: DetailMapConfiguration): void;
  31474. /**
  31475. * Serializes this detail map instance
  31476. * @returns - An object with the serialized instance.
  31477. */
  31478. serialize(): any;
  31479. /**
  31480. * Parses a detail map setting from a serialized object.
  31481. * @param source - Serialized object.
  31482. * @param scene Defines the scene we are parsing for
  31483. * @param rootUrl Defines the rootUrl to load from
  31484. */
  31485. parse(source: any, scene: Scene, rootUrl: string): void;
  31486. }
  31487. }
  31488. declare module "babylonjs/Materials/standardMaterial" {
  31489. import { SmartArray } from "babylonjs/Misc/smartArray";
  31490. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31491. import { Nullable } from "babylonjs/types";
  31492. import { Scene } from "babylonjs/scene";
  31493. import { Matrix } from "babylonjs/Maths/math.vector";
  31494. import { Color3 } from "babylonjs/Maths/math.color";
  31495. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31496. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31497. import { Mesh } from "babylonjs/Meshes/mesh";
  31498. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31499. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31500. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31501. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31502. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31503. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31504. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31505. import "babylonjs/Shaders/default.fragment";
  31506. import "babylonjs/Shaders/default.vertex";
  31507. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31508. /** @hidden */
  31509. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31510. MAINUV1: boolean;
  31511. MAINUV2: boolean;
  31512. DIFFUSE: boolean;
  31513. DIFFUSEDIRECTUV: number;
  31514. DETAIL: boolean;
  31515. DETAILDIRECTUV: number;
  31516. DETAIL_NORMALBLENDMETHOD: number;
  31517. AMBIENT: boolean;
  31518. AMBIENTDIRECTUV: number;
  31519. OPACITY: boolean;
  31520. OPACITYDIRECTUV: number;
  31521. OPACITYRGB: boolean;
  31522. REFLECTION: boolean;
  31523. EMISSIVE: boolean;
  31524. EMISSIVEDIRECTUV: number;
  31525. SPECULAR: boolean;
  31526. SPECULARDIRECTUV: number;
  31527. BUMP: boolean;
  31528. BUMPDIRECTUV: number;
  31529. PARALLAX: boolean;
  31530. PARALLAXOCCLUSION: boolean;
  31531. SPECULAROVERALPHA: boolean;
  31532. CLIPPLANE: boolean;
  31533. CLIPPLANE2: boolean;
  31534. CLIPPLANE3: boolean;
  31535. CLIPPLANE4: boolean;
  31536. CLIPPLANE5: boolean;
  31537. CLIPPLANE6: boolean;
  31538. ALPHATEST: boolean;
  31539. DEPTHPREPASS: boolean;
  31540. ALPHAFROMDIFFUSE: boolean;
  31541. POINTSIZE: boolean;
  31542. FOG: boolean;
  31543. SPECULARTERM: boolean;
  31544. DIFFUSEFRESNEL: boolean;
  31545. OPACITYFRESNEL: boolean;
  31546. REFLECTIONFRESNEL: boolean;
  31547. REFRACTIONFRESNEL: boolean;
  31548. EMISSIVEFRESNEL: boolean;
  31549. FRESNEL: boolean;
  31550. NORMAL: boolean;
  31551. UV1: boolean;
  31552. UV2: boolean;
  31553. VERTEXCOLOR: boolean;
  31554. VERTEXALPHA: boolean;
  31555. NUM_BONE_INFLUENCERS: number;
  31556. BonesPerMesh: number;
  31557. BONETEXTURE: boolean;
  31558. INSTANCES: boolean;
  31559. THIN_INSTANCES: boolean;
  31560. GLOSSINESS: boolean;
  31561. ROUGHNESS: boolean;
  31562. EMISSIVEASILLUMINATION: boolean;
  31563. LINKEMISSIVEWITHDIFFUSE: boolean;
  31564. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31565. LIGHTMAP: boolean;
  31566. LIGHTMAPDIRECTUV: number;
  31567. OBJECTSPACE_NORMALMAP: boolean;
  31568. USELIGHTMAPASSHADOWMAP: boolean;
  31569. REFLECTIONMAP_3D: boolean;
  31570. REFLECTIONMAP_SPHERICAL: boolean;
  31571. REFLECTIONMAP_PLANAR: boolean;
  31572. REFLECTIONMAP_CUBIC: boolean;
  31573. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31574. REFLECTIONMAP_PROJECTION: boolean;
  31575. REFLECTIONMAP_SKYBOX: boolean;
  31576. REFLECTIONMAP_EXPLICIT: boolean;
  31577. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31578. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31579. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31580. INVERTCUBICMAP: boolean;
  31581. LOGARITHMICDEPTH: boolean;
  31582. REFRACTION: boolean;
  31583. REFRACTIONMAP_3D: boolean;
  31584. REFLECTIONOVERALPHA: boolean;
  31585. TWOSIDEDLIGHTING: boolean;
  31586. SHADOWFLOAT: boolean;
  31587. MORPHTARGETS: boolean;
  31588. MORPHTARGETS_NORMAL: boolean;
  31589. MORPHTARGETS_TANGENT: boolean;
  31590. MORPHTARGETS_UV: boolean;
  31591. NUM_MORPH_INFLUENCERS: number;
  31592. NONUNIFORMSCALING: boolean;
  31593. PREMULTIPLYALPHA: boolean;
  31594. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31595. ALPHABLEND: boolean;
  31596. PREPASS: boolean;
  31597. SCENE_MRT_COUNT: number;
  31598. RGBDLIGHTMAP: boolean;
  31599. RGBDREFLECTION: boolean;
  31600. RGBDREFRACTION: boolean;
  31601. IMAGEPROCESSING: boolean;
  31602. VIGNETTE: boolean;
  31603. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31604. VIGNETTEBLENDMODEOPAQUE: boolean;
  31605. TONEMAPPING: boolean;
  31606. TONEMAPPING_ACES: boolean;
  31607. CONTRAST: boolean;
  31608. COLORCURVES: boolean;
  31609. COLORGRADING: boolean;
  31610. COLORGRADING3D: boolean;
  31611. SAMPLER3DGREENDEPTH: boolean;
  31612. SAMPLER3DBGRMAP: boolean;
  31613. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31614. MULTIVIEW: boolean;
  31615. /**
  31616. * If the reflection texture on this material is in linear color space
  31617. * @hidden
  31618. */
  31619. IS_REFLECTION_LINEAR: boolean;
  31620. /**
  31621. * If the refraction texture on this material is in linear color space
  31622. * @hidden
  31623. */
  31624. IS_REFRACTION_LINEAR: boolean;
  31625. EXPOSURE: boolean;
  31626. constructor();
  31627. setReflectionMode(modeToEnable: string): void;
  31628. }
  31629. /**
  31630. * This is the default material used in Babylon. It is the best trade off between quality
  31631. * and performances.
  31632. * @see https://doc.babylonjs.com/babylon101/materials
  31633. */
  31634. export class StandardMaterial extends PushMaterial {
  31635. private _diffuseTexture;
  31636. /**
  31637. * The basic texture of the material as viewed under a light.
  31638. */
  31639. diffuseTexture: Nullable<BaseTexture>;
  31640. private _ambientTexture;
  31641. /**
  31642. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31643. */
  31644. ambientTexture: Nullable<BaseTexture>;
  31645. private _opacityTexture;
  31646. /**
  31647. * Define the transparency of the material from a texture.
  31648. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31649. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31650. */
  31651. opacityTexture: Nullable<BaseTexture>;
  31652. private _reflectionTexture;
  31653. /**
  31654. * Define the texture used to display the reflection.
  31655. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31656. */
  31657. reflectionTexture: Nullable<BaseTexture>;
  31658. private _emissiveTexture;
  31659. /**
  31660. * Define texture of the material as if self lit.
  31661. * This will be mixed in the final result even in the absence of light.
  31662. */
  31663. emissiveTexture: Nullable<BaseTexture>;
  31664. private _specularTexture;
  31665. /**
  31666. * Define how the color and intensity of the highlight given by the light in the material.
  31667. */
  31668. specularTexture: Nullable<BaseTexture>;
  31669. private _bumpTexture;
  31670. /**
  31671. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31672. * 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.
  31673. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31674. */
  31675. bumpTexture: Nullable<BaseTexture>;
  31676. private _lightmapTexture;
  31677. /**
  31678. * Complex lighting can be computationally expensive to compute at runtime.
  31679. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31680. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31681. */
  31682. lightmapTexture: Nullable<BaseTexture>;
  31683. private _refractionTexture;
  31684. /**
  31685. * Define the texture used to display the refraction.
  31686. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31687. */
  31688. refractionTexture: Nullable<BaseTexture>;
  31689. /**
  31690. * The color of the material lit by the environmental background lighting.
  31691. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31692. */
  31693. ambientColor: Color3;
  31694. /**
  31695. * The basic color of the material as viewed under a light.
  31696. */
  31697. diffuseColor: Color3;
  31698. /**
  31699. * Define how the color and intensity of the highlight given by the light in the material.
  31700. */
  31701. specularColor: Color3;
  31702. /**
  31703. * Define the color of the material as if self lit.
  31704. * This will be mixed in the final result even in the absence of light.
  31705. */
  31706. emissiveColor: Color3;
  31707. /**
  31708. * Defines how sharp are the highlights in the material.
  31709. * The bigger the value the sharper giving a more glossy feeling to the result.
  31710. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31711. */
  31712. specularPower: number;
  31713. private _useAlphaFromDiffuseTexture;
  31714. /**
  31715. * Does the transparency come from the diffuse texture alpha channel.
  31716. */
  31717. useAlphaFromDiffuseTexture: boolean;
  31718. private _useEmissiveAsIllumination;
  31719. /**
  31720. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31721. */
  31722. useEmissiveAsIllumination: boolean;
  31723. private _linkEmissiveWithDiffuse;
  31724. /**
  31725. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31726. * the emissive level when the final color is close to one.
  31727. */
  31728. linkEmissiveWithDiffuse: boolean;
  31729. private _useSpecularOverAlpha;
  31730. /**
  31731. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31732. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31733. */
  31734. useSpecularOverAlpha: boolean;
  31735. private _useReflectionOverAlpha;
  31736. /**
  31737. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31738. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31739. */
  31740. useReflectionOverAlpha: boolean;
  31741. private _disableLighting;
  31742. /**
  31743. * Does lights from the scene impacts this material.
  31744. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31745. */
  31746. disableLighting: boolean;
  31747. private _useObjectSpaceNormalMap;
  31748. /**
  31749. * Allows using an object space normal map (instead of tangent space).
  31750. */
  31751. useObjectSpaceNormalMap: boolean;
  31752. private _useParallax;
  31753. /**
  31754. * Is parallax enabled or not.
  31755. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31756. */
  31757. useParallax: boolean;
  31758. private _useParallaxOcclusion;
  31759. /**
  31760. * Is parallax occlusion enabled or not.
  31761. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31762. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31763. */
  31764. useParallaxOcclusion: boolean;
  31765. /**
  31766. * 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.
  31767. */
  31768. parallaxScaleBias: number;
  31769. private _roughness;
  31770. /**
  31771. * Helps to define how blurry the reflections should appears in the material.
  31772. */
  31773. roughness: number;
  31774. /**
  31775. * In case of refraction, define the value of the index of refraction.
  31776. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31777. */
  31778. indexOfRefraction: number;
  31779. /**
  31780. * Invert the refraction texture alongside the y axis.
  31781. * It can be useful with procedural textures or probe for instance.
  31782. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31783. */
  31784. invertRefractionY: boolean;
  31785. /**
  31786. * Defines the alpha limits in alpha test mode.
  31787. */
  31788. alphaCutOff: number;
  31789. private _useLightmapAsShadowmap;
  31790. /**
  31791. * In case of light mapping, define whether the map contains light or shadow informations.
  31792. */
  31793. useLightmapAsShadowmap: boolean;
  31794. private _diffuseFresnelParameters;
  31795. /**
  31796. * Define the diffuse fresnel parameters of the material.
  31797. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31798. */
  31799. diffuseFresnelParameters: FresnelParameters;
  31800. private _opacityFresnelParameters;
  31801. /**
  31802. * Define the opacity fresnel parameters of the material.
  31803. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31804. */
  31805. opacityFresnelParameters: FresnelParameters;
  31806. private _reflectionFresnelParameters;
  31807. /**
  31808. * Define the reflection fresnel parameters of the material.
  31809. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31810. */
  31811. reflectionFresnelParameters: FresnelParameters;
  31812. private _refractionFresnelParameters;
  31813. /**
  31814. * Define the refraction fresnel parameters of the material.
  31815. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31816. */
  31817. refractionFresnelParameters: FresnelParameters;
  31818. private _emissiveFresnelParameters;
  31819. /**
  31820. * Define the emissive fresnel parameters of the material.
  31821. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31822. */
  31823. emissiveFresnelParameters: FresnelParameters;
  31824. private _useReflectionFresnelFromSpecular;
  31825. /**
  31826. * If true automatically deducts the fresnels values from the material specularity.
  31827. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31828. */
  31829. useReflectionFresnelFromSpecular: boolean;
  31830. private _useGlossinessFromSpecularMapAlpha;
  31831. /**
  31832. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31833. */
  31834. useGlossinessFromSpecularMapAlpha: boolean;
  31835. private _maxSimultaneousLights;
  31836. /**
  31837. * Defines the maximum number of lights that can be used in the material
  31838. */
  31839. maxSimultaneousLights: number;
  31840. private _invertNormalMapX;
  31841. /**
  31842. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31843. */
  31844. invertNormalMapX: boolean;
  31845. private _invertNormalMapY;
  31846. /**
  31847. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31848. */
  31849. invertNormalMapY: boolean;
  31850. private _twoSidedLighting;
  31851. /**
  31852. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31853. */
  31854. twoSidedLighting: boolean;
  31855. /**
  31856. * Default configuration related to image processing available in the standard Material.
  31857. */
  31858. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31859. /**
  31860. * Gets the image processing configuration used either in this material.
  31861. */
  31862. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31863. /**
  31864. * Sets the Default image processing configuration used either in the this material.
  31865. *
  31866. * If sets to null, the scene one is in use.
  31867. */
  31868. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31869. /**
  31870. * Keep track of the image processing observer to allow dispose and replace.
  31871. */
  31872. private _imageProcessingObserver;
  31873. /**
  31874. * Attaches a new image processing configuration to the Standard Material.
  31875. * @param configuration
  31876. */
  31877. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31878. /**
  31879. * Gets wether the color curves effect is enabled.
  31880. */
  31881. get cameraColorCurvesEnabled(): boolean;
  31882. /**
  31883. * Sets wether the color curves effect is enabled.
  31884. */
  31885. set cameraColorCurvesEnabled(value: boolean);
  31886. /**
  31887. * Gets wether the color grading effect is enabled.
  31888. */
  31889. get cameraColorGradingEnabled(): boolean;
  31890. /**
  31891. * Gets wether the color grading effect is enabled.
  31892. */
  31893. set cameraColorGradingEnabled(value: boolean);
  31894. /**
  31895. * Gets wether tonemapping is enabled or not.
  31896. */
  31897. get cameraToneMappingEnabled(): boolean;
  31898. /**
  31899. * Sets wether tonemapping is enabled or not
  31900. */
  31901. set cameraToneMappingEnabled(value: boolean);
  31902. /**
  31903. * The camera exposure used on this material.
  31904. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31905. * This corresponds to a photographic exposure.
  31906. */
  31907. get cameraExposure(): number;
  31908. /**
  31909. * The camera exposure used on this material.
  31910. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31911. * This corresponds to a photographic exposure.
  31912. */
  31913. set cameraExposure(value: number);
  31914. /**
  31915. * Gets The camera contrast used on this material.
  31916. */
  31917. get cameraContrast(): number;
  31918. /**
  31919. * Sets The camera contrast used on this material.
  31920. */
  31921. set cameraContrast(value: number);
  31922. /**
  31923. * Gets the Color Grading 2D Lookup Texture.
  31924. */
  31925. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  31926. /**
  31927. * Sets the Color Grading 2D Lookup Texture.
  31928. */
  31929. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  31930. /**
  31931. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31932. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31933. * 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;
  31934. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31935. */
  31936. get cameraColorCurves(): Nullable<ColorCurves>;
  31937. /**
  31938. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31939. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31940. * 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;
  31941. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31942. */
  31943. set cameraColorCurves(value: Nullable<ColorCurves>);
  31944. /**
  31945. * Can this material render to several textures at once
  31946. */
  31947. get canRenderToMRT(): boolean;
  31948. /**
  31949. * Defines the detail map parameters for the material.
  31950. */
  31951. readonly detailMap: DetailMapConfiguration;
  31952. protected _renderTargets: SmartArray<RenderTargetTexture>;
  31953. protected _worldViewProjectionMatrix: Matrix;
  31954. protected _globalAmbientColor: Color3;
  31955. protected _useLogarithmicDepth: boolean;
  31956. protected _rebuildInParallel: boolean;
  31957. /**
  31958. * Instantiates a new standard material.
  31959. * This is the default material used in Babylon. It is the best trade off between quality
  31960. * and performances.
  31961. * @see https://doc.babylonjs.com/babylon101/materials
  31962. * @param name Define the name of the material in the scene
  31963. * @param scene Define the scene the material belong to
  31964. */
  31965. constructor(name: string, scene: Scene);
  31966. /**
  31967. * Gets a boolean indicating that current material needs to register RTT
  31968. */
  31969. get hasRenderTargetTextures(): boolean;
  31970. /**
  31971. * Gets the current class name of the material e.g. "StandardMaterial"
  31972. * Mainly use in serialization.
  31973. * @returns the class name
  31974. */
  31975. getClassName(): string;
  31976. /**
  31977. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  31978. * You can try switching to logarithmic depth.
  31979. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  31980. */
  31981. get useLogarithmicDepth(): boolean;
  31982. set useLogarithmicDepth(value: boolean);
  31983. /**
  31984. * Specifies if the material will require alpha blending
  31985. * @returns a boolean specifying if alpha blending is needed
  31986. */
  31987. needAlphaBlending(): boolean;
  31988. /**
  31989. * Specifies if this material should be rendered in alpha test mode
  31990. * @returns a boolean specifying if an alpha test is needed.
  31991. */
  31992. needAlphaTesting(): boolean;
  31993. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  31994. /**
  31995. * Get the texture used for alpha test purpose.
  31996. * @returns the diffuse texture in case of the standard material.
  31997. */
  31998. getAlphaTestTexture(): Nullable<BaseTexture>;
  31999. /**
  32000. * Get if the submesh is ready to be used and all its information available.
  32001. * Child classes can use it to update shaders
  32002. * @param mesh defines the mesh to check
  32003. * @param subMesh defines which submesh to check
  32004. * @param useInstances specifies that instances should be used
  32005. * @returns a boolean indicating that the submesh is ready or not
  32006. */
  32007. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  32008. /**
  32009. * Builds the material UBO layouts.
  32010. * Used internally during the effect preparation.
  32011. */
  32012. buildUniformLayout(): void;
  32013. /**
  32014. * Unbinds the material from the mesh
  32015. */
  32016. unbind(): void;
  32017. /**
  32018. * Binds the submesh to this material by preparing the effect and shader to draw
  32019. * @param world defines the world transformation matrix
  32020. * @param mesh defines the mesh containing the submesh
  32021. * @param subMesh defines the submesh to bind the material to
  32022. */
  32023. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  32024. /**
  32025. * Get the list of animatables in the material.
  32026. * @returns the list of animatables object used in the material
  32027. */
  32028. getAnimatables(): IAnimatable[];
  32029. /**
  32030. * Gets the active textures from the material
  32031. * @returns an array of textures
  32032. */
  32033. getActiveTextures(): BaseTexture[];
  32034. /**
  32035. * Specifies if the material uses a texture
  32036. * @param texture defines the texture to check against the material
  32037. * @returns a boolean specifying if the material uses the texture
  32038. */
  32039. hasTexture(texture: BaseTexture): boolean;
  32040. /**
  32041. * Disposes the material
  32042. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  32043. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  32044. */
  32045. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  32046. /**
  32047. * Makes a duplicate of the material, and gives it a new name
  32048. * @param name defines the new name for the duplicated material
  32049. * @returns the cloned material
  32050. */
  32051. clone(name: string): StandardMaterial;
  32052. /**
  32053. * Serializes this material in a JSON representation
  32054. * @returns the serialized material object
  32055. */
  32056. serialize(): any;
  32057. /**
  32058. * Creates a standard material from parsed material data
  32059. * @param source defines the JSON representation of the material
  32060. * @param scene defines the hosting scene
  32061. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  32062. * @returns a new standard material
  32063. */
  32064. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  32065. /**
  32066. * Are diffuse textures enabled in the application.
  32067. */
  32068. static get DiffuseTextureEnabled(): boolean;
  32069. static set DiffuseTextureEnabled(value: boolean);
  32070. /**
  32071. * Are detail textures enabled in the application.
  32072. */
  32073. static get DetailTextureEnabled(): boolean;
  32074. static set DetailTextureEnabled(value: boolean);
  32075. /**
  32076. * Are ambient textures enabled in the application.
  32077. */
  32078. static get AmbientTextureEnabled(): boolean;
  32079. static set AmbientTextureEnabled(value: boolean);
  32080. /**
  32081. * Are opacity textures enabled in the application.
  32082. */
  32083. static get OpacityTextureEnabled(): boolean;
  32084. static set OpacityTextureEnabled(value: boolean);
  32085. /**
  32086. * Are reflection textures enabled in the application.
  32087. */
  32088. static get ReflectionTextureEnabled(): boolean;
  32089. static set ReflectionTextureEnabled(value: boolean);
  32090. /**
  32091. * Are emissive textures enabled in the application.
  32092. */
  32093. static get EmissiveTextureEnabled(): boolean;
  32094. static set EmissiveTextureEnabled(value: boolean);
  32095. /**
  32096. * Are specular textures enabled in the application.
  32097. */
  32098. static get SpecularTextureEnabled(): boolean;
  32099. static set SpecularTextureEnabled(value: boolean);
  32100. /**
  32101. * Are bump textures enabled in the application.
  32102. */
  32103. static get BumpTextureEnabled(): boolean;
  32104. static set BumpTextureEnabled(value: boolean);
  32105. /**
  32106. * Are lightmap textures enabled in the application.
  32107. */
  32108. static get LightmapTextureEnabled(): boolean;
  32109. static set LightmapTextureEnabled(value: boolean);
  32110. /**
  32111. * Are refraction textures enabled in the application.
  32112. */
  32113. static get RefractionTextureEnabled(): boolean;
  32114. static set RefractionTextureEnabled(value: boolean);
  32115. /**
  32116. * Are color grading textures enabled in the application.
  32117. */
  32118. static get ColorGradingTextureEnabled(): boolean;
  32119. static set ColorGradingTextureEnabled(value: boolean);
  32120. /**
  32121. * Are fresnels enabled in the application.
  32122. */
  32123. static get FresnelEnabled(): boolean;
  32124. static set FresnelEnabled(value: boolean);
  32125. }
  32126. }
  32127. declare module "babylonjs/Particles/solidParticleSystem" {
  32128. import { Nullable } from "babylonjs/types";
  32129. import { Mesh } from "babylonjs/Meshes/mesh";
  32130. import { Scene, IDisposable } from "babylonjs/scene";
  32131. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  32132. import { Material } from "babylonjs/Materials/material";
  32133. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  32134. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32135. /**
  32136. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  32137. *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.
  32138. * The SPS is also a particle system. It provides some methods to manage the particles.
  32139. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  32140. *
  32141. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  32142. */
  32143. export class SolidParticleSystem implements IDisposable {
  32144. /**
  32145. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  32146. * Example : var p = SPS.particles[i];
  32147. */
  32148. particles: SolidParticle[];
  32149. /**
  32150. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  32151. */
  32152. nbParticles: number;
  32153. /**
  32154. * If the particles must ever face the camera (default false). Useful for planar particles.
  32155. */
  32156. billboard: boolean;
  32157. /**
  32158. * Recompute normals when adding a shape
  32159. */
  32160. recomputeNormals: boolean;
  32161. /**
  32162. * This a counter ofr your own usage. It's not set by any SPS functions.
  32163. */
  32164. counter: number;
  32165. /**
  32166. * The SPS name. This name is also given to the underlying mesh.
  32167. */
  32168. name: string;
  32169. /**
  32170. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  32171. */
  32172. mesh: Mesh;
  32173. /**
  32174. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  32175. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  32176. */
  32177. vars: any;
  32178. /**
  32179. * This array is populated when the SPS is set as 'pickable'.
  32180. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  32181. * Each element of this array is an object `{idx: int, faceId: int}`.
  32182. * `idx` is the picked particle index in the `SPS.particles` array
  32183. * `faceId` is the picked face index counted within this particle.
  32184. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  32185. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  32186. * Use the method SPS.pickedParticle(pickingInfo) instead.
  32187. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32188. */
  32189. pickedParticles: {
  32190. idx: number;
  32191. faceId: number;
  32192. }[];
  32193. /**
  32194. * This array is populated when the SPS is set as 'pickable'
  32195. * Each key of this array is a submesh index.
  32196. * Each element of this array is a second array defined like this :
  32197. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  32198. * Each element of this second array is an object `{idx: int, faceId: int}`.
  32199. * `idx` is the picked particle index in the `SPS.particles` array
  32200. * `faceId` is the picked face index counted within this particle.
  32201. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  32202. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32203. */
  32204. pickedBySubMesh: {
  32205. idx: number;
  32206. faceId: number;
  32207. }[][];
  32208. /**
  32209. * This array is populated when `enableDepthSort` is set to true.
  32210. * Each element of this array is an instance of the class DepthSortedParticle.
  32211. */
  32212. depthSortedParticles: DepthSortedParticle[];
  32213. /**
  32214. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  32215. * @hidden
  32216. */
  32217. _bSphereOnly: boolean;
  32218. /**
  32219. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  32220. * @hidden
  32221. */
  32222. _bSphereRadiusFactor: number;
  32223. private _scene;
  32224. private _positions;
  32225. private _indices;
  32226. private _normals;
  32227. private _colors;
  32228. private _uvs;
  32229. private _indices32;
  32230. private _positions32;
  32231. private _normals32;
  32232. private _fixedNormal32;
  32233. private _colors32;
  32234. private _uvs32;
  32235. private _index;
  32236. private _updatable;
  32237. private _pickable;
  32238. private _isVisibilityBoxLocked;
  32239. private _alwaysVisible;
  32240. private _depthSort;
  32241. private _expandable;
  32242. private _shapeCounter;
  32243. private _copy;
  32244. private _color;
  32245. private _computeParticleColor;
  32246. private _computeParticleTexture;
  32247. private _computeParticleRotation;
  32248. private _computeParticleVertex;
  32249. private _computeBoundingBox;
  32250. private _depthSortParticles;
  32251. private _camera;
  32252. private _mustUnrotateFixedNormals;
  32253. private _particlesIntersect;
  32254. private _needs32Bits;
  32255. private _isNotBuilt;
  32256. private _lastParticleId;
  32257. private _idxOfId;
  32258. private _multimaterialEnabled;
  32259. private _useModelMaterial;
  32260. private _indicesByMaterial;
  32261. private _materialIndexes;
  32262. private _depthSortFunction;
  32263. private _materialSortFunction;
  32264. private _materials;
  32265. private _multimaterial;
  32266. private _materialIndexesById;
  32267. private _defaultMaterial;
  32268. private _autoUpdateSubMeshes;
  32269. private _tmpVertex;
  32270. /**
  32271. * Creates a SPS (Solid Particle System) object.
  32272. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32273. * @param scene (Scene) is the scene in which the SPS is added.
  32274. * @param options defines the options of the sps e.g.
  32275. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32276. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32277. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32278. * * 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.
  32279. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32280. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32281. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32282. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32283. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32284. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32285. */
  32286. constructor(name: string, scene: Scene, options?: {
  32287. updatable?: boolean;
  32288. isPickable?: boolean;
  32289. enableDepthSort?: boolean;
  32290. particleIntersection?: boolean;
  32291. boundingSphereOnly?: boolean;
  32292. bSphereRadiusFactor?: number;
  32293. expandable?: boolean;
  32294. useModelMaterial?: boolean;
  32295. enableMultiMaterial?: boolean;
  32296. });
  32297. /**
  32298. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32299. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32300. * @returns the created mesh
  32301. */
  32302. buildMesh(): Mesh;
  32303. /**
  32304. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32305. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32306. * Thus the particles generated from `digest()` have their property `position` set yet.
  32307. * @param mesh ( Mesh ) is the mesh to be digested
  32308. * @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
  32309. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32310. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32311. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32312. * @returns the current SPS
  32313. */
  32314. digest(mesh: Mesh, options?: {
  32315. facetNb?: number;
  32316. number?: number;
  32317. delta?: number;
  32318. storage?: [];
  32319. }): SolidParticleSystem;
  32320. /**
  32321. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32322. * @hidden
  32323. */
  32324. private _unrotateFixedNormals;
  32325. /**
  32326. * Resets the temporary working copy particle
  32327. * @hidden
  32328. */
  32329. private _resetCopy;
  32330. /**
  32331. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32332. * @param p the current index in the positions array to be updated
  32333. * @param ind the current index in the indices array
  32334. * @param shape a Vector3 array, the shape geometry
  32335. * @param positions the positions array to be updated
  32336. * @param meshInd the shape indices array
  32337. * @param indices the indices array to be updated
  32338. * @param meshUV the shape uv array
  32339. * @param uvs the uv array to be updated
  32340. * @param meshCol the shape color array
  32341. * @param colors the color array to be updated
  32342. * @param meshNor the shape normals array
  32343. * @param normals the normals array to be updated
  32344. * @param idx the particle index
  32345. * @param idxInShape the particle index in its shape
  32346. * @param options the addShape() method passed options
  32347. * @model the particle model
  32348. * @hidden
  32349. */
  32350. private _meshBuilder;
  32351. /**
  32352. * Returns a shape Vector3 array from positions float array
  32353. * @param positions float array
  32354. * @returns a vector3 array
  32355. * @hidden
  32356. */
  32357. private _posToShape;
  32358. /**
  32359. * Returns a shapeUV array from a float uvs (array deep copy)
  32360. * @param uvs as a float array
  32361. * @returns a shapeUV array
  32362. * @hidden
  32363. */
  32364. private _uvsToShapeUV;
  32365. /**
  32366. * Adds a new particle object in the particles array
  32367. * @param idx particle index in particles array
  32368. * @param id particle id
  32369. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32370. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32371. * @param model particle ModelShape object
  32372. * @param shapeId model shape identifier
  32373. * @param idxInShape index of the particle in the current model
  32374. * @param bInfo model bounding info object
  32375. * @param storage target storage array, if any
  32376. * @hidden
  32377. */
  32378. private _addParticle;
  32379. /**
  32380. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32381. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32382. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32383. * @param nb (positive integer) the number of particles to be created from this model
  32384. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32385. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32386. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32387. * @returns the number of shapes in the system
  32388. */
  32389. addShape(mesh: Mesh, nb: number, options?: {
  32390. positionFunction?: any;
  32391. vertexFunction?: any;
  32392. storage?: [];
  32393. }): number;
  32394. /**
  32395. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32396. * @hidden
  32397. */
  32398. private _rebuildParticle;
  32399. /**
  32400. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32401. * @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.
  32402. * @returns the SPS.
  32403. */
  32404. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32405. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32406. * Returns an array with the removed particles.
  32407. * 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.
  32408. * The SPS can't be empty so at least one particle needs to remain in place.
  32409. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32410. * @param start index of the first particle to remove
  32411. * @param end index of the last particle to remove (included)
  32412. * @returns an array populated with the removed particles
  32413. */
  32414. removeParticles(start: number, end: number): SolidParticle[];
  32415. /**
  32416. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32417. * @param solidParticleArray an array populated with Solid Particles objects
  32418. * @returns the SPS
  32419. */
  32420. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32421. /**
  32422. * Creates a new particle and modifies the SPS mesh geometry :
  32423. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32424. * - calls _addParticle() to populate the particle array
  32425. * factorized code from addShape() and insertParticlesFromArray()
  32426. * @param idx particle index in the particles array
  32427. * @param i particle index in its shape
  32428. * @param modelShape particle ModelShape object
  32429. * @param shape shape vertex array
  32430. * @param meshInd shape indices array
  32431. * @param meshUV shape uv array
  32432. * @param meshCol shape color array
  32433. * @param meshNor shape normals array
  32434. * @param bbInfo shape bounding info
  32435. * @param storage target particle storage
  32436. * @options addShape() passed options
  32437. * @hidden
  32438. */
  32439. private _insertNewParticle;
  32440. /**
  32441. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32442. * This method calls `updateParticle()` for each particle of the SPS.
  32443. * For an animated SPS, it is usually called within the render loop.
  32444. * 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.
  32445. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32446. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32447. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32448. * @returns the SPS.
  32449. */
  32450. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32451. /**
  32452. * Disposes the SPS.
  32453. */
  32454. dispose(): void;
  32455. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32456. * idx is the particle index in the SPS
  32457. * faceId is the picked face index counted within this particle.
  32458. * Returns null if the pickInfo can't identify a picked particle.
  32459. * @param pickingInfo (PickingInfo object)
  32460. * @returns {idx: number, faceId: number} or null
  32461. */
  32462. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32463. idx: number;
  32464. faceId: number;
  32465. }>;
  32466. /**
  32467. * Returns a SolidParticle object from its identifier : particle.id
  32468. * @param id (integer) the particle Id
  32469. * @returns the searched particle or null if not found in the SPS.
  32470. */
  32471. getParticleById(id: number): Nullable<SolidParticle>;
  32472. /**
  32473. * Returns a new array populated with the particles having the passed shapeId.
  32474. * @param shapeId (integer) the shape identifier
  32475. * @returns a new solid particle array
  32476. */
  32477. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32478. /**
  32479. * Populates the passed array "ref" with the particles having the passed shapeId.
  32480. * @param shapeId the shape identifier
  32481. * @returns the SPS
  32482. * @param ref
  32483. */
  32484. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32485. /**
  32486. * Computes the required SubMeshes according the materials assigned to the particles.
  32487. * @returns the solid particle system.
  32488. * Does nothing if called before the SPS mesh is built.
  32489. */
  32490. computeSubMeshes(): SolidParticleSystem;
  32491. /**
  32492. * Sorts the solid particles by material when MultiMaterial is enabled.
  32493. * Updates the indices32 array.
  32494. * Updates the indicesByMaterial array.
  32495. * Updates the mesh indices array.
  32496. * @returns the SPS
  32497. * @hidden
  32498. */
  32499. private _sortParticlesByMaterial;
  32500. /**
  32501. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32502. * @hidden
  32503. */
  32504. private _setMaterialIndexesById;
  32505. /**
  32506. * Returns an array with unique values of Materials from the passed array
  32507. * @param array the material array to be checked and filtered
  32508. * @hidden
  32509. */
  32510. private _filterUniqueMaterialId;
  32511. /**
  32512. * Sets a new Standard Material as _defaultMaterial if not already set.
  32513. * @hidden
  32514. */
  32515. private _setDefaultMaterial;
  32516. /**
  32517. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32518. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32519. * @returns the SPS.
  32520. */
  32521. refreshVisibleSize(): SolidParticleSystem;
  32522. /**
  32523. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32524. * @param size the size (float) of the visibility box
  32525. * note : this doesn't lock the SPS mesh bounding box.
  32526. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32527. */
  32528. setVisibilityBox(size: number): void;
  32529. /**
  32530. * Gets whether the SPS as always visible or not
  32531. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32532. */
  32533. get isAlwaysVisible(): boolean;
  32534. /**
  32535. * Sets the SPS as always visible or not
  32536. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32537. */
  32538. set isAlwaysVisible(val: boolean);
  32539. /**
  32540. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32541. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32542. */
  32543. set isVisibilityBoxLocked(val: boolean);
  32544. /**
  32545. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32546. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32547. */
  32548. get isVisibilityBoxLocked(): boolean;
  32549. /**
  32550. * Tells to `setParticles()` to compute the particle rotations or not.
  32551. * Default value : true. The SPS is faster when it's set to false.
  32552. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32553. */
  32554. set computeParticleRotation(val: boolean);
  32555. /**
  32556. * Tells to `setParticles()` to compute the particle colors or not.
  32557. * Default value : true. The SPS is faster when it's set to false.
  32558. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32559. */
  32560. set computeParticleColor(val: boolean);
  32561. set computeParticleTexture(val: boolean);
  32562. /**
  32563. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32564. * Default value : false. The SPS is faster when it's set to false.
  32565. * Note : the particle custom vertex positions aren't stored values.
  32566. */
  32567. set computeParticleVertex(val: boolean);
  32568. /**
  32569. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32570. */
  32571. set computeBoundingBox(val: boolean);
  32572. /**
  32573. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32574. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32575. * Default : `true`
  32576. */
  32577. set depthSortParticles(val: boolean);
  32578. /**
  32579. * Gets if `setParticles()` computes the particle rotations or not.
  32580. * Default value : true. The SPS is faster when it's set to false.
  32581. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32582. */
  32583. get computeParticleRotation(): boolean;
  32584. /**
  32585. * Gets if `setParticles()` computes the particle colors or not.
  32586. * Default value : true. The SPS is faster when it's set to false.
  32587. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32588. */
  32589. get computeParticleColor(): boolean;
  32590. /**
  32591. * Gets if `setParticles()` computes the particle textures or not.
  32592. * Default value : true. The SPS is faster when it's set to false.
  32593. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32594. */
  32595. get computeParticleTexture(): boolean;
  32596. /**
  32597. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32598. * Default value : false. The SPS is faster when it's set to false.
  32599. * Note : the particle custom vertex positions aren't stored values.
  32600. */
  32601. get computeParticleVertex(): boolean;
  32602. /**
  32603. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32604. */
  32605. get computeBoundingBox(): boolean;
  32606. /**
  32607. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32608. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32609. * Default : `true`
  32610. */
  32611. get depthSortParticles(): boolean;
  32612. /**
  32613. * Gets if the SPS is created as expandable at construction time.
  32614. * Default : `false`
  32615. */
  32616. get expandable(): boolean;
  32617. /**
  32618. * Gets if the SPS supports the Multi Materials
  32619. */
  32620. get multimaterialEnabled(): boolean;
  32621. /**
  32622. * Gets if the SPS uses the model materials for its own multimaterial.
  32623. */
  32624. get useModelMaterial(): boolean;
  32625. /**
  32626. * The SPS used material array.
  32627. */
  32628. get materials(): Material[];
  32629. /**
  32630. * Sets the SPS MultiMaterial from the passed materials.
  32631. * Note : the passed array is internally copied and not used then by reference.
  32632. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32633. */
  32634. setMultiMaterial(materials: Material[]): void;
  32635. /**
  32636. * The SPS computed multimaterial object
  32637. */
  32638. get multimaterial(): MultiMaterial;
  32639. set multimaterial(mm: MultiMaterial);
  32640. /**
  32641. * If the subMeshes must be updated on the next call to setParticles()
  32642. */
  32643. get autoUpdateSubMeshes(): boolean;
  32644. set autoUpdateSubMeshes(val: boolean);
  32645. /**
  32646. * This function does nothing. It may be overwritten to set all the particle first values.
  32647. * The SPS doesn't call this function, you may have to call it by your own.
  32648. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32649. */
  32650. initParticles(): void;
  32651. /**
  32652. * This function does nothing. It may be overwritten to recycle a particle.
  32653. * The SPS doesn't call this function, you may have to call it by your own.
  32654. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32655. * @param particle The particle to recycle
  32656. * @returns the recycled particle
  32657. */
  32658. recycleParticle(particle: SolidParticle): SolidParticle;
  32659. /**
  32660. * Updates a particle : this function should be overwritten by the user.
  32661. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32662. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32663. * @example : just set a particle position or velocity and recycle conditions
  32664. * @param particle The particle to update
  32665. * @returns the updated particle
  32666. */
  32667. updateParticle(particle: SolidParticle): SolidParticle;
  32668. /**
  32669. * Updates a vertex of a particle : it can be overwritten by the user.
  32670. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32671. * @param particle the current particle
  32672. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32673. * @param pt the index of the current vertex in the particle shape
  32674. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32675. * @example : just set a vertex particle position or color
  32676. * @returns the sps
  32677. */
  32678. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32679. /**
  32680. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32681. * This does nothing and may be overwritten by the user.
  32682. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32683. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32684. * @param update the boolean update value actually passed to setParticles()
  32685. */
  32686. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32687. /**
  32688. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32689. * This will be passed three parameters.
  32690. * This does nothing and may be overwritten by the user.
  32691. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32692. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32693. * @param update the boolean update value actually passed to setParticles()
  32694. */
  32695. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32696. }
  32697. }
  32698. declare module "babylonjs/Particles/solidParticle" {
  32699. import { Nullable } from "babylonjs/types";
  32700. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32701. import { Color4 } from "babylonjs/Maths/math.color";
  32702. import { Mesh } from "babylonjs/Meshes/mesh";
  32703. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32704. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32705. import { Plane } from "babylonjs/Maths/math.plane";
  32706. import { Material } from "babylonjs/Materials/material";
  32707. /**
  32708. * Represents one particle of a solid particle system.
  32709. */
  32710. export class SolidParticle {
  32711. /**
  32712. * particle global index
  32713. */
  32714. idx: number;
  32715. /**
  32716. * particle identifier
  32717. */
  32718. id: number;
  32719. /**
  32720. * The color of the particle
  32721. */
  32722. color: Nullable<Color4>;
  32723. /**
  32724. * The world space position of the particle.
  32725. */
  32726. position: Vector3;
  32727. /**
  32728. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32729. */
  32730. rotation: Vector3;
  32731. /**
  32732. * The world space rotation quaternion of the particle.
  32733. */
  32734. rotationQuaternion: Nullable<Quaternion>;
  32735. /**
  32736. * The scaling of the particle.
  32737. */
  32738. scaling: Vector3;
  32739. /**
  32740. * The uvs of the particle.
  32741. */
  32742. uvs: Vector4;
  32743. /**
  32744. * The current speed of the particle.
  32745. */
  32746. velocity: Vector3;
  32747. /**
  32748. * The pivot point in the particle local space.
  32749. */
  32750. pivot: Vector3;
  32751. /**
  32752. * Must the particle be translated from its pivot point in its local space ?
  32753. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32754. * Default : false
  32755. */
  32756. translateFromPivot: boolean;
  32757. /**
  32758. * Is the particle active or not ?
  32759. */
  32760. alive: boolean;
  32761. /**
  32762. * Is the particle visible or not ?
  32763. */
  32764. isVisible: boolean;
  32765. /**
  32766. * Index of this particle in the global "positions" array (Internal use)
  32767. * @hidden
  32768. */
  32769. _pos: number;
  32770. /**
  32771. * @hidden Index of this particle in the global "indices" array (Internal use)
  32772. */
  32773. _ind: number;
  32774. /**
  32775. * @hidden ModelShape of this particle (Internal use)
  32776. */
  32777. _model: ModelShape;
  32778. /**
  32779. * ModelShape id of this particle
  32780. */
  32781. shapeId: number;
  32782. /**
  32783. * Index of the particle in its shape id
  32784. */
  32785. idxInShape: number;
  32786. /**
  32787. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32788. */
  32789. _modelBoundingInfo: BoundingInfo;
  32790. /**
  32791. * @hidden Particle BoundingInfo object (Internal use)
  32792. */
  32793. _boundingInfo: BoundingInfo;
  32794. /**
  32795. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32796. */
  32797. _sps: SolidParticleSystem;
  32798. /**
  32799. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32800. */
  32801. _stillInvisible: boolean;
  32802. /**
  32803. * @hidden Last computed particle rotation matrix
  32804. */
  32805. _rotationMatrix: number[];
  32806. /**
  32807. * Parent particle Id, if any.
  32808. * Default null.
  32809. */
  32810. parentId: Nullable<number>;
  32811. /**
  32812. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32813. */
  32814. materialIndex: Nullable<number>;
  32815. /**
  32816. * Custom object or properties.
  32817. */
  32818. props: Nullable<any>;
  32819. /**
  32820. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32821. * The possible values are :
  32822. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32823. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32824. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32825. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32826. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32827. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32828. * */
  32829. cullingStrategy: number;
  32830. /**
  32831. * @hidden Internal global position in the SPS.
  32832. */
  32833. _globalPosition: Vector3;
  32834. /**
  32835. * Creates a Solid Particle object.
  32836. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32837. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32838. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32839. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32840. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32841. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32842. * @param shapeId (integer) is the model shape identifier in the SPS.
  32843. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32844. * @param sps defines the sps it is associated to
  32845. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32846. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32847. */
  32848. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32849. /**
  32850. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32851. * @param target the particle target
  32852. * @returns the current particle
  32853. */
  32854. copyToRef(target: SolidParticle): SolidParticle;
  32855. /**
  32856. * Legacy support, changed scale to scaling
  32857. */
  32858. get scale(): Vector3;
  32859. /**
  32860. * Legacy support, changed scale to scaling
  32861. */
  32862. set scale(scale: Vector3);
  32863. /**
  32864. * Legacy support, changed quaternion to rotationQuaternion
  32865. */
  32866. get quaternion(): Nullable<Quaternion>;
  32867. /**
  32868. * Legacy support, changed quaternion to rotationQuaternion
  32869. */
  32870. set quaternion(q: Nullable<Quaternion>);
  32871. /**
  32872. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32873. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32874. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32875. * @returns true if it intersects
  32876. */
  32877. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32878. /**
  32879. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32880. * A particle is in the frustum if its bounding box intersects the frustum
  32881. * @param frustumPlanes defines the frustum to test
  32882. * @returns true if the particle is in the frustum planes
  32883. */
  32884. isInFrustum(frustumPlanes: Plane[]): boolean;
  32885. /**
  32886. * get the rotation matrix of the particle
  32887. * @hidden
  32888. */
  32889. getRotationMatrix(m: Matrix): void;
  32890. }
  32891. /**
  32892. * Represents the shape of the model used by one particle of a solid particle system.
  32893. * SPS internal tool, don't use it manually.
  32894. */
  32895. export class ModelShape {
  32896. /**
  32897. * The shape id
  32898. * @hidden
  32899. */
  32900. shapeID: number;
  32901. /**
  32902. * flat array of model positions (internal use)
  32903. * @hidden
  32904. */
  32905. _shape: Vector3[];
  32906. /**
  32907. * flat array of model UVs (internal use)
  32908. * @hidden
  32909. */
  32910. _shapeUV: number[];
  32911. /**
  32912. * color array of the model
  32913. * @hidden
  32914. */
  32915. _shapeColors: number[];
  32916. /**
  32917. * indices array of the model
  32918. * @hidden
  32919. */
  32920. _indices: number[];
  32921. /**
  32922. * normals array of the model
  32923. * @hidden
  32924. */
  32925. _normals: number[];
  32926. /**
  32927. * length of the shape in the model indices array (internal use)
  32928. * @hidden
  32929. */
  32930. _indicesLength: number;
  32931. /**
  32932. * Custom position function (internal use)
  32933. * @hidden
  32934. */
  32935. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  32936. /**
  32937. * Custom vertex function (internal use)
  32938. * @hidden
  32939. */
  32940. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  32941. /**
  32942. * Model material (internal use)
  32943. * @hidden
  32944. */
  32945. _material: Nullable<Material>;
  32946. /**
  32947. * 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.
  32948. * SPS internal tool, don't use it manually.
  32949. * @hidden
  32950. */
  32951. 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>);
  32952. }
  32953. /**
  32954. * Represents a Depth Sorted Particle in the solid particle system.
  32955. * @hidden
  32956. */
  32957. export class DepthSortedParticle {
  32958. /**
  32959. * Particle index
  32960. */
  32961. idx: number;
  32962. /**
  32963. * Index of the particle in the "indices" array
  32964. */
  32965. ind: number;
  32966. /**
  32967. * Length of the particle shape in the "indices" array
  32968. */
  32969. indicesLength: number;
  32970. /**
  32971. * Squared distance from the particle to the camera
  32972. */
  32973. sqDistance: number;
  32974. /**
  32975. * Material index when used with MultiMaterials
  32976. */
  32977. materialIndex: number;
  32978. /**
  32979. * Creates a new sorted particle
  32980. * @param materialIndex
  32981. */
  32982. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  32983. }
  32984. /**
  32985. * Represents a solid particle vertex
  32986. */
  32987. export class SolidParticleVertex {
  32988. /**
  32989. * Vertex position
  32990. */
  32991. position: Vector3;
  32992. /**
  32993. * Vertex color
  32994. */
  32995. color: Color4;
  32996. /**
  32997. * Vertex UV
  32998. */
  32999. uv: Vector2;
  33000. /**
  33001. * Creates a new solid particle vertex
  33002. */
  33003. constructor();
  33004. /** Vertex x coordinate */
  33005. get x(): number;
  33006. set x(val: number);
  33007. /** Vertex y coordinate */
  33008. get y(): number;
  33009. set y(val: number);
  33010. /** Vertex z coordinate */
  33011. get z(): number;
  33012. set z(val: number);
  33013. }
  33014. }
  33015. declare module "babylonjs/Collisions/meshCollisionData" {
  33016. import { Collider } from "babylonjs/Collisions/collider";
  33017. import { Vector3 } from "babylonjs/Maths/math.vector";
  33018. import { Nullable } from "babylonjs/types";
  33019. import { Observer } from "babylonjs/Misc/observable";
  33020. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33021. /**
  33022. * @hidden
  33023. */
  33024. export class _MeshCollisionData {
  33025. _checkCollisions: boolean;
  33026. _collisionMask: number;
  33027. _collisionGroup: number;
  33028. _surroundingMeshes: Nullable<AbstractMesh[]>;
  33029. _collider: Nullable<Collider>;
  33030. _oldPositionForCollisions: Vector3;
  33031. _diffPositionForCollisions: Vector3;
  33032. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  33033. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  33034. }
  33035. }
  33036. declare module "babylonjs/Meshes/abstractMesh" {
  33037. import { Observable } from "babylonjs/Misc/observable";
  33038. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  33039. import { Camera } from "babylonjs/Cameras/camera";
  33040. import { Scene, IDisposable } from "babylonjs/scene";
  33041. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  33042. import { Node } from "babylonjs/node";
  33043. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  33044. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33045. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33046. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33047. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  33048. import { Material } from "babylonjs/Materials/material";
  33049. import { Light } from "babylonjs/Lights/light";
  33050. import { Skeleton } from "babylonjs/Bones/skeleton";
  33051. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  33052. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  33053. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33054. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  33055. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  33056. import { Plane } from "babylonjs/Maths/math.plane";
  33057. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33058. import { Ray } from "babylonjs/Culling/ray";
  33059. import { Collider } from "babylonjs/Collisions/collider";
  33060. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33061. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  33062. /** @hidden */
  33063. class _FacetDataStorage {
  33064. facetPositions: Vector3[];
  33065. facetNormals: Vector3[];
  33066. facetPartitioning: number[][];
  33067. facetNb: number;
  33068. partitioningSubdivisions: number;
  33069. partitioningBBoxRatio: number;
  33070. facetDataEnabled: boolean;
  33071. facetParameters: any;
  33072. bbSize: Vector3;
  33073. subDiv: {
  33074. max: number;
  33075. X: number;
  33076. Y: number;
  33077. Z: number;
  33078. };
  33079. facetDepthSort: boolean;
  33080. facetDepthSortEnabled: boolean;
  33081. depthSortedIndices: IndicesArray;
  33082. depthSortedFacets: {
  33083. ind: number;
  33084. sqDistance: number;
  33085. }[];
  33086. facetDepthSortFunction: (f1: {
  33087. ind: number;
  33088. sqDistance: number;
  33089. }, f2: {
  33090. ind: number;
  33091. sqDistance: number;
  33092. }) => number;
  33093. facetDepthSortFrom: Vector3;
  33094. facetDepthSortOrigin: Vector3;
  33095. invertedMatrix: Matrix;
  33096. }
  33097. /**
  33098. * @hidden
  33099. **/
  33100. class _InternalAbstractMeshDataInfo {
  33101. _hasVertexAlpha: boolean;
  33102. _useVertexColors: boolean;
  33103. _numBoneInfluencers: number;
  33104. _applyFog: boolean;
  33105. _receiveShadows: boolean;
  33106. _facetData: _FacetDataStorage;
  33107. _visibility: number;
  33108. _skeleton: Nullable<Skeleton>;
  33109. _layerMask: number;
  33110. _computeBonesUsingShaders: boolean;
  33111. _isActive: boolean;
  33112. _onlyForInstances: boolean;
  33113. _isActiveIntermediate: boolean;
  33114. _onlyForInstancesIntermediate: boolean;
  33115. _actAsRegularMesh: boolean;
  33116. }
  33117. /**
  33118. * Class used to store all common mesh properties
  33119. */
  33120. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  33121. /** No occlusion */
  33122. static OCCLUSION_TYPE_NONE: number;
  33123. /** Occlusion set to optimisitic */
  33124. static OCCLUSION_TYPE_OPTIMISTIC: number;
  33125. /** Occlusion set to strict */
  33126. static OCCLUSION_TYPE_STRICT: number;
  33127. /** Use an accurante occlusion algorithm */
  33128. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  33129. /** Use a conservative occlusion algorithm */
  33130. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  33131. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  33132. * Test order :
  33133. * Is the bounding sphere outside the frustum ?
  33134. * If not, are the bounding box vertices outside the frustum ?
  33135. * It not, then the cullable object is in the frustum.
  33136. */
  33137. static readonly CULLINGSTRATEGY_STANDARD: number;
  33138. /** Culling strategy : Bounding Sphere Only.
  33139. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  33140. * It's also less accurate than the standard because some not visible objects can still be selected.
  33141. * Test : is the bounding sphere outside the frustum ?
  33142. * If not, then the cullable object is in the frustum.
  33143. */
  33144. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  33145. /** Culling strategy : Optimistic Inclusion.
  33146. * This in an inclusion test first, then the standard exclusion test.
  33147. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  33148. * 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.
  33149. * Anyway, it's as accurate as the standard strategy.
  33150. * Test :
  33151. * Is the cullable object bounding sphere center in the frustum ?
  33152. * If not, apply the default culling strategy.
  33153. */
  33154. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  33155. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  33156. * This in an inclusion test first, then the bounding sphere only exclusion test.
  33157. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  33158. * 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.
  33159. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  33160. * Test :
  33161. * Is the cullable object bounding sphere center in the frustum ?
  33162. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  33163. */
  33164. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  33165. /**
  33166. * No billboard
  33167. */
  33168. static get BILLBOARDMODE_NONE(): number;
  33169. /** Billboard on X axis */
  33170. static get BILLBOARDMODE_X(): number;
  33171. /** Billboard on Y axis */
  33172. static get BILLBOARDMODE_Y(): number;
  33173. /** Billboard on Z axis */
  33174. static get BILLBOARDMODE_Z(): number;
  33175. /** Billboard on all axes */
  33176. static get BILLBOARDMODE_ALL(): number;
  33177. /** Billboard on using position instead of orientation */
  33178. static get BILLBOARDMODE_USE_POSITION(): number;
  33179. /** @hidden */
  33180. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  33181. /**
  33182. * The culling strategy to use to check whether the mesh must be rendered or not.
  33183. * This value can be changed at any time and will be used on the next render mesh selection.
  33184. * The possible values are :
  33185. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  33186. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  33187. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  33188. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  33189. * Please read each static variable documentation to get details about the culling process.
  33190. * */
  33191. cullingStrategy: number;
  33192. /**
  33193. * Gets the number of facets in the mesh
  33194. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33195. */
  33196. get facetNb(): number;
  33197. /**
  33198. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  33199. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33200. */
  33201. get partitioningSubdivisions(): number;
  33202. set partitioningSubdivisions(nb: number);
  33203. /**
  33204. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  33205. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  33206. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33207. */
  33208. get partitioningBBoxRatio(): number;
  33209. set partitioningBBoxRatio(ratio: number);
  33210. /**
  33211. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  33212. * Works only for updatable meshes.
  33213. * Doesn't work with multi-materials
  33214. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33215. */
  33216. get mustDepthSortFacets(): boolean;
  33217. set mustDepthSortFacets(sort: boolean);
  33218. /**
  33219. * The location (Vector3) where the facet depth sort must be computed from.
  33220. * By default, the active camera position.
  33221. * Used only when facet depth sort is enabled
  33222. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33223. */
  33224. get facetDepthSortFrom(): Vector3;
  33225. set facetDepthSortFrom(location: Vector3);
  33226. /**
  33227. * gets a boolean indicating if facetData is enabled
  33228. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33229. */
  33230. get isFacetDataEnabled(): boolean;
  33231. /** @hidden */
  33232. _updateNonUniformScalingState(value: boolean): boolean;
  33233. /**
  33234. * An event triggered when this mesh collides with another one
  33235. */
  33236. onCollideObservable: Observable<AbstractMesh>;
  33237. /** Set a function to call when this mesh collides with another one */
  33238. set onCollide(callback: () => void);
  33239. /**
  33240. * An event triggered when the collision's position changes
  33241. */
  33242. onCollisionPositionChangeObservable: Observable<Vector3>;
  33243. /** Set a function to call when the collision's position changes */
  33244. set onCollisionPositionChange(callback: () => void);
  33245. /**
  33246. * An event triggered when material is changed
  33247. */
  33248. onMaterialChangedObservable: Observable<AbstractMesh>;
  33249. /**
  33250. * Gets or sets the orientation for POV movement & rotation
  33251. */
  33252. definedFacingForward: boolean;
  33253. /** @hidden */
  33254. _occlusionQuery: Nullable<WebGLQuery>;
  33255. /** @hidden */
  33256. _renderingGroup: Nullable<RenderingGroup>;
  33257. /**
  33258. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33259. */
  33260. get visibility(): number;
  33261. /**
  33262. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33263. */
  33264. set visibility(value: number);
  33265. /** Gets or sets the alpha index used to sort transparent meshes
  33266. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  33267. */
  33268. alphaIndex: number;
  33269. /**
  33270. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33271. */
  33272. isVisible: boolean;
  33273. /**
  33274. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33275. */
  33276. isPickable: boolean;
  33277. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33278. showSubMeshesBoundingBox: boolean;
  33279. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33280. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33281. */
  33282. isBlocker: boolean;
  33283. /**
  33284. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33285. */
  33286. enablePointerMoveEvents: boolean;
  33287. private _renderingGroupId;
  33288. /**
  33289. * Specifies the rendering group id for this mesh (0 by default)
  33290. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33291. */
  33292. get renderingGroupId(): number;
  33293. set renderingGroupId(value: number);
  33294. private _material;
  33295. /** Gets or sets current material */
  33296. get material(): Nullable<Material>;
  33297. set material(value: Nullable<Material>);
  33298. /**
  33299. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33300. * @see https://doc.babylonjs.com/babylon101/shadows
  33301. */
  33302. get receiveShadows(): boolean;
  33303. set receiveShadows(value: boolean);
  33304. /** Defines color to use when rendering outline */
  33305. outlineColor: Color3;
  33306. /** Define width to use when rendering outline */
  33307. outlineWidth: number;
  33308. /** Defines color to use when rendering overlay */
  33309. overlayColor: Color3;
  33310. /** Defines alpha to use when rendering overlay */
  33311. overlayAlpha: number;
  33312. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33313. get hasVertexAlpha(): boolean;
  33314. set hasVertexAlpha(value: boolean);
  33315. /** 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) */
  33316. get useVertexColors(): boolean;
  33317. set useVertexColors(value: boolean);
  33318. /**
  33319. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33320. */
  33321. get computeBonesUsingShaders(): boolean;
  33322. set computeBonesUsingShaders(value: boolean);
  33323. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33324. get numBoneInfluencers(): number;
  33325. set numBoneInfluencers(value: number);
  33326. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33327. get applyFog(): boolean;
  33328. set applyFog(value: boolean);
  33329. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33330. useOctreeForRenderingSelection: boolean;
  33331. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33332. useOctreeForPicking: boolean;
  33333. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33334. useOctreeForCollisions: boolean;
  33335. /**
  33336. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33337. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33338. */
  33339. get layerMask(): number;
  33340. set layerMask(value: number);
  33341. /**
  33342. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33343. */
  33344. alwaysSelectAsActiveMesh: boolean;
  33345. /**
  33346. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33347. */
  33348. doNotSyncBoundingInfo: boolean;
  33349. /**
  33350. * Gets or sets the current action manager
  33351. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33352. */
  33353. actionManager: Nullable<AbstractActionManager>;
  33354. private _meshCollisionData;
  33355. /**
  33356. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33357. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33358. */
  33359. ellipsoid: Vector3;
  33360. /**
  33361. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33362. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33363. */
  33364. ellipsoidOffset: Vector3;
  33365. /**
  33366. * Gets or sets a collision mask used to mask collisions (default is -1).
  33367. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33368. */
  33369. get collisionMask(): number;
  33370. set collisionMask(mask: number);
  33371. /**
  33372. * Gets or sets the current collision group mask (-1 by default).
  33373. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33374. */
  33375. get collisionGroup(): number;
  33376. set collisionGroup(mask: number);
  33377. /**
  33378. * Gets or sets current surrounding meshes (null by default).
  33379. *
  33380. * By default collision detection is tested against every mesh in the scene.
  33381. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33382. * meshes will be tested for the collision.
  33383. *
  33384. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33385. */
  33386. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33387. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33388. /**
  33389. * Defines edge width used when edgesRenderer is enabled
  33390. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33391. */
  33392. edgesWidth: number;
  33393. /**
  33394. * Defines edge color used when edgesRenderer is enabled
  33395. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33396. */
  33397. edgesColor: Color4;
  33398. /** @hidden */
  33399. _edgesRenderer: Nullable<IEdgesRenderer>;
  33400. /** @hidden */
  33401. _masterMesh: Nullable<AbstractMesh>;
  33402. /** @hidden */
  33403. _boundingInfo: Nullable<BoundingInfo>;
  33404. /** @hidden */
  33405. _renderId: number;
  33406. /**
  33407. * Gets or sets the list of subMeshes
  33408. * @see https://doc.babylonjs.com/how_to/multi_materials
  33409. */
  33410. subMeshes: SubMesh[];
  33411. /** @hidden */
  33412. _intersectionsInProgress: AbstractMesh[];
  33413. /** @hidden */
  33414. _unIndexed: boolean;
  33415. /** @hidden */
  33416. _lightSources: Light[];
  33417. /** Gets the list of lights affecting that mesh */
  33418. get lightSources(): Light[];
  33419. /** @hidden */
  33420. get _positions(): Nullable<Vector3[]>;
  33421. /** @hidden */
  33422. _waitingData: {
  33423. lods: Nullable<any>;
  33424. actions: Nullable<any>;
  33425. freezeWorldMatrix: Nullable<boolean>;
  33426. };
  33427. /** @hidden */
  33428. _bonesTransformMatrices: Nullable<Float32Array>;
  33429. /** @hidden */
  33430. _transformMatrixTexture: Nullable<RawTexture>;
  33431. /**
  33432. * Gets or sets a skeleton to apply skining transformations
  33433. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33434. */
  33435. set skeleton(value: Nullable<Skeleton>);
  33436. get skeleton(): Nullable<Skeleton>;
  33437. /**
  33438. * An event triggered when the mesh is rebuilt.
  33439. */
  33440. onRebuildObservable: Observable<AbstractMesh>;
  33441. /**
  33442. * Creates a new AbstractMesh
  33443. * @param name defines the name of the mesh
  33444. * @param scene defines the hosting scene
  33445. */
  33446. constructor(name: string, scene?: Nullable<Scene>);
  33447. /**
  33448. * Returns the string "AbstractMesh"
  33449. * @returns "AbstractMesh"
  33450. */
  33451. getClassName(): string;
  33452. /**
  33453. * Gets a string representation of the current mesh
  33454. * @param fullDetails defines a boolean indicating if full details must be included
  33455. * @returns a string representation of the current mesh
  33456. */
  33457. toString(fullDetails?: boolean): string;
  33458. /**
  33459. * @hidden
  33460. */
  33461. protected _getEffectiveParent(): Nullable<Node>;
  33462. /** @hidden */
  33463. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33464. /** @hidden */
  33465. _rebuild(): void;
  33466. /** @hidden */
  33467. _resyncLightSources(): void;
  33468. /** @hidden */
  33469. _resyncLightSource(light: Light): void;
  33470. /** @hidden */
  33471. _unBindEffect(): void;
  33472. /** @hidden */
  33473. _removeLightSource(light: Light, dispose: boolean): void;
  33474. private _markSubMeshesAsDirty;
  33475. /** @hidden */
  33476. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33477. /** @hidden */
  33478. _markSubMeshesAsAttributesDirty(): void;
  33479. /** @hidden */
  33480. _markSubMeshesAsMiscDirty(): void;
  33481. /**
  33482. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33483. */
  33484. get scaling(): Vector3;
  33485. set scaling(newScaling: Vector3);
  33486. /**
  33487. * Returns true if the mesh is blocked. Implemented by child classes
  33488. */
  33489. get isBlocked(): boolean;
  33490. /**
  33491. * Returns the mesh itself by default. Implemented by child classes
  33492. * @param camera defines the camera to use to pick the right LOD level
  33493. * @returns the currentAbstractMesh
  33494. */
  33495. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33496. /**
  33497. * Returns 0 by default. Implemented by child classes
  33498. * @returns an integer
  33499. */
  33500. getTotalVertices(): number;
  33501. /**
  33502. * Returns a positive integer : the total number of indices in this mesh geometry.
  33503. * @returns the numner of indices or zero if the mesh has no geometry.
  33504. */
  33505. getTotalIndices(): number;
  33506. /**
  33507. * Returns null by default. Implemented by child classes
  33508. * @returns null
  33509. */
  33510. getIndices(): Nullable<IndicesArray>;
  33511. /**
  33512. * Returns the array of the requested vertex data kind. Implemented by child classes
  33513. * @param kind defines the vertex data kind to use
  33514. * @returns null
  33515. */
  33516. getVerticesData(kind: string): Nullable<FloatArray>;
  33517. /**
  33518. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33519. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33520. * Note that a new underlying VertexBuffer object is created each call.
  33521. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33522. * @param kind defines vertex data kind:
  33523. * * VertexBuffer.PositionKind
  33524. * * VertexBuffer.UVKind
  33525. * * VertexBuffer.UV2Kind
  33526. * * VertexBuffer.UV3Kind
  33527. * * VertexBuffer.UV4Kind
  33528. * * VertexBuffer.UV5Kind
  33529. * * VertexBuffer.UV6Kind
  33530. * * VertexBuffer.ColorKind
  33531. * * VertexBuffer.MatricesIndicesKind
  33532. * * VertexBuffer.MatricesIndicesExtraKind
  33533. * * VertexBuffer.MatricesWeightsKind
  33534. * * VertexBuffer.MatricesWeightsExtraKind
  33535. * @param data defines the data source
  33536. * @param updatable defines if the data must be flagged as updatable (or static)
  33537. * @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
  33538. * @returns the current mesh
  33539. */
  33540. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33541. /**
  33542. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33543. * If the mesh has no geometry, it is simply returned as it is.
  33544. * @param kind defines vertex data kind:
  33545. * * VertexBuffer.PositionKind
  33546. * * VertexBuffer.UVKind
  33547. * * VertexBuffer.UV2Kind
  33548. * * VertexBuffer.UV3Kind
  33549. * * VertexBuffer.UV4Kind
  33550. * * VertexBuffer.UV5Kind
  33551. * * VertexBuffer.UV6Kind
  33552. * * VertexBuffer.ColorKind
  33553. * * VertexBuffer.MatricesIndicesKind
  33554. * * VertexBuffer.MatricesIndicesExtraKind
  33555. * * VertexBuffer.MatricesWeightsKind
  33556. * * VertexBuffer.MatricesWeightsExtraKind
  33557. * @param data defines the data source
  33558. * @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
  33559. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33560. * @returns the current mesh
  33561. */
  33562. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33563. /**
  33564. * Sets the mesh indices,
  33565. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33566. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33567. * @param totalVertices Defines the total number of vertices
  33568. * @returns the current mesh
  33569. */
  33570. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33571. /**
  33572. * Gets a boolean indicating if specific vertex data is present
  33573. * @param kind defines the vertex data kind to use
  33574. * @returns true is data kind is present
  33575. */
  33576. isVerticesDataPresent(kind: string): boolean;
  33577. /**
  33578. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33579. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33580. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33581. * @returns a BoundingInfo
  33582. */
  33583. getBoundingInfo(): BoundingInfo;
  33584. /**
  33585. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33586. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33587. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33588. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33589. * @returns the current mesh
  33590. */
  33591. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33592. /**
  33593. * Overwrite the current bounding info
  33594. * @param boundingInfo defines the new bounding info
  33595. * @returns the current mesh
  33596. */
  33597. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33598. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33599. get useBones(): boolean;
  33600. /** @hidden */
  33601. _preActivate(): void;
  33602. /** @hidden */
  33603. _preActivateForIntermediateRendering(renderId: number): void;
  33604. /** @hidden */
  33605. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33606. /** @hidden */
  33607. _postActivate(): void;
  33608. /** @hidden */
  33609. _freeze(): void;
  33610. /** @hidden */
  33611. _unFreeze(): void;
  33612. /**
  33613. * Gets the current world matrix
  33614. * @returns a Matrix
  33615. */
  33616. getWorldMatrix(): Matrix;
  33617. /** @hidden */
  33618. _getWorldMatrixDeterminant(): number;
  33619. /**
  33620. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33621. */
  33622. get isAnInstance(): boolean;
  33623. /**
  33624. * Gets a boolean indicating if this mesh has instances
  33625. */
  33626. get hasInstances(): boolean;
  33627. /**
  33628. * Gets a boolean indicating if this mesh has thin instances
  33629. */
  33630. get hasThinInstances(): boolean;
  33631. /**
  33632. * Perform 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 current mesh
  33639. */
  33640. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33641. /**
  33642. * Calculate relative position change from the point of view of behind the front of the mesh.
  33643. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33644. * Supports definition of mesh facing forward or backward
  33645. * @param amountRight defines the distance on the right axis
  33646. * @param amountUp defines the distance on the up axis
  33647. * @param amountForward defines the distance on the forward axis
  33648. * @returns the new displacement vector
  33649. */
  33650. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33651. /**
  33652. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33653. * Supports definition of mesh facing forward or backward
  33654. * @param flipBack defines the flip
  33655. * @param twirlClockwise defines the twirl
  33656. * @param tiltRight defines the tilt
  33657. * @returns the current mesh
  33658. */
  33659. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33660. /**
  33661. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33662. * Supports definition of mesh facing forward or backward.
  33663. * @param flipBack defines the flip
  33664. * @param twirlClockwise defines the twirl
  33665. * @param tiltRight defines the tilt
  33666. * @returns the new rotation vector
  33667. */
  33668. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33669. /**
  33670. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33671. * This means the mesh underlying bounding box and sphere are recomputed.
  33672. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33673. * @returns the current mesh
  33674. */
  33675. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33676. /** @hidden */
  33677. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33678. /** @hidden */
  33679. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33680. /** @hidden */
  33681. _updateBoundingInfo(): AbstractMesh;
  33682. /** @hidden */
  33683. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33684. /** @hidden */
  33685. protected _afterComputeWorldMatrix(): void;
  33686. /** @hidden */
  33687. get _effectiveMesh(): AbstractMesh;
  33688. /**
  33689. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33690. * A mesh is in the frustum if its bounding box intersects the frustum
  33691. * @param frustumPlanes defines the frustum to test
  33692. * @returns true if the mesh is in the frustum planes
  33693. */
  33694. isInFrustum(frustumPlanes: Plane[]): boolean;
  33695. /**
  33696. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33697. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33698. * @param frustumPlanes defines the frustum to test
  33699. * @returns true if the mesh is completely in the frustum planes
  33700. */
  33701. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33702. /**
  33703. * True if the mesh intersects another mesh or a SolidParticle object
  33704. * @param mesh defines a target mesh or SolidParticle to test
  33705. * @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)
  33706. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33707. * @returns true if there is an intersection
  33708. */
  33709. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33710. /**
  33711. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33712. * @param point defines the point to test
  33713. * @returns true if there is an intersection
  33714. */
  33715. intersectsPoint(point: Vector3): boolean;
  33716. /**
  33717. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33718. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33719. */
  33720. get checkCollisions(): boolean;
  33721. set checkCollisions(collisionEnabled: boolean);
  33722. /**
  33723. * Gets Collider object used to compute collisions (not physics)
  33724. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33725. */
  33726. get collider(): Nullable<Collider>;
  33727. /**
  33728. * Move the mesh using collision engine
  33729. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33730. * @param displacement defines the requested displacement vector
  33731. * @returns the current mesh
  33732. */
  33733. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33734. private _onCollisionPositionChange;
  33735. /** @hidden */
  33736. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33737. /** @hidden */
  33738. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33739. /** @hidden */
  33740. _checkCollision(collider: Collider): AbstractMesh;
  33741. /** @hidden */
  33742. _generatePointsArray(): boolean;
  33743. /**
  33744. * Checks if the passed Ray intersects with the mesh
  33745. * @param ray defines the ray to use
  33746. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33747. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33748. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33749. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  33750. * @returns the picking info
  33751. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33752. */
  33753. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  33754. /**
  33755. * Clones the current mesh
  33756. * @param name defines the mesh name
  33757. * @param newParent defines the new mesh parent
  33758. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33759. * @returns the new mesh
  33760. */
  33761. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33762. /**
  33763. * Disposes all the submeshes of the current meshnp
  33764. * @returns the current mesh
  33765. */
  33766. releaseSubMeshes(): AbstractMesh;
  33767. /**
  33768. * Releases resources associated with this abstract mesh.
  33769. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33770. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33771. */
  33772. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33773. /**
  33774. * Adds the passed mesh as a child to the current mesh
  33775. * @param mesh defines the child mesh
  33776. * @returns the current mesh
  33777. */
  33778. addChild(mesh: AbstractMesh): AbstractMesh;
  33779. /**
  33780. * Removes the passed mesh from the current mesh children list
  33781. * @param mesh defines the child mesh
  33782. * @returns the current mesh
  33783. */
  33784. removeChild(mesh: AbstractMesh): AbstractMesh;
  33785. /** @hidden */
  33786. private _initFacetData;
  33787. /**
  33788. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33789. * This method can be called within the render loop.
  33790. * 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
  33791. * @returns the current mesh
  33792. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33793. */
  33794. updateFacetData(): AbstractMesh;
  33795. /**
  33796. * Returns the facetLocalNormals array.
  33797. * The normals are expressed in the mesh local spac
  33798. * @returns an array of Vector3
  33799. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33800. */
  33801. getFacetLocalNormals(): Vector3[];
  33802. /**
  33803. * Returns the facetLocalPositions array.
  33804. * The facet positions are expressed in the mesh local space
  33805. * @returns an array of Vector3
  33806. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33807. */
  33808. getFacetLocalPositions(): Vector3[];
  33809. /**
  33810. * Returns the facetLocalPartioning array
  33811. * @returns an array of array of numbers
  33812. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33813. */
  33814. getFacetLocalPartitioning(): number[][];
  33815. /**
  33816. * Returns the i-th facet position in the world system.
  33817. * This method allocates a new Vector3 per call
  33818. * @param i defines the facet index
  33819. * @returns a new Vector3
  33820. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33821. */
  33822. getFacetPosition(i: number): Vector3;
  33823. /**
  33824. * Sets the reference Vector3 with the i-th facet position in the world system
  33825. * @param i defines the facet index
  33826. * @param ref defines the target vector
  33827. * @returns the current mesh
  33828. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33829. */
  33830. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33831. /**
  33832. * Returns the i-th facet normal in the world system.
  33833. * This method allocates a new Vector3 per call
  33834. * @param i defines the facet index
  33835. * @returns a new Vector3
  33836. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33837. */
  33838. getFacetNormal(i: number): Vector3;
  33839. /**
  33840. * Sets the reference Vector3 with the i-th facet normal in the world system
  33841. * @param i defines the facet index
  33842. * @param ref defines the target vector
  33843. * @returns the current mesh
  33844. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33845. */
  33846. getFacetNormalToRef(i: number, ref: Vector3): this;
  33847. /**
  33848. * 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)
  33849. * @param x defines x coordinate
  33850. * @param y defines y coordinate
  33851. * @param z defines z coordinate
  33852. * @returns the array of facet indexes
  33853. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33854. */
  33855. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33856. /**
  33857. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33858. * @param projected sets as the (x,y,z) world projection on the facet
  33859. * @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
  33860. * @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
  33861. * @param x defines x coordinate
  33862. * @param y defines y coordinate
  33863. * @param z defines z coordinate
  33864. * @returns the face index if found (or null instead)
  33865. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33866. */
  33867. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33868. /**
  33869. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33870. * @param projected sets as the (x,y,z) local projection on the facet
  33871. * @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
  33872. * @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
  33873. * @param x defines x coordinate
  33874. * @param y defines y coordinate
  33875. * @param z defines z coordinate
  33876. * @returns the face index if found (or null instead)
  33877. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33878. */
  33879. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33880. /**
  33881. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33882. * @returns the parameters
  33883. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33884. */
  33885. getFacetDataParameters(): any;
  33886. /**
  33887. * Disables the feature FacetData and frees the related memory
  33888. * @returns the current mesh
  33889. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33890. */
  33891. disableFacetData(): AbstractMesh;
  33892. /**
  33893. * Updates the AbstractMesh indices array
  33894. * @param indices defines the data source
  33895. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33896. * @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)
  33897. * @returns the current mesh
  33898. */
  33899. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  33900. /**
  33901. * Creates new normals data for the mesh
  33902. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  33903. * @returns the current mesh
  33904. */
  33905. createNormals(updatable: boolean): AbstractMesh;
  33906. /**
  33907. * Align the mesh with a normal
  33908. * @param normal defines the normal to use
  33909. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  33910. * @returns the current mesh
  33911. */
  33912. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  33913. /** @hidden */
  33914. _checkOcclusionQuery(): boolean;
  33915. /**
  33916. * Disables the mesh edge rendering mode
  33917. * @returns the currentAbstractMesh
  33918. */
  33919. disableEdgesRendering(): AbstractMesh;
  33920. /**
  33921. * Enables the edge rendering mode on the mesh.
  33922. * This mode makes the mesh edges visible
  33923. * @param epsilon defines the maximal distance between two angles to detect a face
  33924. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  33925. * @returns the currentAbstractMesh
  33926. * @see https://www.babylonjs-playground.com/#19O9TU#0
  33927. */
  33928. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  33929. /**
  33930. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  33931. * @returns an array of particle systems in the scene that use the mesh as an emitter
  33932. */
  33933. getConnectedParticleSystems(): IParticleSystem[];
  33934. }
  33935. }
  33936. declare module "babylonjs/Actions/actionEvent" {
  33937. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33938. import { Nullable } from "babylonjs/types";
  33939. import { Sprite } from "babylonjs/Sprites/sprite";
  33940. import { Scene } from "babylonjs/scene";
  33941. import { Vector2 } from "babylonjs/Maths/math.vector";
  33942. /**
  33943. * Interface used to define ActionEvent
  33944. */
  33945. export interface IActionEvent {
  33946. /** The mesh or sprite that triggered the action */
  33947. source: any;
  33948. /** The X mouse cursor position at the time of the event */
  33949. pointerX: number;
  33950. /** The Y mouse cursor position at the time of the event */
  33951. pointerY: number;
  33952. /** The mesh that is currently pointed at (can be null) */
  33953. meshUnderPointer: Nullable<AbstractMesh>;
  33954. /** the original (browser) event that triggered the ActionEvent */
  33955. sourceEvent?: any;
  33956. /** additional data for the event */
  33957. additionalData?: any;
  33958. }
  33959. /**
  33960. * ActionEvent is the event being sent when an action is triggered.
  33961. */
  33962. export class ActionEvent implements IActionEvent {
  33963. /** The mesh or sprite that triggered the action */
  33964. source: any;
  33965. /** The X mouse cursor position at the time of the event */
  33966. pointerX: number;
  33967. /** The Y mouse cursor position at the time of the event */
  33968. pointerY: number;
  33969. /** The mesh that is currently pointed at (can be null) */
  33970. meshUnderPointer: Nullable<AbstractMesh>;
  33971. /** the original (browser) event that triggered the ActionEvent */
  33972. sourceEvent?: any;
  33973. /** additional data for the event */
  33974. additionalData?: any;
  33975. /**
  33976. * Creates a new ActionEvent
  33977. * @param source The mesh or sprite that triggered the action
  33978. * @param pointerX The X mouse cursor position at the time of the event
  33979. * @param pointerY The Y mouse cursor position at the time of the event
  33980. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  33981. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  33982. * @param additionalData additional data for the event
  33983. */
  33984. constructor(
  33985. /** The mesh or sprite that triggered the action */
  33986. source: any,
  33987. /** The X mouse cursor position at the time of the event */
  33988. pointerX: number,
  33989. /** The Y mouse cursor position at the time of the event */
  33990. pointerY: number,
  33991. /** The mesh that is currently pointed at (can be null) */
  33992. meshUnderPointer: Nullable<AbstractMesh>,
  33993. /** the original (browser) event that triggered the ActionEvent */
  33994. sourceEvent?: any,
  33995. /** additional data for the event */
  33996. additionalData?: any);
  33997. /**
  33998. * Helper function to auto-create an ActionEvent from a source mesh.
  33999. * @param source The source mesh that triggered the event
  34000. * @param evt The original (browser) event
  34001. * @param additionalData additional data for the event
  34002. * @returns the new ActionEvent
  34003. */
  34004. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  34005. /**
  34006. * Helper function to auto-create an ActionEvent from a source sprite
  34007. * @param source The source sprite that triggered the event
  34008. * @param scene Scene associated with the sprite
  34009. * @param evt The original (browser) event
  34010. * @param additionalData additional data for the event
  34011. * @returns the new ActionEvent
  34012. */
  34013. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  34014. /**
  34015. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  34016. * @param scene the scene where the event occurred
  34017. * @param evt The original (browser) event
  34018. * @returns the new ActionEvent
  34019. */
  34020. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  34021. /**
  34022. * Helper function to auto-create an ActionEvent from a primitive
  34023. * @param prim defines the target primitive
  34024. * @param pointerPos defines the pointer position
  34025. * @param evt The original (browser) event
  34026. * @param additionalData additional data for the event
  34027. * @returns the new ActionEvent
  34028. */
  34029. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  34030. }
  34031. }
  34032. declare module "babylonjs/Actions/abstractActionManager" {
  34033. import { IDisposable } from "babylonjs/scene";
  34034. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  34035. import { IAction } from "babylonjs/Actions/action";
  34036. import { Nullable } from "babylonjs/types";
  34037. /**
  34038. * Abstract class used to decouple action Manager from scene and meshes.
  34039. * Do not instantiate.
  34040. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  34041. */
  34042. export abstract class AbstractActionManager implements IDisposable {
  34043. /** Gets the list of active triggers */
  34044. static Triggers: {
  34045. [key: string]: number;
  34046. };
  34047. /** Gets the cursor to use when hovering items */
  34048. hoverCursor: string;
  34049. /** Gets the list of actions */
  34050. actions: IAction[];
  34051. /**
  34052. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  34053. */
  34054. isRecursive: boolean;
  34055. /**
  34056. * Releases all associated resources
  34057. */
  34058. abstract dispose(): void;
  34059. /**
  34060. * Does this action manager has pointer triggers
  34061. */
  34062. abstract get hasPointerTriggers(): boolean;
  34063. /**
  34064. * Does this action manager has pick triggers
  34065. */
  34066. abstract get hasPickTriggers(): boolean;
  34067. /**
  34068. * Process a specific trigger
  34069. * @param trigger defines the trigger to process
  34070. * @param evt defines the event details to be processed
  34071. */
  34072. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  34073. /**
  34074. * Does this action manager handles actions of any of the given triggers
  34075. * @param triggers defines the triggers to be tested
  34076. * @return a boolean indicating whether one (or more) of the triggers is handled
  34077. */
  34078. abstract hasSpecificTriggers(triggers: number[]): boolean;
  34079. /**
  34080. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  34081. * speed.
  34082. * @param triggerA defines the trigger to be tested
  34083. * @param triggerB defines the trigger to be tested
  34084. * @return a boolean indicating whether one (or more) of the triggers is handled
  34085. */
  34086. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  34087. /**
  34088. * Does this action manager handles actions of a given trigger
  34089. * @param trigger defines the trigger to be tested
  34090. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  34091. * @return whether the trigger is handled
  34092. */
  34093. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  34094. /**
  34095. * Serialize this manager to a JSON object
  34096. * @param name defines the property name to store this manager
  34097. * @returns a JSON representation of this manager
  34098. */
  34099. abstract serialize(name: string): any;
  34100. /**
  34101. * Registers an action to this action manager
  34102. * @param action defines the action to be registered
  34103. * @return the action amended (prepared) after registration
  34104. */
  34105. abstract registerAction(action: IAction): Nullable<IAction>;
  34106. /**
  34107. * Unregisters an action to this action manager
  34108. * @param action defines the action to be unregistered
  34109. * @return a boolean indicating whether the action has been unregistered
  34110. */
  34111. abstract unregisterAction(action: IAction): Boolean;
  34112. /**
  34113. * Does exist one action manager with at least one trigger
  34114. **/
  34115. static get HasTriggers(): boolean;
  34116. /**
  34117. * Does exist one action manager with at least one pick trigger
  34118. **/
  34119. static get HasPickTriggers(): boolean;
  34120. /**
  34121. * Does exist one action manager that handles actions of a given trigger
  34122. * @param trigger defines the trigger to be tested
  34123. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  34124. **/
  34125. static HasSpecificTrigger(trigger: number): boolean;
  34126. }
  34127. }
  34128. declare module "babylonjs/node" {
  34129. import { Scene } from "babylonjs/scene";
  34130. import { Nullable } from "babylonjs/types";
  34131. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  34132. import { Engine } from "babylonjs/Engines/engine";
  34133. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  34134. import { Observable } from "babylonjs/Misc/observable";
  34135. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34136. import { IInspectable } from "babylonjs/Misc/iInspectable";
  34137. import { Animatable } from "babylonjs/Animations/animatable";
  34138. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34139. import { Animation } from "babylonjs/Animations/animation";
  34140. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34141. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34142. /**
  34143. * Defines how a node can be built from a string name.
  34144. */
  34145. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  34146. /**
  34147. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  34148. */
  34149. export class Node implements IBehaviorAware<Node> {
  34150. /** @hidden */
  34151. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  34152. private static _NodeConstructors;
  34153. /**
  34154. * Add a new node constructor
  34155. * @param type defines the type name of the node to construct
  34156. * @param constructorFunc defines the constructor function
  34157. */
  34158. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  34159. /**
  34160. * Returns a node constructor based on type name
  34161. * @param type defines the type name
  34162. * @param name defines the new node name
  34163. * @param scene defines the hosting scene
  34164. * @param options defines optional options to transmit to constructors
  34165. * @returns the new constructor or null
  34166. */
  34167. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  34168. /**
  34169. * Gets or sets the name of the node
  34170. */
  34171. name: string;
  34172. /**
  34173. * Gets or sets the id of the node
  34174. */
  34175. id: string;
  34176. /**
  34177. * Gets or sets the unique id of the node
  34178. */
  34179. uniqueId: number;
  34180. /**
  34181. * Gets or sets a string used to store user defined state for the node
  34182. */
  34183. state: string;
  34184. /**
  34185. * Gets or sets an object used to store user defined information for the node
  34186. */
  34187. metadata: any;
  34188. /**
  34189. * For internal use only. Please do not use.
  34190. */
  34191. reservedDataStore: any;
  34192. /**
  34193. * List of inspectable custom properties (used by the Inspector)
  34194. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  34195. */
  34196. inspectableCustomProperties: IInspectable[];
  34197. private _doNotSerialize;
  34198. /**
  34199. * Gets or sets a boolean used to define if the node must be serialized
  34200. */
  34201. get doNotSerialize(): boolean;
  34202. set doNotSerialize(value: boolean);
  34203. /** @hidden */
  34204. _isDisposed: boolean;
  34205. /**
  34206. * Gets a list of Animations associated with the node
  34207. */
  34208. animations: import("babylonjs/Animations/animation").Animation[];
  34209. protected _ranges: {
  34210. [name: string]: Nullable<AnimationRange>;
  34211. };
  34212. /**
  34213. * Callback raised when the node is ready to be used
  34214. */
  34215. onReady: Nullable<(node: Node) => void>;
  34216. private _isEnabled;
  34217. private _isParentEnabled;
  34218. private _isReady;
  34219. /** @hidden */
  34220. _currentRenderId: number;
  34221. private _parentUpdateId;
  34222. /** @hidden */
  34223. _childUpdateId: number;
  34224. /** @hidden */
  34225. _waitingParentId: Nullable<string>;
  34226. /** @hidden */
  34227. _scene: Scene;
  34228. /** @hidden */
  34229. _cache: any;
  34230. private _parentNode;
  34231. private _children;
  34232. /** @hidden */
  34233. _worldMatrix: Matrix;
  34234. /** @hidden */
  34235. _worldMatrixDeterminant: number;
  34236. /** @hidden */
  34237. _worldMatrixDeterminantIsDirty: boolean;
  34238. /** @hidden */
  34239. private _sceneRootNodesIndex;
  34240. /**
  34241. * Gets a boolean indicating if the node has been disposed
  34242. * @returns true if the node was disposed
  34243. */
  34244. isDisposed(): boolean;
  34245. /**
  34246. * Gets or sets the parent of the node (without keeping the current position in the scene)
  34247. * @see https://doc.babylonjs.com/how_to/parenting
  34248. */
  34249. set parent(parent: Nullable<Node>);
  34250. get parent(): Nullable<Node>;
  34251. /** @hidden */
  34252. _addToSceneRootNodes(): void;
  34253. /** @hidden */
  34254. _removeFromSceneRootNodes(): void;
  34255. private _animationPropertiesOverride;
  34256. /**
  34257. * Gets or sets the animation properties override
  34258. */
  34259. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  34260. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  34261. /**
  34262. * Gets a string identifying the name of the class
  34263. * @returns "Node" string
  34264. */
  34265. getClassName(): string;
  34266. /** @hidden */
  34267. readonly _isNode: boolean;
  34268. /**
  34269. * An event triggered when the mesh is disposed
  34270. */
  34271. onDisposeObservable: Observable<Node>;
  34272. private _onDisposeObserver;
  34273. /**
  34274. * Sets a callback that will be raised when the node will be disposed
  34275. */
  34276. set onDispose(callback: () => void);
  34277. /**
  34278. * Creates a new Node
  34279. * @param name the name and id to be given to this node
  34280. * @param scene the scene this node will be added to
  34281. */
  34282. constructor(name: string, scene?: Nullable<Scene>);
  34283. /**
  34284. * Gets the scene of the node
  34285. * @returns a scene
  34286. */
  34287. getScene(): Scene;
  34288. /**
  34289. * Gets the engine of the node
  34290. * @returns a Engine
  34291. */
  34292. getEngine(): Engine;
  34293. private _behaviors;
  34294. /**
  34295. * Attach a behavior to the node
  34296. * @see https://doc.babylonjs.com/features/behaviour
  34297. * @param behavior defines the behavior to attach
  34298. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34299. * @returns the current Node
  34300. */
  34301. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34302. /**
  34303. * Remove an attached behavior
  34304. * @see https://doc.babylonjs.com/features/behaviour
  34305. * @param behavior defines the behavior to attach
  34306. * @returns the current Node
  34307. */
  34308. removeBehavior(behavior: Behavior<Node>): Node;
  34309. /**
  34310. * Gets the list of attached behaviors
  34311. * @see https://doc.babylonjs.com/features/behaviour
  34312. */
  34313. get behaviors(): Behavior<Node>[];
  34314. /**
  34315. * Gets an attached behavior by name
  34316. * @param name defines the name of the behavior to look for
  34317. * @see https://doc.babylonjs.com/features/behaviour
  34318. * @returns null if behavior was not found else the requested behavior
  34319. */
  34320. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34321. /**
  34322. * Returns the latest update of the World matrix
  34323. * @returns a Matrix
  34324. */
  34325. getWorldMatrix(): Matrix;
  34326. /** @hidden */
  34327. _getWorldMatrixDeterminant(): number;
  34328. /**
  34329. * Returns directly the latest state of the mesh World matrix.
  34330. * A Matrix is returned.
  34331. */
  34332. get worldMatrixFromCache(): Matrix;
  34333. /** @hidden */
  34334. _initCache(): void;
  34335. /** @hidden */
  34336. updateCache(force?: boolean): void;
  34337. /** @hidden */
  34338. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34339. /** @hidden */
  34340. _updateCache(ignoreParentClass?: boolean): void;
  34341. /** @hidden */
  34342. _isSynchronized(): boolean;
  34343. /** @hidden */
  34344. _markSyncedWithParent(): void;
  34345. /** @hidden */
  34346. isSynchronizedWithParent(): boolean;
  34347. /** @hidden */
  34348. isSynchronized(): boolean;
  34349. /**
  34350. * Is this node ready to be used/rendered
  34351. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34352. * @return true if the node is ready
  34353. */
  34354. isReady(completeCheck?: boolean): boolean;
  34355. /**
  34356. * Is this node enabled?
  34357. * 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
  34358. * @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
  34359. * @return whether this node (and its parent) is enabled
  34360. */
  34361. isEnabled(checkAncestors?: boolean): boolean;
  34362. /** @hidden */
  34363. protected _syncParentEnabledState(): void;
  34364. /**
  34365. * Set the enabled state of this node
  34366. * @param value defines the new enabled state
  34367. */
  34368. setEnabled(value: boolean): void;
  34369. /**
  34370. * Is this node a descendant of the given node?
  34371. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34372. * @param ancestor defines the parent node to inspect
  34373. * @returns a boolean indicating if this node is a descendant of the given node
  34374. */
  34375. isDescendantOf(ancestor: Node): boolean;
  34376. /** @hidden */
  34377. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34378. /**
  34379. * Will return all nodes that have this node as ascendant
  34380. * @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
  34381. * @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
  34382. * @return all children nodes of all types
  34383. */
  34384. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34385. /**
  34386. * Get all child-meshes of this node
  34387. * @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)
  34388. * @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
  34389. * @returns an array of AbstractMesh
  34390. */
  34391. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34392. /**
  34393. * Get all direct children of this node
  34394. * @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
  34395. * @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)
  34396. * @returns an array of Node
  34397. */
  34398. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34399. /** @hidden */
  34400. _setReady(state: boolean): void;
  34401. /**
  34402. * Get an animation by name
  34403. * @param name defines the name of the animation to look for
  34404. * @returns null if not found else the requested animation
  34405. */
  34406. getAnimationByName(name: string): Nullable<Animation>;
  34407. /**
  34408. * Creates an animation range for this node
  34409. * @param name defines the name of the range
  34410. * @param from defines the starting key
  34411. * @param to defines the end key
  34412. */
  34413. createAnimationRange(name: string, from: number, to: number): void;
  34414. /**
  34415. * Delete a specific animation range
  34416. * @param name defines the name of the range to delete
  34417. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34418. */
  34419. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34420. /**
  34421. * Get an animation range by name
  34422. * @param name defines the name of the animation range to look for
  34423. * @returns null if not found else the requested animation range
  34424. */
  34425. getAnimationRange(name: string): Nullable<AnimationRange>;
  34426. /**
  34427. * Gets the list of all animation ranges defined on this node
  34428. * @returns an array
  34429. */
  34430. getAnimationRanges(): Nullable<AnimationRange>[];
  34431. /**
  34432. * Will start the animation sequence
  34433. * @param name defines the range frames for animation sequence
  34434. * @param loop defines if the animation should loop (false by default)
  34435. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34436. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34437. * @returns the object created for this animation. If range does not exist, it will return null
  34438. */
  34439. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34440. /**
  34441. * Serialize animation ranges into a JSON compatible object
  34442. * @returns serialization object
  34443. */
  34444. serializeAnimationRanges(): any;
  34445. /**
  34446. * Computes the world matrix of the node
  34447. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34448. * @returns the world matrix
  34449. */
  34450. computeWorldMatrix(force?: boolean): Matrix;
  34451. /**
  34452. * Releases resources associated with this node.
  34453. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34454. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34455. */
  34456. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34457. /**
  34458. * Parse animation range data from a serialization object and store them into a given node
  34459. * @param node defines where to store the animation ranges
  34460. * @param parsedNode defines the serialization object to read data from
  34461. * @param scene defines the hosting scene
  34462. */
  34463. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34464. /**
  34465. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34466. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34467. * @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
  34468. * @returns the new bounding vectors
  34469. */
  34470. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34471. min: Vector3;
  34472. max: Vector3;
  34473. };
  34474. }
  34475. }
  34476. declare module "babylonjs/Animations/animation" {
  34477. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34478. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34479. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34480. import { Nullable } from "babylonjs/types";
  34481. import { Scene } from "babylonjs/scene";
  34482. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34483. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34484. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34485. import { Node } from "babylonjs/node";
  34486. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34487. import { Size } from "babylonjs/Maths/math.size";
  34488. import { Animatable } from "babylonjs/Animations/animatable";
  34489. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34490. /**
  34491. * @hidden
  34492. */
  34493. export class _IAnimationState {
  34494. key: number;
  34495. repeatCount: number;
  34496. workValue?: any;
  34497. loopMode?: number;
  34498. offsetValue?: any;
  34499. highLimitValue?: any;
  34500. }
  34501. /**
  34502. * Class used to store any kind of animation
  34503. */
  34504. export class Animation {
  34505. /**Name of the animation */
  34506. name: string;
  34507. /**Property to animate */
  34508. targetProperty: string;
  34509. /**The frames per second of the animation */
  34510. framePerSecond: number;
  34511. /**The data type of the animation */
  34512. dataType: number;
  34513. /**The loop mode of the animation */
  34514. loopMode?: number | undefined;
  34515. /**Specifies if blending should be enabled */
  34516. enableBlending?: boolean | undefined;
  34517. /**
  34518. * Use matrix interpolation instead of using direct key value when animating matrices
  34519. */
  34520. static AllowMatricesInterpolation: boolean;
  34521. /**
  34522. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34523. */
  34524. static AllowMatrixDecomposeForInterpolation: boolean;
  34525. /** Define the Url to load snippets */
  34526. static SnippetUrl: string;
  34527. /** Snippet ID if the animation was created from the snippet server */
  34528. snippetId: string;
  34529. /**
  34530. * Stores the key frames of the animation
  34531. */
  34532. private _keys;
  34533. /**
  34534. * Stores the easing function of the animation
  34535. */
  34536. private _easingFunction;
  34537. /**
  34538. * @hidden Internal use only
  34539. */
  34540. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34541. /**
  34542. * The set of event that will be linked to this animation
  34543. */
  34544. private _events;
  34545. /**
  34546. * Stores an array of target property paths
  34547. */
  34548. targetPropertyPath: string[];
  34549. /**
  34550. * Stores the blending speed of the animation
  34551. */
  34552. blendingSpeed: number;
  34553. /**
  34554. * Stores the animation ranges for the animation
  34555. */
  34556. private _ranges;
  34557. /**
  34558. * @hidden Internal use
  34559. */
  34560. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34561. /**
  34562. * Sets up an animation
  34563. * @param property The property to animate
  34564. * @param animationType The animation type to apply
  34565. * @param framePerSecond The frames per second of the animation
  34566. * @param easingFunction The easing function used in the animation
  34567. * @returns The created animation
  34568. */
  34569. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34570. /**
  34571. * Create and start an animation on a node
  34572. * @param name defines the name of the global animation that will be run on all nodes
  34573. * @param node defines the root node where the animation will take place
  34574. * @param targetProperty defines property to animate
  34575. * @param framePerSecond defines the number of frame per second yo use
  34576. * @param totalFrame defines the number of frames in total
  34577. * @param from defines the initial value
  34578. * @param to defines the final value
  34579. * @param loopMode defines which loop mode you want to use (off by default)
  34580. * @param easingFunction defines the easing function to use (linear by default)
  34581. * @param onAnimationEnd defines the callback to call when animation end
  34582. * @returns the animatable created for this animation
  34583. */
  34584. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34585. /**
  34586. * Create and start an animation on a node and its descendants
  34587. * @param name defines the name of the global animation that will be run on all nodes
  34588. * @param node defines the root node where the animation will take place
  34589. * @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
  34590. * @param targetProperty defines property to animate
  34591. * @param framePerSecond defines the number of frame per second to use
  34592. * @param totalFrame defines the number of frames in total
  34593. * @param from defines the initial value
  34594. * @param to defines the final value
  34595. * @param loopMode defines which loop mode you want to use (off by default)
  34596. * @param easingFunction defines the easing function to use (linear by default)
  34597. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34598. * @returns the list of animatables created for all nodes
  34599. * @example https://www.babylonjs-playground.com/#MH0VLI
  34600. */
  34601. 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[]>;
  34602. /**
  34603. * Creates a new animation, merges it with the existing animations and starts it
  34604. * @param name Name of the animation
  34605. * @param node Node which contains the scene that begins the animations
  34606. * @param targetProperty Specifies which property to animate
  34607. * @param framePerSecond The frames per second of the animation
  34608. * @param totalFrame The total number of frames
  34609. * @param from The frame at the beginning of the animation
  34610. * @param to The frame at the end of the animation
  34611. * @param loopMode Specifies the loop mode of the animation
  34612. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34613. * @param onAnimationEnd Callback to run once the animation is complete
  34614. * @returns Nullable animation
  34615. */
  34616. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34617. /**
  34618. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34619. * @param sourceAnimation defines the Animation containing keyframes to convert
  34620. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34621. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34622. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34623. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34624. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34625. */
  34626. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34627. /**
  34628. * Transition property of an host to the target Value
  34629. * @param property The property to transition
  34630. * @param targetValue The target Value of the property
  34631. * @param host The object where the property to animate belongs
  34632. * @param scene Scene used to run the animation
  34633. * @param frameRate Framerate (in frame/s) to use
  34634. * @param transition The transition type we want to use
  34635. * @param duration The duration of the animation, in milliseconds
  34636. * @param onAnimationEnd Callback trigger at the end of the animation
  34637. * @returns Nullable animation
  34638. */
  34639. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34640. /**
  34641. * Return the array of runtime animations currently using this animation
  34642. */
  34643. get runtimeAnimations(): RuntimeAnimation[];
  34644. /**
  34645. * Specifies if any of the runtime animations are currently running
  34646. */
  34647. get hasRunningRuntimeAnimations(): boolean;
  34648. /**
  34649. * Initializes the animation
  34650. * @param name Name of the animation
  34651. * @param targetProperty Property to animate
  34652. * @param framePerSecond The frames per second of the animation
  34653. * @param dataType The data type of the animation
  34654. * @param loopMode The loop mode of the animation
  34655. * @param enableBlending Specifies if blending should be enabled
  34656. */
  34657. constructor(
  34658. /**Name of the animation */
  34659. name: string,
  34660. /**Property to animate */
  34661. targetProperty: string,
  34662. /**The frames per second of the animation */
  34663. framePerSecond: number,
  34664. /**The data type of the animation */
  34665. dataType: number,
  34666. /**The loop mode of the animation */
  34667. loopMode?: number | undefined,
  34668. /**Specifies if blending should be enabled */
  34669. enableBlending?: boolean | undefined);
  34670. /**
  34671. * Converts the animation to a string
  34672. * @param fullDetails support for multiple levels of logging within scene loading
  34673. * @returns String form of the animation
  34674. */
  34675. toString(fullDetails?: boolean): string;
  34676. /**
  34677. * Add an event to this animation
  34678. * @param event Event to add
  34679. */
  34680. addEvent(event: AnimationEvent): void;
  34681. /**
  34682. * Remove all events found at the given frame
  34683. * @param frame The frame to remove events from
  34684. */
  34685. removeEvents(frame: number): void;
  34686. /**
  34687. * Retrieves all the events from the animation
  34688. * @returns Events from the animation
  34689. */
  34690. getEvents(): AnimationEvent[];
  34691. /**
  34692. * Creates an animation range
  34693. * @param name Name of the animation range
  34694. * @param from Starting frame of the animation range
  34695. * @param to Ending frame of the animation
  34696. */
  34697. createRange(name: string, from: number, to: number): void;
  34698. /**
  34699. * Deletes an animation range by name
  34700. * @param name Name of the animation range to delete
  34701. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34702. */
  34703. deleteRange(name: string, deleteFrames?: boolean): void;
  34704. /**
  34705. * Gets the animation range by name, or null if not defined
  34706. * @param name Name of the animation range
  34707. * @returns Nullable animation range
  34708. */
  34709. getRange(name: string): Nullable<AnimationRange>;
  34710. /**
  34711. * Gets the key frames from the animation
  34712. * @returns The key frames of the animation
  34713. */
  34714. getKeys(): Array<IAnimationKey>;
  34715. /**
  34716. * Gets the highest frame rate of the animation
  34717. * @returns Highest frame rate of the animation
  34718. */
  34719. getHighestFrame(): number;
  34720. /**
  34721. * Gets the easing function of the animation
  34722. * @returns Easing function of the animation
  34723. */
  34724. getEasingFunction(): IEasingFunction;
  34725. /**
  34726. * Sets the easing function of the animation
  34727. * @param easingFunction A custom mathematical formula for animation
  34728. */
  34729. setEasingFunction(easingFunction: EasingFunction): void;
  34730. /**
  34731. * Interpolates a scalar linearly
  34732. * @param startValue Start value of the animation curve
  34733. * @param endValue End value of the animation curve
  34734. * @param gradient Scalar amount to interpolate
  34735. * @returns Interpolated scalar value
  34736. */
  34737. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34738. /**
  34739. * Interpolates a scalar cubically
  34740. * @param startValue Start value of the animation curve
  34741. * @param outTangent End tangent of the animation
  34742. * @param endValue End value of the animation curve
  34743. * @param inTangent Start tangent of the animation curve
  34744. * @param gradient Scalar amount to interpolate
  34745. * @returns Interpolated scalar value
  34746. */
  34747. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34748. /**
  34749. * Interpolates a quaternion using a spherical linear interpolation
  34750. * @param startValue Start value of the animation curve
  34751. * @param endValue End value of the animation curve
  34752. * @param gradient Scalar amount to interpolate
  34753. * @returns Interpolated quaternion value
  34754. */
  34755. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34756. /**
  34757. * Interpolates a quaternion cubically
  34758. * @param startValue Start value of the animation curve
  34759. * @param outTangent End tangent of the animation curve
  34760. * @param endValue End value of the animation curve
  34761. * @param inTangent Start tangent of the animation curve
  34762. * @param gradient Scalar amount to interpolate
  34763. * @returns Interpolated quaternion value
  34764. */
  34765. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34766. /**
  34767. * Interpolates a Vector3 linearl
  34768. * @param startValue Start value of the animation curve
  34769. * @param endValue End value of the animation curve
  34770. * @param gradient Scalar amount to interpolate
  34771. * @returns Interpolated scalar value
  34772. */
  34773. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34774. /**
  34775. * Interpolates a Vector3 cubically
  34776. * @param startValue Start value of the animation curve
  34777. * @param outTangent End tangent of the animation
  34778. * @param endValue End value of the animation curve
  34779. * @param inTangent Start tangent of the animation curve
  34780. * @param gradient Scalar amount to interpolate
  34781. * @returns InterpolatedVector3 value
  34782. */
  34783. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34784. /**
  34785. * Interpolates a Vector2 linearly
  34786. * @param startValue Start value of the animation curve
  34787. * @param endValue End value of the animation curve
  34788. * @param gradient Scalar amount to interpolate
  34789. * @returns Interpolated Vector2 value
  34790. */
  34791. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34792. /**
  34793. * Interpolates a Vector2 cubically
  34794. * @param startValue Start value of the animation curve
  34795. * @param outTangent End tangent of the animation
  34796. * @param endValue End value of the animation curve
  34797. * @param inTangent Start tangent of the animation curve
  34798. * @param gradient Scalar amount to interpolate
  34799. * @returns Interpolated Vector2 value
  34800. */
  34801. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34802. /**
  34803. * Interpolates a size linearly
  34804. * @param startValue Start value of the animation curve
  34805. * @param endValue End value of the animation curve
  34806. * @param gradient Scalar amount to interpolate
  34807. * @returns Interpolated Size value
  34808. */
  34809. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34810. /**
  34811. * Interpolates a Color3 linearly
  34812. * @param startValue Start value of the animation curve
  34813. * @param endValue End value of the animation curve
  34814. * @param gradient Scalar amount to interpolate
  34815. * @returns Interpolated Color3 value
  34816. */
  34817. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34818. /**
  34819. * Interpolates a Color4 linearly
  34820. * @param startValue Start value of the animation curve
  34821. * @param endValue End value of the animation curve
  34822. * @param gradient Scalar amount to interpolate
  34823. * @returns Interpolated Color3 value
  34824. */
  34825. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34826. /**
  34827. * @hidden Internal use only
  34828. */
  34829. _getKeyValue(value: any): any;
  34830. /**
  34831. * @hidden Internal use only
  34832. */
  34833. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34834. /**
  34835. * Defines the function to use to interpolate matrices
  34836. * @param startValue defines the start matrix
  34837. * @param endValue defines the end matrix
  34838. * @param gradient defines the gradient between both matrices
  34839. * @param result defines an optional target matrix where to store the interpolation
  34840. * @returns the interpolated matrix
  34841. */
  34842. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34843. /**
  34844. * Makes a copy of the animation
  34845. * @returns Cloned animation
  34846. */
  34847. clone(): Animation;
  34848. /**
  34849. * Sets the key frames of the animation
  34850. * @param values The animation key frames to set
  34851. */
  34852. setKeys(values: Array<IAnimationKey>): void;
  34853. /**
  34854. * Serializes the animation to an object
  34855. * @returns Serialized object
  34856. */
  34857. serialize(): any;
  34858. /**
  34859. * Float animation type
  34860. */
  34861. static readonly ANIMATIONTYPE_FLOAT: number;
  34862. /**
  34863. * Vector3 animation type
  34864. */
  34865. static readonly ANIMATIONTYPE_VECTOR3: number;
  34866. /**
  34867. * Quaternion animation type
  34868. */
  34869. static readonly ANIMATIONTYPE_QUATERNION: number;
  34870. /**
  34871. * Matrix animation type
  34872. */
  34873. static readonly ANIMATIONTYPE_MATRIX: number;
  34874. /**
  34875. * Color3 animation type
  34876. */
  34877. static readonly ANIMATIONTYPE_COLOR3: number;
  34878. /**
  34879. * Color3 animation type
  34880. */
  34881. static readonly ANIMATIONTYPE_COLOR4: number;
  34882. /**
  34883. * Vector2 animation type
  34884. */
  34885. static readonly ANIMATIONTYPE_VECTOR2: number;
  34886. /**
  34887. * Size animation type
  34888. */
  34889. static readonly ANIMATIONTYPE_SIZE: number;
  34890. /**
  34891. * Relative Loop Mode
  34892. */
  34893. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34894. /**
  34895. * Cycle Loop Mode
  34896. */
  34897. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34898. /**
  34899. * Constant Loop Mode
  34900. */
  34901. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  34902. /** @hidden */
  34903. static _UniversalLerp(left: any, right: any, amount: number): any;
  34904. /**
  34905. * Parses an animation object and creates an animation
  34906. * @param parsedAnimation Parsed animation object
  34907. * @returns Animation object
  34908. */
  34909. static Parse(parsedAnimation: any): Animation;
  34910. /**
  34911. * Appends the serialized animations from the source animations
  34912. * @param source Source containing the animations
  34913. * @param destination Target to store the animations
  34914. */
  34915. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34916. /**
  34917. * Creates a new animation or an array of animations from a snippet saved in a remote file
  34918. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  34919. * @param url defines the url to load from
  34920. * @returns a promise that will resolve to the new animation or an array of animations
  34921. */
  34922. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  34923. /**
  34924. * Creates an animation or an array of animations from a snippet saved by the Inspector
  34925. * @param snippetId defines the snippet to load
  34926. * @returns a promise that will resolve to the new animation or a new array of animations
  34927. */
  34928. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  34929. }
  34930. }
  34931. declare module "babylonjs/Animations/animatable.interface" {
  34932. import { Nullable } from "babylonjs/types";
  34933. import { Animation } from "babylonjs/Animations/animation";
  34934. /**
  34935. * Interface containing an array of animations
  34936. */
  34937. export interface IAnimatable {
  34938. /**
  34939. * Array of animations
  34940. */
  34941. animations: Nullable<Array<Animation>>;
  34942. }
  34943. }
  34944. declare module "babylonjs/Misc/decorators" {
  34945. import { Nullable } from "babylonjs/types";
  34946. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34947. import { Scene } from "babylonjs/scene";
  34948. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34949. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  34950. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  34951. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34952. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  34953. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34954. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34955. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34956. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34957. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34958. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34959. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34960. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34961. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34962. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34963. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34964. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34965. /**
  34966. * Decorator used to define property that can be serialized as reference to a camera
  34967. * @param sourceName defines the name of the property to decorate
  34968. */
  34969. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34970. /**
  34971. * Class used to help serialization objects
  34972. */
  34973. export class SerializationHelper {
  34974. /** @hidden */
  34975. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  34976. /** @hidden */
  34977. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  34978. /** @hidden */
  34979. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  34980. /** @hidden */
  34981. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  34982. /**
  34983. * Appends the serialized animations from the source animations
  34984. * @param source Source containing the animations
  34985. * @param destination Target to store the animations
  34986. */
  34987. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34988. /**
  34989. * Static function used to serialized a specific entity
  34990. * @param entity defines the entity to serialize
  34991. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  34992. * @returns a JSON compatible object representing the serialization of the entity
  34993. */
  34994. static Serialize<T>(entity: T, serializationObject?: any): any;
  34995. /**
  34996. * Creates a new entity from a serialization data object
  34997. * @param creationFunction defines a function used to instanciated the new entity
  34998. * @param source defines the source serialization data
  34999. * @param scene defines the hosting scene
  35000. * @param rootUrl defines the root url for resources
  35001. * @returns a new entity
  35002. */
  35003. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  35004. /**
  35005. * Clones an object
  35006. * @param creationFunction defines the function used to instanciate the new object
  35007. * @param source defines the source object
  35008. * @returns the cloned object
  35009. */
  35010. static Clone<T>(creationFunction: () => T, source: T): T;
  35011. /**
  35012. * Instanciates a new object based on a source one (some data will be shared between both object)
  35013. * @param creationFunction defines the function used to instanciate the new object
  35014. * @param source defines the source object
  35015. * @returns the new object
  35016. */
  35017. static Instanciate<T>(creationFunction: () => T, source: T): T;
  35018. }
  35019. }
  35020. declare module "babylonjs/Materials/Textures/baseTexture" {
  35021. import { Observable } from "babylonjs/Misc/observable";
  35022. import { Nullable } from "babylonjs/types";
  35023. import { Scene } from "babylonjs/scene";
  35024. import { Matrix } from "babylonjs/Maths/math.vector";
  35025. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35026. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35027. import { ISize } from "babylonjs/Maths/math.size";
  35028. import "babylonjs/Misc/fileTools";
  35029. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35030. /**
  35031. * Base class of all the textures in babylon.
  35032. * It groups all the common properties the materials, post process, lights... might need
  35033. * in order to make a correct use of the texture.
  35034. */
  35035. export class BaseTexture implements IAnimatable {
  35036. /**
  35037. * Default anisotropic filtering level for the application.
  35038. * It is set to 4 as a good tradeoff between perf and quality.
  35039. */
  35040. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  35041. /**
  35042. * Gets or sets the unique id of the texture
  35043. */
  35044. uniqueId: number;
  35045. /**
  35046. * Define the name of the texture.
  35047. */
  35048. name: string;
  35049. /**
  35050. * Gets or sets an object used to store user defined information.
  35051. */
  35052. metadata: any;
  35053. /**
  35054. * For internal use only. Please do not use.
  35055. */
  35056. reservedDataStore: any;
  35057. private _hasAlpha;
  35058. /**
  35059. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  35060. */
  35061. set hasAlpha(value: boolean);
  35062. get hasAlpha(): boolean;
  35063. /**
  35064. * Defines if the alpha value should be determined via the rgb values.
  35065. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  35066. */
  35067. getAlphaFromRGB: boolean;
  35068. /**
  35069. * Intensity or strength of the texture.
  35070. * It is commonly used by materials to fine tune the intensity of the texture
  35071. */
  35072. level: number;
  35073. /**
  35074. * Define the UV chanel to use starting from 0 and defaulting to 0.
  35075. * This is part of the texture as textures usually maps to one uv set.
  35076. */
  35077. coordinatesIndex: number;
  35078. protected _coordinatesMode: number;
  35079. /**
  35080. * How a texture is mapped.
  35081. *
  35082. * | Value | Type | Description |
  35083. * | ----- | ----------------------------------- | ----------- |
  35084. * | 0 | EXPLICIT_MODE | |
  35085. * | 1 | SPHERICAL_MODE | |
  35086. * | 2 | PLANAR_MODE | |
  35087. * | 3 | CUBIC_MODE | |
  35088. * | 4 | PROJECTION_MODE | |
  35089. * | 5 | SKYBOX_MODE | |
  35090. * | 6 | INVCUBIC_MODE | |
  35091. * | 7 | EQUIRECTANGULAR_MODE | |
  35092. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  35093. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  35094. */
  35095. set coordinatesMode(value: number);
  35096. get coordinatesMode(): number;
  35097. private _wrapU;
  35098. /**
  35099. * | Value | Type | Description |
  35100. * | ----- | ------------------ | ----------- |
  35101. * | 0 | CLAMP_ADDRESSMODE | |
  35102. * | 1 | WRAP_ADDRESSMODE | |
  35103. * | 2 | MIRROR_ADDRESSMODE | |
  35104. */
  35105. get wrapU(): number;
  35106. set wrapU(value: number);
  35107. private _wrapV;
  35108. /**
  35109. * | Value | Type | Description |
  35110. * | ----- | ------------------ | ----------- |
  35111. * | 0 | CLAMP_ADDRESSMODE | |
  35112. * | 1 | WRAP_ADDRESSMODE | |
  35113. * | 2 | MIRROR_ADDRESSMODE | |
  35114. */
  35115. get wrapV(): number;
  35116. set wrapV(value: number);
  35117. /**
  35118. * | Value | Type | Description |
  35119. * | ----- | ------------------ | ----------- |
  35120. * | 0 | CLAMP_ADDRESSMODE | |
  35121. * | 1 | WRAP_ADDRESSMODE | |
  35122. * | 2 | MIRROR_ADDRESSMODE | |
  35123. */
  35124. wrapR: number;
  35125. /**
  35126. * With compliant hardware and browser (supporting anisotropic filtering)
  35127. * this defines the level of anisotropic filtering in the texture.
  35128. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  35129. */
  35130. anisotropicFilteringLevel: number;
  35131. /**
  35132. * Define if the texture is a cube texture or if false a 2d texture.
  35133. */
  35134. get isCube(): boolean;
  35135. set isCube(value: boolean);
  35136. /**
  35137. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  35138. */
  35139. get is3D(): boolean;
  35140. set is3D(value: boolean);
  35141. /**
  35142. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  35143. */
  35144. get is2DArray(): boolean;
  35145. set is2DArray(value: boolean);
  35146. /**
  35147. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  35148. * HDR texture are usually stored in linear space.
  35149. * This only impacts the PBR and Background materials
  35150. */
  35151. gammaSpace: boolean;
  35152. /**
  35153. * Gets or sets whether or not the texture contains RGBD data.
  35154. */
  35155. get isRGBD(): boolean;
  35156. set isRGBD(value: boolean);
  35157. /**
  35158. * Is Z inverted in the texture (useful in a cube texture).
  35159. */
  35160. invertZ: boolean;
  35161. /**
  35162. * Are mip maps generated for this texture or not.
  35163. */
  35164. get noMipmap(): boolean;
  35165. /**
  35166. * @hidden
  35167. */
  35168. lodLevelInAlpha: boolean;
  35169. /**
  35170. * With prefiltered texture, defined the offset used during the prefiltering steps.
  35171. */
  35172. get lodGenerationOffset(): number;
  35173. set lodGenerationOffset(value: number);
  35174. /**
  35175. * With prefiltered texture, defined the scale used during the prefiltering steps.
  35176. */
  35177. get lodGenerationScale(): number;
  35178. set lodGenerationScale(value: number);
  35179. /**
  35180. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  35181. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  35182. * average roughness values.
  35183. */
  35184. get linearSpecularLOD(): boolean;
  35185. set linearSpecularLOD(value: boolean);
  35186. /**
  35187. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  35188. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  35189. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  35190. */
  35191. get irradianceTexture(): Nullable<BaseTexture>;
  35192. set irradianceTexture(value: Nullable<BaseTexture>);
  35193. /**
  35194. * Define if the texture is a render target.
  35195. */
  35196. isRenderTarget: boolean;
  35197. /**
  35198. * Define the unique id of the texture in the scene.
  35199. */
  35200. get uid(): string;
  35201. /** @hidden */
  35202. _prefiltered: boolean;
  35203. /**
  35204. * Return a string representation of the texture.
  35205. * @returns the texture as a string
  35206. */
  35207. toString(): string;
  35208. /**
  35209. * Get the class name of the texture.
  35210. * @returns "BaseTexture"
  35211. */
  35212. getClassName(): string;
  35213. /**
  35214. * Define the list of animation attached to the texture.
  35215. */
  35216. animations: import("babylonjs/Animations/animation").Animation[];
  35217. /**
  35218. * An event triggered when the texture is disposed.
  35219. */
  35220. onDisposeObservable: Observable<BaseTexture>;
  35221. private _onDisposeObserver;
  35222. /**
  35223. * Callback triggered when the texture has been disposed.
  35224. * Kept for back compatibility, you can use the onDisposeObservable instead.
  35225. */
  35226. set onDispose(callback: () => void);
  35227. /**
  35228. * Define the current state of the loading sequence when in delayed load mode.
  35229. */
  35230. delayLoadState: number;
  35231. protected _scene: Nullable<Scene>;
  35232. protected _engine: Nullable<ThinEngine>;
  35233. /** @hidden */
  35234. _texture: Nullable<InternalTexture>;
  35235. private _uid;
  35236. /**
  35237. * Define if the texture is preventinga material to render or not.
  35238. * If not and the texture is not ready, the engine will use a default black texture instead.
  35239. */
  35240. get isBlocking(): boolean;
  35241. /**
  35242. * Instantiates a new BaseTexture.
  35243. * Base class of all the textures in babylon.
  35244. * It groups all the common properties the materials, post process, lights... might need
  35245. * in order to make a correct use of the texture.
  35246. * @param sceneOrEngine Define the scene or engine the texture blongs to
  35247. */
  35248. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  35249. /**
  35250. * Get the scene the texture belongs to.
  35251. * @returns the scene or null if undefined
  35252. */
  35253. getScene(): Nullable<Scene>;
  35254. /** @hidden */
  35255. protected _getEngine(): Nullable<ThinEngine>;
  35256. /**
  35257. * Get the texture transform matrix used to offset tile the texture for istance.
  35258. * @returns the transformation matrix
  35259. */
  35260. getTextureMatrix(): Matrix;
  35261. /**
  35262. * Get the texture reflection matrix used to rotate/transform the reflection.
  35263. * @returns the reflection matrix
  35264. */
  35265. getReflectionTextureMatrix(): Matrix;
  35266. /**
  35267. * Get the underlying lower level texture from Babylon.
  35268. * @returns the insternal texture
  35269. */
  35270. getInternalTexture(): Nullable<InternalTexture>;
  35271. /**
  35272. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  35273. * @returns true if ready or not blocking
  35274. */
  35275. isReadyOrNotBlocking(): boolean;
  35276. /**
  35277. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35278. * @returns true if fully ready
  35279. */
  35280. isReady(): boolean;
  35281. private _cachedSize;
  35282. /**
  35283. * Get the size of the texture.
  35284. * @returns the texture size.
  35285. */
  35286. getSize(): ISize;
  35287. /**
  35288. * Get the base size of the texture.
  35289. * It can be different from the size if the texture has been resized for POT for instance
  35290. * @returns the base size
  35291. */
  35292. getBaseSize(): ISize;
  35293. /**
  35294. * Update the sampling mode of the texture.
  35295. * Default is Trilinear mode.
  35296. *
  35297. * | Value | Type | Description |
  35298. * | ----- | ------------------ | ----------- |
  35299. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35300. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35301. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35302. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35303. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35304. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35305. * | 7 | NEAREST_LINEAR | |
  35306. * | 8 | NEAREST_NEAREST | |
  35307. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35308. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35309. * | 11 | LINEAR_LINEAR | |
  35310. * | 12 | LINEAR_NEAREST | |
  35311. *
  35312. * > _mag_: magnification filter (close to the viewer)
  35313. * > _min_: minification filter (far from the viewer)
  35314. * > _mip_: filter used between mip map levels
  35315. *@param samplingMode Define the new sampling mode of the texture
  35316. */
  35317. updateSamplingMode(samplingMode: number): void;
  35318. /**
  35319. * Scales the texture if is `canRescale()`
  35320. * @param ratio the resize factor we want to use to rescale
  35321. */
  35322. scale(ratio: number): void;
  35323. /**
  35324. * Get if the texture can rescale.
  35325. */
  35326. get canRescale(): boolean;
  35327. /** @hidden */
  35328. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35329. /** @hidden */
  35330. _rebuild(): void;
  35331. /**
  35332. * Triggers the load sequence in delayed load mode.
  35333. */
  35334. delayLoad(): void;
  35335. /**
  35336. * Clones the texture.
  35337. * @returns the cloned texture
  35338. */
  35339. clone(): Nullable<BaseTexture>;
  35340. /**
  35341. * Get the texture underlying type (INT, FLOAT...)
  35342. */
  35343. get textureType(): number;
  35344. /**
  35345. * Get the texture underlying format (RGB, RGBA...)
  35346. */
  35347. get textureFormat(): number;
  35348. /**
  35349. * Indicates that textures need to be re-calculated for all materials
  35350. */
  35351. protected _markAllSubMeshesAsTexturesDirty(): void;
  35352. /**
  35353. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35354. * This will returns an RGBA array buffer containing either in values (0-255) or
  35355. * float values (0-1) depending of the underlying buffer type.
  35356. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35357. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35358. * @param buffer defines a user defined buffer to fill with data (can be null)
  35359. * @returns The Array buffer containing the pixels data.
  35360. */
  35361. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35362. /**
  35363. * Release and destroy the underlying lower level texture aka internalTexture.
  35364. */
  35365. releaseInternalTexture(): void;
  35366. /** @hidden */
  35367. get _lodTextureHigh(): Nullable<BaseTexture>;
  35368. /** @hidden */
  35369. get _lodTextureMid(): Nullable<BaseTexture>;
  35370. /** @hidden */
  35371. get _lodTextureLow(): Nullable<BaseTexture>;
  35372. /**
  35373. * Dispose the texture and release its associated resources.
  35374. */
  35375. dispose(): void;
  35376. /**
  35377. * Serialize the texture into a JSON representation that can be parsed later on.
  35378. * @returns the JSON representation of the texture
  35379. */
  35380. serialize(): any;
  35381. /**
  35382. * Helper function to be called back once a list of texture contains only ready textures.
  35383. * @param textures Define the list of textures to wait for
  35384. * @param callback Define the callback triggered once the entire list will be ready
  35385. */
  35386. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35387. private static _isScene;
  35388. }
  35389. }
  35390. declare module "babylonjs/Materials/effect" {
  35391. import { Observable } from "babylonjs/Misc/observable";
  35392. import { Nullable } from "babylonjs/types";
  35393. import { IDisposable } from "babylonjs/scene";
  35394. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35395. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35396. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35397. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35398. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35399. import { Engine } from "babylonjs/Engines/engine";
  35400. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35401. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35402. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35403. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35404. /**
  35405. * Options to be used when creating an effect.
  35406. */
  35407. export interface IEffectCreationOptions {
  35408. /**
  35409. * Atrributes that will be used in the shader.
  35410. */
  35411. attributes: string[];
  35412. /**
  35413. * Uniform varible names that will be set in the shader.
  35414. */
  35415. uniformsNames: string[];
  35416. /**
  35417. * Uniform buffer variable names that will be set in the shader.
  35418. */
  35419. uniformBuffersNames: string[];
  35420. /**
  35421. * Sampler texture variable names that will be set in the shader.
  35422. */
  35423. samplers: string[];
  35424. /**
  35425. * Define statements that will be set in the shader.
  35426. */
  35427. defines: any;
  35428. /**
  35429. * Possible fallbacks for this effect to improve performance when needed.
  35430. */
  35431. fallbacks: Nullable<IEffectFallbacks>;
  35432. /**
  35433. * Callback that will be called when the shader is compiled.
  35434. */
  35435. onCompiled: Nullable<(effect: Effect) => void>;
  35436. /**
  35437. * Callback that will be called if an error occurs during shader compilation.
  35438. */
  35439. onError: Nullable<(effect: Effect, errors: string) => void>;
  35440. /**
  35441. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35442. */
  35443. indexParameters?: any;
  35444. /**
  35445. * Max number of lights that can be used in the shader.
  35446. */
  35447. maxSimultaneousLights?: number;
  35448. /**
  35449. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35450. */
  35451. transformFeedbackVaryings?: Nullable<string[]>;
  35452. /**
  35453. * 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
  35454. */
  35455. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35456. /**
  35457. * Is this effect rendering to several color attachments ?
  35458. */
  35459. multiTarget?: boolean;
  35460. }
  35461. /**
  35462. * Effect containing vertex and fragment shader that can be executed on an object.
  35463. */
  35464. export class Effect implements IDisposable {
  35465. /**
  35466. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35467. */
  35468. static ShadersRepository: string;
  35469. /**
  35470. * Enable logging of the shader code when a compilation error occurs
  35471. */
  35472. static LogShaderCodeOnCompilationError: boolean;
  35473. /**
  35474. * Name of the effect.
  35475. */
  35476. name: any;
  35477. /**
  35478. * String container all the define statements that should be set on the shader.
  35479. */
  35480. defines: string;
  35481. /**
  35482. * Callback that will be called when the shader is compiled.
  35483. */
  35484. onCompiled: Nullable<(effect: Effect) => void>;
  35485. /**
  35486. * Callback that will be called if an error occurs during shader compilation.
  35487. */
  35488. onError: Nullable<(effect: Effect, errors: string) => void>;
  35489. /**
  35490. * Callback that will be called when effect is bound.
  35491. */
  35492. onBind: Nullable<(effect: Effect) => void>;
  35493. /**
  35494. * Unique ID of the effect.
  35495. */
  35496. uniqueId: number;
  35497. /**
  35498. * Observable that will be called when the shader is compiled.
  35499. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35500. */
  35501. onCompileObservable: Observable<Effect>;
  35502. /**
  35503. * Observable that will be called if an error occurs during shader compilation.
  35504. */
  35505. onErrorObservable: Observable<Effect>;
  35506. /** @hidden */
  35507. _onBindObservable: Nullable<Observable<Effect>>;
  35508. /**
  35509. * @hidden
  35510. * Specifies if the effect was previously ready
  35511. */
  35512. _wasPreviouslyReady: boolean;
  35513. /**
  35514. * Observable that will be called when effect is bound.
  35515. */
  35516. get onBindObservable(): Observable<Effect>;
  35517. /** @hidden */
  35518. _bonesComputationForcedToCPU: boolean;
  35519. /** @hidden */
  35520. _multiTarget: boolean;
  35521. private static _uniqueIdSeed;
  35522. private _engine;
  35523. private _uniformBuffersNames;
  35524. private _uniformBuffersNamesList;
  35525. private _uniformsNames;
  35526. private _samplerList;
  35527. private _samplers;
  35528. private _isReady;
  35529. private _compilationError;
  35530. private _allFallbacksProcessed;
  35531. private _attributesNames;
  35532. private _attributes;
  35533. private _attributeLocationByName;
  35534. private _uniforms;
  35535. /**
  35536. * Key for the effect.
  35537. * @hidden
  35538. */
  35539. _key: string;
  35540. private _indexParameters;
  35541. private _fallbacks;
  35542. private _vertexSourceCode;
  35543. private _fragmentSourceCode;
  35544. private _vertexSourceCodeOverride;
  35545. private _fragmentSourceCodeOverride;
  35546. private _transformFeedbackVaryings;
  35547. /**
  35548. * Compiled shader to webGL program.
  35549. * @hidden
  35550. */
  35551. _pipelineContext: Nullable<IPipelineContext>;
  35552. private _valueCache;
  35553. private static _baseCache;
  35554. /**
  35555. * Instantiates an effect.
  35556. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35557. * @param baseName Name of the effect.
  35558. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35559. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35560. * @param samplers List of sampler variables that will be passed to the shader.
  35561. * @param engine Engine to be used to render the effect
  35562. * @param defines Define statements to be added to the shader.
  35563. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35564. * @param onCompiled Callback that will be called when the shader is compiled.
  35565. * @param onError Callback that will be called if an error occurs during shader compilation.
  35566. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35567. */
  35568. 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);
  35569. private _useFinalCode;
  35570. /**
  35571. * Unique key for this effect
  35572. */
  35573. get key(): string;
  35574. /**
  35575. * If the effect has been compiled and prepared.
  35576. * @returns if the effect is compiled and prepared.
  35577. */
  35578. isReady(): boolean;
  35579. private _isReadyInternal;
  35580. /**
  35581. * The engine the effect was initialized with.
  35582. * @returns the engine.
  35583. */
  35584. getEngine(): Engine;
  35585. /**
  35586. * The pipeline context for this effect
  35587. * @returns the associated pipeline context
  35588. */
  35589. getPipelineContext(): Nullable<IPipelineContext>;
  35590. /**
  35591. * The set of names of attribute variables for the shader.
  35592. * @returns An array of attribute names.
  35593. */
  35594. getAttributesNames(): string[];
  35595. /**
  35596. * Returns the attribute at the given index.
  35597. * @param index The index of the attribute.
  35598. * @returns The location of the attribute.
  35599. */
  35600. getAttributeLocation(index: number): number;
  35601. /**
  35602. * Returns the attribute based on the name of the variable.
  35603. * @param name of the attribute to look up.
  35604. * @returns the attribute location.
  35605. */
  35606. getAttributeLocationByName(name: string): number;
  35607. /**
  35608. * The number of attributes.
  35609. * @returns the numnber of attributes.
  35610. */
  35611. getAttributesCount(): number;
  35612. /**
  35613. * Gets the index of a uniform variable.
  35614. * @param uniformName of the uniform to look up.
  35615. * @returns the index.
  35616. */
  35617. getUniformIndex(uniformName: string): number;
  35618. /**
  35619. * Returns the attribute based on the name of the variable.
  35620. * @param uniformName of the uniform to look up.
  35621. * @returns the location of the uniform.
  35622. */
  35623. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35624. /**
  35625. * Returns an array of sampler variable names
  35626. * @returns The array of sampler variable names.
  35627. */
  35628. getSamplers(): string[];
  35629. /**
  35630. * Returns an array of uniform variable names
  35631. * @returns The array of uniform variable names.
  35632. */
  35633. getUniformNames(): string[];
  35634. /**
  35635. * Returns an array of uniform buffer variable names
  35636. * @returns The array of uniform buffer variable names.
  35637. */
  35638. getUniformBuffersNames(): string[];
  35639. /**
  35640. * Returns the index parameters used to create the effect
  35641. * @returns The index parameters object
  35642. */
  35643. getIndexParameters(): any;
  35644. /**
  35645. * The error from the last compilation.
  35646. * @returns the error string.
  35647. */
  35648. getCompilationError(): string;
  35649. /**
  35650. * Gets a boolean indicating that all fallbacks were used during compilation
  35651. * @returns true if all fallbacks were used
  35652. */
  35653. allFallbacksProcessed(): boolean;
  35654. /**
  35655. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35656. * @param func The callback to be used.
  35657. */
  35658. executeWhenCompiled(func: (effect: Effect) => void): void;
  35659. private _checkIsReady;
  35660. private _loadShader;
  35661. /**
  35662. * Gets the vertex shader source code of this effect
  35663. */
  35664. get vertexSourceCode(): string;
  35665. /**
  35666. * Gets the fragment shader source code of this effect
  35667. */
  35668. get fragmentSourceCode(): string;
  35669. /**
  35670. * Recompiles the webGL program
  35671. * @param vertexSourceCode The source code for the vertex shader.
  35672. * @param fragmentSourceCode The source code for the fragment shader.
  35673. * @param onCompiled Callback called when completed.
  35674. * @param onError Callback called on error.
  35675. * @hidden
  35676. */
  35677. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35678. /**
  35679. * Prepares the effect
  35680. * @hidden
  35681. */
  35682. _prepareEffect(): void;
  35683. private _getShaderCodeAndErrorLine;
  35684. private _processCompilationErrors;
  35685. /**
  35686. * Checks if the effect is supported. (Must be called after compilation)
  35687. */
  35688. get isSupported(): boolean;
  35689. /**
  35690. * Binds a texture to the engine to be used as output of the shader.
  35691. * @param channel Name of the output variable.
  35692. * @param texture Texture to bind.
  35693. * @hidden
  35694. */
  35695. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35696. /**
  35697. * Sets a texture on the engine to be used in the shader.
  35698. * @param channel Name of the sampler variable.
  35699. * @param texture Texture to set.
  35700. */
  35701. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35702. /**
  35703. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35704. * @param channel Name of the sampler variable.
  35705. * @param texture Texture to set.
  35706. */
  35707. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35708. /**
  35709. * Sets an array of textures on the engine to be used in the shader.
  35710. * @param channel Name of the variable.
  35711. * @param textures Textures to set.
  35712. */
  35713. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35714. /**
  35715. * 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)
  35716. * @param channel Name of the sampler variable.
  35717. * @param postProcess Post process to get the input texture from.
  35718. */
  35719. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35720. /**
  35721. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35722. * 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)
  35723. * @param channel Name of the sampler variable.
  35724. * @param postProcess Post process to get the output texture from.
  35725. */
  35726. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35727. /** @hidden */
  35728. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35729. /** @hidden */
  35730. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35731. /** @hidden */
  35732. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35733. /** @hidden */
  35734. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35735. /**
  35736. * Binds a buffer to a uniform.
  35737. * @param buffer Buffer to bind.
  35738. * @param name Name of the uniform variable to bind to.
  35739. */
  35740. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35741. /**
  35742. * Binds block to a uniform.
  35743. * @param blockName Name of the block to bind.
  35744. * @param index Index to bind.
  35745. */
  35746. bindUniformBlock(blockName: string, index: number): void;
  35747. /**
  35748. * Sets an interger value on a uniform variable.
  35749. * @param uniformName Name of the variable.
  35750. * @param value Value to be set.
  35751. * @returns this effect.
  35752. */
  35753. setInt(uniformName: string, value: number): Effect;
  35754. /**
  35755. * Sets an int array on a uniform variable.
  35756. * @param uniformName Name of the variable.
  35757. * @param array array to be set.
  35758. * @returns this effect.
  35759. */
  35760. setIntArray(uniformName: string, array: Int32Array): Effect;
  35761. /**
  35762. * 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)
  35763. * @param uniformName Name of the variable.
  35764. * @param array array to be set.
  35765. * @returns this effect.
  35766. */
  35767. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35768. /**
  35769. * 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)
  35770. * @param uniformName Name of the variable.
  35771. * @param array array to be set.
  35772. * @returns this effect.
  35773. */
  35774. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35775. /**
  35776. * 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)
  35777. * @param uniformName Name of the variable.
  35778. * @param array array to be set.
  35779. * @returns this effect.
  35780. */
  35781. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35782. /**
  35783. * Sets an float array on a uniform variable.
  35784. * @param uniformName Name of the variable.
  35785. * @param array array to be set.
  35786. * @returns this effect.
  35787. */
  35788. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35789. /**
  35790. * 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)
  35791. * @param uniformName Name of the variable.
  35792. * @param array array to be set.
  35793. * @returns this effect.
  35794. */
  35795. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35796. /**
  35797. * 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)
  35798. * @param uniformName Name of the variable.
  35799. * @param array array to be set.
  35800. * @returns this effect.
  35801. */
  35802. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35803. /**
  35804. * 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)
  35805. * @param uniformName Name of the variable.
  35806. * @param array array to be set.
  35807. * @returns this effect.
  35808. */
  35809. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35810. /**
  35811. * Sets an array on a uniform variable.
  35812. * @param uniformName Name of the variable.
  35813. * @param array array to be set.
  35814. * @returns this effect.
  35815. */
  35816. setArray(uniformName: string, array: number[]): Effect;
  35817. /**
  35818. * 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)
  35819. * @param uniformName Name of the variable.
  35820. * @param array array to be set.
  35821. * @returns this effect.
  35822. */
  35823. setArray2(uniformName: string, array: number[]): Effect;
  35824. /**
  35825. * 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)
  35826. * @param uniformName Name of the variable.
  35827. * @param array array to be set.
  35828. * @returns this effect.
  35829. */
  35830. setArray3(uniformName: string, array: number[]): Effect;
  35831. /**
  35832. * 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)
  35833. * @param uniformName Name of the variable.
  35834. * @param array array to be set.
  35835. * @returns this effect.
  35836. */
  35837. setArray4(uniformName: string, array: number[]): Effect;
  35838. /**
  35839. * Sets matrices on a uniform variable.
  35840. * @param uniformName Name of the variable.
  35841. * @param matrices matrices to be set.
  35842. * @returns this effect.
  35843. */
  35844. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35845. /**
  35846. * Sets matrix on a uniform variable.
  35847. * @param uniformName Name of the variable.
  35848. * @param matrix matrix to be set.
  35849. * @returns this effect.
  35850. */
  35851. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35852. /**
  35853. * 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)
  35854. * @param uniformName Name of the variable.
  35855. * @param matrix matrix to be set.
  35856. * @returns this effect.
  35857. */
  35858. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35859. /**
  35860. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35861. * @param uniformName Name of the variable.
  35862. * @param matrix matrix to be set.
  35863. * @returns this effect.
  35864. */
  35865. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35866. /**
  35867. * Sets a float on a uniform variable.
  35868. * @param uniformName Name of the variable.
  35869. * @param value value to be set.
  35870. * @returns this effect.
  35871. */
  35872. setFloat(uniformName: string, value: number): Effect;
  35873. /**
  35874. * Sets a boolean on a uniform variable.
  35875. * @param uniformName Name of the variable.
  35876. * @param bool value to be set.
  35877. * @returns this effect.
  35878. */
  35879. setBool(uniformName: string, bool: boolean): Effect;
  35880. /**
  35881. * Sets a Vector2 on a uniform variable.
  35882. * @param uniformName Name of the variable.
  35883. * @param vector2 vector2 to be set.
  35884. * @returns this effect.
  35885. */
  35886. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35887. /**
  35888. * Sets a float2 on a uniform variable.
  35889. * @param uniformName Name of the variable.
  35890. * @param x First float in float2.
  35891. * @param y Second float in float2.
  35892. * @returns this effect.
  35893. */
  35894. setFloat2(uniformName: string, x: number, y: number): Effect;
  35895. /**
  35896. * Sets a Vector3 on a uniform variable.
  35897. * @param uniformName Name of the variable.
  35898. * @param vector3 Value to be set.
  35899. * @returns this effect.
  35900. */
  35901. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  35902. /**
  35903. * Sets a float3 on a uniform variable.
  35904. * @param uniformName Name of the variable.
  35905. * @param x First float in float3.
  35906. * @param y Second float in float3.
  35907. * @param z Third float in float3.
  35908. * @returns this effect.
  35909. */
  35910. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  35911. /**
  35912. * Sets a Vector4 on a uniform variable.
  35913. * @param uniformName Name of the variable.
  35914. * @param vector4 Value to be set.
  35915. * @returns this effect.
  35916. */
  35917. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  35918. /**
  35919. * Sets a float4 on a uniform variable.
  35920. * @param uniformName Name of the variable.
  35921. * @param x First float in float4.
  35922. * @param y Second float in float4.
  35923. * @param z Third float in float4.
  35924. * @param w Fourth float in float4.
  35925. * @returns this effect.
  35926. */
  35927. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  35928. /**
  35929. * Sets a Color3 on a uniform variable.
  35930. * @param uniformName Name of the variable.
  35931. * @param color3 Value to be set.
  35932. * @returns this effect.
  35933. */
  35934. setColor3(uniformName: string, color3: IColor3Like): Effect;
  35935. /**
  35936. * Sets a Color4 on a uniform variable.
  35937. * @param uniformName Name of the variable.
  35938. * @param color3 Value to be set.
  35939. * @param alpha Alpha value to be set.
  35940. * @returns this effect.
  35941. */
  35942. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  35943. /**
  35944. * Sets a Color4 on a uniform variable
  35945. * @param uniformName defines the name of the variable
  35946. * @param color4 defines the value to be set
  35947. * @returns this effect.
  35948. */
  35949. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  35950. /** Release all associated resources */
  35951. dispose(): void;
  35952. /**
  35953. * This function will add a new shader to the shader store
  35954. * @param name the name of the shader
  35955. * @param pixelShader optional pixel shader content
  35956. * @param vertexShader optional vertex shader content
  35957. */
  35958. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  35959. /**
  35960. * Store of each shader (The can be looked up using effect.key)
  35961. */
  35962. static ShadersStore: {
  35963. [key: string]: string;
  35964. };
  35965. /**
  35966. * Store of each included file for a shader (The can be looked up using effect.key)
  35967. */
  35968. static IncludesShadersStore: {
  35969. [key: string]: string;
  35970. };
  35971. /**
  35972. * Resets the cache of effects.
  35973. */
  35974. static ResetCache(): void;
  35975. }
  35976. }
  35977. declare module "babylonjs/Engines/engineCapabilities" {
  35978. /**
  35979. * Interface used to describe the capabilities of the engine relatively to the current browser
  35980. */
  35981. export interface EngineCapabilities {
  35982. /** Maximum textures units per fragment shader */
  35983. maxTexturesImageUnits: number;
  35984. /** Maximum texture units per vertex shader */
  35985. maxVertexTextureImageUnits: number;
  35986. /** Maximum textures units in the entire pipeline */
  35987. maxCombinedTexturesImageUnits: number;
  35988. /** Maximum texture size */
  35989. maxTextureSize: number;
  35990. /** Maximum texture samples */
  35991. maxSamples?: number;
  35992. /** Maximum cube texture size */
  35993. maxCubemapTextureSize: number;
  35994. /** Maximum render texture size */
  35995. maxRenderTextureSize: number;
  35996. /** Maximum number of vertex attributes */
  35997. maxVertexAttribs: number;
  35998. /** Maximum number of varyings */
  35999. maxVaryingVectors: number;
  36000. /** Maximum number of uniforms per vertex shader */
  36001. maxVertexUniformVectors: number;
  36002. /** Maximum number of uniforms per fragment shader */
  36003. maxFragmentUniformVectors: number;
  36004. /** Defines if standard derivates (dx/dy) are supported */
  36005. standardDerivatives: boolean;
  36006. /** Defines if s3tc texture compression is supported */
  36007. s3tc?: WEBGL_compressed_texture_s3tc;
  36008. /** Defines if pvrtc texture compression is supported */
  36009. pvrtc: any;
  36010. /** Defines if etc1 texture compression is supported */
  36011. etc1: any;
  36012. /** Defines if etc2 texture compression is supported */
  36013. etc2: any;
  36014. /** Defines if astc texture compression is supported */
  36015. astc: any;
  36016. /** Defines if float textures are supported */
  36017. textureFloat: boolean;
  36018. /** Defines if vertex array objects are supported */
  36019. vertexArrayObject: boolean;
  36020. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  36021. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  36022. /** Gets the maximum level of anisotropy supported */
  36023. maxAnisotropy: number;
  36024. /** Defines if instancing is supported */
  36025. instancedArrays: boolean;
  36026. /** Defines if 32 bits indices are supported */
  36027. uintIndices: boolean;
  36028. /** Defines if high precision shaders are supported */
  36029. highPrecisionShaderSupported: boolean;
  36030. /** Defines if depth reading in the fragment shader is supported */
  36031. fragmentDepthSupported: boolean;
  36032. /** Defines if float texture linear filtering is supported*/
  36033. textureFloatLinearFiltering: boolean;
  36034. /** Defines if rendering to float textures is supported */
  36035. textureFloatRender: boolean;
  36036. /** Defines if half float textures are supported*/
  36037. textureHalfFloat: boolean;
  36038. /** Defines if half float texture linear filtering is supported*/
  36039. textureHalfFloatLinearFiltering: boolean;
  36040. /** Defines if rendering to half float textures is supported */
  36041. textureHalfFloatRender: boolean;
  36042. /** Defines if textureLOD shader command is supported */
  36043. textureLOD: boolean;
  36044. /** Defines if draw buffers extension is supported */
  36045. drawBuffersExtension: boolean;
  36046. /** Defines if depth textures are supported */
  36047. depthTextureExtension: boolean;
  36048. /** Defines if float color buffer are supported */
  36049. colorBufferFloat: boolean;
  36050. /** Gets disjoint timer query extension (null if not supported) */
  36051. timerQuery?: EXT_disjoint_timer_query;
  36052. /** Defines if timestamp can be used with timer query */
  36053. canUseTimestampForTimerQuery: boolean;
  36054. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  36055. multiview?: any;
  36056. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  36057. oculusMultiview?: any;
  36058. /** Function used to let the system compiles shaders in background */
  36059. parallelShaderCompile?: {
  36060. COMPLETION_STATUS_KHR: number;
  36061. };
  36062. /** Max number of texture samples for MSAA */
  36063. maxMSAASamples: number;
  36064. /** Defines if the blend min max extension is supported */
  36065. blendMinMax: boolean;
  36066. }
  36067. }
  36068. declare module "babylonjs/States/depthCullingState" {
  36069. import { Nullable } from "babylonjs/types";
  36070. /**
  36071. * @hidden
  36072. **/
  36073. export class DepthCullingState {
  36074. private _isDepthTestDirty;
  36075. private _isDepthMaskDirty;
  36076. private _isDepthFuncDirty;
  36077. private _isCullFaceDirty;
  36078. private _isCullDirty;
  36079. private _isZOffsetDirty;
  36080. private _isFrontFaceDirty;
  36081. private _depthTest;
  36082. private _depthMask;
  36083. private _depthFunc;
  36084. private _cull;
  36085. private _cullFace;
  36086. private _zOffset;
  36087. private _frontFace;
  36088. /**
  36089. * Initializes the state.
  36090. */
  36091. constructor();
  36092. get isDirty(): boolean;
  36093. get zOffset(): number;
  36094. set zOffset(value: number);
  36095. get cullFace(): Nullable<number>;
  36096. set cullFace(value: Nullable<number>);
  36097. get cull(): Nullable<boolean>;
  36098. set cull(value: Nullable<boolean>);
  36099. get depthFunc(): Nullable<number>;
  36100. set depthFunc(value: Nullable<number>);
  36101. get depthMask(): boolean;
  36102. set depthMask(value: boolean);
  36103. get depthTest(): boolean;
  36104. set depthTest(value: boolean);
  36105. get frontFace(): Nullable<number>;
  36106. set frontFace(value: Nullable<number>);
  36107. reset(): void;
  36108. apply(gl: WebGLRenderingContext): void;
  36109. }
  36110. }
  36111. declare module "babylonjs/States/stencilState" {
  36112. /**
  36113. * @hidden
  36114. **/
  36115. export class StencilState {
  36116. /** 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 */
  36117. static readonly ALWAYS: number;
  36118. /** Passed to stencilOperation to specify that stencil value must be kept */
  36119. static readonly KEEP: number;
  36120. /** Passed to stencilOperation to specify that stencil value must be replaced */
  36121. static readonly REPLACE: number;
  36122. private _isStencilTestDirty;
  36123. private _isStencilMaskDirty;
  36124. private _isStencilFuncDirty;
  36125. private _isStencilOpDirty;
  36126. private _stencilTest;
  36127. private _stencilMask;
  36128. private _stencilFunc;
  36129. private _stencilFuncRef;
  36130. private _stencilFuncMask;
  36131. private _stencilOpStencilFail;
  36132. private _stencilOpDepthFail;
  36133. private _stencilOpStencilDepthPass;
  36134. get isDirty(): boolean;
  36135. get stencilFunc(): number;
  36136. set stencilFunc(value: number);
  36137. get stencilFuncRef(): number;
  36138. set stencilFuncRef(value: number);
  36139. get stencilFuncMask(): number;
  36140. set stencilFuncMask(value: number);
  36141. get stencilOpStencilFail(): number;
  36142. set stencilOpStencilFail(value: number);
  36143. get stencilOpDepthFail(): number;
  36144. set stencilOpDepthFail(value: number);
  36145. get stencilOpStencilDepthPass(): number;
  36146. set stencilOpStencilDepthPass(value: number);
  36147. get stencilMask(): number;
  36148. set stencilMask(value: number);
  36149. get stencilTest(): boolean;
  36150. set stencilTest(value: boolean);
  36151. constructor();
  36152. reset(): void;
  36153. apply(gl: WebGLRenderingContext): void;
  36154. }
  36155. }
  36156. declare module "babylonjs/States/alphaCullingState" {
  36157. /**
  36158. * @hidden
  36159. **/
  36160. export class AlphaState {
  36161. private _isAlphaBlendDirty;
  36162. private _isBlendFunctionParametersDirty;
  36163. private _isBlendEquationParametersDirty;
  36164. private _isBlendConstantsDirty;
  36165. private _alphaBlend;
  36166. private _blendFunctionParameters;
  36167. private _blendEquationParameters;
  36168. private _blendConstants;
  36169. /**
  36170. * Initializes the state.
  36171. */
  36172. constructor();
  36173. get isDirty(): boolean;
  36174. get alphaBlend(): boolean;
  36175. set alphaBlend(value: boolean);
  36176. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  36177. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  36178. setAlphaEquationParameters(rgb: number, alpha: number): void;
  36179. reset(): void;
  36180. apply(gl: WebGLRenderingContext): void;
  36181. }
  36182. }
  36183. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  36184. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36185. /** @hidden */
  36186. export class WebGL2ShaderProcessor implements IShaderProcessor {
  36187. attributeProcessor(attribute: string): string;
  36188. varyingProcessor(varying: string, isFragment: boolean): string;
  36189. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  36190. }
  36191. }
  36192. declare module "babylonjs/Engines/instancingAttributeInfo" {
  36193. /**
  36194. * Interface for attribute information associated with buffer instanciation
  36195. */
  36196. export interface InstancingAttributeInfo {
  36197. /**
  36198. * Name of the GLSL attribute
  36199. * if attribute index is not specified, this is used to retrieve the index from the effect
  36200. */
  36201. attributeName: string;
  36202. /**
  36203. * Index/offset of the attribute in the vertex shader
  36204. * if not specified, this will be computes from the name.
  36205. */
  36206. index?: number;
  36207. /**
  36208. * size of the attribute, 1, 2, 3 or 4
  36209. */
  36210. attributeSize: number;
  36211. /**
  36212. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  36213. */
  36214. offset: number;
  36215. /**
  36216. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  36217. * default to 1
  36218. */
  36219. divisor?: number;
  36220. /**
  36221. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  36222. * default is FLOAT
  36223. */
  36224. attributeType?: number;
  36225. /**
  36226. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  36227. */
  36228. normalized?: boolean;
  36229. }
  36230. }
  36231. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  36232. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36233. import { Nullable } from "babylonjs/types";
  36234. module "babylonjs/Engines/thinEngine" {
  36235. interface ThinEngine {
  36236. /**
  36237. * Update a video texture
  36238. * @param texture defines the texture to update
  36239. * @param video defines the video element to use
  36240. * @param invertY defines if data must be stored with Y axis inverted
  36241. */
  36242. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  36243. }
  36244. }
  36245. }
  36246. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  36247. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36248. import { Nullable } from "babylonjs/types";
  36249. module "babylonjs/Engines/thinEngine" {
  36250. interface ThinEngine {
  36251. /**
  36252. * Creates a dynamic texture
  36253. * @param width defines the width of the texture
  36254. * @param height defines the height of the texture
  36255. * @param generateMipMaps defines if the engine should generate the mip levels
  36256. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  36257. * @returns the dynamic texture inside an InternalTexture
  36258. */
  36259. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  36260. /**
  36261. * Update the content of a dynamic texture
  36262. * @param texture defines the texture to update
  36263. * @param canvas defines the canvas containing the source
  36264. * @param invertY defines if data must be stored with Y axis inverted
  36265. * @param premulAlpha defines if alpha is stored as premultiplied
  36266. * @param format defines the format of the data
  36267. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  36268. */
  36269. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  36270. }
  36271. }
  36272. }
  36273. declare module "babylonjs/Materials/Textures/videoTexture" {
  36274. import { Observable } from "babylonjs/Misc/observable";
  36275. import { Nullable } from "babylonjs/types";
  36276. import { Scene } from "babylonjs/scene";
  36277. import { Texture } from "babylonjs/Materials/Textures/texture";
  36278. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36279. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36280. /**
  36281. * Settings for finer control over video usage
  36282. */
  36283. export interface VideoTextureSettings {
  36284. /**
  36285. * Applies `autoplay` to video, if specified
  36286. */
  36287. autoPlay?: boolean;
  36288. /**
  36289. * Applies `loop` to video, if specified
  36290. */
  36291. loop?: boolean;
  36292. /**
  36293. * Automatically updates internal texture from video at every frame in the render loop
  36294. */
  36295. autoUpdateTexture: boolean;
  36296. /**
  36297. * Image src displayed during the video loading or until the user interacts with the video.
  36298. */
  36299. poster?: string;
  36300. }
  36301. /**
  36302. * If you want to display a video in your scene, this is the special texture for that.
  36303. * This special texture works similar to other textures, with the exception of a few parameters.
  36304. * @see https://doc.babylonjs.com/how_to/video_texture
  36305. */
  36306. export class VideoTexture extends Texture {
  36307. /**
  36308. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36309. */
  36310. readonly autoUpdateTexture: boolean;
  36311. /**
  36312. * The video instance used by the texture internally
  36313. */
  36314. readonly video: HTMLVideoElement;
  36315. private _onUserActionRequestedObservable;
  36316. /**
  36317. * Event triggerd when a dom action is required by the user to play the video.
  36318. * This happens due to recent changes in browser policies preventing video to auto start.
  36319. */
  36320. get onUserActionRequestedObservable(): Observable<Texture>;
  36321. private _generateMipMaps;
  36322. private _stillImageCaptured;
  36323. private _displayingPosterTexture;
  36324. private _settings;
  36325. private _createInternalTextureOnEvent;
  36326. private _frameId;
  36327. private _currentSrc;
  36328. /**
  36329. * Creates a video texture.
  36330. * If you want to display a video in your scene, this is the special texture for that.
  36331. * This special texture works similar to other textures, with the exception of a few parameters.
  36332. * @see https://doc.babylonjs.com/how_to/video_texture
  36333. * @param name optional name, will detect from video source, if not defined
  36334. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36335. * @param scene is obviously the current scene.
  36336. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36337. * @param invertY is false by default but can be used to invert video on Y axis
  36338. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36339. * @param settings allows finer control over video usage
  36340. */
  36341. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36342. private _getName;
  36343. private _getVideo;
  36344. private _createInternalTexture;
  36345. private reset;
  36346. /**
  36347. * @hidden Internal method to initiate `update`.
  36348. */
  36349. _rebuild(): void;
  36350. /**
  36351. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36352. */
  36353. update(): void;
  36354. /**
  36355. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36356. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36357. */
  36358. updateTexture(isVisible: boolean): void;
  36359. protected _updateInternalTexture: () => void;
  36360. /**
  36361. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36362. * @param url New url.
  36363. */
  36364. updateURL(url: string): void;
  36365. /**
  36366. * Clones the texture.
  36367. * @returns the cloned texture
  36368. */
  36369. clone(): VideoTexture;
  36370. /**
  36371. * Dispose the texture and release its associated resources.
  36372. */
  36373. dispose(): void;
  36374. /**
  36375. * Creates a video texture straight from a stream.
  36376. * @param scene Define the scene the texture should be created in
  36377. * @param stream Define the stream the texture should be created from
  36378. * @returns The created video texture as a promise
  36379. */
  36380. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36381. /**
  36382. * Creates a video texture straight from your WebCam video feed.
  36383. * @param scene Define the scene the texture should be created in
  36384. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36385. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36386. * @returns The created video texture as a promise
  36387. */
  36388. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36389. minWidth: number;
  36390. maxWidth: number;
  36391. minHeight: number;
  36392. maxHeight: number;
  36393. deviceId: string;
  36394. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36395. /**
  36396. * Creates a video texture straight from your WebCam video feed.
  36397. * @param scene Define the scene the texture should be created in
  36398. * @param onReady Define a callback to triggered once the texture will be ready
  36399. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36400. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36401. */
  36402. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36403. minWidth: number;
  36404. maxWidth: number;
  36405. minHeight: number;
  36406. maxHeight: number;
  36407. deviceId: string;
  36408. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36409. }
  36410. }
  36411. declare module "babylonjs/Engines/thinEngine" {
  36412. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36413. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36414. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36415. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36416. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36417. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36418. import { Observable } from "babylonjs/Misc/observable";
  36419. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36420. import { StencilState } from "babylonjs/States/stencilState";
  36421. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36422. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36423. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36424. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36425. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36426. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36427. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36428. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36429. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36430. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36431. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36432. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36433. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36434. import { WebRequest } from "babylonjs/Misc/webRequest";
  36435. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36436. /**
  36437. * Defines the interface used by objects working like Scene
  36438. * @hidden
  36439. */
  36440. export interface ISceneLike {
  36441. _addPendingData(data: any): void;
  36442. _removePendingData(data: any): void;
  36443. offlineProvider: IOfflineProvider;
  36444. }
  36445. /**
  36446. * Information about the current host
  36447. */
  36448. export interface HostInformation {
  36449. /**
  36450. * Defines if the current host is a mobile
  36451. */
  36452. isMobile: boolean;
  36453. }
  36454. /** Interface defining initialization parameters for Engine class */
  36455. export interface EngineOptions extends WebGLContextAttributes {
  36456. /**
  36457. * Defines if the engine should no exceed a specified device ratio
  36458. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36459. */
  36460. limitDeviceRatio?: number;
  36461. /**
  36462. * Defines if webvr should be enabled automatically
  36463. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36464. */
  36465. autoEnableWebVR?: boolean;
  36466. /**
  36467. * Defines if webgl2 should be turned off even if supported
  36468. * @see https://doc.babylonjs.com/features/webgl2
  36469. */
  36470. disableWebGL2Support?: boolean;
  36471. /**
  36472. * Defines if webaudio should be initialized as well
  36473. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36474. */
  36475. audioEngine?: boolean;
  36476. /**
  36477. * Defines if animations should run using a deterministic lock step
  36478. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36479. */
  36480. deterministicLockstep?: boolean;
  36481. /** Defines the maximum steps to use with deterministic lock step mode */
  36482. lockstepMaxSteps?: number;
  36483. /** Defines the seconds between each deterministic lock step */
  36484. timeStep?: number;
  36485. /**
  36486. * Defines that engine should ignore context lost events
  36487. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36488. */
  36489. doNotHandleContextLost?: boolean;
  36490. /**
  36491. * Defines that engine should ignore modifying touch action attribute and style
  36492. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36493. */
  36494. doNotHandleTouchAction?: boolean;
  36495. /**
  36496. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36497. */
  36498. useHighPrecisionFloats?: boolean;
  36499. /**
  36500. * Make the canvas XR Compatible for XR sessions
  36501. */
  36502. xrCompatible?: boolean;
  36503. /**
  36504. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36505. */
  36506. useHighPrecisionMatrix?: boolean;
  36507. }
  36508. /**
  36509. * The base engine class (root of all engines)
  36510. */
  36511. export class ThinEngine {
  36512. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36513. static ExceptionList: ({
  36514. key: string;
  36515. capture: string;
  36516. captureConstraint: number;
  36517. targets: string[];
  36518. } | {
  36519. key: string;
  36520. capture: null;
  36521. captureConstraint: null;
  36522. targets: string[];
  36523. })[];
  36524. /** @hidden */
  36525. static _TextureLoaders: IInternalTextureLoader[];
  36526. /**
  36527. * Returns the current npm package of the sdk
  36528. */
  36529. static get NpmPackage(): string;
  36530. /**
  36531. * Returns the current version of the framework
  36532. */
  36533. static get Version(): string;
  36534. /**
  36535. * Returns a string describing the current engine
  36536. */
  36537. get description(): string;
  36538. /**
  36539. * Gets or sets the epsilon value used by collision engine
  36540. */
  36541. static CollisionsEpsilon: number;
  36542. /**
  36543. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36544. */
  36545. static get ShadersRepository(): string;
  36546. static set ShadersRepository(value: string);
  36547. /** @hidden */
  36548. _shaderProcessor: IShaderProcessor;
  36549. /**
  36550. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36551. */
  36552. forcePOTTextures: boolean;
  36553. /**
  36554. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36555. */
  36556. isFullscreen: boolean;
  36557. /**
  36558. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36559. */
  36560. cullBackFaces: boolean;
  36561. /**
  36562. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36563. */
  36564. renderEvenInBackground: boolean;
  36565. /**
  36566. * Gets or sets a boolean indicating that cache can be kept between frames
  36567. */
  36568. preventCacheWipeBetweenFrames: boolean;
  36569. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36570. validateShaderPrograms: boolean;
  36571. /**
  36572. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36573. * This can provide greater z depth for distant objects.
  36574. */
  36575. useReverseDepthBuffer: boolean;
  36576. /**
  36577. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36578. */
  36579. disableUniformBuffers: boolean;
  36580. /** @hidden */
  36581. _uniformBuffers: UniformBuffer[];
  36582. /**
  36583. * Gets a boolean indicating that the engine supports uniform buffers
  36584. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36585. */
  36586. get supportsUniformBuffers(): boolean;
  36587. /** @hidden */
  36588. _gl: WebGLRenderingContext;
  36589. /** @hidden */
  36590. _webGLVersion: number;
  36591. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36592. protected _windowIsBackground: boolean;
  36593. protected _creationOptions: EngineOptions;
  36594. protected _highPrecisionShadersAllowed: boolean;
  36595. /** @hidden */
  36596. get _shouldUseHighPrecisionShader(): boolean;
  36597. /**
  36598. * Gets a boolean indicating that only power of 2 textures are supported
  36599. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36600. */
  36601. get needPOTTextures(): boolean;
  36602. /** @hidden */
  36603. _badOS: boolean;
  36604. /** @hidden */
  36605. _badDesktopOS: boolean;
  36606. private _hardwareScalingLevel;
  36607. /** @hidden */
  36608. _caps: EngineCapabilities;
  36609. private _isStencilEnable;
  36610. private _glVersion;
  36611. private _glRenderer;
  36612. private _glVendor;
  36613. /** @hidden */
  36614. _videoTextureSupported: boolean;
  36615. protected _renderingQueueLaunched: boolean;
  36616. protected _activeRenderLoops: (() => void)[];
  36617. /**
  36618. * Observable signaled when a context lost event is raised
  36619. */
  36620. onContextLostObservable: Observable<ThinEngine>;
  36621. /**
  36622. * Observable signaled when a context restored event is raised
  36623. */
  36624. onContextRestoredObservable: Observable<ThinEngine>;
  36625. private _onContextLost;
  36626. private _onContextRestored;
  36627. protected _contextWasLost: boolean;
  36628. /** @hidden */
  36629. _doNotHandleContextLost: boolean;
  36630. /**
  36631. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36632. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36633. */
  36634. get doNotHandleContextLost(): boolean;
  36635. set doNotHandleContextLost(value: boolean);
  36636. /**
  36637. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36638. */
  36639. disableVertexArrayObjects: boolean;
  36640. /** @hidden */
  36641. protected _colorWrite: boolean;
  36642. /** @hidden */
  36643. protected _colorWriteChanged: boolean;
  36644. /** @hidden */
  36645. protected _depthCullingState: DepthCullingState;
  36646. /** @hidden */
  36647. protected _stencilState: StencilState;
  36648. /** @hidden */
  36649. _alphaState: AlphaState;
  36650. /** @hidden */
  36651. _alphaMode: number;
  36652. /** @hidden */
  36653. _alphaEquation: number;
  36654. /** @hidden */
  36655. _internalTexturesCache: InternalTexture[];
  36656. /** @hidden */
  36657. protected _activeChannel: number;
  36658. private _currentTextureChannel;
  36659. /** @hidden */
  36660. protected _boundTexturesCache: {
  36661. [key: string]: Nullable<InternalTexture>;
  36662. };
  36663. /** @hidden */
  36664. protected _currentEffect: Nullable<Effect>;
  36665. /** @hidden */
  36666. protected _currentProgram: Nullable<WebGLProgram>;
  36667. private _compiledEffects;
  36668. private _vertexAttribArraysEnabled;
  36669. /** @hidden */
  36670. protected _cachedViewport: Nullable<IViewportLike>;
  36671. private _cachedVertexArrayObject;
  36672. /** @hidden */
  36673. protected _cachedVertexBuffers: any;
  36674. /** @hidden */
  36675. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36676. /** @hidden */
  36677. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36678. /** @hidden */
  36679. _currentRenderTarget: Nullable<InternalTexture>;
  36680. private _uintIndicesCurrentlySet;
  36681. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36682. /** @hidden */
  36683. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36684. /** @hidden */
  36685. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36686. private _currentBufferPointers;
  36687. private _currentInstanceLocations;
  36688. private _currentInstanceBuffers;
  36689. private _textureUnits;
  36690. /** @hidden */
  36691. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36692. /** @hidden */
  36693. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36694. /** @hidden */
  36695. _boundRenderFunction: any;
  36696. private _vaoRecordInProgress;
  36697. private _mustWipeVertexAttributes;
  36698. private _emptyTexture;
  36699. private _emptyCubeTexture;
  36700. private _emptyTexture3D;
  36701. private _emptyTexture2DArray;
  36702. /** @hidden */
  36703. _frameHandler: number;
  36704. private _nextFreeTextureSlots;
  36705. private _maxSimultaneousTextures;
  36706. private _activeRequests;
  36707. /** @hidden */
  36708. _transformTextureUrl: Nullable<(url: string) => string>;
  36709. /**
  36710. * Gets information about the current host
  36711. */
  36712. hostInformation: HostInformation;
  36713. protected get _supportsHardwareTextureRescaling(): boolean;
  36714. private _framebufferDimensionsObject;
  36715. /**
  36716. * sets the object from which width and height will be taken from when getting render width and height
  36717. * Will fallback to the gl object
  36718. * @param dimensions the framebuffer width and height that will be used.
  36719. */
  36720. set framebufferDimensionsObject(dimensions: Nullable<{
  36721. framebufferWidth: number;
  36722. framebufferHeight: number;
  36723. }>);
  36724. /**
  36725. * Gets the current viewport
  36726. */
  36727. get currentViewport(): Nullable<IViewportLike>;
  36728. /**
  36729. * Gets the default empty texture
  36730. */
  36731. get emptyTexture(): InternalTexture;
  36732. /**
  36733. * Gets the default empty 3D texture
  36734. */
  36735. get emptyTexture3D(): InternalTexture;
  36736. /**
  36737. * Gets the default empty 2D array texture
  36738. */
  36739. get emptyTexture2DArray(): InternalTexture;
  36740. /**
  36741. * Gets the default empty cube texture
  36742. */
  36743. get emptyCubeTexture(): InternalTexture;
  36744. /**
  36745. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36746. */
  36747. readonly premultipliedAlpha: boolean;
  36748. /**
  36749. * Observable event triggered before each texture is initialized
  36750. */
  36751. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36752. /**
  36753. * Creates a new engine
  36754. * @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
  36755. * @param antialias defines enable antialiasing (default: false)
  36756. * @param options defines further options to be sent to the getContext() function
  36757. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36758. */
  36759. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36760. private _rebuildInternalTextures;
  36761. private _rebuildEffects;
  36762. /**
  36763. * Gets a boolean indicating if all created effects are ready
  36764. * @returns true if all effects are ready
  36765. */
  36766. areAllEffectsReady(): boolean;
  36767. protected _rebuildBuffers(): void;
  36768. protected _initGLContext(): void;
  36769. /**
  36770. * Gets version of the current webGL context
  36771. */
  36772. get webGLVersion(): number;
  36773. /**
  36774. * Gets a string identifying the name of the class
  36775. * @returns "Engine" string
  36776. */
  36777. getClassName(): string;
  36778. /**
  36779. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36780. */
  36781. get isStencilEnable(): boolean;
  36782. /** @hidden */
  36783. _prepareWorkingCanvas(): void;
  36784. /**
  36785. * Reset the texture cache to empty state
  36786. */
  36787. resetTextureCache(): void;
  36788. /**
  36789. * Gets an object containing information about the current webGL context
  36790. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36791. */
  36792. getGlInfo(): {
  36793. vendor: string;
  36794. renderer: string;
  36795. version: string;
  36796. };
  36797. /**
  36798. * Defines the hardware scaling level.
  36799. * By default the hardware scaling level is computed from the window device ratio.
  36800. * 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.
  36801. * @param level defines the level to use
  36802. */
  36803. setHardwareScalingLevel(level: number): void;
  36804. /**
  36805. * Gets the current hardware scaling level.
  36806. * By default the hardware scaling level is computed from the window device ratio.
  36807. * 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.
  36808. * @returns a number indicating the current hardware scaling level
  36809. */
  36810. getHardwareScalingLevel(): number;
  36811. /**
  36812. * Gets the list of loaded textures
  36813. * @returns an array containing all loaded textures
  36814. */
  36815. getLoadedTexturesCache(): InternalTexture[];
  36816. /**
  36817. * Gets the object containing all engine capabilities
  36818. * @returns the EngineCapabilities object
  36819. */
  36820. getCaps(): EngineCapabilities;
  36821. /**
  36822. * stop executing a render loop function and remove it from the execution array
  36823. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36824. */
  36825. stopRenderLoop(renderFunction?: () => void): void;
  36826. /** @hidden */
  36827. _renderLoop(): void;
  36828. /**
  36829. * Gets the HTML canvas attached with the current webGL context
  36830. * @returns a HTML canvas
  36831. */
  36832. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36833. /**
  36834. * Gets host window
  36835. * @returns the host window object
  36836. */
  36837. getHostWindow(): Nullable<Window>;
  36838. /**
  36839. * Gets the current render width
  36840. * @param useScreen defines if screen size must be used (or the current render target if any)
  36841. * @returns a number defining the current render width
  36842. */
  36843. getRenderWidth(useScreen?: boolean): number;
  36844. /**
  36845. * Gets the current render height
  36846. * @param useScreen defines if screen size must be used (or the current render target if any)
  36847. * @returns a number defining the current render height
  36848. */
  36849. getRenderHeight(useScreen?: boolean): number;
  36850. /**
  36851. * Can be used to override the current requestAnimationFrame requester.
  36852. * @hidden
  36853. */
  36854. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36855. /**
  36856. * Register and execute a render loop. The engine can have more than one render function
  36857. * @param renderFunction defines the function to continuously execute
  36858. */
  36859. runRenderLoop(renderFunction: () => void): void;
  36860. /**
  36861. * Clear the current render buffer or the current render target (if any is set up)
  36862. * @param color defines the color to use
  36863. * @param backBuffer defines if the back buffer must be cleared
  36864. * @param depth defines if the depth buffer must be cleared
  36865. * @param stencil defines if the stencil buffer must be cleared
  36866. */
  36867. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36868. private _viewportCached;
  36869. /** @hidden */
  36870. _viewport(x: number, y: number, width: number, height: number): void;
  36871. /**
  36872. * Set the WebGL's viewport
  36873. * @param viewport defines the viewport element to be used
  36874. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36875. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36876. */
  36877. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36878. /**
  36879. * Begin a new frame
  36880. */
  36881. beginFrame(): void;
  36882. /**
  36883. * Enf the current frame
  36884. */
  36885. endFrame(): void;
  36886. /**
  36887. * Resize the view according to the canvas' size
  36888. */
  36889. resize(): void;
  36890. /**
  36891. * Force a specific size of the canvas
  36892. * @param width defines the new canvas' width
  36893. * @param height defines the new canvas' height
  36894. * @returns true if the size was changed
  36895. */
  36896. setSize(width: number, height: number): boolean;
  36897. /**
  36898. * Binds the frame buffer to the specified texture.
  36899. * @param texture The texture to render to or null for the default canvas
  36900. * @param faceIndex The face of the texture to render to in case of cube texture
  36901. * @param requiredWidth The width of the target to render to
  36902. * @param requiredHeight The height of the target to render to
  36903. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  36904. * @param lodLevel defines the lod level to bind to the frame buffer
  36905. * @param layer defines the 2d array index to bind to frame buffer to
  36906. */
  36907. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  36908. /** @hidden */
  36909. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  36910. /**
  36911. * Unbind the current render target texture from the webGL context
  36912. * @param texture defines the render target texture to unbind
  36913. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  36914. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  36915. */
  36916. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  36917. /**
  36918. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  36919. */
  36920. flushFramebuffer(): void;
  36921. /**
  36922. * Unbind the current render target and bind the default framebuffer
  36923. */
  36924. restoreDefaultFramebuffer(): void;
  36925. /** @hidden */
  36926. protected _resetVertexBufferBinding(): void;
  36927. /**
  36928. * Creates a vertex buffer
  36929. * @param data the data for the vertex buffer
  36930. * @returns the new WebGL static buffer
  36931. */
  36932. createVertexBuffer(data: DataArray): DataBuffer;
  36933. private _createVertexBuffer;
  36934. /**
  36935. * Creates a dynamic vertex buffer
  36936. * @param data the data for the dynamic vertex buffer
  36937. * @returns the new WebGL dynamic buffer
  36938. */
  36939. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  36940. protected _resetIndexBufferBinding(): void;
  36941. /**
  36942. * Creates a new index buffer
  36943. * @param indices defines the content of the index buffer
  36944. * @param updatable defines if the index buffer must be updatable
  36945. * @returns a new webGL buffer
  36946. */
  36947. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  36948. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  36949. /**
  36950. * Bind a webGL buffer to the webGL context
  36951. * @param buffer defines the buffer to bind
  36952. */
  36953. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  36954. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  36955. private bindBuffer;
  36956. /**
  36957. * update the bound buffer with the given data
  36958. * @param data defines the data to update
  36959. */
  36960. updateArrayBuffer(data: Float32Array): void;
  36961. private _vertexAttribPointer;
  36962. /** @hidden */
  36963. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  36964. private _bindVertexBuffersAttributes;
  36965. /**
  36966. * Records a vertex array object
  36967. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36968. * @param vertexBuffers defines the list of vertex buffers to store
  36969. * @param indexBuffer defines the index buffer to store
  36970. * @param effect defines the effect to store
  36971. * @returns the new vertex array object
  36972. */
  36973. recordVertexArrayObject(vertexBuffers: {
  36974. [key: string]: VertexBuffer;
  36975. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  36976. /**
  36977. * Bind a specific vertex array object
  36978. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36979. * @param vertexArrayObject defines the vertex array object to bind
  36980. * @param indexBuffer defines the index buffer to bind
  36981. */
  36982. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  36983. /**
  36984. * Bind webGl buffers directly to the webGL context
  36985. * @param vertexBuffer defines the vertex buffer to bind
  36986. * @param indexBuffer defines the index buffer to bind
  36987. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  36988. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  36989. * @param effect defines the effect associated with the vertex buffer
  36990. */
  36991. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  36992. private _unbindVertexArrayObject;
  36993. /**
  36994. * Bind a list of vertex buffers to the webGL context
  36995. * @param vertexBuffers defines the list of vertex buffers to bind
  36996. * @param indexBuffer defines the index buffer to bind
  36997. * @param effect defines the effect associated with the vertex buffers
  36998. */
  36999. bindBuffers(vertexBuffers: {
  37000. [key: string]: Nullable<VertexBuffer>;
  37001. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  37002. /**
  37003. * Unbind all instance attributes
  37004. */
  37005. unbindInstanceAttributes(): void;
  37006. /**
  37007. * Release and free the memory of a vertex array object
  37008. * @param vao defines the vertex array object to delete
  37009. */
  37010. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  37011. /** @hidden */
  37012. _releaseBuffer(buffer: DataBuffer): boolean;
  37013. protected _deleteBuffer(buffer: DataBuffer): void;
  37014. /**
  37015. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  37016. * @param instancesBuffer defines the webGL buffer to update and bind
  37017. * @param data defines the data to store in the buffer
  37018. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  37019. */
  37020. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  37021. /**
  37022. * Bind the content of a webGL buffer used with instantiation
  37023. * @param instancesBuffer defines the webGL buffer to bind
  37024. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  37025. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  37026. */
  37027. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  37028. /**
  37029. * Disable the instance attribute corresponding to the name in parameter
  37030. * @param name defines the name of the attribute to disable
  37031. */
  37032. disableInstanceAttributeByName(name: string): void;
  37033. /**
  37034. * Disable the instance attribute corresponding to the location in parameter
  37035. * @param attributeLocation defines the attribute location of the attribute to disable
  37036. */
  37037. disableInstanceAttribute(attributeLocation: number): void;
  37038. /**
  37039. * Disable the attribute corresponding to the location in parameter
  37040. * @param attributeLocation defines the attribute location of the attribute to disable
  37041. */
  37042. disableAttributeByIndex(attributeLocation: number): void;
  37043. /**
  37044. * Send a draw order
  37045. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37046. * @param indexStart defines the starting index
  37047. * @param indexCount defines the number of index to draw
  37048. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37049. */
  37050. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  37051. /**
  37052. * Draw a list of points
  37053. * @param verticesStart defines the index of first vertex to draw
  37054. * @param verticesCount defines the count of vertices to draw
  37055. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37056. */
  37057. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37058. /**
  37059. * Draw a list of unindexed primitives
  37060. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37061. * @param verticesStart defines the index of first vertex to draw
  37062. * @param verticesCount defines the count of vertices to draw
  37063. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37064. */
  37065. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37066. /**
  37067. * Draw a list of indexed primitives
  37068. * @param fillMode defines the primitive to use
  37069. * @param indexStart defines the starting index
  37070. * @param indexCount defines the number of index to draw
  37071. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37072. */
  37073. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  37074. /**
  37075. * Draw a list of unindexed primitives
  37076. * @param fillMode defines the primitive to use
  37077. * @param verticesStart defines the index of first vertex to draw
  37078. * @param verticesCount defines the count of vertices to draw
  37079. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37080. */
  37081. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37082. private _drawMode;
  37083. /** @hidden */
  37084. protected _reportDrawCall(): void;
  37085. /** @hidden */
  37086. _releaseEffect(effect: Effect): void;
  37087. /** @hidden */
  37088. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  37089. /**
  37090. * Create a new effect (used to store vertex/fragment shaders)
  37091. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  37092. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  37093. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  37094. * @param samplers defines an array of string used to represent textures
  37095. * @param defines defines the string containing the defines to use to compile the shaders
  37096. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  37097. * @param onCompiled defines a function to call when the effect creation is successful
  37098. * @param onError defines a function to call when the effect creation has failed
  37099. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  37100. * @returns the new Effect
  37101. */
  37102. 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;
  37103. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  37104. private _compileShader;
  37105. private _compileRawShader;
  37106. /** @hidden */
  37107. _getShaderSource(shader: WebGLShader): Nullable<string>;
  37108. /**
  37109. * Directly 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 context defines the webGL context to use (if not set, the current one will be used)
  37114. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37115. * @returns the new webGL program
  37116. */
  37117. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37118. /**
  37119. * Creates a webGL program
  37120. * @param pipelineContext defines the pipeline context to attach to
  37121. * @param vertexCode defines the vertex shader code to use
  37122. * @param fragmentCode defines the fragment shader code to use
  37123. * @param defines defines the string containing the defines to use to compile the shaders
  37124. * @param context defines the webGL context to use (if not set, the current one will be used)
  37125. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37126. * @returns the new webGL program
  37127. */
  37128. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37129. /**
  37130. * Creates a new pipeline context
  37131. * @returns the new pipeline
  37132. */
  37133. createPipelineContext(): IPipelineContext;
  37134. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37135. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  37136. /** @hidden */
  37137. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  37138. /** @hidden */
  37139. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  37140. /** @hidden */
  37141. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  37142. /**
  37143. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  37144. * @param pipelineContext defines the pipeline context to use
  37145. * @param uniformsNames defines the list of uniform names
  37146. * @returns an array of webGL uniform locations
  37147. */
  37148. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  37149. /**
  37150. * Gets the lsit of active attributes for a given webGL program
  37151. * @param pipelineContext defines the pipeline context to use
  37152. * @param attributesNames defines the list of attribute names to get
  37153. * @returns an array of indices indicating the offset of each attribute
  37154. */
  37155. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  37156. /**
  37157. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  37158. * @param effect defines the effect to activate
  37159. */
  37160. enableEffect(effect: Nullable<Effect>): void;
  37161. /**
  37162. * Set the value of an uniform to a number (int)
  37163. * @param uniform defines the webGL uniform location where to store the value
  37164. * @param value defines the int number to store
  37165. */
  37166. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37167. /**
  37168. * Set the value of an uniform to an array of int32
  37169. * @param uniform defines the webGL uniform location where to store the value
  37170. * @param array defines the array of int32 to store
  37171. */
  37172. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37173. /**
  37174. * Set the value of an uniform to an array of int32 (stored as vec2)
  37175. * @param uniform defines the webGL uniform location where to store the value
  37176. * @param array defines the array of int32 to store
  37177. */
  37178. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37179. /**
  37180. * Set the value of an uniform to an array of int32 (stored as vec3)
  37181. * @param uniform defines the webGL uniform location where to store the value
  37182. * @param array defines the array of int32 to store
  37183. */
  37184. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37185. /**
  37186. * Set the value of an uniform to an array of int32 (stored as vec4)
  37187. * @param uniform defines the webGL uniform location where to store the value
  37188. * @param array defines the array of int32 to store
  37189. */
  37190. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37191. /**
  37192. * Set the value of an uniform to an array of number
  37193. * @param uniform defines the webGL uniform location where to store the value
  37194. * @param array defines the array of number to store
  37195. */
  37196. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37197. /**
  37198. * Set the value of an uniform to an array of number (stored as vec2)
  37199. * @param uniform defines the webGL uniform location where to store the value
  37200. * @param array defines the array of number to store
  37201. */
  37202. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37203. /**
  37204. * Set the value of an uniform to an array of number (stored as vec3)
  37205. * @param uniform defines the webGL uniform location where to store the value
  37206. * @param array defines the array of number to store
  37207. */
  37208. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37209. /**
  37210. * Set the value of an uniform to an array of number (stored as vec4)
  37211. * @param uniform defines the webGL uniform location where to store the value
  37212. * @param array defines the array of number to store
  37213. */
  37214. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37215. /**
  37216. * Set the value of an uniform to an array of float32 (stored as matrices)
  37217. * @param uniform defines the webGL uniform location where to store the value
  37218. * @param matrices defines the array of float32 to store
  37219. */
  37220. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  37221. /**
  37222. * Set the value of an uniform to a matrix (3x3)
  37223. * @param uniform defines the webGL uniform location where to store the value
  37224. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  37225. */
  37226. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37227. /**
  37228. * Set the value of an uniform to a matrix (2x2)
  37229. * @param uniform defines the webGL uniform location where to store the value
  37230. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  37231. */
  37232. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37233. /**
  37234. * Set the value of an uniform to a number (float)
  37235. * @param uniform defines the webGL uniform location where to store the value
  37236. * @param value defines the float number to store
  37237. */
  37238. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37239. /**
  37240. * Set the value of an uniform to a vec2
  37241. * @param uniform defines the webGL uniform location where to store the value
  37242. * @param x defines the 1st component of the value
  37243. * @param y defines the 2nd component of the value
  37244. */
  37245. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  37246. /**
  37247. * Set the value of an uniform to a vec3
  37248. * @param uniform defines the webGL uniform location where to store the value
  37249. * @param x defines the 1st component of the value
  37250. * @param y defines the 2nd component of the value
  37251. * @param z defines the 3rd component of the value
  37252. */
  37253. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  37254. /**
  37255. * Set the value of an uniform to a vec4
  37256. * @param uniform defines the webGL uniform location where to store the value
  37257. * @param x defines the 1st component of the value
  37258. * @param y defines the 2nd component of the value
  37259. * @param z defines the 3rd component of the value
  37260. * @param w defines the 4th component of the value
  37261. */
  37262. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  37263. /**
  37264. * Apply all cached states (depth, culling, stencil and alpha)
  37265. */
  37266. applyStates(): void;
  37267. /**
  37268. * Enable or disable color writing
  37269. * @param enable defines the state to set
  37270. */
  37271. setColorWrite(enable: boolean): void;
  37272. /**
  37273. * Gets a boolean indicating if color writing is enabled
  37274. * @returns the current color writing state
  37275. */
  37276. getColorWrite(): boolean;
  37277. /**
  37278. * Gets the depth culling state manager
  37279. */
  37280. get depthCullingState(): DepthCullingState;
  37281. /**
  37282. * Gets the alpha state manager
  37283. */
  37284. get alphaState(): AlphaState;
  37285. /**
  37286. * Gets the stencil state manager
  37287. */
  37288. get stencilState(): StencilState;
  37289. /**
  37290. * Clears the list of texture accessible through engine.
  37291. * This can help preventing texture load conflict due to name collision.
  37292. */
  37293. clearInternalTexturesCache(): void;
  37294. /**
  37295. * Force the entire cache to be cleared
  37296. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37297. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37298. */
  37299. wipeCaches(bruteForce?: boolean): void;
  37300. /** @hidden */
  37301. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37302. min: number;
  37303. mag: number;
  37304. };
  37305. /** @hidden */
  37306. _createTexture(): WebGLTexture;
  37307. /**
  37308. * Usually called from Texture.ts.
  37309. * Passed information to create a WebGLTexture
  37310. * @param url defines a value which contains one of the following:
  37311. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37312. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37313. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37314. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37315. * @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)
  37316. * @param scene needed for loading to the correct scene
  37317. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37318. * @param onLoad optional callback to be called upon successful completion
  37319. * @param onError optional callback to be called upon failure
  37320. * @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
  37321. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37322. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37323. * @param forcedExtension defines the extension to use to pick the right loader
  37324. * @param mimeType defines an optional mime type
  37325. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37326. */
  37327. 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;
  37328. /**
  37329. * Loads an image as an HTMLImageElement.
  37330. * @param input url string, ArrayBuffer, or Blob to load
  37331. * @param onLoad callback called when the image successfully loads
  37332. * @param onError callback called when the image fails to load
  37333. * @param offlineProvider offline provider for caching
  37334. * @param mimeType optional mime type
  37335. * @returns the HTMLImageElement of the loaded image
  37336. * @hidden
  37337. */
  37338. 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>;
  37339. /**
  37340. * @hidden
  37341. */
  37342. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37343. private _unpackFlipYCached;
  37344. /**
  37345. * In case you are sharing the context with other applications, it might
  37346. * be interested to not cache the unpack flip y state to ensure a consistent
  37347. * value would be set.
  37348. */
  37349. enableUnpackFlipYCached: boolean;
  37350. /** @hidden */
  37351. _unpackFlipY(value: boolean): void;
  37352. /** @hidden */
  37353. _getUnpackAlignement(): number;
  37354. private _getTextureTarget;
  37355. /**
  37356. * Update the sampling mode of a given texture
  37357. * @param samplingMode defines the required sampling mode
  37358. * @param texture defines the texture to update
  37359. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37360. */
  37361. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37362. /**
  37363. * Update the sampling mode of a given texture
  37364. * @param texture defines the texture to update
  37365. * @param wrapU defines the texture wrap mode of the u coordinates
  37366. * @param wrapV defines the texture wrap mode of the v coordinates
  37367. * @param wrapR defines the texture wrap mode of the r coordinates
  37368. */
  37369. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37370. /** @hidden */
  37371. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37372. width: number;
  37373. height: number;
  37374. layers?: number;
  37375. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37376. /** @hidden */
  37377. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37378. /** @hidden */
  37379. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37380. /**
  37381. * Update a portion of an internal texture
  37382. * @param texture defines the texture to update
  37383. * @param imageData defines the data to store into the texture
  37384. * @param xOffset defines the x coordinates of the update rectangle
  37385. * @param yOffset defines the y coordinates of the update rectangle
  37386. * @param width defines the width of the update rectangle
  37387. * @param height defines the height of the update rectangle
  37388. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37389. * @param lod defines the lod level to update (0 by default)
  37390. */
  37391. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37392. /** @hidden */
  37393. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37394. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37395. private _prepareWebGLTexture;
  37396. /** @hidden */
  37397. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37398. private _getDepthStencilBuffer;
  37399. /** @hidden */
  37400. _releaseFramebufferObjects(texture: InternalTexture): void;
  37401. /** @hidden */
  37402. _releaseTexture(texture: InternalTexture): void;
  37403. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37404. protected _setProgram(program: WebGLProgram): void;
  37405. protected _boundUniforms: {
  37406. [key: number]: WebGLUniformLocation;
  37407. };
  37408. /**
  37409. * Binds an effect to the webGL context
  37410. * @param effect defines the effect to bind
  37411. */
  37412. bindSamplers(effect: Effect): void;
  37413. private _activateCurrentTexture;
  37414. /** @hidden */
  37415. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37416. /** @hidden */
  37417. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37418. /**
  37419. * Unbind all textures from the webGL context
  37420. */
  37421. unbindAllTextures(): void;
  37422. /**
  37423. * Sets a texture to the according uniform.
  37424. * @param channel The texture channel
  37425. * @param uniform The uniform to set
  37426. * @param texture The texture to apply
  37427. */
  37428. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37429. private _bindSamplerUniformToChannel;
  37430. private _getTextureWrapMode;
  37431. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37432. /**
  37433. * Sets an array of texture to the webGL context
  37434. * @param channel defines the channel where the texture array must be set
  37435. * @param uniform defines the associated uniform location
  37436. * @param textures defines the array of textures to bind
  37437. */
  37438. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37439. /** @hidden */
  37440. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37441. private _setTextureParameterFloat;
  37442. private _setTextureParameterInteger;
  37443. /**
  37444. * Unbind all vertex attributes from the webGL context
  37445. */
  37446. unbindAllAttributes(): void;
  37447. /**
  37448. * 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
  37449. */
  37450. releaseEffects(): void;
  37451. /**
  37452. * Dispose and release all associated resources
  37453. */
  37454. dispose(): void;
  37455. /**
  37456. * Attach a new callback raised when context lost event is fired
  37457. * @param callback defines the callback to call
  37458. */
  37459. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37460. /**
  37461. * Attach a new callback raised when context restored event is fired
  37462. * @param callback defines the callback to call
  37463. */
  37464. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37465. /**
  37466. * Get the current error code of the webGL context
  37467. * @returns the error code
  37468. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37469. */
  37470. getError(): number;
  37471. private _canRenderToFloatFramebuffer;
  37472. private _canRenderToHalfFloatFramebuffer;
  37473. private _canRenderToFramebuffer;
  37474. /** @hidden */
  37475. _getWebGLTextureType(type: number): number;
  37476. /** @hidden */
  37477. _getInternalFormat(format: number): number;
  37478. /** @hidden */
  37479. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37480. /** @hidden */
  37481. _getRGBAMultiSampleBufferFormat(type: number): number;
  37482. /** @hidden */
  37483. _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;
  37484. /**
  37485. * Loads a file from a url
  37486. * @param url url to load
  37487. * @param onSuccess callback called when the file successfully loads
  37488. * @param onProgress callback called while file is loading (if the server supports this mode)
  37489. * @param offlineProvider defines the offline provider for caching
  37490. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37491. * @param onError callback called when the file fails to load
  37492. * @returns a file request object
  37493. * @hidden
  37494. */
  37495. 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;
  37496. /**
  37497. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37498. * @param x defines the x coordinate of the rectangle where pixels must be read
  37499. * @param y defines the y coordinate of the rectangle where pixels must be read
  37500. * @param width defines the width of the rectangle where pixels must be read
  37501. * @param height defines the height of the rectangle where pixels must be read
  37502. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37503. * @returns a Uint8Array containing RGBA colors
  37504. */
  37505. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37506. private static _isSupported;
  37507. /**
  37508. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37509. * @returns true if the engine can be created
  37510. * @ignorenaming
  37511. */
  37512. static isSupported(): boolean;
  37513. /**
  37514. * Find the next highest power of two.
  37515. * @param x Number to start search from.
  37516. * @return Next highest power of two.
  37517. */
  37518. static CeilingPOT(x: number): number;
  37519. /**
  37520. * Find the next lowest power of two.
  37521. * @param x Number to start search from.
  37522. * @return Next lowest power of two.
  37523. */
  37524. static FloorPOT(x: number): number;
  37525. /**
  37526. * Find the nearest power of two.
  37527. * @param x Number to start search from.
  37528. * @return Next nearest power of two.
  37529. */
  37530. static NearestPOT(x: number): number;
  37531. /**
  37532. * Get the closest exponent of two
  37533. * @param value defines the value to approximate
  37534. * @param max defines the maximum value to return
  37535. * @param mode defines how to define the closest value
  37536. * @returns closest exponent of two of the given value
  37537. */
  37538. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37539. /**
  37540. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37541. * @param func - the function to be called
  37542. * @param requester - the object that will request the next frame. Falls back to window.
  37543. * @returns frame number
  37544. */
  37545. static QueueNewFrame(func: () => void, requester?: any): number;
  37546. /**
  37547. * Gets host document
  37548. * @returns the host document object
  37549. */
  37550. getHostDocument(): Nullable<Document>;
  37551. }
  37552. }
  37553. declare module "babylonjs/Maths/sphericalPolynomial" {
  37554. import { Vector3 } from "babylonjs/Maths/math.vector";
  37555. import { Color3 } from "babylonjs/Maths/math.color";
  37556. /**
  37557. * Class representing spherical harmonics coefficients to the 3rd degree
  37558. */
  37559. export class SphericalHarmonics {
  37560. /**
  37561. * Defines whether or not the harmonics have been prescaled for rendering.
  37562. */
  37563. preScaled: boolean;
  37564. /**
  37565. * The l0,0 coefficients of the spherical harmonics
  37566. */
  37567. l00: Vector3;
  37568. /**
  37569. * The l1,-1 coefficients of the spherical harmonics
  37570. */
  37571. l1_1: Vector3;
  37572. /**
  37573. * The l1,0 coefficients of the spherical harmonics
  37574. */
  37575. l10: Vector3;
  37576. /**
  37577. * The l1,1 coefficients of the spherical harmonics
  37578. */
  37579. l11: Vector3;
  37580. /**
  37581. * The l2,-2 coefficients of the spherical harmonics
  37582. */
  37583. l2_2: Vector3;
  37584. /**
  37585. * The l2,-1 coefficients of the spherical harmonics
  37586. */
  37587. l2_1: Vector3;
  37588. /**
  37589. * The l2,0 coefficients of the spherical harmonics
  37590. */
  37591. l20: Vector3;
  37592. /**
  37593. * The l2,1 coefficients of the spherical harmonics
  37594. */
  37595. l21: Vector3;
  37596. /**
  37597. * The l2,2 coefficients of the spherical harmonics
  37598. */
  37599. l22: Vector3;
  37600. /**
  37601. * Adds a light to the spherical harmonics
  37602. * @param direction the direction of the light
  37603. * @param color the color of the light
  37604. * @param deltaSolidAngle the delta solid angle of the light
  37605. */
  37606. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37607. /**
  37608. * Scales the spherical harmonics by the given amount
  37609. * @param scale the amount to scale
  37610. */
  37611. scaleInPlace(scale: number): void;
  37612. /**
  37613. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37614. *
  37615. * ```
  37616. * E_lm = A_l * L_lm
  37617. * ```
  37618. *
  37619. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37620. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37621. * the scaling factors are given in equation 9.
  37622. */
  37623. convertIncidentRadianceToIrradiance(): void;
  37624. /**
  37625. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37626. *
  37627. * ```
  37628. * L = (1/pi) * E * rho
  37629. * ```
  37630. *
  37631. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37632. */
  37633. convertIrradianceToLambertianRadiance(): void;
  37634. /**
  37635. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37636. * required operations at run time.
  37637. *
  37638. * This is simply done by scaling back the SH with Ylm constants parameter.
  37639. * The trigonometric part being applied by the shader at run time.
  37640. */
  37641. preScaleForRendering(): void;
  37642. /**
  37643. * Constructs a spherical harmonics from an array.
  37644. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37645. * @returns the spherical harmonics
  37646. */
  37647. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37648. /**
  37649. * Gets the spherical harmonics from polynomial
  37650. * @param polynomial the spherical polynomial
  37651. * @returns the spherical harmonics
  37652. */
  37653. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37654. }
  37655. /**
  37656. * Class representing spherical polynomial coefficients to the 3rd degree
  37657. */
  37658. export class SphericalPolynomial {
  37659. private _harmonics;
  37660. /**
  37661. * The spherical harmonics used to create the polynomials.
  37662. */
  37663. get preScaledHarmonics(): SphericalHarmonics;
  37664. /**
  37665. * The x coefficients of the spherical polynomial
  37666. */
  37667. x: Vector3;
  37668. /**
  37669. * The y coefficients of the spherical polynomial
  37670. */
  37671. y: Vector3;
  37672. /**
  37673. * The z coefficients of the spherical polynomial
  37674. */
  37675. z: Vector3;
  37676. /**
  37677. * The xx coefficients of the spherical polynomial
  37678. */
  37679. xx: Vector3;
  37680. /**
  37681. * The yy coefficients of the spherical polynomial
  37682. */
  37683. yy: Vector3;
  37684. /**
  37685. * The zz coefficients of the spherical polynomial
  37686. */
  37687. zz: Vector3;
  37688. /**
  37689. * The xy coefficients of the spherical polynomial
  37690. */
  37691. xy: Vector3;
  37692. /**
  37693. * The yz coefficients of the spherical polynomial
  37694. */
  37695. yz: Vector3;
  37696. /**
  37697. * The zx coefficients of the spherical polynomial
  37698. */
  37699. zx: Vector3;
  37700. /**
  37701. * Adds an ambient color to the spherical polynomial
  37702. * @param color the color to add
  37703. */
  37704. addAmbient(color: Color3): void;
  37705. /**
  37706. * Scales the spherical polynomial by the given amount
  37707. * @param scale the amount to scale
  37708. */
  37709. scaleInPlace(scale: number): void;
  37710. /**
  37711. * Gets the spherical polynomial from harmonics
  37712. * @param harmonics the spherical harmonics
  37713. * @returns the spherical polynomial
  37714. */
  37715. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37716. /**
  37717. * Constructs a spherical polynomial from an array.
  37718. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37719. * @returns the spherical polynomial
  37720. */
  37721. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37722. }
  37723. }
  37724. declare module "babylonjs/Materials/Textures/internalTexture" {
  37725. import { Observable } from "babylonjs/Misc/observable";
  37726. import { Nullable, int } from "babylonjs/types";
  37727. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37728. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37729. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37730. /**
  37731. * Defines the source of the internal texture
  37732. */
  37733. export enum InternalTextureSource {
  37734. /**
  37735. * The source of the texture data is unknown
  37736. */
  37737. Unknown = 0,
  37738. /**
  37739. * Texture data comes from an URL
  37740. */
  37741. Url = 1,
  37742. /**
  37743. * Texture data is only used for temporary storage
  37744. */
  37745. Temp = 2,
  37746. /**
  37747. * Texture data comes from raw data (ArrayBuffer)
  37748. */
  37749. Raw = 3,
  37750. /**
  37751. * Texture content is dynamic (video or dynamic texture)
  37752. */
  37753. Dynamic = 4,
  37754. /**
  37755. * Texture content is generated by rendering to it
  37756. */
  37757. RenderTarget = 5,
  37758. /**
  37759. * Texture content is part of a multi render target process
  37760. */
  37761. MultiRenderTarget = 6,
  37762. /**
  37763. * Texture data comes from a cube data file
  37764. */
  37765. Cube = 7,
  37766. /**
  37767. * Texture data comes from a raw cube data
  37768. */
  37769. CubeRaw = 8,
  37770. /**
  37771. * Texture data come from a prefiltered cube data file
  37772. */
  37773. CubePrefiltered = 9,
  37774. /**
  37775. * Texture content is raw 3D data
  37776. */
  37777. Raw3D = 10,
  37778. /**
  37779. * Texture content is raw 2D array data
  37780. */
  37781. Raw2DArray = 11,
  37782. /**
  37783. * Texture content is a depth texture
  37784. */
  37785. Depth = 12,
  37786. /**
  37787. * Texture data comes from a raw cube data encoded with RGBD
  37788. */
  37789. CubeRawRGBD = 13
  37790. }
  37791. /**
  37792. * Class used to store data associated with WebGL texture data for the engine
  37793. * This class should not be used directly
  37794. */
  37795. export class InternalTexture {
  37796. /** @hidden */
  37797. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37798. /**
  37799. * Defines if the texture is ready
  37800. */
  37801. isReady: boolean;
  37802. /**
  37803. * Defines if the texture is a cube texture
  37804. */
  37805. isCube: boolean;
  37806. /**
  37807. * Defines if the texture contains 3D data
  37808. */
  37809. is3D: boolean;
  37810. /**
  37811. * Defines if the texture contains 2D array data
  37812. */
  37813. is2DArray: boolean;
  37814. /**
  37815. * Defines if the texture contains multiview data
  37816. */
  37817. isMultiview: boolean;
  37818. /**
  37819. * Gets the URL used to load this texture
  37820. */
  37821. url: string;
  37822. /**
  37823. * Gets the sampling mode of the texture
  37824. */
  37825. samplingMode: number;
  37826. /**
  37827. * Gets a boolean indicating if the texture needs mipmaps generation
  37828. */
  37829. generateMipMaps: boolean;
  37830. /**
  37831. * Gets the number of samples used by the texture (WebGL2+ only)
  37832. */
  37833. samples: number;
  37834. /**
  37835. * Gets the type of the texture (int, float...)
  37836. */
  37837. type: number;
  37838. /**
  37839. * Gets the format of the texture (RGB, RGBA...)
  37840. */
  37841. format: number;
  37842. /**
  37843. * Observable called when the texture is loaded
  37844. */
  37845. onLoadedObservable: Observable<InternalTexture>;
  37846. /**
  37847. * Gets the width of the texture
  37848. */
  37849. width: number;
  37850. /**
  37851. * Gets the height of the texture
  37852. */
  37853. height: number;
  37854. /**
  37855. * Gets the depth of the texture
  37856. */
  37857. depth: number;
  37858. /**
  37859. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37860. */
  37861. baseWidth: number;
  37862. /**
  37863. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37864. */
  37865. baseHeight: number;
  37866. /**
  37867. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37868. */
  37869. baseDepth: number;
  37870. /**
  37871. * Gets a boolean indicating if the texture is inverted on Y axis
  37872. */
  37873. invertY: boolean;
  37874. /** @hidden */
  37875. _invertVScale: boolean;
  37876. /** @hidden */
  37877. _associatedChannel: number;
  37878. /** @hidden */
  37879. _source: InternalTextureSource;
  37880. /** @hidden */
  37881. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  37882. /** @hidden */
  37883. _bufferView: Nullable<ArrayBufferView>;
  37884. /** @hidden */
  37885. _bufferViewArray: Nullable<ArrayBufferView[]>;
  37886. /** @hidden */
  37887. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  37888. /** @hidden */
  37889. _size: number;
  37890. /** @hidden */
  37891. _extension: string;
  37892. /** @hidden */
  37893. _files: Nullable<string[]>;
  37894. /** @hidden */
  37895. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  37896. /** @hidden */
  37897. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  37898. /** @hidden */
  37899. _framebuffer: Nullable<WebGLFramebuffer>;
  37900. /** @hidden */
  37901. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  37902. /** @hidden */
  37903. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  37904. /** @hidden */
  37905. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  37906. /** @hidden */
  37907. _attachments: Nullable<number[]>;
  37908. /** @hidden */
  37909. _textureArray: Nullable<InternalTexture[]>;
  37910. /** @hidden */
  37911. _cachedCoordinatesMode: Nullable<number>;
  37912. /** @hidden */
  37913. _cachedWrapU: Nullable<number>;
  37914. /** @hidden */
  37915. _cachedWrapV: Nullable<number>;
  37916. /** @hidden */
  37917. _cachedWrapR: Nullable<number>;
  37918. /** @hidden */
  37919. _cachedAnisotropicFilteringLevel: Nullable<number>;
  37920. /** @hidden */
  37921. _isDisabled: boolean;
  37922. /** @hidden */
  37923. _compression: Nullable<string>;
  37924. /** @hidden */
  37925. _generateStencilBuffer: boolean;
  37926. /** @hidden */
  37927. _generateDepthBuffer: boolean;
  37928. /** @hidden */
  37929. _comparisonFunction: number;
  37930. /** @hidden */
  37931. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  37932. /** @hidden */
  37933. _lodGenerationScale: number;
  37934. /** @hidden */
  37935. _lodGenerationOffset: number;
  37936. /** @hidden */
  37937. _depthStencilTexture: Nullable<InternalTexture>;
  37938. /** @hidden */
  37939. _colorTextureArray: Nullable<WebGLTexture>;
  37940. /** @hidden */
  37941. _depthStencilTextureArray: Nullable<WebGLTexture>;
  37942. /** @hidden */
  37943. _lodTextureHigh: Nullable<BaseTexture>;
  37944. /** @hidden */
  37945. _lodTextureMid: Nullable<BaseTexture>;
  37946. /** @hidden */
  37947. _lodTextureLow: Nullable<BaseTexture>;
  37948. /** @hidden */
  37949. _isRGBD: boolean;
  37950. /** @hidden */
  37951. _linearSpecularLOD: boolean;
  37952. /** @hidden */
  37953. _irradianceTexture: Nullable<BaseTexture>;
  37954. /** @hidden */
  37955. _webGLTexture: Nullable<WebGLTexture>;
  37956. /** @hidden */
  37957. _references: number;
  37958. private _engine;
  37959. /**
  37960. * Gets the Engine the texture belongs to.
  37961. * @returns The babylon engine
  37962. */
  37963. getEngine(): ThinEngine;
  37964. /**
  37965. * Gets the data source type of the texture
  37966. */
  37967. get source(): InternalTextureSource;
  37968. /**
  37969. * Creates a new InternalTexture
  37970. * @param engine defines the engine to use
  37971. * @param source defines the type of data that will be used
  37972. * @param delayAllocation if the texture allocation should be delayed (default: false)
  37973. */
  37974. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  37975. /**
  37976. * Increments the number of references (ie. the number of Texture that point to it)
  37977. */
  37978. incrementReferences(): void;
  37979. /**
  37980. * Change the size of the texture (not the size of the content)
  37981. * @param width defines the new width
  37982. * @param height defines the new height
  37983. * @param depth defines the new depth (1 by default)
  37984. */
  37985. updateSize(width: int, height: int, depth?: int): void;
  37986. /** @hidden */
  37987. _rebuild(): void;
  37988. /** @hidden */
  37989. _swapAndDie(target: InternalTexture): void;
  37990. /**
  37991. * Dispose the current allocated resources
  37992. */
  37993. dispose(): void;
  37994. }
  37995. }
  37996. declare module "babylonjs/Audio/analyser" {
  37997. import { Scene } from "babylonjs/scene";
  37998. /**
  37999. * Class used to work with sound analyzer using fast fourier transform (FFT)
  38000. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38001. */
  38002. export class Analyser {
  38003. /**
  38004. * Gets or sets the smoothing
  38005. * @ignorenaming
  38006. */
  38007. SMOOTHING: number;
  38008. /**
  38009. * Gets or sets the FFT table size
  38010. * @ignorenaming
  38011. */
  38012. FFT_SIZE: number;
  38013. /**
  38014. * Gets or sets the bar graph amplitude
  38015. * @ignorenaming
  38016. */
  38017. BARGRAPHAMPLITUDE: number;
  38018. /**
  38019. * Gets or sets the position of the debug canvas
  38020. * @ignorenaming
  38021. */
  38022. DEBUGCANVASPOS: {
  38023. x: number;
  38024. y: number;
  38025. };
  38026. /**
  38027. * Gets or sets the debug canvas size
  38028. * @ignorenaming
  38029. */
  38030. DEBUGCANVASSIZE: {
  38031. width: number;
  38032. height: number;
  38033. };
  38034. private _byteFreqs;
  38035. private _byteTime;
  38036. private _floatFreqs;
  38037. private _webAudioAnalyser;
  38038. private _debugCanvas;
  38039. private _debugCanvasContext;
  38040. private _scene;
  38041. private _registerFunc;
  38042. private _audioEngine;
  38043. /**
  38044. * Creates a new analyser
  38045. * @param scene defines hosting scene
  38046. */
  38047. constructor(scene: Scene);
  38048. /**
  38049. * Get the number of data values you will have to play with for the visualization
  38050. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  38051. * @returns a number
  38052. */
  38053. getFrequencyBinCount(): number;
  38054. /**
  38055. * Gets the current frequency data as a byte array
  38056. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38057. * @returns a Uint8Array
  38058. */
  38059. getByteFrequencyData(): Uint8Array;
  38060. /**
  38061. * Gets the current waveform as a byte array
  38062. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  38063. * @returns a Uint8Array
  38064. */
  38065. getByteTimeDomainData(): Uint8Array;
  38066. /**
  38067. * Gets the current frequency data as a float array
  38068. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38069. * @returns a Float32Array
  38070. */
  38071. getFloatFrequencyData(): Float32Array;
  38072. /**
  38073. * Renders the debug canvas
  38074. */
  38075. drawDebugCanvas(): void;
  38076. /**
  38077. * Stops rendering the debug canvas and removes it
  38078. */
  38079. stopDebugCanvas(): void;
  38080. /**
  38081. * Connects two audio nodes
  38082. * @param inputAudioNode defines first node to connect
  38083. * @param outputAudioNode defines second node to connect
  38084. */
  38085. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  38086. /**
  38087. * Releases all associated resources
  38088. */
  38089. dispose(): void;
  38090. }
  38091. }
  38092. declare module "babylonjs/Audio/audioEngine" {
  38093. import { IDisposable } from "babylonjs/scene";
  38094. import { Analyser } from "babylonjs/Audio/analyser";
  38095. import { Nullable } from "babylonjs/types";
  38096. import { Observable } from "babylonjs/Misc/observable";
  38097. /**
  38098. * This represents an audio engine and it is responsible
  38099. * to play, synchronize and analyse sounds throughout the application.
  38100. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38101. */
  38102. export interface IAudioEngine extends IDisposable {
  38103. /**
  38104. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38105. */
  38106. readonly canUseWebAudio: boolean;
  38107. /**
  38108. * Gets the current AudioContext if available.
  38109. */
  38110. readonly audioContext: Nullable<AudioContext>;
  38111. /**
  38112. * The master gain node defines the global audio volume of your audio engine.
  38113. */
  38114. readonly masterGain: GainNode;
  38115. /**
  38116. * Gets whether or not mp3 are supported by your browser.
  38117. */
  38118. readonly isMP3supported: boolean;
  38119. /**
  38120. * Gets whether or not ogg are supported by your browser.
  38121. */
  38122. readonly isOGGsupported: boolean;
  38123. /**
  38124. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38125. * @ignoreNaming
  38126. */
  38127. WarnedWebAudioUnsupported: boolean;
  38128. /**
  38129. * Defines if the audio engine relies on a custom unlocked button.
  38130. * In this case, the embedded button will not be displayed.
  38131. */
  38132. useCustomUnlockedButton: boolean;
  38133. /**
  38134. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  38135. */
  38136. readonly unlocked: boolean;
  38137. /**
  38138. * Event raised when audio has been unlocked on the browser.
  38139. */
  38140. onAudioUnlockedObservable: Observable<AudioEngine>;
  38141. /**
  38142. * Event raised when audio has been locked on the browser.
  38143. */
  38144. onAudioLockedObservable: Observable<AudioEngine>;
  38145. /**
  38146. * Flags the audio engine in Locked state.
  38147. * This happens due to new browser policies preventing audio to autoplay.
  38148. */
  38149. lock(): void;
  38150. /**
  38151. * Unlocks the audio engine once a user action has been done on the dom.
  38152. * This is helpful to resume play once browser policies have been satisfied.
  38153. */
  38154. unlock(): void;
  38155. /**
  38156. * Gets the global volume sets on the master gain.
  38157. * @returns the global volume if set or -1 otherwise
  38158. */
  38159. getGlobalVolume(): number;
  38160. /**
  38161. * Sets the global volume of your experience (sets on the master gain).
  38162. * @param newVolume Defines the new global volume of the application
  38163. */
  38164. setGlobalVolume(newVolume: number): void;
  38165. /**
  38166. * Connect the audio engine to an audio analyser allowing some amazing
  38167. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38168. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38169. * @param analyser The analyser to connect to the engine
  38170. */
  38171. connectToAnalyser(analyser: Analyser): void;
  38172. }
  38173. /**
  38174. * This represents the default audio engine used in babylon.
  38175. * It is responsible to play, synchronize and analyse sounds throughout the application.
  38176. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38177. */
  38178. export class AudioEngine implements IAudioEngine {
  38179. private _audioContext;
  38180. private _audioContextInitialized;
  38181. private _muteButton;
  38182. private _hostElement;
  38183. /**
  38184. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38185. */
  38186. canUseWebAudio: boolean;
  38187. /**
  38188. * The master gain node defines the global audio volume of your audio engine.
  38189. */
  38190. masterGain: GainNode;
  38191. /**
  38192. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38193. * @ignoreNaming
  38194. */
  38195. WarnedWebAudioUnsupported: boolean;
  38196. /**
  38197. * Gets whether or not mp3 are supported by your browser.
  38198. */
  38199. isMP3supported: boolean;
  38200. /**
  38201. * Gets whether or not ogg are supported by your browser.
  38202. */
  38203. isOGGsupported: boolean;
  38204. /**
  38205. * Gets whether audio has been unlocked on the device.
  38206. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  38207. * a user interaction has happened.
  38208. */
  38209. unlocked: boolean;
  38210. /**
  38211. * Defines if the audio engine relies on a custom unlocked button.
  38212. * In this case, the embedded button will not be displayed.
  38213. */
  38214. useCustomUnlockedButton: boolean;
  38215. /**
  38216. * Event raised when audio has been unlocked on the browser.
  38217. */
  38218. onAudioUnlockedObservable: Observable<AudioEngine>;
  38219. /**
  38220. * Event raised when audio has been locked on the browser.
  38221. */
  38222. onAudioLockedObservable: Observable<AudioEngine>;
  38223. /**
  38224. * Gets the current AudioContext if available.
  38225. */
  38226. get audioContext(): Nullable<AudioContext>;
  38227. private _connectedAnalyser;
  38228. /**
  38229. * Instantiates a new audio engine.
  38230. *
  38231. * There should be only one per page as some browsers restrict the number
  38232. * of audio contexts you can create.
  38233. * @param hostElement defines the host element where to display the mute icon if necessary
  38234. */
  38235. constructor(hostElement?: Nullable<HTMLElement>);
  38236. /**
  38237. * Flags the audio engine in Locked state.
  38238. * This happens due to new browser policies preventing audio to autoplay.
  38239. */
  38240. lock(): void;
  38241. /**
  38242. * Unlocks the audio engine once a user action has been done on the dom.
  38243. * This is helpful to resume play once browser policies have been satisfied.
  38244. */
  38245. unlock(): void;
  38246. private _resumeAudioContext;
  38247. private _initializeAudioContext;
  38248. private _tryToRun;
  38249. private _triggerRunningState;
  38250. private _triggerSuspendedState;
  38251. private _displayMuteButton;
  38252. private _moveButtonToTopLeft;
  38253. private _onResize;
  38254. private _hideMuteButton;
  38255. /**
  38256. * Destroy and release the resources associated with the audio ccontext.
  38257. */
  38258. dispose(): void;
  38259. /**
  38260. * Gets the global volume sets on the master gain.
  38261. * @returns the global volume if set or -1 otherwise
  38262. */
  38263. getGlobalVolume(): number;
  38264. /**
  38265. * Sets the global volume of your experience (sets on the master gain).
  38266. * @param newVolume Defines the new global volume of the application
  38267. */
  38268. setGlobalVolume(newVolume: number): void;
  38269. /**
  38270. * Connect the audio engine to an audio analyser allowing some amazing
  38271. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38272. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38273. * @param analyser The analyser to connect to the engine
  38274. */
  38275. connectToAnalyser(analyser: Analyser): void;
  38276. }
  38277. }
  38278. declare module "babylonjs/Loading/loadingScreen" {
  38279. /**
  38280. * Interface used to present a loading screen while loading a scene
  38281. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38282. */
  38283. export interface ILoadingScreen {
  38284. /**
  38285. * Function called to display the loading screen
  38286. */
  38287. displayLoadingUI: () => void;
  38288. /**
  38289. * Function called to hide the loading screen
  38290. */
  38291. hideLoadingUI: () => void;
  38292. /**
  38293. * Gets or sets the color to use for the background
  38294. */
  38295. loadingUIBackgroundColor: string;
  38296. /**
  38297. * Gets or sets the text to display while loading
  38298. */
  38299. loadingUIText: string;
  38300. }
  38301. /**
  38302. * Class used for the default loading screen
  38303. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38304. */
  38305. export class DefaultLoadingScreen implements ILoadingScreen {
  38306. private _renderingCanvas;
  38307. private _loadingText;
  38308. private _loadingDivBackgroundColor;
  38309. private _loadingDiv;
  38310. private _loadingTextDiv;
  38311. /** Gets or sets the logo url to use for the default loading screen */
  38312. static DefaultLogoUrl: string;
  38313. /** Gets or sets the spinner url to use for the default loading screen */
  38314. static DefaultSpinnerUrl: string;
  38315. /**
  38316. * Creates a new default loading screen
  38317. * @param _renderingCanvas defines the canvas used to render the scene
  38318. * @param _loadingText defines the default text to display
  38319. * @param _loadingDivBackgroundColor defines the default background color
  38320. */
  38321. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38322. /**
  38323. * Function called to display the loading screen
  38324. */
  38325. displayLoadingUI(): void;
  38326. /**
  38327. * Function called to hide the loading screen
  38328. */
  38329. hideLoadingUI(): void;
  38330. /**
  38331. * Gets or sets the text to display while loading
  38332. */
  38333. set loadingUIText(text: string);
  38334. get loadingUIText(): string;
  38335. /**
  38336. * Gets or sets the color to use for the background
  38337. */
  38338. get loadingUIBackgroundColor(): string;
  38339. set loadingUIBackgroundColor(color: string);
  38340. private _resizeLoadingUI;
  38341. }
  38342. }
  38343. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38344. /**
  38345. * Interface for any object that can request an animation frame
  38346. */
  38347. export interface ICustomAnimationFrameRequester {
  38348. /**
  38349. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38350. */
  38351. renderFunction?: Function;
  38352. /**
  38353. * Called to request the next frame to render to
  38354. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38355. */
  38356. requestAnimationFrame: Function;
  38357. /**
  38358. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38359. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38360. */
  38361. requestID?: number;
  38362. }
  38363. }
  38364. declare module "babylonjs/Misc/performanceMonitor" {
  38365. /**
  38366. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38367. */
  38368. export class PerformanceMonitor {
  38369. private _enabled;
  38370. private _rollingFrameTime;
  38371. private _lastFrameTimeMs;
  38372. /**
  38373. * constructor
  38374. * @param frameSampleSize The number of samples required to saturate the sliding window
  38375. */
  38376. constructor(frameSampleSize?: number);
  38377. /**
  38378. * Samples current frame
  38379. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38380. */
  38381. sampleFrame(timeMs?: number): void;
  38382. /**
  38383. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38384. */
  38385. get averageFrameTime(): number;
  38386. /**
  38387. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38388. */
  38389. get averageFrameTimeVariance(): number;
  38390. /**
  38391. * Returns the frame time of the most recent frame
  38392. */
  38393. get instantaneousFrameTime(): number;
  38394. /**
  38395. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38396. */
  38397. get averageFPS(): number;
  38398. /**
  38399. * Returns the average framerate in frames per second using the most recent frame time
  38400. */
  38401. get instantaneousFPS(): number;
  38402. /**
  38403. * Returns true if enough samples have been taken to completely fill the sliding window
  38404. */
  38405. get isSaturated(): boolean;
  38406. /**
  38407. * Enables contributions to the sliding window sample set
  38408. */
  38409. enable(): void;
  38410. /**
  38411. * Disables contributions to the sliding window sample set
  38412. * Samples will not be interpolated over the disabled period
  38413. */
  38414. disable(): void;
  38415. /**
  38416. * Returns true if sampling is enabled
  38417. */
  38418. get isEnabled(): boolean;
  38419. /**
  38420. * Resets performance monitor
  38421. */
  38422. reset(): void;
  38423. }
  38424. /**
  38425. * RollingAverage
  38426. *
  38427. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38428. */
  38429. export class RollingAverage {
  38430. /**
  38431. * Current average
  38432. */
  38433. average: number;
  38434. /**
  38435. * Current variance
  38436. */
  38437. variance: number;
  38438. protected _samples: Array<number>;
  38439. protected _sampleCount: number;
  38440. protected _pos: number;
  38441. protected _m2: number;
  38442. /**
  38443. * constructor
  38444. * @param length The number of samples required to saturate the sliding window
  38445. */
  38446. constructor(length: number);
  38447. /**
  38448. * Adds a sample to the sample set
  38449. * @param v The sample value
  38450. */
  38451. add(v: number): void;
  38452. /**
  38453. * Returns previously added values or null if outside of history or outside the sliding window domain
  38454. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38455. * @return Value previously recorded with add() or null if outside of range
  38456. */
  38457. history(i: number): number;
  38458. /**
  38459. * Returns true if enough samples have been taken to completely fill the sliding window
  38460. * @return true if sample-set saturated
  38461. */
  38462. isSaturated(): boolean;
  38463. /**
  38464. * Resets the rolling average (equivalent to 0 samples taken so far)
  38465. */
  38466. reset(): void;
  38467. /**
  38468. * Wraps a value around the sample range boundaries
  38469. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38470. * @return Wrapped position in sample range
  38471. */
  38472. protected _wrapPosition(i: number): number;
  38473. }
  38474. }
  38475. declare module "babylonjs/Misc/perfCounter" {
  38476. /**
  38477. * This class is used to track a performance counter which is number based.
  38478. * The user has access to many properties which give statistics of different nature.
  38479. *
  38480. * The implementer can track two kinds of Performance Counter: time and count.
  38481. * 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.
  38482. * 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.
  38483. */
  38484. export class PerfCounter {
  38485. /**
  38486. * Gets or sets a global boolean to turn on and off all the counters
  38487. */
  38488. static Enabled: boolean;
  38489. /**
  38490. * Returns the smallest value ever
  38491. */
  38492. get min(): number;
  38493. /**
  38494. * Returns the biggest value ever
  38495. */
  38496. get max(): number;
  38497. /**
  38498. * Returns the average value since the performance counter is running
  38499. */
  38500. get average(): number;
  38501. /**
  38502. * Returns the average value of the last second the counter was monitored
  38503. */
  38504. get lastSecAverage(): number;
  38505. /**
  38506. * Returns the current value
  38507. */
  38508. get current(): number;
  38509. /**
  38510. * Gets the accumulated total
  38511. */
  38512. get total(): number;
  38513. /**
  38514. * Gets the total value count
  38515. */
  38516. get count(): number;
  38517. /**
  38518. * Creates a new counter
  38519. */
  38520. constructor();
  38521. /**
  38522. * Call this method to start monitoring a new frame.
  38523. * 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.
  38524. */
  38525. fetchNewFrame(): void;
  38526. /**
  38527. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38528. * @param newCount the count value to add to the monitored count
  38529. * @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.
  38530. */
  38531. addCount(newCount: number, fetchResult: boolean): void;
  38532. /**
  38533. * Start monitoring this performance counter
  38534. */
  38535. beginMonitoring(): void;
  38536. /**
  38537. * Compute the time lapsed since the previous beginMonitoring() call.
  38538. * @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
  38539. */
  38540. endMonitoring(newFrame?: boolean): void;
  38541. private _fetchResult;
  38542. private _startMonitoringTime;
  38543. private _min;
  38544. private _max;
  38545. private _average;
  38546. private _current;
  38547. private _totalValueCount;
  38548. private _totalAccumulated;
  38549. private _lastSecAverage;
  38550. private _lastSecAccumulated;
  38551. private _lastSecTime;
  38552. private _lastSecValueCount;
  38553. }
  38554. }
  38555. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38556. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38557. import { Nullable } from "babylonjs/types";
  38558. module "babylonjs/Engines/thinEngine" {
  38559. interface ThinEngine {
  38560. /** @hidden */
  38561. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38562. }
  38563. }
  38564. }
  38565. declare module "babylonjs/Engines/engine" {
  38566. import { Observable } from "babylonjs/Misc/observable";
  38567. import { Nullable } from "babylonjs/types";
  38568. import { Scene } from "babylonjs/scene";
  38569. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38570. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38571. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38572. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38573. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38574. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38575. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38576. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38577. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38578. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38579. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38580. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38581. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38582. import "babylonjs/Engines/Extensions/engine.alpha";
  38583. import "babylonjs/Engines/Extensions/engine.readTexture";
  38584. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  38585. import { Material } from "babylonjs/Materials/material";
  38586. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38587. /**
  38588. * Defines the interface used by display changed events
  38589. */
  38590. export interface IDisplayChangedEventArgs {
  38591. /** Gets the vrDisplay object (if any) */
  38592. vrDisplay: Nullable<any>;
  38593. /** Gets a boolean indicating if webVR is supported */
  38594. vrSupported: boolean;
  38595. }
  38596. /**
  38597. * Defines the interface used by objects containing a viewport (like a camera)
  38598. */
  38599. interface IViewportOwnerLike {
  38600. /**
  38601. * Gets or sets the viewport
  38602. */
  38603. viewport: IViewportLike;
  38604. }
  38605. /**
  38606. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38607. */
  38608. export class Engine extends ThinEngine {
  38609. /** Defines that alpha blending is disabled */
  38610. static readonly ALPHA_DISABLE: number;
  38611. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38612. static readonly ALPHA_ADD: number;
  38613. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38614. static readonly ALPHA_COMBINE: number;
  38615. /** Defines that alpha blending to DEST - SRC * DEST */
  38616. static readonly ALPHA_SUBTRACT: number;
  38617. /** Defines that alpha blending to SRC * DEST */
  38618. static readonly ALPHA_MULTIPLY: number;
  38619. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38620. static readonly ALPHA_MAXIMIZED: number;
  38621. /** Defines that alpha blending to SRC + DEST */
  38622. static readonly ALPHA_ONEONE: number;
  38623. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38624. static readonly ALPHA_PREMULTIPLIED: number;
  38625. /**
  38626. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38627. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38628. */
  38629. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38630. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38631. static readonly ALPHA_INTERPOLATE: number;
  38632. /**
  38633. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38634. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38635. */
  38636. static readonly ALPHA_SCREENMODE: number;
  38637. /** Defines that the ressource is not delayed*/
  38638. static readonly DELAYLOADSTATE_NONE: number;
  38639. /** Defines that the ressource was successfully delay loaded */
  38640. static readonly DELAYLOADSTATE_LOADED: number;
  38641. /** Defines that the ressource is currently delay loading */
  38642. static readonly DELAYLOADSTATE_LOADING: number;
  38643. /** Defines that the ressource is delayed and has not started loading */
  38644. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38645. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38646. static readonly NEVER: number;
  38647. /** 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 */
  38648. static readonly ALWAYS: number;
  38649. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38650. static readonly LESS: number;
  38651. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38652. static readonly EQUAL: number;
  38653. /** 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 */
  38654. static readonly LEQUAL: number;
  38655. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38656. static readonly GREATER: number;
  38657. /** 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 */
  38658. static readonly GEQUAL: number;
  38659. /** 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 */
  38660. static readonly NOTEQUAL: number;
  38661. /** Passed to stencilOperation to specify that stencil value must be kept */
  38662. static readonly KEEP: number;
  38663. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38664. static readonly REPLACE: number;
  38665. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38666. static readonly INCR: number;
  38667. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38668. static readonly DECR: number;
  38669. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38670. static readonly INVERT: number;
  38671. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38672. static readonly INCR_WRAP: number;
  38673. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38674. static readonly DECR_WRAP: number;
  38675. /** Texture is not repeating outside of 0..1 UVs */
  38676. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38677. /** Texture is repeating outside of 0..1 UVs */
  38678. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38679. /** Texture is repeating and mirrored */
  38680. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38681. /** ALPHA */
  38682. static readonly TEXTUREFORMAT_ALPHA: number;
  38683. /** LUMINANCE */
  38684. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38685. /** LUMINANCE_ALPHA */
  38686. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38687. /** RGB */
  38688. static readonly TEXTUREFORMAT_RGB: number;
  38689. /** RGBA */
  38690. static readonly TEXTUREFORMAT_RGBA: number;
  38691. /** RED */
  38692. static readonly TEXTUREFORMAT_RED: number;
  38693. /** RED (2nd reference) */
  38694. static readonly TEXTUREFORMAT_R: number;
  38695. /** RG */
  38696. static readonly TEXTUREFORMAT_RG: number;
  38697. /** RED_INTEGER */
  38698. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38699. /** RED_INTEGER (2nd reference) */
  38700. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38701. /** RG_INTEGER */
  38702. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38703. /** RGB_INTEGER */
  38704. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38705. /** RGBA_INTEGER */
  38706. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38707. /** UNSIGNED_BYTE */
  38708. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38709. /** UNSIGNED_BYTE (2nd reference) */
  38710. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38711. /** FLOAT */
  38712. static readonly TEXTURETYPE_FLOAT: number;
  38713. /** HALF_FLOAT */
  38714. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38715. /** BYTE */
  38716. static readonly TEXTURETYPE_BYTE: number;
  38717. /** SHORT */
  38718. static readonly TEXTURETYPE_SHORT: number;
  38719. /** UNSIGNED_SHORT */
  38720. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38721. /** INT */
  38722. static readonly TEXTURETYPE_INT: number;
  38723. /** UNSIGNED_INT */
  38724. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38725. /** UNSIGNED_SHORT_4_4_4_4 */
  38726. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38727. /** UNSIGNED_SHORT_5_5_5_1 */
  38728. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38729. /** UNSIGNED_SHORT_5_6_5 */
  38730. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38731. /** UNSIGNED_INT_2_10_10_10_REV */
  38732. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38733. /** UNSIGNED_INT_24_8 */
  38734. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38735. /** UNSIGNED_INT_10F_11F_11F_REV */
  38736. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38737. /** UNSIGNED_INT_5_9_9_9_REV */
  38738. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38739. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38740. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38741. /** nearest is mag = nearest and min = nearest and mip = linear */
  38742. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38743. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38744. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38745. /** Trilinear is mag = linear and min = linear and mip = linear */
  38746. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38747. /** nearest is mag = nearest and min = nearest and mip = linear */
  38748. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38749. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38750. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38751. /** Trilinear is mag = linear and min = linear and mip = linear */
  38752. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38753. /** mag = nearest and min = nearest and mip = nearest */
  38754. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38755. /** mag = nearest and min = linear and mip = nearest */
  38756. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38757. /** mag = nearest and min = linear and mip = linear */
  38758. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38759. /** mag = nearest and min = linear and mip = none */
  38760. static readonly TEXTURE_NEAREST_LINEAR: number;
  38761. /** mag = nearest and min = nearest and mip = none */
  38762. static readonly TEXTURE_NEAREST_NEAREST: number;
  38763. /** mag = linear and min = nearest and mip = nearest */
  38764. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38765. /** mag = linear and min = nearest and mip = linear */
  38766. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38767. /** mag = linear and min = linear and mip = none */
  38768. static readonly TEXTURE_LINEAR_LINEAR: number;
  38769. /** mag = linear and min = nearest and mip = none */
  38770. static readonly TEXTURE_LINEAR_NEAREST: number;
  38771. /** Explicit coordinates mode */
  38772. static readonly TEXTURE_EXPLICIT_MODE: number;
  38773. /** Spherical coordinates mode */
  38774. static readonly TEXTURE_SPHERICAL_MODE: number;
  38775. /** Planar coordinates mode */
  38776. static readonly TEXTURE_PLANAR_MODE: number;
  38777. /** Cubic coordinates mode */
  38778. static readonly TEXTURE_CUBIC_MODE: number;
  38779. /** Projection coordinates mode */
  38780. static readonly TEXTURE_PROJECTION_MODE: number;
  38781. /** Skybox coordinates mode */
  38782. static readonly TEXTURE_SKYBOX_MODE: number;
  38783. /** Inverse Cubic coordinates mode */
  38784. static readonly TEXTURE_INVCUBIC_MODE: number;
  38785. /** Equirectangular coordinates mode */
  38786. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38787. /** Equirectangular Fixed coordinates mode */
  38788. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38789. /** Equirectangular Fixed Mirrored coordinates mode */
  38790. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38791. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38792. static readonly SCALEMODE_FLOOR: number;
  38793. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38794. static readonly SCALEMODE_NEAREST: number;
  38795. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38796. static readonly SCALEMODE_CEILING: number;
  38797. /**
  38798. * Returns the current npm package of the sdk
  38799. */
  38800. static get NpmPackage(): string;
  38801. /**
  38802. * Returns the current version of the framework
  38803. */
  38804. static get Version(): string;
  38805. /** Gets the list of created engines */
  38806. static get Instances(): Engine[];
  38807. /**
  38808. * Gets the latest created engine
  38809. */
  38810. static get LastCreatedEngine(): Nullable<Engine>;
  38811. /**
  38812. * Gets the latest created scene
  38813. */
  38814. static get LastCreatedScene(): Nullable<Scene>;
  38815. /**
  38816. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38817. * @param flag defines which part of the materials must be marked as dirty
  38818. * @param predicate defines a predicate used to filter which materials should be affected
  38819. */
  38820. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38821. /**
  38822. * Method called to create the default loading screen.
  38823. * This can be overriden in your own app.
  38824. * @param canvas The rendering canvas element
  38825. * @returns The loading screen
  38826. */
  38827. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38828. /**
  38829. * Method called to create the default rescale post process on each engine.
  38830. */
  38831. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38832. /**
  38833. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38834. **/
  38835. enableOfflineSupport: boolean;
  38836. /**
  38837. * 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)
  38838. **/
  38839. disableManifestCheck: boolean;
  38840. /**
  38841. * Gets the list of created scenes
  38842. */
  38843. scenes: Scene[];
  38844. /**
  38845. * Event raised when a new scene is created
  38846. */
  38847. onNewSceneAddedObservable: Observable<Scene>;
  38848. /**
  38849. * Gets the list of created postprocesses
  38850. */
  38851. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38852. /**
  38853. * Gets a boolean indicating if the pointer is currently locked
  38854. */
  38855. isPointerLock: boolean;
  38856. /**
  38857. * Observable event triggered each time the rendering canvas is resized
  38858. */
  38859. onResizeObservable: Observable<Engine>;
  38860. /**
  38861. * Observable event triggered each time the canvas loses focus
  38862. */
  38863. onCanvasBlurObservable: Observable<Engine>;
  38864. /**
  38865. * Observable event triggered each time the canvas gains focus
  38866. */
  38867. onCanvasFocusObservable: Observable<Engine>;
  38868. /**
  38869. * Observable event triggered each time the canvas receives pointerout event
  38870. */
  38871. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38872. /**
  38873. * Observable raised when the engine begins a new frame
  38874. */
  38875. onBeginFrameObservable: Observable<Engine>;
  38876. /**
  38877. * If set, will be used to request the next animation frame for the render loop
  38878. */
  38879. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  38880. /**
  38881. * Observable raised when the engine ends the current frame
  38882. */
  38883. onEndFrameObservable: Observable<Engine>;
  38884. /**
  38885. * Observable raised when the engine is about to compile a shader
  38886. */
  38887. onBeforeShaderCompilationObservable: Observable<Engine>;
  38888. /**
  38889. * Observable raised when the engine has jsut compiled a shader
  38890. */
  38891. onAfterShaderCompilationObservable: Observable<Engine>;
  38892. /**
  38893. * Gets the audio engine
  38894. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38895. * @ignorenaming
  38896. */
  38897. static audioEngine: IAudioEngine;
  38898. /**
  38899. * Default AudioEngine factory responsible of creating the Audio Engine.
  38900. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  38901. */
  38902. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  38903. /**
  38904. * Default offline support factory responsible of creating a tool used to store data locally.
  38905. * By default, this will create a Database object if the workload has been embedded.
  38906. */
  38907. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  38908. private _loadingScreen;
  38909. private _pointerLockRequested;
  38910. private _rescalePostProcess;
  38911. private _deterministicLockstep;
  38912. private _lockstepMaxSteps;
  38913. private _timeStep;
  38914. protected get _supportsHardwareTextureRescaling(): boolean;
  38915. private _fps;
  38916. private _deltaTime;
  38917. /** @hidden */
  38918. _drawCalls: PerfCounter;
  38919. /** 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 */
  38920. canvasTabIndex: number;
  38921. /**
  38922. * Turn this value on if you want to pause FPS computation when in background
  38923. */
  38924. disablePerformanceMonitorInBackground: boolean;
  38925. private _performanceMonitor;
  38926. /**
  38927. * Gets the performance monitor attached to this engine
  38928. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  38929. */
  38930. get performanceMonitor(): PerformanceMonitor;
  38931. private _onFocus;
  38932. private _onBlur;
  38933. private _onCanvasPointerOut;
  38934. private _onCanvasBlur;
  38935. private _onCanvasFocus;
  38936. private _onFullscreenChange;
  38937. private _onPointerLockChange;
  38938. /**
  38939. * Gets the HTML element used to attach event listeners
  38940. * @returns a HTML element
  38941. */
  38942. getInputElement(): Nullable<HTMLElement>;
  38943. /**
  38944. * Creates a new engine
  38945. * @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
  38946. * @param antialias defines enable antialiasing (default: false)
  38947. * @param options defines further options to be sent to the getContext() function
  38948. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  38949. */
  38950. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  38951. /**
  38952. * Gets current aspect ratio
  38953. * @param viewportOwner defines the camera to use to get the aspect ratio
  38954. * @param useScreen defines if screen size must be used (or the current render target if any)
  38955. * @returns a number defining the aspect ratio
  38956. */
  38957. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  38958. /**
  38959. * Gets current screen aspect ratio
  38960. * @returns a number defining the aspect ratio
  38961. */
  38962. getScreenAspectRatio(): number;
  38963. /**
  38964. * Gets the client rect of the HTML canvas attached with the current webGL context
  38965. * @returns a client rectanglee
  38966. */
  38967. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  38968. /**
  38969. * Gets the client rect of the HTML element used for events
  38970. * @returns a client rectanglee
  38971. */
  38972. getInputElementClientRect(): Nullable<ClientRect>;
  38973. /**
  38974. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  38975. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38976. * @returns true if engine is in deterministic lock step mode
  38977. */
  38978. isDeterministicLockStep(): boolean;
  38979. /**
  38980. * Gets the max steps when engine is running in deterministic lock step
  38981. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38982. * @returns the max steps
  38983. */
  38984. getLockstepMaxSteps(): number;
  38985. /**
  38986. * Returns the time in ms between steps when using deterministic lock step.
  38987. * @returns time step in (ms)
  38988. */
  38989. getTimeStep(): number;
  38990. /**
  38991. * Force the mipmap generation for the given render target texture
  38992. * @param texture defines the render target texture to use
  38993. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  38994. */
  38995. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  38996. /** States */
  38997. /**
  38998. * Set various states to the webGL context
  38999. * @param culling defines backface culling state
  39000. * @param zOffset defines the value to apply to zOffset (0 by default)
  39001. * @param force defines if states must be applied even if cache is up to date
  39002. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  39003. */
  39004. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  39005. /**
  39006. * Set the z offset to apply to current rendering
  39007. * @param value defines the offset to apply
  39008. */
  39009. setZOffset(value: number): void;
  39010. /**
  39011. * Gets the current value of the zOffset
  39012. * @returns the current zOffset state
  39013. */
  39014. getZOffset(): number;
  39015. /**
  39016. * Enable or disable depth buffering
  39017. * @param enable defines the state to set
  39018. */
  39019. setDepthBuffer(enable: boolean): void;
  39020. /**
  39021. * Gets a boolean indicating if depth writing is enabled
  39022. * @returns the current depth writing state
  39023. */
  39024. getDepthWrite(): boolean;
  39025. /**
  39026. * Enable or disable depth writing
  39027. * @param enable defines the state to set
  39028. */
  39029. setDepthWrite(enable: boolean): void;
  39030. /**
  39031. * Gets a boolean indicating if stencil buffer is enabled
  39032. * @returns the current stencil buffer state
  39033. */
  39034. getStencilBuffer(): boolean;
  39035. /**
  39036. * Enable or disable the stencil buffer
  39037. * @param enable defines if the stencil buffer must be enabled or disabled
  39038. */
  39039. setStencilBuffer(enable: boolean): void;
  39040. /**
  39041. * Gets the current stencil mask
  39042. * @returns a number defining the new stencil mask to use
  39043. */
  39044. getStencilMask(): number;
  39045. /**
  39046. * Sets the current stencil mask
  39047. * @param mask defines the new stencil mask to use
  39048. */
  39049. setStencilMask(mask: number): void;
  39050. /**
  39051. * Gets the current stencil function
  39052. * @returns a number defining the stencil function to use
  39053. */
  39054. getStencilFunction(): number;
  39055. /**
  39056. * Gets the current stencil reference value
  39057. * @returns a number defining the stencil reference value to use
  39058. */
  39059. getStencilFunctionReference(): number;
  39060. /**
  39061. * Gets the current stencil mask
  39062. * @returns a number defining the stencil mask to use
  39063. */
  39064. getStencilFunctionMask(): number;
  39065. /**
  39066. * Sets the current stencil function
  39067. * @param stencilFunc defines the new stencil function to use
  39068. */
  39069. setStencilFunction(stencilFunc: number): void;
  39070. /**
  39071. * Sets the current stencil reference
  39072. * @param reference defines the new stencil reference to use
  39073. */
  39074. setStencilFunctionReference(reference: number): void;
  39075. /**
  39076. * Sets the current stencil mask
  39077. * @param mask defines the new stencil mask to use
  39078. */
  39079. setStencilFunctionMask(mask: number): void;
  39080. /**
  39081. * Gets the current stencil operation when stencil fails
  39082. * @returns a number defining stencil operation to use when stencil fails
  39083. */
  39084. getStencilOperationFail(): number;
  39085. /**
  39086. * Gets the current stencil operation when depth fails
  39087. * @returns a number defining stencil operation to use when depth fails
  39088. */
  39089. getStencilOperationDepthFail(): number;
  39090. /**
  39091. * Gets the current stencil operation when stencil passes
  39092. * @returns a number defining stencil operation to use when stencil passes
  39093. */
  39094. getStencilOperationPass(): number;
  39095. /**
  39096. * Sets the stencil operation to use when stencil fails
  39097. * @param operation defines the stencil operation to use when stencil fails
  39098. */
  39099. setStencilOperationFail(operation: number): void;
  39100. /**
  39101. * Sets the stencil operation to use when depth fails
  39102. * @param operation defines the stencil operation to use when depth fails
  39103. */
  39104. setStencilOperationDepthFail(operation: number): void;
  39105. /**
  39106. * Sets the stencil operation to use when stencil passes
  39107. * @param operation defines the stencil operation to use when stencil passes
  39108. */
  39109. setStencilOperationPass(operation: number): void;
  39110. /**
  39111. * Sets a boolean indicating if the dithering state is enabled or disabled
  39112. * @param value defines the dithering state
  39113. */
  39114. setDitheringState(value: boolean): void;
  39115. /**
  39116. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  39117. * @param value defines the rasterizer state
  39118. */
  39119. setRasterizerState(value: boolean): void;
  39120. /**
  39121. * Gets the current depth function
  39122. * @returns a number defining the depth function
  39123. */
  39124. getDepthFunction(): Nullable<number>;
  39125. /**
  39126. * Sets the current depth function
  39127. * @param depthFunc defines the function to use
  39128. */
  39129. setDepthFunction(depthFunc: number): void;
  39130. /**
  39131. * Sets the current depth function to GREATER
  39132. */
  39133. setDepthFunctionToGreater(): void;
  39134. /**
  39135. * Sets the current depth function to GEQUAL
  39136. */
  39137. setDepthFunctionToGreaterOrEqual(): void;
  39138. /**
  39139. * Sets the current depth function to LESS
  39140. */
  39141. setDepthFunctionToLess(): void;
  39142. /**
  39143. * Sets the current depth function to LEQUAL
  39144. */
  39145. setDepthFunctionToLessOrEqual(): void;
  39146. private _cachedStencilBuffer;
  39147. private _cachedStencilFunction;
  39148. private _cachedStencilMask;
  39149. private _cachedStencilOperationPass;
  39150. private _cachedStencilOperationFail;
  39151. private _cachedStencilOperationDepthFail;
  39152. private _cachedStencilReference;
  39153. /**
  39154. * Caches the the state of the stencil buffer
  39155. */
  39156. cacheStencilState(): void;
  39157. /**
  39158. * Restores the state of the stencil buffer
  39159. */
  39160. restoreStencilState(): void;
  39161. /**
  39162. * Directly set the WebGL Viewport
  39163. * @param x defines the x coordinate of the viewport (in screen space)
  39164. * @param y defines the y coordinate of the viewport (in screen space)
  39165. * @param width defines the width of the viewport (in screen space)
  39166. * @param height defines the height of the viewport (in screen space)
  39167. * @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
  39168. */
  39169. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  39170. /**
  39171. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  39172. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39173. * @param y defines the y-coordinate of the corner of the clear rectangle
  39174. * @param width defines the width of the clear rectangle
  39175. * @param height defines the height of the clear rectangle
  39176. * @param clearColor defines the clear color
  39177. */
  39178. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  39179. /**
  39180. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  39181. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39182. * @param y defines the y-coordinate of the corner of the clear rectangle
  39183. * @param width defines the width of the clear rectangle
  39184. * @param height defines the height of the clear rectangle
  39185. */
  39186. enableScissor(x: number, y: number, width: number, height: number): void;
  39187. /**
  39188. * Disable previously set scissor test rectangle
  39189. */
  39190. disableScissor(): void;
  39191. protected _reportDrawCall(): void;
  39192. /**
  39193. * Initializes a webVR display and starts listening to display change events
  39194. * The onVRDisplayChangedObservable will be notified upon these changes
  39195. * @returns The onVRDisplayChangedObservable
  39196. */
  39197. initWebVR(): Observable<IDisplayChangedEventArgs>;
  39198. /** @hidden */
  39199. _prepareVRComponent(): void;
  39200. /** @hidden */
  39201. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  39202. /** @hidden */
  39203. _submitVRFrame(): void;
  39204. /**
  39205. * Call this function to leave webVR mode
  39206. * Will do nothing if webVR is not supported or if there is no webVR device
  39207. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39208. */
  39209. disableVR(): void;
  39210. /**
  39211. * Gets a boolean indicating that the system is in VR mode and is presenting
  39212. * @returns true if VR mode is engaged
  39213. */
  39214. isVRPresenting(): boolean;
  39215. /** @hidden */
  39216. _requestVRFrame(): void;
  39217. /** @hidden */
  39218. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  39219. /**
  39220. * Gets the source code of the vertex shader associated with a specific webGL program
  39221. * @param program defines the program to use
  39222. * @returns a string containing the source code of the vertex shader associated with the program
  39223. */
  39224. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  39225. /**
  39226. * Gets the source code of the fragment shader associated with a specific webGL program
  39227. * @param program defines the program to use
  39228. * @returns a string containing the source code of the fragment shader associated with the program
  39229. */
  39230. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  39231. /**
  39232. * Sets a depth stencil texture from a render target to the according uniform.
  39233. * @param channel The texture channel
  39234. * @param uniform The uniform to set
  39235. * @param texture The render target texture containing the depth stencil texture to apply
  39236. */
  39237. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  39238. /**
  39239. * Sets a texture to the webGL context from a postprocess
  39240. * @param channel defines the channel to use
  39241. * @param postProcess defines the source postprocess
  39242. */
  39243. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  39244. /**
  39245. * Binds the output of the passed in post process to the texture channel specified
  39246. * @param channel The channel the texture should be bound to
  39247. * @param postProcess The post process which's output should be bound
  39248. */
  39249. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  39250. protected _rebuildBuffers(): void;
  39251. /** @hidden */
  39252. _renderFrame(): void;
  39253. _renderLoop(): void;
  39254. /** @hidden */
  39255. _renderViews(): boolean;
  39256. /**
  39257. * Toggle full screen mode
  39258. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39259. */
  39260. switchFullscreen(requestPointerLock: boolean): void;
  39261. /**
  39262. * Enters full screen mode
  39263. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39264. */
  39265. enterFullscreen(requestPointerLock: boolean): void;
  39266. /**
  39267. * Exits full screen mode
  39268. */
  39269. exitFullscreen(): void;
  39270. /**
  39271. * Enters Pointerlock mode
  39272. */
  39273. enterPointerlock(): void;
  39274. /**
  39275. * Exits Pointerlock mode
  39276. */
  39277. exitPointerlock(): void;
  39278. /**
  39279. * Begin a new frame
  39280. */
  39281. beginFrame(): void;
  39282. /**
  39283. * Enf the current frame
  39284. */
  39285. endFrame(): void;
  39286. resize(): void;
  39287. /**
  39288. * Force a specific size of the canvas
  39289. * @param width defines the new canvas' width
  39290. * @param height defines the new canvas' height
  39291. * @returns true if the size was changed
  39292. */
  39293. setSize(width: number, height: number): boolean;
  39294. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39295. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39296. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39297. _releaseTexture(texture: InternalTexture): void;
  39298. /**
  39299. * @hidden
  39300. * Rescales a texture
  39301. * @param source input texutre
  39302. * @param destination destination texture
  39303. * @param scene scene to use to render the resize
  39304. * @param internalFormat format to use when resizing
  39305. * @param onComplete callback to be called when resize has completed
  39306. */
  39307. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39308. /**
  39309. * Gets the current framerate
  39310. * @returns a number representing the framerate
  39311. */
  39312. getFps(): number;
  39313. /**
  39314. * Gets the time spent between current and previous frame
  39315. * @returns a number representing the delta time in ms
  39316. */
  39317. getDeltaTime(): number;
  39318. private _measureFps;
  39319. /** @hidden */
  39320. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39321. /**
  39322. * Updates the sample count of a render target texture
  39323. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39324. * @param texture defines the texture to update
  39325. * @param samples defines the sample count to set
  39326. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39327. */
  39328. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39329. /**
  39330. * Updates a depth texture Comparison Mode and Function.
  39331. * If the comparison Function is equal to 0, the mode will be set to none.
  39332. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39333. * @param texture The texture to set the comparison function for
  39334. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39335. */
  39336. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39337. /**
  39338. * Creates a webGL buffer to use with instanciation
  39339. * @param capacity defines the size of the buffer
  39340. * @returns the webGL buffer
  39341. */
  39342. createInstancesBuffer(capacity: number): DataBuffer;
  39343. /**
  39344. * Delete a webGL buffer used with instanciation
  39345. * @param buffer defines the webGL buffer to delete
  39346. */
  39347. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39348. private _clientWaitAsync;
  39349. /** @hidden */
  39350. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39351. dispose(): void;
  39352. private _disableTouchAction;
  39353. /**
  39354. * Display the loading screen
  39355. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39356. */
  39357. displayLoadingUI(): void;
  39358. /**
  39359. * Hide the loading screen
  39360. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39361. */
  39362. hideLoadingUI(): void;
  39363. /**
  39364. * Gets the current loading screen object
  39365. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39366. */
  39367. get loadingScreen(): ILoadingScreen;
  39368. /**
  39369. * Sets the current loading screen object
  39370. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39371. */
  39372. set loadingScreen(loadingScreen: ILoadingScreen);
  39373. /**
  39374. * Sets the current loading screen text
  39375. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39376. */
  39377. set loadingUIText(text: string);
  39378. /**
  39379. * Sets the current loading screen background color
  39380. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39381. */
  39382. set loadingUIBackgroundColor(color: string);
  39383. /** Pointerlock and fullscreen */
  39384. /**
  39385. * Ask the browser to promote the current element to pointerlock mode
  39386. * @param element defines the DOM element to promote
  39387. */
  39388. static _RequestPointerlock(element: HTMLElement): void;
  39389. /**
  39390. * Asks the browser to exit pointerlock mode
  39391. */
  39392. static _ExitPointerlock(): void;
  39393. /**
  39394. * Ask the browser to promote the current element to fullscreen rendering mode
  39395. * @param element defines the DOM element to promote
  39396. */
  39397. static _RequestFullscreen(element: HTMLElement): void;
  39398. /**
  39399. * Asks the browser to exit fullscreen mode
  39400. */
  39401. static _ExitFullscreen(): void;
  39402. }
  39403. }
  39404. declare module "babylonjs/Engines/engineStore" {
  39405. import { Nullable } from "babylonjs/types";
  39406. import { Engine } from "babylonjs/Engines/engine";
  39407. import { Scene } from "babylonjs/scene";
  39408. /**
  39409. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39410. * during the life time of the application.
  39411. */
  39412. export class EngineStore {
  39413. /** Gets the list of created engines */
  39414. static Instances: import("babylonjs/Engines/engine").Engine[];
  39415. /** @hidden */
  39416. static _LastCreatedScene: Nullable<Scene>;
  39417. /**
  39418. * Gets the latest created engine
  39419. */
  39420. static get LastCreatedEngine(): Nullable<Engine>;
  39421. /**
  39422. * Gets the latest created scene
  39423. */
  39424. static get LastCreatedScene(): Nullable<Scene>;
  39425. /**
  39426. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39427. * @ignorenaming
  39428. */
  39429. static UseFallbackTexture: boolean;
  39430. /**
  39431. * Texture content used if a texture cannot loaded
  39432. * @ignorenaming
  39433. */
  39434. static FallbackTexture: string;
  39435. }
  39436. }
  39437. declare module "babylonjs/Misc/promise" {
  39438. /**
  39439. * Helper class that provides a small promise polyfill
  39440. */
  39441. export class PromisePolyfill {
  39442. /**
  39443. * Static function used to check if the polyfill is required
  39444. * If this is the case then the function will inject the polyfill to window.Promise
  39445. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39446. */
  39447. static Apply(force?: boolean): void;
  39448. }
  39449. }
  39450. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39451. /**
  39452. * Interface for screenshot methods with describe argument called `size` as object with options
  39453. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39454. */
  39455. export interface IScreenshotSize {
  39456. /**
  39457. * number in pixels for canvas height
  39458. */
  39459. height?: number;
  39460. /**
  39461. * multiplier allowing render at a higher or lower resolution
  39462. * If value is defined then height and width will be ignored and taken from camera
  39463. */
  39464. precision?: number;
  39465. /**
  39466. * number in pixels for canvas width
  39467. */
  39468. width?: number;
  39469. }
  39470. }
  39471. declare module "babylonjs/Misc/tools" {
  39472. import { Nullable, float } from "babylonjs/types";
  39473. import { DomManagement } from "babylonjs/Misc/domManagement";
  39474. import { WebRequest } from "babylonjs/Misc/webRequest";
  39475. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39476. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39477. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39478. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39479. import { Camera } from "babylonjs/Cameras/camera";
  39480. import { Engine } from "babylonjs/Engines/engine";
  39481. interface IColor4Like {
  39482. r: float;
  39483. g: float;
  39484. b: float;
  39485. a: float;
  39486. }
  39487. /**
  39488. * Class containing a set of static utilities functions
  39489. */
  39490. export class Tools {
  39491. /**
  39492. * Gets or sets the base URL to use to load assets
  39493. */
  39494. static get BaseUrl(): string;
  39495. static set BaseUrl(value: string);
  39496. /**
  39497. * Enable/Disable Custom HTTP Request Headers globally.
  39498. * default = false
  39499. * @see CustomRequestHeaders
  39500. */
  39501. static UseCustomRequestHeaders: boolean;
  39502. /**
  39503. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39504. * i.e. when loading files, where the server/service expects an Authorization header
  39505. */
  39506. static CustomRequestHeaders: {
  39507. [key: string]: string;
  39508. };
  39509. /**
  39510. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39511. */
  39512. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39513. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39514. /**
  39515. * Default behaviour for cors in the application.
  39516. * It can be a string if the expected behavior is identical in the entire app.
  39517. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39518. */
  39519. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39520. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39521. /**
  39522. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39523. * @ignorenaming
  39524. */
  39525. static get UseFallbackTexture(): boolean;
  39526. static set UseFallbackTexture(value: boolean);
  39527. /**
  39528. * Use this object to register external classes like custom textures or material
  39529. * to allow the laoders to instantiate them
  39530. */
  39531. static get RegisteredExternalClasses(): {
  39532. [key: string]: Object;
  39533. };
  39534. static set RegisteredExternalClasses(classes: {
  39535. [key: string]: Object;
  39536. });
  39537. /**
  39538. * Texture content used if a texture cannot loaded
  39539. * @ignorenaming
  39540. */
  39541. static get fallbackTexture(): string;
  39542. static set fallbackTexture(value: string);
  39543. /**
  39544. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39545. * @param u defines the coordinate on X axis
  39546. * @param v defines the coordinate on Y axis
  39547. * @param width defines the width of the source data
  39548. * @param height defines the height of the source data
  39549. * @param pixels defines the source byte array
  39550. * @param color defines the output color
  39551. */
  39552. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39553. /**
  39554. * Interpolates between a and b via alpha
  39555. * @param a The lower value (returned when alpha = 0)
  39556. * @param b The upper value (returned when alpha = 1)
  39557. * @param alpha The interpolation-factor
  39558. * @return The mixed value
  39559. */
  39560. static Mix(a: number, b: number, alpha: number): number;
  39561. /**
  39562. * Tries to instantiate a new object from a given class name
  39563. * @param className defines the class name to instantiate
  39564. * @returns the new object or null if the system was not able to do the instantiation
  39565. */
  39566. static Instantiate(className: string): any;
  39567. /**
  39568. * Provides a slice function that will work even on IE
  39569. * @param data defines the array to slice
  39570. * @param start defines the start of the data (optional)
  39571. * @param end defines the end of the data (optional)
  39572. * @returns the new sliced array
  39573. */
  39574. static Slice<T>(data: T, start?: number, end?: number): T;
  39575. /**
  39576. * Polyfill for setImmediate
  39577. * @param action defines the action to execute after the current execution block
  39578. */
  39579. static SetImmediate(action: () => void): void;
  39580. /**
  39581. * Function indicating if a number is an exponent of 2
  39582. * @param value defines the value to test
  39583. * @returns true if the value is an exponent of 2
  39584. */
  39585. static IsExponentOfTwo(value: number): boolean;
  39586. private static _tmpFloatArray;
  39587. /**
  39588. * Returns the nearest 32-bit single precision float representation of a Number
  39589. * @param value A Number. If the parameter is of a different type, it will get converted
  39590. * to a number or to NaN if it cannot be converted
  39591. * @returns number
  39592. */
  39593. static FloatRound(value: number): number;
  39594. /**
  39595. * Extracts the filename from a path
  39596. * @param path defines the path to use
  39597. * @returns the filename
  39598. */
  39599. static GetFilename(path: string): string;
  39600. /**
  39601. * Extracts the "folder" part of a path (everything before the filename).
  39602. * @param uri The URI to extract the info from
  39603. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39604. * @returns The "folder" part of the path
  39605. */
  39606. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39607. /**
  39608. * Extracts text content from a DOM element hierarchy
  39609. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39610. */
  39611. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39612. /**
  39613. * Convert an angle in radians to degrees
  39614. * @param angle defines the angle to convert
  39615. * @returns the angle in degrees
  39616. */
  39617. static ToDegrees(angle: number): number;
  39618. /**
  39619. * Convert an angle in degrees to radians
  39620. * @param angle defines the angle to convert
  39621. * @returns the angle in radians
  39622. */
  39623. static ToRadians(angle: number): number;
  39624. /**
  39625. * Returns an array if obj is not an array
  39626. * @param obj defines the object to evaluate as an array
  39627. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39628. * @returns either obj directly if obj is an array or a new array containing obj
  39629. */
  39630. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39631. /**
  39632. * Gets the pointer prefix to use
  39633. * @param engine defines the engine we are finding the prefix for
  39634. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39635. */
  39636. static GetPointerPrefix(engine: Engine): string;
  39637. /**
  39638. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39639. * @param url define the url we are trying
  39640. * @param element define the dom element where to configure the cors policy
  39641. */
  39642. static SetCorsBehavior(url: string | string[], element: {
  39643. crossOrigin: string | null;
  39644. }): void;
  39645. /**
  39646. * Removes unwanted characters from an url
  39647. * @param url defines the url to clean
  39648. * @returns the cleaned url
  39649. */
  39650. static CleanUrl(url: string): string;
  39651. /**
  39652. * Gets or sets a function used to pre-process url before using them to load assets
  39653. */
  39654. static get PreprocessUrl(): (url: string) => string;
  39655. static set PreprocessUrl(processor: (url: string) => string);
  39656. /**
  39657. * Loads an image as an HTMLImageElement.
  39658. * @param input url string, ArrayBuffer, or Blob to load
  39659. * @param onLoad callback called when the image successfully loads
  39660. * @param onError callback called when the image fails to load
  39661. * @param offlineProvider offline provider for caching
  39662. * @param mimeType optional mime type
  39663. * @returns the HTMLImageElement of the loaded image
  39664. */
  39665. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39666. /**
  39667. * Loads a file from a url
  39668. * @param url url string, ArrayBuffer, or Blob to load
  39669. * @param onSuccess callback called when the file successfully loads
  39670. * @param onProgress callback called while file is loading (if the server supports this mode)
  39671. * @param offlineProvider defines the offline provider for caching
  39672. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39673. * @param onError callback called when the file fails to load
  39674. * @returns a file request object
  39675. */
  39676. 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;
  39677. /**
  39678. * Loads a file from a url
  39679. * @param url the file url to load
  39680. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39681. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39682. */
  39683. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39684. /**
  39685. * Load a script (identified by an url). When the url returns, the
  39686. * content of this file is added into a new script element, attached to the DOM (body element)
  39687. * @param scriptUrl defines the url of the script to laod
  39688. * @param onSuccess defines the callback called when the script is loaded
  39689. * @param onError defines the callback to call if an error occurs
  39690. * @param scriptId defines the id of the script element
  39691. */
  39692. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39693. /**
  39694. * Load an asynchronous script (identified by an url). When the url returns, the
  39695. * content of this file is added into a new script element, attached to the DOM (body element)
  39696. * @param scriptUrl defines the url of the script to laod
  39697. * @param scriptId defines the id of the script element
  39698. * @returns a promise request object
  39699. */
  39700. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39701. /**
  39702. * Loads a file from a blob
  39703. * @param fileToLoad defines the blob to use
  39704. * @param callback defines the callback to call when data is loaded
  39705. * @param progressCallback defines the callback to call during loading process
  39706. * @returns a file request object
  39707. */
  39708. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39709. /**
  39710. * Reads a file from a File object
  39711. * @param file defines the file to load
  39712. * @param onSuccess defines the callback to call when data is loaded
  39713. * @param onProgress defines the callback to call during loading process
  39714. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39715. * @param onError defines the callback to call when an error occurs
  39716. * @returns a file request object
  39717. */
  39718. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39719. /**
  39720. * Creates a data url from a given string content
  39721. * @param content defines the content to convert
  39722. * @returns the new data url link
  39723. */
  39724. static FileAsURL(content: string): string;
  39725. /**
  39726. * Format the given number to a specific decimal format
  39727. * @param value defines the number to format
  39728. * @param decimals defines the number of decimals to use
  39729. * @returns the formatted string
  39730. */
  39731. static Format(value: number, decimals?: number): string;
  39732. /**
  39733. * Tries to copy an object by duplicating every property
  39734. * @param source defines the source object
  39735. * @param destination defines the target object
  39736. * @param doNotCopyList defines a list of properties to avoid
  39737. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39738. */
  39739. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39740. /**
  39741. * Gets a boolean indicating if the given object has no own property
  39742. * @param obj defines the object to test
  39743. * @returns true if object has no own property
  39744. */
  39745. static IsEmpty(obj: any): boolean;
  39746. /**
  39747. * Function used to register events at window level
  39748. * @param windowElement defines the Window object to use
  39749. * @param events defines the events to register
  39750. */
  39751. static RegisterTopRootEvents(windowElement: Window, events: {
  39752. name: string;
  39753. handler: Nullable<(e: FocusEvent) => any>;
  39754. }[]): void;
  39755. /**
  39756. * Function used to unregister events from window level
  39757. * @param windowElement defines the Window object to use
  39758. * @param events defines the events to unregister
  39759. */
  39760. static UnregisterTopRootEvents(windowElement: Window, events: {
  39761. name: string;
  39762. handler: Nullable<(e: FocusEvent) => any>;
  39763. }[]): void;
  39764. /**
  39765. * @ignore
  39766. */
  39767. static _ScreenshotCanvas: HTMLCanvasElement;
  39768. /**
  39769. * Dumps the current bound framebuffer
  39770. * @param width defines the rendering width
  39771. * @param height defines the rendering height
  39772. * @param engine defines the hosting engine
  39773. * @param successCallback defines the callback triggered once the data are available
  39774. * @param mimeType defines the mime type of the result
  39775. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39776. */
  39777. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39778. /**
  39779. * Converts the canvas data to blob.
  39780. * This acts as a polyfill for browsers not supporting the to blob function.
  39781. * @param canvas Defines the canvas to extract the data from
  39782. * @param successCallback Defines the callback triggered once the data are available
  39783. * @param mimeType Defines the mime type of the result
  39784. */
  39785. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39786. /**
  39787. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39788. * @param successCallback defines the callback triggered once the data are available
  39789. * @param mimeType defines the mime type of the result
  39790. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39791. */
  39792. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39793. /**
  39794. * Downloads a blob in the browser
  39795. * @param blob defines the blob to download
  39796. * @param fileName defines the name of the downloaded file
  39797. */
  39798. static Download(blob: Blob, fileName: string): void;
  39799. /**
  39800. * Captures a screenshot of the current rendering
  39801. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39802. * @param engine defines the rendering engine
  39803. * @param camera defines the source camera
  39804. * @param size This parameter can be set to a single number or to an object with the
  39805. * following (optional) properties: precision, width, height. If a single number is passed,
  39806. * it will be used for both width and height. If an object is passed, the screenshot size
  39807. * will be derived from the parameters. The precision property is a multiplier allowing
  39808. * rendering at a higher or lower resolution
  39809. * @param successCallback defines the callback receives a single parameter which contains the
  39810. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39811. * src parameter of an <img> to display it
  39812. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39813. * Check your browser for supported MIME types
  39814. */
  39815. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39816. /**
  39817. * Captures a screenshot of the current rendering
  39818. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39819. * @param engine defines the rendering engine
  39820. * @param camera defines the source camera
  39821. * @param size This parameter can be set to a single number or to an object with the
  39822. * following (optional) properties: precision, width, height. If a single number is passed,
  39823. * it will be used for both width and height. If an object is passed, the screenshot size
  39824. * will be derived from the parameters. The precision property is a multiplier allowing
  39825. * rendering at a higher or lower resolution
  39826. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39827. * Check your browser for supported MIME types
  39828. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39829. * to the src parameter of an <img> to display it
  39830. */
  39831. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39832. /**
  39833. * Generates an image screenshot from the specified camera.
  39834. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39835. * @param engine The engine to use for rendering
  39836. * @param camera The camera to use for rendering
  39837. * @param size This parameter can be set to a single number or to an object with the
  39838. * following (optional) properties: precision, width, height. If a single number is passed,
  39839. * it will be used for both width and height. If an object is passed, the screenshot size
  39840. * will be derived from the parameters. The precision property is a multiplier allowing
  39841. * rendering at a higher or lower resolution
  39842. * @param successCallback The callback receives a single parameter which contains the
  39843. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39844. * src parameter of an <img> to display it
  39845. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39846. * Check your browser for supported MIME types
  39847. * @param samples Texture samples (default: 1)
  39848. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39849. * @param fileName A name for for the downloaded file.
  39850. */
  39851. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39852. /**
  39853. * Generates an image screenshot from the specified camera.
  39854. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39855. * @param engine The engine to use for rendering
  39856. * @param camera The camera to use for rendering
  39857. * @param size This parameter can be set to a single number or to an object with the
  39858. * following (optional) properties: precision, width, height. If a single number is passed,
  39859. * it will be used for both width and height. If an object is passed, the screenshot size
  39860. * will be derived from the parameters. The precision property is a multiplier allowing
  39861. * rendering at a higher or lower resolution
  39862. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39863. * Check your browser for supported MIME types
  39864. * @param samples Texture samples (default: 1)
  39865. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39866. * @param fileName A name for for the downloaded file.
  39867. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39868. * to the src parameter of an <img> to display it
  39869. */
  39870. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39871. /**
  39872. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39873. * Be aware Math.random() could cause collisions, but:
  39874. * "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"
  39875. * @returns a pseudo random id
  39876. */
  39877. static RandomId(): string;
  39878. /**
  39879. * Test if the given uri is a base64 string
  39880. * @param uri The uri to test
  39881. * @return True if the uri is a base64 string or false otherwise
  39882. */
  39883. static IsBase64(uri: string): boolean;
  39884. /**
  39885. * Decode the given base64 uri.
  39886. * @param uri The uri to decode
  39887. * @return The decoded base64 data.
  39888. */
  39889. static DecodeBase64(uri: string): ArrayBuffer;
  39890. /**
  39891. * Gets the absolute url.
  39892. * @param url the input url
  39893. * @return the absolute url
  39894. */
  39895. static GetAbsoluteUrl(url: string): string;
  39896. /**
  39897. * No log
  39898. */
  39899. static readonly NoneLogLevel: number;
  39900. /**
  39901. * Only message logs
  39902. */
  39903. static readonly MessageLogLevel: number;
  39904. /**
  39905. * Only warning logs
  39906. */
  39907. static readonly WarningLogLevel: number;
  39908. /**
  39909. * Only error logs
  39910. */
  39911. static readonly ErrorLogLevel: number;
  39912. /**
  39913. * All logs
  39914. */
  39915. static readonly AllLogLevel: number;
  39916. /**
  39917. * Gets a value indicating the number of loading errors
  39918. * @ignorenaming
  39919. */
  39920. static get errorsCount(): number;
  39921. /**
  39922. * Callback called when a new log is added
  39923. */
  39924. static OnNewCacheEntry: (entry: string) => void;
  39925. /**
  39926. * Log a message to the console
  39927. * @param message defines the message to log
  39928. */
  39929. static Log(message: string): void;
  39930. /**
  39931. * Write a warning message to the console
  39932. * @param message defines the message to log
  39933. */
  39934. static Warn(message: string): void;
  39935. /**
  39936. * Write an error message to the console
  39937. * @param message defines the message to log
  39938. */
  39939. static Error(message: string): void;
  39940. /**
  39941. * Gets current log cache (list of logs)
  39942. */
  39943. static get LogCache(): string;
  39944. /**
  39945. * Clears the log cache
  39946. */
  39947. static ClearLogCache(): void;
  39948. /**
  39949. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  39950. */
  39951. static set LogLevels(level: number);
  39952. /**
  39953. * Checks if the window object exists
  39954. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  39955. */
  39956. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  39957. /**
  39958. * No performance log
  39959. */
  39960. static readonly PerformanceNoneLogLevel: number;
  39961. /**
  39962. * Use user marks to log performance
  39963. */
  39964. static readonly PerformanceUserMarkLogLevel: number;
  39965. /**
  39966. * Log performance to the console
  39967. */
  39968. static readonly PerformanceConsoleLogLevel: number;
  39969. private static _performance;
  39970. /**
  39971. * Sets the current performance log level
  39972. */
  39973. static set PerformanceLogLevel(level: number);
  39974. private static _StartPerformanceCounterDisabled;
  39975. private static _EndPerformanceCounterDisabled;
  39976. private static _StartUserMark;
  39977. private static _EndUserMark;
  39978. private static _StartPerformanceConsole;
  39979. private static _EndPerformanceConsole;
  39980. /**
  39981. * Starts a performance counter
  39982. */
  39983. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39984. /**
  39985. * Ends a specific performance coutner
  39986. */
  39987. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39988. /**
  39989. * Gets either window.performance.now() if supported or Date.now() else
  39990. */
  39991. static get Now(): number;
  39992. /**
  39993. * This method will return the name of the class used to create the instance of the given object.
  39994. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  39995. * @param object the object to get the class name from
  39996. * @param isType defines if the object is actually a type
  39997. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  39998. */
  39999. static GetClassName(object: any, isType?: boolean): string;
  40000. /**
  40001. * Gets the first element of an array satisfying a given predicate
  40002. * @param array defines the array to browse
  40003. * @param predicate defines the predicate to use
  40004. * @returns null if not found or the element
  40005. */
  40006. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  40007. /**
  40008. * This method will return the name of the full name of the class, including its owning module (if any).
  40009. * 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).
  40010. * @param object the object to get the class name from
  40011. * @param isType defines if the object is actually a type
  40012. * @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.
  40013. * @ignorenaming
  40014. */
  40015. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  40016. /**
  40017. * Returns a promise that resolves after the given amount of time.
  40018. * @param delay Number of milliseconds to delay
  40019. * @returns Promise that resolves after the given amount of time
  40020. */
  40021. static DelayAsync(delay: number): Promise<void>;
  40022. /**
  40023. * Utility function to detect if the current user agent is Safari
  40024. * @returns whether or not the current user agent is safari
  40025. */
  40026. static IsSafari(): boolean;
  40027. }
  40028. /**
  40029. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  40030. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  40031. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  40032. * @param name The name of the class, case should be preserved
  40033. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  40034. */
  40035. export function className(name: string, module?: string): (target: Object) => void;
  40036. /**
  40037. * An implementation of a loop for asynchronous functions.
  40038. */
  40039. export class AsyncLoop {
  40040. /**
  40041. * Defines the number of iterations for the loop
  40042. */
  40043. iterations: number;
  40044. /**
  40045. * Defines the current index of the loop.
  40046. */
  40047. index: number;
  40048. private _done;
  40049. private _fn;
  40050. private _successCallback;
  40051. /**
  40052. * Constructor.
  40053. * @param iterations the number of iterations.
  40054. * @param func the function to run each iteration
  40055. * @param successCallback the callback that will be called upon succesful execution
  40056. * @param offset starting offset.
  40057. */
  40058. constructor(
  40059. /**
  40060. * Defines the number of iterations for the loop
  40061. */
  40062. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  40063. /**
  40064. * Execute the next iteration. Must be called after the last iteration was finished.
  40065. */
  40066. executeNext(): void;
  40067. /**
  40068. * Break the loop and run the success callback.
  40069. */
  40070. breakLoop(): void;
  40071. /**
  40072. * Create and run an async loop.
  40073. * @param iterations the number of iterations.
  40074. * @param fn the function to run each iteration
  40075. * @param successCallback the callback that will be called upon succesful execution
  40076. * @param offset starting offset.
  40077. * @returns the created async loop object
  40078. */
  40079. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  40080. /**
  40081. * A for-loop that will run a given number of iterations synchronous and the rest async.
  40082. * @param iterations total number of iterations
  40083. * @param syncedIterations number of synchronous iterations in each async iteration.
  40084. * @param fn the function to call each iteration.
  40085. * @param callback a success call back that will be called when iterating stops.
  40086. * @param breakFunction a break condition (optional)
  40087. * @param timeout timeout settings for the setTimeout function. default - 0.
  40088. * @returns the created async loop object
  40089. */
  40090. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  40091. }
  40092. }
  40093. declare module "babylonjs/Misc/stringDictionary" {
  40094. import { Nullable } from "babylonjs/types";
  40095. /**
  40096. * This class implement a typical dictionary using a string as key and the generic type T as value.
  40097. * The underlying implementation relies on an associative array to ensure the best performances.
  40098. * The value can be anything including 'null' but except 'undefined'
  40099. */
  40100. export class StringDictionary<T> {
  40101. /**
  40102. * This will clear this dictionary and copy the content from the 'source' one.
  40103. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  40104. * @param source the dictionary to take the content from and copy to this dictionary
  40105. */
  40106. copyFrom(source: StringDictionary<T>): void;
  40107. /**
  40108. * Get a value based from its key
  40109. * @param key the given key to get the matching value from
  40110. * @return the value if found, otherwise undefined is returned
  40111. */
  40112. get(key: string): T | undefined;
  40113. /**
  40114. * Get a value from its key or add it if it doesn't exist.
  40115. * This method will ensure you that a given key/data will be present in the dictionary.
  40116. * @param key the given key to get the matching value from
  40117. * @param factory the factory that will create the value if the key is not present in the dictionary.
  40118. * The factory will only be invoked if there's no data for the given key.
  40119. * @return the value corresponding to the key.
  40120. */
  40121. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  40122. /**
  40123. * Get a value from its key if present in the dictionary otherwise add it
  40124. * @param key the key to get the value from
  40125. * @param val if there's no such key/value pair in the dictionary add it with this value
  40126. * @return the value corresponding to the key
  40127. */
  40128. getOrAdd(key: string, val: T): T;
  40129. /**
  40130. * Check if there's a given key in the dictionary
  40131. * @param key the key to check for
  40132. * @return true if the key is present, false otherwise
  40133. */
  40134. contains(key: string): boolean;
  40135. /**
  40136. * Add a new key and its corresponding value
  40137. * @param key the key to add
  40138. * @param value the value corresponding to the key
  40139. * @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
  40140. */
  40141. add(key: string, value: T): boolean;
  40142. /**
  40143. * Update a specific value associated to a key
  40144. * @param key defines the key to use
  40145. * @param value defines the value to store
  40146. * @returns true if the value was updated (or false if the key was not found)
  40147. */
  40148. set(key: string, value: T): boolean;
  40149. /**
  40150. * Get the element of the given key and remove it from the dictionary
  40151. * @param key defines the key to search
  40152. * @returns the value associated with the key or null if not found
  40153. */
  40154. getAndRemove(key: string): Nullable<T>;
  40155. /**
  40156. * Remove a key/value from the dictionary.
  40157. * @param key the key to remove
  40158. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  40159. */
  40160. remove(key: string): boolean;
  40161. /**
  40162. * Clear the whole content of the dictionary
  40163. */
  40164. clear(): void;
  40165. /**
  40166. * Gets the current count
  40167. */
  40168. get count(): number;
  40169. /**
  40170. * Execute a callback on each key/val of the dictionary.
  40171. * Note that you can remove any element in this dictionary in the callback implementation
  40172. * @param callback the callback to execute on a given key/value pair
  40173. */
  40174. forEach(callback: (key: string, val: T) => void): void;
  40175. /**
  40176. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  40177. * If the callback returns null or undefined the method will iterate to the next key/value pair
  40178. * Note that you can remove any element in this dictionary in the callback implementation
  40179. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  40180. * @returns the first item
  40181. */
  40182. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  40183. private _count;
  40184. private _data;
  40185. }
  40186. }
  40187. declare module "babylonjs/Collisions/collisionCoordinator" {
  40188. import { Nullable } from "babylonjs/types";
  40189. import { Scene } from "babylonjs/scene";
  40190. import { Vector3 } from "babylonjs/Maths/math.vector";
  40191. import { Collider } from "babylonjs/Collisions/collider";
  40192. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40193. /** @hidden */
  40194. export interface ICollisionCoordinator {
  40195. createCollider(): Collider;
  40196. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40197. init(scene: Scene): void;
  40198. }
  40199. /** @hidden */
  40200. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  40201. private _scene;
  40202. private _scaledPosition;
  40203. private _scaledVelocity;
  40204. private _finalPosition;
  40205. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40206. createCollider(): Collider;
  40207. init(scene: Scene): void;
  40208. private _collideWithWorld;
  40209. }
  40210. }
  40211. declare module "babylonjs/Inputs/scene.inputManager" {
  40212. import { Nullable } from "babylonjs/types";
  40213. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40214. import { Vector2 } from "babylonjs/Maths/math.vector";
  40215. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40216. import { Scene } from "babylonjs/scene";
  40217. /**
  40218. * Class used to manage all inputs for the scene.
  40219. */
  40220. export class InputManager {
  40221. /** The distance in pixel that you have to move to prevent some events */
  40222. static DragMovementThreshold: number;
  40223. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  40224. static LongPressDelay: number;
  40225. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  40226. static DoubleClickDelay: number;
  40227. /** If you need to check double click without raising a single click at first click, enable this flag */
  40228. static ExclusiveDoubleClickMode: boolean;
  40229. /** 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. */
  40230. private _alreadyAttached;
  40231. private _wheelEventName;
  40232. private _onPointerMove;
  40233. private _onPointerDown;
  40234. private _onPointerUp;
  40235. private _initClickEvent;
  40236. private _initActionManager;
  40237. private _delayedSimpleClick;
  40238. private _delayedSimpleClickTimeout;
  40239. private _previousDelayedSimpleClickTimeout;
  40240. private _meshPickProceed;
  40241. private _previousButtonPressed;
  40242. private _currentPickResult;
  40243. private _previousPickResult;
  40244. private _totalPointersPressed;
  40245. private _doubleClickOccured;
  40246. private _pointerOverMesh;
  40247. private _pickedDownMesh;
  40248. private _pickedUpMesh;
  40249. private _pointerX;
  40250. private _pointerY;
  40251. private _unTranslatedPointerX;
  40252. private _unTranslatedPointerY;
  40253. private _startingPointerPosition;
  40254. private _previousStartingPointerPosition;
  40255. private _startingPointerTime;
  40256. private _previousStartingPointerTime;
  40257. private _pointerCaptures;
  40258. private _meshUnderPointerId;
  40259. private _onKeyDown;
  40260. private _onKeyUp;
  40261. private _onCanvasFocusObserver;
  40262. private _onCanvasBlurObserver;
  40263. private _scene;
  40264. /**
  40265. * Creates a new InputManager
  40266. * @param scene defines the hosting scene
  40267. */
  40268. constructor(scene: Scene);
  40269. /**
  40270. * Gets the mesh that is currently under the pointer
  40271. */
  40272. get meshUnderPointer(): Nullable<AbstractMesh>;
  40273. /**
  40274. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  40275. * @param pointerId the pointer id to use
  40276. * @returns The mesh under this pointer id or null if not found
  40277. */
  40278. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  40279. /**
  40280. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40281. */
  40282. get unTranslatedPointer(): Vector2;
  40283. /**
  40284. * Gets or sets the current on-screen X position of the pointer
  40285. */
  40286. get pointerX(): number;
  40287. set pointerX(value: number);
  40288. /**
  40289. * Gets or sets the current on-screen Y position of the pointer
  40290. */
  40291. get pointerY(): number;
  40292. set pointerY(value: number);
  40293. private _updatePointerPosition;
  40294. private _processPointerMove;
  40295. private _setRayOnPointerInfo;
  40296. private _checkPrePointerObservable;
  40297. /**
  40298. * Use this method to simulate a pointer move 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. */
  40303. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40304. /**
  40305. * Use this method to simulate a pointer down on a mesh
  40306. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40307. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40308. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40309. */
  40310. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40311. private _processPointerDown;
  40312. /** @hidden */
  40313. _isPointerSwiping(): boolean;
  40314. /**
  40315. * Use this method to simulate a pointer up on a mesh
  40316. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40317. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40318. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40319. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40320. */
  40321. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40322. private _processPointerUp;
  40323. /**
  40324. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40325. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40326. * @returns true if the pointer was captured
  40327. */
  40328. isPointerCaptured(pointerId?: number): boolean;
  40329. /**
  40330. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40331. * @param attachUp defines if you want to attach events to pointerup
  40332. * @param attachDown defines if you want to attach events to pointerdown
  40333. * @param attachMove defines if you want to attach events to pointermove
  40334. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40335. */
  40336. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40337. /**
  40338. * Detaches all event handlers
  40339. */
  40340. detachControl(): void;
  40341. /**
  40342. * Force the value of meshUnderPointer
  40343. * @param mesh defines the mesh to use
  40344. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  40345. */
  40346. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  40347. /**
  40348. * Gets the mesh under the pointer
  40349. * @returns a Mesh or null if no mesh is under the pointer
  40350. */
  40351. getPointerOverMesh(): Nullable<AbstractMesh>;
  40352. }
  40353. }
  40354. declare module "babylonjs/Animations/animationGroup" {
  40355. import { Animatable } from "babylonjs/Animations/animatable";
  40356. import { Animation } from "babylonjs/Animations/animation";
  40357. import { Scene, IDisposable } from "babylonjs/scene";
  40358. import { Observable } from "babylonjs/Misc/observable";
  40359. import { Nullable } from "babylonjs/types";
  40360. import "babylonjs/Animations/animatable";
  40361. /**
  40362. * This class defines the direct association between an animation and a target
  40363. */
  40364. export class TargetedAnimation {
  40365. /**
  40366. * Animation to perform
  40367. */
  40368. animation: Animation;
  40369. /**
  40370. * Target to animate
  40371. */
  40372. target: any;
  40373. /**
  40374. * Returns the string "TargetedAnimation"
  40375. * @returns "TargetedAnimation"
  40376. */
  40377. getClassName(): string;
  40378. /**
  40379. * Serialize the object
  40380. * @returns the JSON object representing the current entity
  40381. */
  40382. serialize(): any;
  40383. }
  40384. /**
  40385. * Use this class to create coordinated animations on multiple targets
  40386. */
  40387. export class AnimationGroup implements IDisposable {
  40388. /** The name of the animation group */
  40389. name: string;
  40390. private _scene;
  40391. private _targetedAnimations;
  40392. private _animatables;
  40393. private _from;
  40394. private _to;
  40395. private _isStarted;
  40396. private _isPaused;
  40397. private _speedRatio;
  40398. private _loopAnimation;
  40399. private _isAdditive;
  40400. /**
  40401. * Gets or sets the unique id of the node
  40402. */
  40403. uniqueId: number;
  40404. /**
  40405. * This observable will notify when one animation have ended
  40406. */
  40407. onAnimationEndObservable: Observable<TargetedAnimation>;
  40408. /**
  40409. * Observer raised when one animation loops
  40410. */
  40411. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40412. /**
  40413. * Observer raised when all animations have looped
  40414. */
  40415. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40416. /**
  40417. * This observable will notify when all animations have ended.
  40418. */
  40419. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40420. /**
  40421. * This observable will notify when all animations have paused.
  40422. */
  40423. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40424. /**
  40425. * This observable will notify when all animations are playing.
  40426. */
  40427. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40428. /**
  40429. * Gets the first frame
  40430. */
  40431. get from(): number;
  40432. /**
  40433. * Gets the last frame
  40434. */
  40435. get to(): number;
  40436. /**
  40437. * Define if the animations are started
  40438. */
  40439. get isStarted(): boolean;
  40440. /**
  40441. * Gets a value indicating that the current group is playing
  40442. */
  40443. get isPlaying(): boolean;
  40444. /**
  40445. * Gets or sets the speed ratio to use for all animations
  40446. */
  40447. get speedRatio(): number;
  40448. /**
  40449. * Gets or sets the speed ratio to use for all animations
  40450. */
  40451. set speedRatio(value: number);
  40452. /**
  40453. * Gets or sets if all animations should loop or not
  40454. */
  40455. get loopAnimation(): boolean;
  40456. set loopAnimation(value: boolean);
  40457. /**
  40458. * Gets or sets if all animations should be evaluated additively
  40459. */
  40460. get isAdditive(): boolean;
  40461. set isAdditive(value: boolean);
  40462. /**
  40463. * Gets the targeted animations for this animation group
  40464. */
  40465. get targetedAnimations(): Array<TargetedAnimation>;
  40466. /**
  40467. * returning the list of animatables controlled by this animation group.
  40468. */
  40469. get animatables(): Array<Animatable>;
  40470. /**
  40471. * Gets the list of target animations
  40472. */
  40473. get children(): TargetedAnimation[];
  40474. /**
  40475. * Instantiates a new Animation Group.
  40476. * This helps managing several animations at once.
  40477. * @see https://doc.babylonjs.com/how_to/group
  40478. * @param name Defines the name of the group
  40479. * @param scene Defines the scene the group belongs to
  40480. */
  40481. constructor(
  40482. /** The name of the animation group */
  40483. name: string, scene?: Nullable<Scene>);
  40484. /**
  40485. * Add an animation (with its target) in the group
  40486. * @param animation defines the animation we want to add
  40487. * @param target defines the target of the animation
  40488. * @returns the TargetedAnimation object
  40489. */
  40490. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40491. /**
  40492. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40493. * It can add constant keys at begin or end
  40494. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40495. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40496. * @returns the animation group
  40497. */
  40498. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40499. private _animationLoopCount;
  40500. private _animationLoopFlags;
  40501. private _processLoop;
  40502. /**
  40503. * Start all animations on given targets
  40504. * @param loop defines if animations must loop
  40505. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40506. * @param from defines the from key (optional)
  40507. * @param to defines the to key (optional)
  40508. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40509. * @returns the current animation group
  40510. */
  40511. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40512. /**
  40513. * Pause all animations
  40514. * @returns the animation group
  40515. */
  40516. pause(): AnimationGroup;
  40517. /**
  40518. * Play all animations to initial state
  40519. * This function will start() the animations if they were not started or will restart() them if they were paused
  40520. * @param loop defines if animations must loop
  40521. * @returns the animation group
  40522. */
  40523. play(loop?: boolean): AnimationGroup;
  40524. /**
  40525. * Reset all animations to initial state
  40526. * @returns the animation group
  40527. */
  40528. reset(): AnimationGroup;
  40529. /**
  40530. * Restart animations from key 0
  40531. * @returns the animation group
  40532. */
  40533. restart(): AnimationGroup;
  40534. /**
  40535. * Stop all animations
  40536. * @returns the animation group
  40537. */
  40538. stop(): AnimationGroup;
  40539. /**
  40540. * Set animation weight for all animatables
  40541. * @param weight defines the weight to use
  40542. * @return the animationGroup
  40543. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40544. */
  40545. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40546. /**
  40547. * Synchronize and normalize all animatables with a source animatable
  40548. * @param root defines the root animatable to synchronize with
  40549. * @return the animationGroup
  40550. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40551. */
  40552. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40553. /**
  40554. * Goes to a specific frame in this animation group
  40555. * @param frame the frame number to go to
  40556. * @return the animationGroup
  40557. */
  40558. goToFrame(frame: number): AnimationGroup;
  40559. /**
  40560. * Dispose all associated resources
  40561. */
  40562. dispose(): void;
  40563. private _checkAnimationGroupEnded;
  40564. /**
  40565. * Clone the current animation group and returns a copy
  40566. * @param newName defines the name of the new group
  40567. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40568. * @returns the new aniamtion group
  40569. */
  40570. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40571. /**
  40572. * Serializes the animationGroup to an object
  40573. * @returns Serialized object
  40574. */
  40575. serialize(): any;
  40576. /**
  40577. * Returns a new AnimationGroup object parsed from the source provided.
  40578. * @param parsedAnimationGroup defines the source
  40579. * @param scene defines the scene that will receive the animationGroup
  40580. * @returns a new AnimationGroup
  40581. */
  40582. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40583. /**
  40584. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40585. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40586. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40587. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40588. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40589. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40590. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40591. */
  40592. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40593. /**
  40594. * Returns the string "AnimationGroup"
  40595. * @returns "AnimationGroup"
  40596. */
  40597. getClassName(): string;
  40598. /**
  40599. * Creates a detailled string about the object
  40600. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40601. * @returns a string representing the object
  40602. */
  40603. toString(fullDetails?: boolean): string;
  40604. }
  40605. }
  40606. declare module "babylonjs/scene" {
  40607. import { Nullable } from "babylonjs/types";
  40608. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40609. import { Observable } from "babylonjs/Misc/observable";
  40610. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40611. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40612. import { Geometry } from "babylonjs/Meshes/geometry";
  40613. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40614. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40615. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40616. import { Mesh } from "babylonjs/Meshes/mesh";
  40617. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40618. import { Bone } from "babylonjs/Bones/bone";
  40619. import { Skeleton } from "babylonjs/Bones/skeleton";
  40620. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40621. import { Camera } from "babylonjs/Cameras/camera";
  40622. import { AbstractScene } from "babylonjs/abstractScene";
  40623. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40624. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40625. import { Material } from "babylonjs/Materials/material";
  40626. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40627. import { Effect } from "babylonjs/Materials/effect";
  40628. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40629. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40630. import { Light } from "babylonjs/Lights/light";
  40631. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40632. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40633. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40634. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40635. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40636. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40637. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40638. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40639. import { Engine } from "babylonjs/Engines/engine";
  40640. import { Node } from "babylonjs/node";
  40641. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40642. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40643. import { WebRequest } from "babylonjs/Misc/webRequest";
  40644. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40645. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40646. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40647. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40648. import { Plane } from "babylonjs/Maths/math.plane";
  40649. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40650. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  40651. import { Ray } from "babylonjs/Culling/ray";
  40652. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40653. import { Animation } from "babylonjs/Animations/animation";
  40654. import { Animatable } from "babylonjs/Animations/animatable";
  40655. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40656. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40657. import { Collider } from "babylonjs/Collisions/collider";
  40658. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40659. /**
  40660. * Define an interface for all classes that will hold resources
  40661. */
  40662. export interface IDisposable {
  40663. /**
  40664. * Releases all held resources
  40665. */
  40666. dispose(): void;
  40667. }
  40668. /** Interface defining initialization parameters for Scene class */
  40669. export interface SceneOptions {
  40670. /**
  40671. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40672. * It will improve performance when the number of geometries becomes important.
  40673. */
  40674. useGeometryUniqueIdsMap?: boolean;
  40675. /**
  40676. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40677. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40678. */
  40679. useMaterialMeshMap?: boolean;
  40680. /**
  40681. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40682. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40683. */
  40684. useClonedMeshMap?: boolean;
  40685. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40686. virtual?: boolean;
  40687. }
  40688. /**
  40689. * Represents a scene to be rendered by the engine.
  40690. * @see https://doc.babylonjs.com/features/scene
  40691. */
  40692. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  40693. /** The fog is deactivated */
  40694. static readonly FOGMODE_NONE: number;
  40695. /** The fog density is following an exponential function */
  40696. static readonly FOGMODE_EXP: number;
  40697. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40698. static readonly FOGMODE_EXP2: number;
  40699. /** The fog density is following a linear function. */
  40700. static readonly FOGMODE_LINEAR: number;
  40701. /**
  40702. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40703. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40704. */
  40705. static MinDeltaTime: number;
  40706. /**
  40707. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40708. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40709. */
  40710. static MaxDeltaTime: number;
  40711. /**
  40712. * Factory used to create the default material.
  40713. * @param name The name of the material to create
  40714. * @param scene The scene to create the material for
  40715. * @returns The default material
  40716. */
  40717. static DefaultMaterialFactory(scene: Scene): Material;
  40718. /**
  40719. * Factory used to create the a collision coordinator.
  40720. * @returns The collision coordinator
  40721. */
  40722. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40723. /** @hidden */
  40724. _inputManager: InputManager;
  40725. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40726. cameraToUseForPointers: Nullable<Camera>;
  40727. /** @hidden */
  40728. readonly _isScene: boolean;
  40729. /** @hidden */
  40730. _blockEntityCollection: boolean;
  40731. /**
  40732. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40733. */
  40734. autoClear: boolean;
  40735. /**
  40736. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40737. */
  40738. autoClearDepthAndStencil: boolean;
  40739. /**
  40740. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40741. */
  40742. clearColor: Color4;
  40743. /**
  40744. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40745. */
  40746. ambientColor: Color3;
  40747. /**
  40748. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40749. * It should only be one of the following (if not the default embedded one):
  40750. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40751. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40752. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40753. * The material properties need to be setup according to the type of texture in use.
  40754. */
  40755. environmentBRDFTexture: BaseTexture;
  40756. /**
  40757. * Texture used in all pbr material as the reflection texture.
  40758. * As in the majority of the scene they are the same (exception for multi room and so on),
  40759. * this is easier to reference from here than from all the materials.
  40760. */
  40761. get environmentTexture(): Nullable<BaseTexture>;
  40762. /**
  40763. * Texture used in all pbr material as the reflection texture.
  40764. * As in the majority of the scene they are the same (exception for multi room and so on),
  40765. * this is easier to set here than in all the materials.
  40766. */
  40767. set environmentTexture(value: Nullable<BaseTexture>);
  40768. /** @hidden */
  40769. protected _environmentIntensity: number;
  40770. /**
  40771. * Intensity of the environment in all pbr material.
  40772. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40773. * As in the majority of the scene they are the same (exception for multi room and so on),
  40774. * this is easier to reference from here than from all the materials.
  40775. */
  40776. get environmentIntensity(): number;
  40777. /**
  40778. * Intensity of the environment in all pbr material.
  40779. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40780. * As in the majority of the scene they are the same (exception for multi room and so on),
  40781. * this is easier to set here than in all the materials.
  40782. */
  40783. set environmentIntensity(value: number);
  40784. /** @hidden */
  40785. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40786. /**
  40787. * Default image processing configuration used either in the rendering
  40788. * Forward main pass or through the imageProcessingPostProcess if present.
  40789. * As in the majority of the scene they are the same (exception for multi camera),
  40790. * this is easier to reference from here than from all the materials and post process.
  40791. *
  40792. * No setter as we it is a shared configuration, you can set the values instead.
  40793. */
  40794. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40795. private _forceWireframe;
  40796. /**
  40797. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40798. */
  40799. set forceWireframe(value: boolean);
  40800. get forceWireframe(): boolean;
  40801. private _skipFrustumClipping;
  40802. /**
  40803. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40804. */
  40805. set skipFrustumClipping(value: boolean);
  40806. get skipFrustumClipping(): boolean;
  40807. private _forcePointsCloud;
  40808. /**
  40809. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40810. */
  40811. set forcePointsCloud(value: boolean);
  40812. get forcePointsCloud(): boolean;
  40813. /**
  40814. * Gets or sets the active clipplane 1
  40815. */
  40816. clipPlane: Nullable<Plane>;
  40817. /**
  40818. * Gets or sets the active clipplane 2
  40819. */
  40820. clipPlane2: Nullable<Plane>;
  40821. /**
  40822. * Gets or sets the active clipplane 3
  40823. */
  40824. clipPlane3: Nullable<Plane>;
  40825. /**
  40826. * Gets or sets the active clipplane 4
  40827. */
  40828. clipPlane4: Nullable<Plane>;
  40829. /**
  40830. * Gets or sets the active clipplane 5
  40831. */
  40832. clipPlane5: Nullable<Plane>;
  40833. /**
  40834. * Gets or sets the active clipplane 6
  40835. */
  40836. clipPlane6: Nullable<Plane>;
  40837. /**
  40838. * Gets or sets a boolean indicating if animations are enabled
  40839. */
  40840. animationsEnabled: boolean;
  40841. private _animationPropertiesOverride;
  40842. /**
  40843. * Gets or sets the animation properties override
  40844. */
  40845. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40846. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40847. /**
  40848. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40849. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40850. */
  40851. useConstantAnimationDeltaTime: boolean;
  40852. /**
  40853. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40854. * Please note that it requires to run a ray cast through the scene on every frame
  40855. */
  40856. constantlyUpdateMeshUnderPointer: boolean;
  40857. /**
  40858. * Defines the HTML cursor to use when hovering over interactive elements
  40859. */
  40860. hoverCursor: string;
  40861. /**
  40862. * Defines the HTML default cursor to use (empty by default)
  40863. */
  40864. defaultCursor: string;
  40865. /**
  40866. * Defines whether cursors are handled by the scene.
  40867. */
  40868. doNotHandleCursors: boolean;
  40869. /**
  40870. * This is used to call preventDefault() on pointer down
  40871. * in order to block unwanted artifacts like system double clicks
  40872. */
  40873. preventDefaultOnPointerDown: boolean;
  40874. /**
  40875. * This is used to call preventDefault() on pointer up
  40876. * in order to block unwanted artifacts like system double clicks
  40877. */
  40878. preventDefaultOnPointerUp: boolean;
  40879. /**
  40880. * Gets or sets user defined metadata
  40881. */
  40882. metadata: any;
  40883. /**
  40884. * For internal use only. Please do not use.
  40885. */
  40886. reservedDataStore: any;
  40887. /**
  40888. * Gets the name of the plugin used to load this scene (null by default)
  40889. */
  40890. loadingPluginName: string;
  40891. /**
  40892. * Use this array to add regular expressions used to disable offline support for specific urls
  40893. */
  40894. disableOfflineSupportExceptionRules: RegExp[];
  40895. /**
  40896. * An event triggered when the scene is disposed.
  40897. */
  40898. onDisposeObservable: Observable<Scene>;
  40899. private _onDisposeObserver;
  40900. /** Sets a function to be executed when this scene is disposed. */
  40901. set onDispose(callback: () => void);
  40902. /**
  40903. * An event triggered before rendering the scene (right after animations and physics)
  40904. */
  40905. onBeforeRenderObservable: Observable<Scene>;
  40906. private _onBeforeRenderObserver;
  40907. /** Sets a function to be executed before rendering this scene */
  40908. set beforeRender(callback: Nullable<() => void>);
  40909. /**
  40910. * An event triggered after rendering the scene
  40911. */
  40912. onAfterRenderObservable: Observable<Scene>;
  40913. /**
  40914. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  40915. */
  40916. onAfterRenderCameraObservable: Observable<Camera>;
  40917. private _onAfterRenderObserver;
  40918. /** Sets a function to be executed after rendering this scene */
  40919. set afterRender(callback: Nullable<() => void>);
  40920. /**
  40921. * An event triggered before animating the scene
  40922. */
  40923. onBeforeAnimationsObservable: Observable<Scene>;
  40924. /**
  40925. * An event triggered after animations processing
  40926. */
  40927. onAfterAnimationsObservable: Observable<Scene>;
  40928. /**
  40929. * An event triggered before draw calls are ready to be sent
  40930. */
  40931. onBeforeDrawPhaseObservable: Observable<Scene>;
  40932. /**
  40933. * An event triggered after draw calls have been sent
  40934. */
  40935. onAfterDrawPhaseObservable: Observable<Scene>;
  40936. /**
  40937. * An event triggered when the scene is ready
  40938. */
  40939. onReadyObservable: Observable<Scene>;
  40940. /**
  40941. * An event triggered before rendering a camera
  40942. */
  40943. onBeforeCameraRenderObservable: Observable<Camera>;
  40944. private _onBeforeCameraRenderObserver;
  40945. /** Sets a function to be executed before rendering a camera*/
  40946. set beforeCameraRender(callback: () => void);
  40947. /**
  40948. * An event triggered after rendering a camera
  40949. */
  40950. onAfterCameraRenderObservable: Observable<Camera>;
  40951. private _onAfterCameraRenderObserver;
  40952. /** Sets a function to be executed after rendering a camera*/
  40953. set afterCameraRender(callback: () => void);
  40954. /**
  40955. * An event triggered when active meshes evaluation is about to start
  40956. */
  40957. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  40958. /**
  40959. * An event triggered when active meshes evaluation is done
  40960. */
  40961. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  40962. /**
  40963. * An event triggered when particles rendering is about to start
  40964. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40965. */
  40966. onBeforeParticlesRenderingObservable: Observable<Scene>;
  40967. /**
  40968. * An event triggered when particles rendering is done
  40969. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40970. */
  40971. onAfterParticlesRenderingObservable: Observable<Scene>;
  40972. /**
  40973. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  40974. */
  40975. onDataLoadedObservable: Observable<Scene>;
  40976. /**
  40977. * An event triggered when a camera is created
  40978. */
  40979. onNewCameraAddedObservable: Observable<Camera>;
  40980. /**
  40981. * An event triggered when a camera is removed
  40982. */
  40983. onCameraRemovedObservable: Observable<Camera>;
  40984. /**
  40985. * An event triggered when a light is created
  40986. */
  40987. onNewLightAddedObservable: Observable<Light>;
  40988. /**
  40989. * An event triggered when a light is removed
  40990. */
  40991. onLightRemovedObservable: Observable<Light>;
  40992. /**
  40993. * An event triggered when a geometry is created
  40994. */
  40995. onNewGeometryAddedObservable: Observable<Geometry>;
  40996. /**
  40997. * An event triggered when a geometry is removed
  40998. */
  40999. onGeometryRemovedObservable: Observable<Geometry>;
  41000. /**
  41001. * An event triggered when a transform node is created
  41002. */
  41003. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  41004. /**
  41005. * An event triggered when a transform node is removed
  41006. */
  41007. onTransformNodeRemovedObservable: Observable<TransformNode>;
  41008. /**
  41009. * An event triggered when a mesh is created
  41010. */
  41011. onNewMeshAddedObservable: Observable<AbstractMesh>;
  41012. /**
  41013. * An event triggered when a mesh is removed
  41014. */
  41015. onMeshRemovedObservable: Observable<AbstractMesh>;
  41016. /**
  41017. * An event triggered when a skeleton is created
  41018. */
  41019. onNewSkeletonAddedObservable: Observable<Skeleton>;
  41020. /**
  41021. * An event triggered when a skeleton is removed
  41022. */
  41023. onSkeletonRemovedObservable: Observable<Skeleton>;
  41024. /**
  41025. * An event triggered when a material is created
  41026. */
  41027. onNewMaterialAddedObservable: Observable<Material>;
  41028. /**
  41029. * An event triggered when a material is removed
  41030. */
  41031. onMaterialRemovedObservable: Observable<Material>;
  41032. /**
  41033. * An event triggered when a texture is created
  41034. */
  41035. onNewTextureAddedObservable: Observable<BaseTexture>;
  41036. /**
  41037. * An event triggered when a texture is removed
  41038. */
  41039. onTextureRemovedObservable: Observable<BaseTexture>;
  41040. /**
  41041. * An event triggered when render targets are about to be rendered
  41042. * Can happen multiple times per frame.
  41043. */
  41044. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  41045. /**
  41046. * An event triggered when render targets were rendered.
  41047. * Can happen multiple times per frame.
  41048. */
  41049. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  41050. /**
  41051. * An event triggered before calculating deterministic simulation step
  41052. */
  41053. onBeforeStepObservable: Observable<Scene>;
  41054. /**
  41055. * An event triggered after calculating deterministic simulation step
  41056. */
  41057. onAfterStepObservable: Observable<Scene>;
  41058. /**
  41059. * An event triggered when the activeCamera property is updated
  41060. */
  41061. onActiveCameraChanged: Observable<Scene>;
  41062. /**
  41063. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  41064. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41065. * 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)
  41066. */
  41067. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41068. /**
  41069. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  41070. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41071. * 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)
  41072. */
  41073. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41074. /**
  41075. * This Observable will when a mesh has been imported into the scene.
  41076. */
  41077. onMeshImportedObservable: Observable<AbstractMesh>;
  41078. /**
  41079. * This Observable will when an animation file has been imported into the scene.
  41080. */
  41081. onAnimationFileImportedObservable: Observable<Scene>;
  41082. /**
  41083. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  41084. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  41085. */
  41086. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  41087. /** @hidden */
  41088. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  41089. /**
  41090. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  41091. */
  41092. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  41093. /**
  41094. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  41095. */
  41096. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  41097. /**
  41098. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  41099. */
  41100. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  41101. /** Callback called when a pointer move is detected */
  41102. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41103. /** Callback called when a pointer down is detected */
  41104. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41105. /** Callback called when a pointer up is detected */
  41106. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  41107. /** Callback called when a pointer pick is detected */
  41108. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  41109. /**
  41110. * 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).
  41111. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  41112. */
  41113. onPrePointerObservable: Observable<PointerInfoPre>;
  41114. /**
  41115. * Observable event triggered each time an input event is received from the rendering canvas
  41116. */
  41117. onPointerObservable: Observable<PointerInfo>;
  41118. /**
  41119. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  41120. */
  41121. get unTranslatedPointer(): Vector2;
  41122. /**
  41123. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  41124. */
  41125. static get DragMovementThreshold(): number;
  41126. static set DragMovementThreshold(value: number);
  41127. /**
  41128. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  41129. */
  41130. static get LongPressDelay(): number;
  41131. static set LongPressDelay(value: number);
  41132. /**
  41133. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  41134. */
  41135. static get DoubleClickDelay(): number;
  41136. static set DoubleClickDelay(value: number);
  41137. /** If you need to check double click without raising a single click at first click, enable this flag */
  41138. static get ExclusiveDoubleClickMode(): boolean;
  41139. static set ExclusiveDoubleClickMode(value: boolean);
  41140. /** @hidden */
  41141. _mirroredCameraPosition: Nullable<Vector3>;
  41142. /**
  41143. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  41144. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  41145. */
  41146. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  41147. /**
  41148. * Observable event triggered each time an keyboard event is received from the hosting window
  41149. */
  41150. onKeyboardObservable: Observable<KeyboardInfo>;
  41151. private _useRightHandedSystem;
  41152. /**
  41153. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  41154. */
  41155. set useRightHandedSystem(value: boolean);
  41156. get useRightHandedSystem(): boolean;
  41157. private _timeAccumulator;
  41158. private _currentStepId;
  41159. private _currentInternalStep;
  41160. /**
  41161. * Sets the step Id used by deterministic lock step
  41162. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41163. * @param newStepId defines the step Id
  41164. */
  41165. setStepId(newStepId: number): void;
  41166. /**
  41167. * Gets the step Id used by deterministic lock step
  41168. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41169. * @returns the step Id
  41170. */
  41171. getStepId(): number;
  41172. /**
  41173. * Gets the internal step used by deterministic lock step
  41174. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41175. * @returns the internal step
  41176. */
  41177. getInternalStep(): number;
  41178. private _fogEnabled;
  41179. /**
  41180. * Gets or sets a boolean indicating if fog is enabled on this scene
  41181. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41182. * (Default is true)
  41183. */
  41184. set fogEnabled(value: boolean);
  41185. get fogEnabled(): boolean;
  41186. private _fogMode;
  41187. /**
  41188. * Gets or sets the fog mode to use
  41189. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41190. * | mode | value |
  41191. * | --- | --- |
  41192. * | FOGMODE_NONE | 0 |
  41193. * | FOGMODE_EXP | 1 |
  41194. * | FOGMODE_EXP2 | 2 |
  41195. * | FOGMODE_LINEAR | 3 |
  41196. */
  41197. set fogMode(value: number);
  41198. get fogMode(): number;
  41199. /**
  41200. * Gets or sets the fog color to use
  41201. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41202. * (Default is Color3(0.2, 0.2, 0.3))
  41203. */
  41204. fogColor: Color3;
  41205. /**
  41206. * Gets or sets the fog density to use
  41207. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41208. * (Default is 0.1)
  41209. */
  41210. fogDensity: number;
  41211. /**
  41212. * Gets or sets the fog start distance to use
  41213. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41214. * (Default is 0)
  41215. */
  41216. fogStart: number;
  41217. /**
  41218. * Gets or sets the fog end distance to use
  41219. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41220. * (Default is 1000)
  41221. */
  41222. fogEnd: number;
  41223. /**
  41224. * Flag indicating that the frame buffer binding is handled by another component
  41225. */
  41226. prePass: boolean;
  41227. private _shadowsEnabled;
  41228. /**
  41229. * Gets or sets a boolean indicating if shadows are enabled on this scene
  41230. */
  41231. set shadowsEnabled(value: boolean);
  41232. get shadowsEnabled(): boolean;
  41233. private _lightsEnabled;
  41234. /**
  41235. * Gets or sets a boolean indicating if lights are enabled on this scene
  41236. */
  41237. set lightsEnabled(value: boolean);
  41238. get lightsEnabled(): boolean;
  41239. /** All of the active cameras added to this scene. */
  41240. activeCameras: Camera[];
  41241. /** @hidden */
  41242. _activeCamera: Nullable<Camera>;
  41243. /** Gets or sets the current active camera */
  41244. get activeCamera(): Nullable<Camera>;
  41245. set activeCamera(value: Nullable<Camera>);
  41246. private _defaultMaterial;
  41247. /** The default material used on meshes when no material is affected */
  41248. get defaultMaterial(): Material;
  41249. /** The default material used on meshes when no material is affected */
  41250. set defaultMaterial(value: Material);
  41251. private _texturesEnabled;
  41252. /**
  41253. * Gets or sets a boolean indicating if textures are enabled on this scene
  41254. */
  41255. set texturesEnabled(value: boolean);
  41256. get texturesEnabled(): boolean;
  41257. /**
  41258. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41259. */
  41260. physicsEnabled: boolean;
  41261. /**
  41262. * Gets or sets a boolean indicating if particles are enabled on this scene
  41263. */
  41264. particlesEnabled: boolean;
  41265. /**
  41266. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41267. */
  41268. spritesEnabled: boolean;
  41269. private _skeletonsEnabled;
  41270. /**
  41271. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41272. */
  41273. set skeletonsEnabled(value: boolean);
  41274. get skeletonsEnabled(): boolean;
  41275. /**
  41276. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41277. */
  41278. lensFlaresEnabled: boolean;
  41279. /**
  41280. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41281. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41282. */
  41283. collisionsEnabled: boolean;
  41284. private _collisionCoordinator;
  41285. /** @hidden */
  41286. get collisionCoordinator(): ICollisionCoordinator;
  41287. /**
  41288. * Defines the gravity applied to this scene (used only for collisions)
  41289. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41290. */
  41291. gravity: Vector3;
  41292. /**
  41293. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41294. */
  41295. postProcessesEnabled: boolean;
  41296. /**
  41297. * Gets the current postprocess manager
  41298. */
  41299. postProcessManager: PostProcessManager;
  41300. /**
  41301. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41302. */
  41303. renderTargetsEnabled: boolean;
  41304. /**
  41305. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41306. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41307. */
  41308. dumpNextRenderTargets: boolean;
  41309. /**
  41310. * The list of user defined render targets added to the scene
  41311. */
  41312. customRenderTargets: RenderTargetTexture[];
  41313. /**
  41314. * Defines if texture loading must be delayed
  41315. * If true, textures will only be loaded when they need to be rendered
  41316. */
  41317. useDelayedTextureLoading: boolean;
  41318. /**
  41319. * Gets the list of meshes imported to the scene through SceneLoader
  41320. */
  41321. importedMeshesFiles: String[];
  41322. /**
  41323. * Gets or sets a boolean indicating if probes are enabled on this scene
  41324. */
  41325. probesEnabled: boolean;
  41326. /**
  41327. * Gets or sets the current offline provider to use to store scene data
  41328. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41329. */
  41330. offlineProvider: IOfflineProvider;
  41331. /**
  41332. * Gets or sets the action manager associated with the scene
  41333. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41334. */
  41335. actionManager: AbstractActionManager;
  41336. private _meshesForIntersections;
  41337. /**
  41338. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41339. */
  41340. proceduralTexturesEnabled: boolean;
  41341. private _engine;
  41342. private _totalVertices;
  41343. /** @hidden */
  41344. _activeIndices: PerfCounter;
  41345. /** @hidden */
  41346. _activeParticles: PerfCounter;
  41347. /** @hidden */
  41348. _activeBones: PerfCounter;
  41349. private _animationRatio;
  41350. /** @hidden */
  41351. _animationTimeLast: number;
  41352. /** @hidden */
  41353. _animationTime: number;
  41354. /**
  41355. * Gets or sets a general scale for animation speed
  41356. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41357. */
  41358. animationTimeScale: number;
  41359. /** @hidden */
  41360. _cachedMaterial: Nullable<Material>;
  41361. /** @hidden */
  41362. _cachedEffect: Nullable<Effect>;
  41363. /** @hidden */
  41364. _cachedVisibility: Nullable<number>;
  41365. private _renderId;
  41366. private _frameId;
  41367. private _executeWhenReadyTimeoutId;
  41368. private _intermediateRendering;
  41369. private _viewUpdateFlag;
  41370. private _projectionUpdateFlag;
  41371. /** @hidden */
  41372. _toBeDisposed: Nullable<IDisposable>[];
  41373. private _activeRequests;
  41374. /** @hidden */
  41375. _pendingData: any[];
  41376. private _isDisposed;
  41377. /**
  41378. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41379. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41380. */
  41381. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41382. private _activeMeshes;
  41383. private _processedMaterials;
  41384. private _renderTargets;
  41385. /** @hidden */
  41386. _activeParticleSystems: SmartArray<IParticleSystem>;
  41387. private _activeSkeletons;
  41388. private _softwareSkinnedMeshes;
  41389. private _renderingManager;
  41390. /** @hidden */
  41391. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41392. private _transformMatrix;
  41393. private _sceneUbo;
  41394. /** @hidden */
  41395. _viewMatrix: Matrix;
  41396. private _projectionMatrix;
  41397. /** @hidden */
  41398. _forcedViewPosition: Nullable<Vector3>;
  41399. /** @hidden */
  41400. _frustumPlanes: Plane[];
  41401. /**
  41402. * Gets the list of frustum planes (built from the active camera)
  41403. */
  41404. get frustumPlanes(): Plane[];
  41405. /**
  41406. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41407. * This is useful if there are more lights that the maximum simulteanous authorized
  41408. */
  41409. requireLightSorting: boolean;
  41410. /** @hidden */
  41411. readonly useMaterialMeshMap: boolean;
  41412. /** @hidden */
  41413. readonly useClonedMeshMap: boolean;
  41414. private _externalData;
  41415. private _uid;
  41416. /**
  41417. * @hidden
  41418. * Backing store of defined scene components.
  41419. */
  41420. _components: ISceneComponent[];
  41421. /**
  41422. * @hidden
  41423. * Backing store of defined scene components.
  41424. */
  41425. _serializableComponents: ISceneSerializableComponent[];
  41426. /**
  41427. * List of components to register on the next registration step.
  41428. */
  41429. private _transientComponents;
  41430. /**
  41431. * Registers the transient components if needed.
  41432. */
  41433. private _registerTransientComponents;
  41434. /**
  41435. * @hidden
  41436. * Add a component to the scene.
  41437. * Note that the ccomponent could be registered on th next frame if this is called after
  41438. * the register component stage.
  41439. * @param component Defines the component to add to the scene
  41440. */
  41441. _addComponent(component: ISceneComponent): void;
  41442. /**
  41443. * @hidden
  41444. * Gets a component from the scene.
  41445. * @param name defines the name of the component to retrieve
  41446. * @returns the component or null if not present
  41447. */
  41448. _getComponent(name: string): Nullable<ISceneComponent>;
  41449. /**
  41450. * @hidden
  41451. * Defines the actions happening before camera updates.
  41452. */
  41453. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41454. /**
  41455. * @hidden
  41456. * Defines the actions happening before clear the canvas.
  41457. */
  41458. _beforeClearStage: Stage<SimpleStageAction>;
  41459. /**
  41460. * @hidden
  41461. * Defines the actions when collecting render targets for the frame.
  41462. */
  41463. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41464. /**
  41465. * @hidden
  41466. * Defines the actions happening for one camera in the frame.
  41467. */
  41468. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41469. /**
  41470. * @hidden
  41471. * Defines the actions happening during the per mesh ready checks.
  41472. */
  41473. _isReadyForMeshStage: Stage<MeshStageAction>;
  41474. /**
  41475. * @hidden
  41476. * Defines the actions happening before evaluate active mesh checks.
  41477. */
  41478. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41479. /**
  41480. * @hidden
  41481. * Defines the actions happening during the evaluate sub mesh checks.
  41482. */
  41483. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41484. /**
  41485. * @hidden
  41486. * Defines the actions happening during the active mesh stage.
  41487. */
  41488. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41489. /**
  41490. * @hidden
  41491. * Defines the actions happening during the per camera render target step.
  41492. */
  41493. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41494. /**
  41495. * @hidden
  41496. * Defines the actions happening just before the active camera is drawing.
  41497. */
  41498. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41499. /**
  41500. * @hidden
  41501. * Defines the actions happening just before a render target is drawing.
  41502. */
  41503. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41504. /**
  41505. * @hidden
  41506. * Defines the actions happening just before a rendering group is drawing.
  41507. */
  41508. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41509. /**
  41510. * @hidden
  41511. * Defines the actions happening just before a mesh is drawing.
  41512. */
  41513. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41514. /**
  41515. * @hidden
  41516. * Defines the actions happening just after a mesh has been drawn.
  41517. */
  41518. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41519. /**
  41520. * @hidden
  41521. * Defines the actions happening just after a rendering group has been drawn.
  41522. */
  41523. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41524. /**
  41525. * @hidden
  41526. * Defines the actions happening just after the active camera has been drawn.
  41527. */
  41528. _afterCameraDrawStage: Stage<CameraStageAction>;
  41529. /**
  41530. * @hidden
  41531. * Defines the actions happening just after a render target has been drawn.
  41532. */
  41533. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41534. /**
  41535. * @hidden
  41536. * Defines the actions happening just after rendering all cameras and computing intersections.
  41537. */
  41538. _afterRenderStage: Stage<SimpleStageAction>;
  41539. /**
  41540. * @hidden
  41541. * Defines the actions happening when a pointer move event happens.
  41542. */
  41543. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41544. /**
  41545. * @hidden
  41546. * Defines the actions happening when a pointer down event happens.
  41547. */
  41548. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41549. /**
  41550. * @hidden
  41551. * Defines the actions happening when a pointer up event happens.
  41552. */
  41553. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41554. /**
  41555. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41556. */
  41557. private geometriesByUniqueId;
  41558. /**
  41559. * Creates a new Scene
  41560. * @param engine defines the engine to use to render this scene
  41561. * @param options defines the scene options
  41562. */
  41563. constructor(engine: Engine, options?: SceneOptions);
  41564. /**
  41565. * Gets a string identifying the name of the class
  41566. * @returns "Scene" string
  41567. */
  41568. getClassName(): string;
  41569. private _defaultMeshCandidates;
  41570. /**
  41571. * @hidden
  41572. */
  41573. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41574. private _defaultSubMeshCandidates;
  41575. /**
  41576. * @hidden
  41577. */
  41578. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41579. /**
  41580. * Sets the default candidate providers for the scene.
  41581. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41582. * and getCollidingSubMeshCandidates to their default function
  41583. */
  41584. setDefaultCandidateProviders(): void;
  41585. /**
  41586. * Gets the mesh that is currently under the pointer
  41587. */
  41588. get meshUnderPointer(): Nullable<AbstractMesh>;
  41589. /**
  41590. * Gets or sets the current on-screen X position of the pointer
  41591. */
  41592. get pointerX(): number;
  41593. set pointerX(value: number);
  41594. /**
  41595. * Gets or sets the current on-screen Y position of the pointer
  41596. */
  41597. get pointerY(): number;
  41598. set pointerY(value: number);
  41599. /**
  41600. * Gets the cached material (ie. the latest rendered one)
  41601. * @returns the cached material
  41602. */
  41603. getCachedMaterial(): Nullable<Material>;
  41604. /**
  41605. * Gets the cached effect (ie. the latest rendered one)
  41606. * @returns the cached effect
  41607. */
  41608. getCachedEffect(): Nullable<Effect>;
  41609. /**
  41610. * Gets the cached visibility state (ie. the latest rendered one)
  41611. * @returns the cached visibility state
  41612. */
  41613. getCachedVisibility(): Nullable<number>;
  41614. /**
  41615. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41616. * @param material defines the current material
  41617. * @param effect defines the current effect
  41618. * @param visibility defines the current visibility state
  41619. * @returns true if one parameter is not cached
  41620. */
  41621. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41622. /**
  41623. * Gets the engine associated with the scene
  41624. * @returns an Engine
  41625. */
  41626. getEngine(): Engine;
  41627. /**
  41628. * Gets the total number of vertices rendered per frame
  41629. * @returns the total number of vertices rendered per frame
  41630. */
  41631. getTotalVertices(): number;
  41632. /**
  41633. * Gets the performance counter for total vertices
  41634. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41635. */
  41636. get totalVerticesPerfCounter(): PerfCounter;
  41637. /**
  41638. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41639. * @returns the total number of active indices rendered per frame
  41640. */
  41641. getActiveIndices(): number;
  41642. /**
  41643. * Gets the performance counter for active indices
  41644. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41645. */
  41646. get totalActiveIndicesPerfCounter(): PerfCounter;
  41647. /**
  41648. * Gets the total number of active particles rendered per frame
  41649. * @returns the total number of active particles rendered per frame
  41650. */
  41651. getActiveParticles(): number;
  41652. /**
  41653. * Gets the performance counter for active particles
  41654. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41655. */
  41656. get activeParticlesPerfCounter(): PerfCounter;
  41657. /**
  41658. * Gets the total number of active bones rendered per frame
  41659. * @returns the total number of active bones rendered per frame
  41660. */
  41661. getActiveBones(): number;
  41662. /**
  41663. * Gets the performance counter for active bones
  41664. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41665. */
  41666. get activeBonesPerfCounter(): PerfCounter;
  41667. /**
  41668. * Gets the array of active meshes
  41669. * @returns an array of AbstractMesh
  41670. */
  41671. getActiveMeshes(): SmartArray<AbstractMesh>;
  41672. /**
  41673. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41674. * @returns a number
  41675. */
  41676. getAnimationRatio(): number;
  41677. /**
  41678. * Gets an unique Id for the current render phase
  41679. * @returns a number
  41680. */
  41681. getRenderId(): number;
  41682. /**
  41683. * Gets an unique Id for the current frame
  41684. * @returns a number
  41685. */
  41686. getFrameId(): number;
  41687. /** Call this function if you want to manually increment the render Id*/
  41688. incrementRenderId(): void;
  41689. private _createUbo;
  41690. /**
  41691. * Use this method to simulate a pointer move on a mesh
  41692. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41693. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41694. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41695. * @returns the current scene
  41696. */
  41697. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41698. /**
  41699. * Use this method to simulate a pointer down on a mesh
  41700. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41701. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41702. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41703. * @returns the current scene
  41704. */
  41705. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41706. /**
  41707. * Use this method to simulate a pointer up on a mesh
  41708. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41709. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41710. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41711. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41712. * @returns the current scene
  41713. */
  41714. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41715. /**
  41716. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41717. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41718. * @returns true if the pointer was captured
  41719. */
  41720. isPointerCaptured(pointerId?: number): boolean;
  41721. /**
  41722. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41723. * @param attachUp defines if you want to attach events to pointerup
  41724. * @param attachDown defines if you want to attach events to pointerdown
  41725. * @param attachMove defines if you want to attach events to pointermove
  41726. */
  41727. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41728. /** Detaches all event handlers*/
  41729. detachControl(): void;
  41730. /**
  41731. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41732. * Delay loaded resources are not taking in account
  41733. * @return true if all required resources are ready
  41734. */
  41735. isReady(): boolean;
  41736. /** Resets all cached information relative to material (including effect and visibility) */
  41737. resetCachedMaterial(): void;
  41738. /**
  41739. * Registers a function to be called before every frame render
  41740. * @param func defines the function to register
  41741. */
  41742. registerBeforeRender(func: () => void): void;
  41743. /**
  41744. * Unregisters a function called before every frame render
  41745. * @param func defines the function to unregister
  41746. */
  41747. unregisterBeforeRender(func: () => void): void;
  41748. /**
  41749. * Registers a function to be called after every frame render
  41750. * @param func defines the function to register
  41751. */
  41752. registerAfterRender(func: () => void): void;
  41753. /**
  41754. * Unregisters a function called after every frame render
  41755. * @param func defines the function to unregister
  41756. */
  41757. unregisterAfterRender(func: () => void): void;
  41758. private _executeOnceBeforeRender;
  41759. /**
  41760. * The provided function will run before render once and will be disposed afterwards.
  41761. * A timeout delay can be provided so that the function will be executed in N ms.
  41762. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41763. * @param func The function to be executed.
  41764. * @param timeout optional delay in ms
  41765. */
  41766. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41767. /** @hidden */
  41768. _addPendingData(data: any): void;
  41769. /** @hidden */
  41770. _removePendingData(data: any): void;
  41771. /**
  41772. * Returns the number of items waiting to be loaded
  41773. * @returns the number of items waiting to be loaded
  41774. */
  41775. getWaitingItemsCount(): number;
  41776. /**
  41777. * Returns a boolean indicating if the scene is still loading data
  41778. */
  41779. get isLoading(): boolean;
  41780. /**
  41781. * Registers a function to be executed when the scene is ready
  41782. * @param {Function} func - the function to be executed
  41783. */
  41784. executeWhenReady(func: () => void): void;
  41785. /**
  41786. * Returns a promise that resolves when the scene is ready
  41787. * @returns A promise that resolves when the scene is ready
  41788. */
  41789. whenReadyAsync(): Promise<void>;
  41790. /** @hidden */
  41791. _checkIsReady(): void;
  41792. /**
  41793. * Gets all animatable attached to the scene
  41794. */
  41795. get animatables(): Animatable[];
  41796. /**
  41797. * Resets the last animation time frame.
  41798. * Useful to override when animations start running when loading a scene for the first time.
  41799. */
  41800. resetLastAnimationTimeFrame(): void;
  41801. /**
  41802. * Gets the current view matrix
  41803. * @returns a Matrix
  41804. */
  41805. getViewMatrix(): Matrix;
  41806. /**
  41807. * Gets the current projection matrix
  41808. * @returns a Matrix
  41809. */
  41810. getProjectionMatrix(): Matrix;
  41811. /**
  41812. * Gets the current transform matrix
  41813. * @returns a Matrix made of View * Projection
  41814. */
  41815. getTransformMatrix(): Matrix;
  41816. /**
  41817. * Sets the current transform matrix
  41818. * @param viewL defines the View matrix to use
  41819. * @param projectionL defines the Projection matrix to use
  41820. * @param viewR defines the right View matrix to use (if provided)
  41821. * @param projectionR defines the right Projection matrix to use (if provided)
  41822. */
  41823. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41824. /**
  41825. * Gets the uniform buffer used to store scene data
  41826. * @returns a UniformBuffer
  41827. */
  41828. getSceneUniformBuffer(): UniformBuffer;
  41829. /**
  41830. * Gets an unique (relatively to the current scene) Id
  41831. * @returns an unique number for the scene
  41832. */
  41833. getUniqueId(): number;
  41834. /**
  41835. * Add a mesh to the list of scene's meshes
  41836. * @param newMesh defines the mesh to add
  41837. * @param recursive if all child meshes should also be added to the scene
  41838. */
  41839. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41840. /**
  41841. * Remove a mesh for the list of scene's meshes
  41842. * @param toRemove defines the mesh to remove
  41843. * @param recursive if all child meshes should also be removed from the scene
  41844. * @returns the index where the mesh was in the mesh list
  41845. */
  41846. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41847. /**
  41848. * Add a transform node to the list of scene's transform nodes
  41849. * @param newTransformNode defines the transform node to add
  41850. */
  41851. addTransformNode(newTransformNode: TransformNode): void;
  41852. /**
  41853. * Remove a transform node for the list of scene's transform nodes
  41854. * @param toRemove defines the transform node to remove
  41855. * @returns the index where the transform node was in the transform node list
  41856. */
  41857. removeTransformNode(toRemove: TransformNode): number;
  41858. /**
  41859. * Remove a skeleton for the list of scene's skeletons
  41860. * @param toRemove defines the skeleton to remove
  41861. * @returns the index where the skeleton was in the skeleton list
  41862. */
  41863. removeSkeleton(toRemove: Skeleton): number;
  41864. /**
  41865. * Remove a morph target for the list of scene's morph targets
  41866. * @param toRemove defines the morph target to remove
  41867. * @returns the index where the morph target was in the morph target list
  41868. */
  41869. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41870. /**
  41871. * Remove a light for the list of scene's lights
  41872. * @param toRemove defines the light to remove
  41873. * @returns the index where the light was in the light list
  41874. */
  41875. removeLight(toRemove: Light): number;
  41876. /**
  41877. * Remove a camera for the list of scene's cameras
  41878. * @param toRemove defines the camera to remove
  41879. * @returns the index where the camera was in the camera list
  41880. */
  41881. removeCamera(toRemove: Camera): number;
  41882. /**
  41883. * Remove a particle system for the list of scene's particle systems
  41884. * @param toRemove defines the particle system to remove
  41885. * @returns the index where the particle system was in the particle system list
  41886. */
  41887. removeParticleSystem(toRemove: IParticleSystem): number;
  41888. /**
  41889. * Remove a animation for the list of scene's animations
  41890. * @param toRemove defines the animation to remove
  41891. * @returns the index where the animation was in the animation list
  41892. */
  41893. removeAnimation(toRemove: Animation): number;
  41894. /**
  41895. * Will stop the animation of the given target
  41896. * @param target - the target
  41897. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  41898. * @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)
  41899. */
  41900. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  41901. /**
  41902. * Removes the given animation group from this scene.
  41903. * @param toRemove The animation group to remove
  41904. * @returns The index of the removed animation group
  41905. */
  41906. removeAnimationGroup(toRemove: AnimationGroup): number;
  41907. /**
  41908. * Removes the given multi-material from this scene.
  41909. * @param toRemove The multi-material to remove
  41910. * @returns The index of the removed multi-material
  41911. */
  41912. removeMultiMaterial(toRemove: MultiMaterial): number;
  41913. /**
  41914. * Removes the given material from this scene.
  41915. * @param toRemove The material to remove
  41916. * @returns The index of the removed material
  41917. */
  41918. removeMaterial(toRemove: Material): number;
  41919. /**
  41920. * Removes the given action manager from this scene.
  41921. * @param toRemove The action manager to remove
  41922. * @returns The index of the removed action manager
  41923. */
  41924. removeActionManager(toRemove: AbstractActionManager): number;
  41925. /**
  41926. * Removes the given texture from this scene.
  41927. * @param toRemove The texture to remove
  41928. * @returns The index of the removed texture
  41929. */
  41930. removeTexture(toRemove: BaseTexture): number;
  41931. /**
  41932. * Adds the given light to this scene
  41933. * @param newLight The light to add
  41934. */
  41935. addLight(newLight: Light): void;
  41936. /**
  41937. * Sorts the list list based on light priorities
  41938. */
  41939. sortLightsByPriority(): void;
  41940. /**
  41941. * Adds the given camera to this scene
  41942. * @param newCamera The camera to add
  41943. */
  41944. addCamera(newCamera: Camera): void;
  41945. /**
  41946. * Adds the given skeleton to this scene
  41947. * @param newSkeleton The skeleton to add
  41948. */
  41949. addSkeleton(newSkeleton: Skeleton): void;
  41950. /**
  41951. * Adds the given particle system to this scene
  41952. * @param newParticleSystem The particle system to add
  41953. */
  41954. addParticleSystem(newParticleSystem: IParticleSystem): void;
  41955. /**
  41956. * Adds the given animation to this scene
  41957. * @param newAnimation The animation to add
  41958. */
  41959. addAnimation(newAnimation: Animation): void;
  41960. /**
  41961. * Adds the given animation group to this scene.
  41962. * @param newAnimationGroup The animation group to add
  41963. */
  41964. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  41965. /**
  41966. * Adds the given multi-material to this scene
  41967. * @param newMultiMaterial The multi-material to add
  41968. */
  41969. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  41970. /**
  41971. * Adds the given material to this scene
  41972. * @param newMaterial The material to add
  41973. */
  41974. addMaterial(newMaterial: Material): void;
  41975. /**
  41976. * Adds the given morph target to this scene
  41977. * @param newMorphTargetManager The morph target to add
  41978. */
  41979. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  41980. /**
  41981. * Adds the given geometry to this scene
  41982. * @param newGeometry The geometry to add
  41983. */
  41984. addGeometry(newGeometry: Geometry): void;
  41985. /**
  41986. * Adds the given action manager to this scene
  41987. * @param newActionManager The action manager to add
  41988. */
  41989. addActionManager(newActionManager: AbstractActionManager): void;
  41990. /**
  41991. * Adds the given texture to this scene.
  41992. * @param newTexture The texture to add
  41993. */
  41994. addTexture(newTexture: BaseTexture): void;
  41995. /**
  41996. * Switch active camera
  41997. * @param newCamera defines the new active camera
  41998. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  41999. */
  42000. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  42001. /**
  42002. * sets the active camera of the scene using its ID
  42003. * @param id defines the camera's ID
  42004. * @return the new active camera or null if none found.
  42005. */
  42006. setActiveCameraByID(id: string): Nullable<Camera>;
  42007. /**
  42008. * sets the active camera of the scene using its name
  42009. * @param name defines the camera's name
  42010. * @returns the new active camera or null if none found.
  42011. */
  42012. setActiveCameraByName(name: string): Nullable<Camera>;
  42013. /**
  42014. * get an animation group using its name
  42015. * @param name defines the material's name
  42016. * @return the animation group or null if none found.
  42017. */
  42018. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  42019. /**
  42020. * Get a material using its unique id
  42021. * @param uniqueId defines the material's unique id
  42022. * @return the material or null if none found.
  42023. */
  42024. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  42025. /**
  42026. * get a material using its id
  42027. * @param id defines the material's ID
  42028. * @return the material or null if none found.
  42029. */
  42030. getMaterialByID(id: string): Nullable<Material>;
  42031. /**
  42032. * Gets a the last added material using a given id
  42033. * @param id defines the material's ID
  42034. * @return the last material with the given id or null if none found.
  42035. */
  42036. getLastMaterialByID(id: string): Nullable<Material>;
  42037. /**
  42038. * Gets a material using its name
  42039. * @param name defines the material's name
  42040. * @return the material or null if none found.
  42041. */
  42042. getMaterialByName(name: string): Nullable<Material>;
  42043. /**
  42044. * Get a texture using its unique id
  42045. * @param uniqueId defines the texture's unique id
  42046. * @return the texture or null if none found.
  42047. */
  42048. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  42049. /**
  42050. * Gets a camera using its id
  42051. * @param id defines the id to look for
  42052. * @returns the camera or null if not found
  42053. */
  42054. getCameraByID(id: string): Nullable<Camera>;
  42055. /**
  42056. * Gets a camera using its unique id
  42057. * @param uniqueId defines the unique id to look for
  42058. * @returns the camera or null if not found
  42059. */
  42060. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  42061. /**
  42062. * Gets a camera using its name
  42063. * @param name defines the camera's name
  42064. * @return the camera or null if none found.
  42065. */
  42066. getCameraByName(name: string): Nullable<Camera>;
  42067. /**
  42068. * Gets a bone using its id
  42069. * @param id defines the bone's id
  42070. * @return the bone or null if not found
  42071. */
  42072. getBoneByID(id: string): Nullable<Bone>;
  42073. /**
  42074. * Gets a bone using its id
  42075. * @param name defines the bone's name
  42076. * @return the bone or null if not found
  42077. */
  42078. getBoneByName(name: string): Nullable<Bone>;
  42079. /**
  42080. * Gets a light node using its name
  42081. * @param name defines the the light's name
  42082. * @return the light or null if none found.
  42083. */
  42084. getLightByName(name: string): Nullable<Light>;
  42085. /**
  42086. * Gets a light node using its id
  42087. * @param id defines the light's id
  42088. * @return the light or null if none found.
  42089. */
  42090. getLightByID(id: string): Nullable<Light>;
  42091. /**
  42092. * Gets a light node using its scene-generated unique ID
  42093. * @param uniqueId defines the light's unique id
  42094. * @return the light or null if none found.
  42095. */
  42096. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  42097. /**
  42098. * Gets a particle system by id
  42099. * @param id defines the particle system id
  42100. * @return the corresponding system or null if none found
  42101. */
  42102. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  42103. /**
  42104. * Gets a geometry using its ID
  42105. * @param id defines the geometry's id
  42106. * @return the geometry or null if none found.
  42107. */
  42108. getGeometryByID(id: string): Nullable<Geometry>;
  42109. private _getGeometryByUniqueID;
  42110. /**
  42111. * Add a new geometry to this scene
  42112. * @param geometry defines the geometry to be added to the scene.
  42113. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  42114. * @return a boolean defining if the geometry was added or not
  42115. */
  42116. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  42117. /**
  42118. * Removes an existing geometry
  42119. * @param geometry defines the geometry to be removed from the scene
  42120. * @return a boolean defining if the geometry was removed or not
  42121. */
  42122. removeGeometry(geometry: Geometry): boolean;
  42123. /**
  42124. * Gets the list of geometries attached to the scene
  42125. * @returns an array of Geometry
  42126. */
  42127. getGeometries(): Geometry[];
  42128. /**
  42129. * Gets the first added mesh found of a given ID
  42130. * @param id defines the id to search for
  42131. * @return the mesh found or null if not found at all
  42132. */
  42133. getMeshByID(id: string): Nullable<AbstractMesh>;
  42134. /**
  42135. * Gets a list of meshes using their id
  42136. * @param id defines the id to search for
  42137. * @returns a list of meshes
  42138. */
  42139. getMeshesByID(id: string): Array<AbstractMesh>;
  42140. /**
  42141. * Gets the first added transform node found of a given ID
  42142. * @param id defines the id to search for
  42143. * @return the found transform node or null if not found at all.
  42144. */
  42145. getTransformNodeByID(id: string): Nullable<TransformNode>;
  42146. /**
  42147. * Gets a transform node with its auto-generated unique id
  42148. * @param uniqueId efines the unique id to search for
  42149. * @return the found transform node or null if not found at all.
  42150. */
  42151. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  42152. /**
  42153. * Gets a list of transform nodes using their id
  42154. * @param id defines the id to search for
  42155. * @returns a list of transform nodes
  42156. */
  42157. getTransformNodesByID(id: string): Array<TransformNode>;
  42158. /**
  42159. * Gets a mesh with its auto-generated unique id
  42160. * @param uniqueId defines the unique id to search for
  42161. * @return the found mesh or null if not found at all.
  42162. */
  42163. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  42164. /**
  42165. * Gets a the last added mesh using a given id
  42166. * @param id defines the id to search for
  42167. * @return the found mesh or null if not found at all.
  42168. */
  42169. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  42170. /**
  42171. * Gets a the last added node (Mesh, Camera, Light) using a given id
  42172. * @param id defines the id to search for
  42173. * @return the found node or null if not found at all
  42174. */
  42175. getLastEntryByID(id: string): Nullable<Node>;
  42176. /**
  42177. * Gets a node (Mesh, Camera, Light) using a given id
  42178. * @param id defines the id to search for
  42179. * @return the found node or null if not found at all
  42180. */
  42181. getNodeByID(id: string): Nullable<Node>;
  42182. /**
  42183. * Gets a node (Mesh, Camera, Light) using a given name
  42184. * @param name defines the name to search for
  42185. * @return the found node or null if not found at all.
  42186. */
  42187. getNodeByName(name: string): Nullable<Node>;
  42188. /**
  42189. * Gets a mesh using a given name
  42190. * @param name defines the name to search for
  42191. * @return the found mesh or null if not found at all.
  42192. */
  42193. getMeshByName(name: string): Nullable<AbstractMesh>;
  42194. /**
  42195. * Gets a transform node using a given name
  42196. * @param name defines the name to search for
  42197. * @return the found transform node or null if not found at all.
  42198. */
  42199. getTransformNodeByName(name: string): Nullable<TransformNode>;
  42200. /**
  42201. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  42202. * @param id defines the id to search for
  42203. * @return the found skeleton or null if not found at all.
  42204. */
  42205. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  42206. /**
  42207. * Gets a skeleton using a given auto generated unique id
  42208. * @param uniqueId defines the unique id to search for
  42209. * @return the found skeleton or null if not found at all.
  42210. */
  42211. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  42212. /**
  42213. * Gets a skeleton 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 skeleton or null if not found at all.
  42216. */
  42217. getSkeletonById(id: string): Nullable<Skeleton>;
  42218. /**
  42219. * Gets a skeleton using a given name
  42220. * @param name defines the name to search for
  42221. * @return the found skeleton or null if not found at all.
  42222. */
  42223. getSkeletonByName(name: string): Nullable<Skeleton>;
  42224. /**
  42225. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  42226. * @param id defines the id to search for
  42227. * @return the found morph target manager or null if not found at all.
  42228. */
  42229. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  42230. /**
  42231. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  42232. * @param id defines the id to search for
  42233. * @return the found morph target or null if not found at all.
  42234. */
  42235. getMorphTargetById(id: string): Nullable<MorphTarget>;
  42236. /**
  42237. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  42238. * @param name defines the name to search for
  42239. * @return the found morph target or null if not found at all.
  42240. */
  42241. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  42242. /**
  42243. * Gets a post process using a given name (if many are found, this function will pick the first one)
  42244. * @param name defines the name to search for
  42245. * @return the found post process or null if not found at all.
  42246. */
  42247. getPostProcessByName(name: string): Nullable<PostProcess>;
  42248. /**
  42249. * Gets a boolean indicating if the given mesh is active
  42250. * @param mesh defines the mesh to look for
  42251. * @returns true if the mesh is in the active list
  42252. */
  42253. isActiveMesh(mesh: AbstractMesh): boolean;
  42254. /**
  42255. * Return a unique id as a string which can serve as an identifier for the scene
  42256. */
  42257. get uid(): string;
  42258. /**
  42259. * Add an externaly attached data from its key.
  42260. * This method call will fail and return false, if such key already exists.
  42261. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42262. * @param key the unique key that identifies the data
  42263. * @param data the data object to associate to the key for this Engine instance
  42264. * @return true if no such key were already present and the data was added successfully, false otherwise
  42265. */
  42266. addExternalData<T>(key: string, data: T): boolean;
  42267. /**
  42268. * Get an externaly attached data from its key
  42269. * @param key the unique key that identifies the data
  42270. * @return the associated data, if present (can be null), or undefined if not present
  42271. */
  42272. getExternalData<T>(key: string): Nullable<T>;
  42273. /**
  42274. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42275. * @param key the unique key that identifies the data
  42276. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42277. * @return the associated data, can be null if the factory returned null.
  42278. */
  42279. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42280. /**
  42281. * Remove an externaly attached data from the Engine instance
  42282. * @param key the unique key that identifies the data
  42283. * @return true if the data was successfully removed, false if it doesn't exist
  42284. */
  42285. removeExternalData(key: string): boolean;
  42286. private _evaluateSubMesh;
  42287. /**
  42288. * Clear the processed materials smart array preventing retention point in material dispose.
  42289. */
  42290. freeProcessedMaterials(): void;
  42291. private _preventFreeActiveMeshesAndRenderingGroups;
  42292. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42293. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42294. * when disposing several meshes in a row or a hierarchy of meshes.
  42295. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42296. */
  42297. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42298. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42299. /**
  42300. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42301. */
  42302. freeActiveMeshes(): void;
  42303. /**
  42304. * Clear the info related to rendering groups preventing retention points during dispose.
  42305. */
  42306. freeRenderingGroups(): void;
  42307. /** @hidden */
  42308. _isInIntermediateRendering(): boolean;
  42309. /**
  42310. * Lambda returning the list of potentially active meshes.
  42311. */
  42312. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42313. /**
  42314. * Lambda returning the list of potentially active sub meshes.
  42315. */
  42316. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42317. /**
  42318. * Lambda returning the list of potentially intersecting sub meshes.
  42319. */
  42320. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42321. /**
  42322. * Lambda returning the list of potentially colliding sub meshes.
  42323. */
  42324. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42325. private _activeMeshesFrozen;
  42326. private _skipEvaluateActiveMeshesCompletely;
  42327. /**
  42328. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42329. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42330. * @returns the current scene
  42331. */
  42332. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42333. /**
  42334. * Use this function to restart evaluating active meshes on every frame
  42335. * @returns the current scene
  42336. */
  42337. unfreezeActiveMeshes(): Scene;
  42338. private _evaluateActiveMeshes;
  42339. private _activeMesh;
  42340. /**
  42341. * Update the transform matrix to update from the current active camera
  42342. * @param force defines a boolean used to force the update even if cache is up to date
  42343. */
  42344. updateTransformMatrix(force?: boolean): void;
  42345. private _bindFrameBuffer;
  42346. /** @hidden */
  42347. _allowPostProcessClearColor: boolean;
  42348. /** @hidden */
  42349. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42350. private _processSubCameras;
  42351. private _checkIntersections;
  42352. /** @hidden */
  42353. _advancePhysicsEngineStep(step: number): void;
  42354. /**
  42355. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42356. */
  42357. getDeterministicFrameTime: () => number;
  42358. /** @hidden */
  42359. _animate(): void;
  42360. /** Execute all animations (for a frame) */
  42361. animate(): void;
  42362. /**
  42363. * Render the scene
  42364. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42365. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42366. */
  42367. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42368. /**
  42369. * Freeze all materials
  42370. * A frozen material will not be updatable but should be faster to render
  42371. */
  42372. freezeMaterials(): void;
  42373. /**
  42374. * Unfreeze all materials
  42375. * A frozen material will not be updatable but should be faster to render
  42376. */
  42377. unfreezeMaterials(): void;
  42378. /**
  42379. * Releases all held ressources
  42380. */
  42381. dispose(): void;
  42382. /**
  42383. * Gets if the scene is already disposed
  42384. */
  42385. get isDisposed(): boolean;
  42386. /**
  42387. * Call this function to reduce memory footprint of the scene.
  42388. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42389. */
  42390. clearCachedVertexData(): void;
  42391. /**
  42392. * This function will remove the local cached buffer data from texture.
  42393. * It will save memory but will prevent the texture from being rebuilt
  42394. */
  42395. cleanCachedTextureBuffer(): void;
  42396. /**
  42397. * Get the world extend vectors with an optional filter
  42398. *
  42399. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42400. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42401. */
  42402. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42403. min: Vector3;
  42404. max: Vector3;
  42405. };
  42406. /**
  42407. * Creates a ray that can be used to pick in the scene
  42408. * @param x defines the x coordinate of the origin (on-screen)
  42409. * @param y defines the y coordinate of the origin (on-screen)
  42410. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42411. * @param camera defines the camera to use for the picking
  42412. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42413. * @returns a Ray
  42414. */
  42415. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42416. /**
  42417. * Creates a ray that can be used to pick in the scene
  42418. * @param x defines the x coordinate of the origin (on-screen)
  42419. * @param y defines the y coordinate of the origin (on-screen)
  42420. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42421. * @param result defines the ray where to store the picking ray
  42422. * @param camera defines the camera to use for the picking
  42423. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42424. * @returns the current scene
  42425. */
  42426. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42427. /**
  42428. * Creates a ray that can be used to pick in the scene
  42429. * @param x defines the x coordinate of the origin (on-screen)
  42430. * @param y defines the y coordinate of the origin (on-screen)
  42431. * @param camera defines the camera to use for the picking
  42432. * @returns a Ray
  42433. */
  42434. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  42435. /**
  42436. * Creates a ray that can be used to pick in the scene
  42437. * @param x defines the x coordinate of the origin (on-screen)
  42438. * @param y defines the y coordinate of the origin (on-screen)
  42439. * @param result defines the ray where to store the picking ray
  42440. * @param camera defines the camera to use for the picking
  42441. * @returns the current scene
  42442. */
  42443. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42444. /** Launch a ray to try to pick a mesh in the scene
  42445. * @param x position on screen
  42446. * @param y position on screen
  42447. * @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
  42448. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42449. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42450. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42451. * @returns a PickingInfo
  42452. */
  42453. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42454. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42455. * @param x position on screen
  42456. * @param 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 fastCheck defines if the first intersection will be used (and not the closest)
  42459. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42460. * @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)
  42461. */
  42462. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42463. /** Use the given ray to pick a mesh in the scene
  42464. * @param ray The ray to use to pick meshes
  42465. * @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
  42466. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42467. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42468. * @returns a PickingInfo
  42469. */
  42470. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42471. /**
  42472. * Launch a ray to try to pick a mesh in the scene
  42473. * @param x X position on screen
  42474. * @param y Y position on screen
  42475. * @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
  42476. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42477. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42478. * @returns an array of PickingInfo
  42479. */
  42480. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42481. /**
  42482. * Launch a ray to try to pick a mesh in the scene
  42483. * @param ray Ray to use
  42484. * @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
  42485. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42486. * @returns an array of PickingInfo
  42487. */
  42488. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42489. /**
  42490. * Force the value of meshUnderPointer
  42491. * @param mesh defines the mesh to use
  42492. * @param pointerId optional pointer id when using more than one pointer
  42493. */
  42494. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  42495. /**
  42496. * Gets the mesh under the pointer
  42497. * @returns a Mesh or null if no mesh is under the pointer
  42498. */
  42499. getPointerOverMesh(): Nullable<AbstractMesh>;
  42500. /** @hidden */
  42501. _rebuildGeometries(): void;
  42502. /** @hidden */
  42503. _rebuildTextures(): void;
  42504. private _getByTags;
  42505. /**
  42506. * Get a list of meshes by tags
  42507. * @param tagsQuery defines the tags query to use
  42508. * @param forEach defines a predicate used to filter results
  42509. * @returns an array of Mesh
  42510. */
  42511. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42512. /**
  42513. * Get a list of cameras by tags
  42514. * @param tagsQuery defines the tags query to use
  42515. * @param forEach defines a predicate used to filter results
  42516. * @returns an array of Camera
  42517. */
  42518. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42519. /**
  42520. * Get a list of lights by tags
  42521. * @param tagsQuery defines the tags query to use
  42522. * @param forEach defines a predicate used to filter results
  42523. * @returns an array of Light
  42524. */
  42525. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42526. /**
  42527. * Get a list of materials by tags
  42528. * @param tagsQuery defines the tags query to use
  42529. * @param forEach defines a predicate used to filter results
  42530. * @returns an array of Material
  42531. */
  42532. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42533. /**
  42534. * Get a list of transform nodes by tags
  42535. * @param tagsQuery defines the tags query to use
  42536. * @param forEach defines a predicate used to filter results
  42537. * @returns an array of TransformNode
  42538. */
  42539. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  42540. /**
  42541. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42542. * This allowed control for front to back rendering or reversly depending of the special needs.
  42543. *
  42544. * @param renderingGroupId The rendering group id corresponding to its index
  42545. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42546. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42547. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42548. */
  42549. 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;
  42550. /**
  42551. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42552. *
  42553. * @param renderingGroupId The rendering group id corresponding to its index
  42554. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42555. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42556. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42557. */
  42558. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42559. /**
  42560. * Gets the current auto clear configuration for one rendering group of the rendering
  42561. * manager.
  42562. * @param index the rendering group index to get the information for
  42563. * @returns The auto clear setup for the requested rendering group
  42564. */
  42565. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42566. private _blockMaterialDirtyMechanism;
  42567. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42568. get blockMaterialDirtyMechanism(): boolean;
  42569. set blockMaterialDirtyMechanism(value: boolean);
  42570. /**
  42571. * Will flag all materials as dirty to trigger new shader compilation
  42572. * @param flag defines the flag used to specify which material part must be marked as dirty
  42573. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42574. */
  42575. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42576. /** @hidden */
  42577. _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;
  42578. /** @hidden */
  42579. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42580. /** @hidden */
  42581. _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;
  42582. /** @hidden */
  42583. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42584. /** @hidden */
  42585. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42586. /** @hidden */
  42587. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42588. }
  42589. }
  42590. declare module "babylonjs/assetContainer" {
  42591. import { AbstractScene } from "babylonjs/abstractScene";
  42592. import { Scene } from "babylonjs/scene";
  42593. import { Mesh } from "babylonjs/Meshes/mesh";
  42594. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42595. import { Skeleton } from "babylonjs/Bones/skeleton";
  42596. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42597. import { Animatable } from "babylonjs/Animations/animatable";
  42598. import { Nullable } from "babylonjs/types";
  42599. import { Node } from "babylonjs/node";
  42600. /**
  42601. * Set of assets to keep when moving a scene into an asset container.
  42602. */
  42603. export class KeepAssets extends AbstractScene {
  42604. }
  42605. /**
  42606. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42607. */
  42608. export class InstantiatedEntries {
  42609. /**
  42610. * List of new root nodes (eg. nodes with no parent)
  42611. */
  42612. rootNodes: TransformNode[];
  42613. /**
  42614. * List of new skeletons
  42615. */
  42616. skeletons: Skeleton[];
  42617. /**
  42618. * List of new animation groups
  42619. */
  42620. animationGroups: AnimationGroup[];
  42621. }
  42622. /**
  42623. * Container with a set of assets that can be added or removed from a scene.
  42624. */
  42625. export class AssetContainer extends AbstractScene {
  42626. private _wasAddedToScene;
  42627. /**
  42628. * The scene the AssetContainer belongs to.
  42629. */
  42630. scene: Scene;
  42631. /**
  42632. * Instantiates an AssetContainer.
  42633. * @param scene The scene the AssetContainer belongs to.
  42634. */
  42635. constructor(scene: Scene);
  42636. /**
  42637. * Instantiate or clone all meshes and add the new ones to the scene.
  42638. * Skeletons and animation groups will all be cloned
  42639. * @param nameFunction defines an optional function used to get new names for clones
  42640. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42641. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42642. */
  42643. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42644. /**
  42645. * Adds all the assets from the container to the scene.
  42646. */
  42647. addAllToScene(): void;
  42648. /**
  42649. * Removes all the assets in the container from the scene
  42650. */
  42651. removeAllFromScene(): void;
  42652. /**
  42653. * Disposes all the assets in the container
  42654. */
  42655. dispose(): void;
  42656. private _moveAssets;
  42657. /**
  42658. * Removes all the assets contained in the scene and adds them to the container.
  42659. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42660. */
  42661. moveAllFromScene(keepAssets?: KeepAssets): void;
  42662. /**
  42663. * 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.
  42664. * @returns the root mesh
  42665. */
  42666. createRootMesh(): Mesh;
  42667. /**
  42668. * Merge animations (direct and animation groups) from this asset container into a scene
  42669. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42670. * @param animatables set of animatables to retarget to a node from the scene
  42671. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42672. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42673. */
  42674. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42675. }
  42676. }
  42677. declare module "babylonjs/abstractScene" {
  42678. import { Scene } from "babylonjs/scene";
  42679. import { Nullable } from "babylonjs/types";
  42680. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42681. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42682. import { Geometry } from "babylonjs/Meshes/geometry";
  42683. import { Skeleton } from "babylonjs/Bones/skeleton";
  42684. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42685. import { AssetContainer } from "babylonjs/assetContainer";
  42686. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42687. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42688. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42689. import { Material } from "babylonjs/Materials/material";
  42690. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42691. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42692. import { Camera } from "babylonjs/Cameras/camera";
  42693. import { Light } from "babylonjs/Lights/light";
  42694. import { Node } from "babylonjs/node";
  42695. import { Animation } from "babylonjs/Animations/animation";
  42696. /**
  42697. * Defines how the parser contract is defined.
  42698. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42699. */
  42700. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42701. /**
  42702. * Defines how the individual parser contract is defined.
  42703. * These parser can parse an individual asset
  42704. */
  42705. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42706. /**
  42707. * Base class of the scene acting as a container for the different elements composing a scene.
  42708. * This class is dynamically extended by the different components of the scene increasing
  42709. * flexibility and reducing coupling
  42710. */
  42711. export abstract class AbstractScene {
  42712. /**
  42713. * Stores the list of available parsers in the application.
  42714. */
  42715. private static _BabylonFileParsers;
  42716. /**
  42717. * Stores the list of available individual parsers in the application.
  42718. */
  42719. private static _IndividualBabylonFileParsers;
  42720. /**
  42721. * Adds a parser in the list of available ones
  42722. * @param name Defines the name of the parser
  42723. * @param parser Defines the parser to add
  42724. */
  42725. static AddParser(name: string, parser: BabylonFileParser): void;
  42726. /**
  42727. * Gets a general parser from the list of avaialble ones
  42728. * @param name Defines the name of the parser
  42729. * @returns the requested parser or null
  42730. */
  42731. static GetParser(name: string): Nullable<BabylonFileParser>;
  42732. /**
  42733. * Adds n individual parser in the list of available ones
  42734. * @param name Defines the name of the parser
  42735. * @param parser Defines the parser to add
  42736. */
  42737. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42738. /**
  42739. * Gets an individual parser from the list of avaialble ones
  42740. * @param name Defines the name of the parser
  42741. * @returns the requested parser or null
  42742. */
  42743. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42744. /**
  42745. * Parser json data and populate both a scene and its associated container object
  42746. * @param jsonData Defines the data to parse
  42747. * @param scene Defines the scene to parse the data for
  42748. * @param container Defines the container attached to the parsing sequence
  42749. * @param rootUrl Defines the root url of the data
  42750. */
  42751. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42752. /**
  42753. * Gets the list of root nodes (ie. nodes with no parent)
  42754. */
  42755. rootNodes: Node[];
  42756. /** All of the cameras added to this scene
  42757. * @see https://doc.babylonjs.com/babylon101/cameras
  42758. */
  42759. cameras: Camera[];
  42760. /**
  42761. * All of the lights added to this scene
  42762. * @see https://doc.babylonjs.com/babylon101/lights
  42763. */
  42764. lights: Light[];
  42765. /**
  42766. * All of the (abstract) meshes added to this scene
  42767. */
  42768. meshes: AbstractMesh[];
  42769. /**
  42770. * The list of skeletons added to the scene
  42771. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42772. */
  42773. skeletons: Skeleton[];
  42774. /**
  42775. * All of the particle systems added to this scene
  42776. * @see https://doc.babylonjs.com/babylon101/particles
  42777. */
  42778. particleSystems: IParticleSystem[];
  42779. /**
  42780. * Gets a list of Animations associated with the scene
  42781. */
  42782. animations: Animation[];
  42783. /**
  42784. * All of the animation groups added to this scene
  42785. * @see https://doc.babylonjs.com/how_to/group
  42786. */
  42787. animationGroups: AnimationGroup[];
  42788. /**
  42789. * All of the multi-materials added to this scene
  42790. * @see https://doc.babylonjs.com/how_to/multi_materials
  42791. */
  42792. multiMaterials: MultiMaterial[];
  42793. /**
  42794. * All of the materials added to this scene
  42795. * In the context of a Scene, it is not supposed to be modified manually.
  42796. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42797. * Note also that the order of the Material within the array is not significant and might change.
  42798. * @see https://doc.babylonjs.com/babylon101/materials
  42799. */
  42800. materials: Material[];
  42801. /**
  42802. * The list of morph target managers added to the scene
  42803. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42804. */
  42805. morphTargetManagers: MorphTargetManager[];
  42806. /**
  42807. * The list of geometries used in the scene.
  42808. */
  42809. geometries: Geometry[];
  42810. /**
  42811. * All of the tranform nodes added to this scene
  42812. * In the context of a Scene, it is not supposed to be modified manually.
  42813. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42814. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42815. * @see https://doc.babylonjs.com/how_to/transformnode
  42816. */
  42817. transformNodes: TransformNode[];
  42818. /**
  42819. * ActionManagers available on the scene.
  42820. */
  42821. actionManagers: AbstractActionManager[];
  42822. /**
  42823. * Textures to keep.
  42824. */
  42825. textures: BaseTexture[];
  42826. /** @hidden */
  42827. protected _environmentTexture: Nullable<BaseTexture>;
  42828. /**
  42829. * Texture used in all pbr material as the reflection texture.
  42830. * As in the majority of the scene they are the same (exception for multi room and so on),
  42831. * this is easier to reference from here than from all the materials.
  42832. */
  42833. get environmentTexture(): Nullable<BaseTexture>;
  42834. set environmentTexture(value: Nullable<BaseTexture>);
  42835. /**
  42836. * The list of postprocesses added to the scene
  42837. */
  42838. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  42839. /**
  42840. * @returns all meshes, lights, cameras, transformNodes and bones
  42841. */
  42842. getNodes(): Array<Node>;
  42843. }
  42844. }
  42845. declare module "babylonjs/Audio/sound" {
  42846. import { Observable } from "babylonjs/Misc/observable";
  42847. import { Vector3 } from "babylonjs/Maths/math.vector";
  42848. import { Nullable } from "babylonjs/types";
  42849. import { Scene } from "babylonjs/scene";
  42850. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42851. /**
  42852. * Interface used to define options for Sound class
  42853. */
  42854. export interface ISoundOptions {
  42855. /**
  42856. * Does the sound autoplay once loaded.
  42857. */
  42858. autoplay?: boolean;
  42859. /**
  42860. * Does the sound loop after it finishes playing once.
  42861. */
  42862. loop?: boolean;
  42863. /**
  42864. * Sound's volume
  42865. */
  42866. volume?: number;
  42867. /**
  42868. * Is it a spatial sound?
  42869. */
  42870. spatialSound?: boolean;
  42871. /**
  42872. * Maximum distance to hear that sound
  42873. */
  42874. maxDistance?: number;
  42875. /**
  42876. * Uses user defined attenuation function
  42877. */
  42878. useCustomAttenuation?: boolean;
  42879. /**
  42880. * Define the roll off factor of spatial sounds.
  42881. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42882. */
  42883. rolloffFactor?: number;
  42884. /**
  42885. * Define the reference distance the sound should be heard perfectly.
  42886. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42887. */
  42888. refDistance?: number;
  42889. /**
  42890. * Define the distance attenuation model the sound will follow.
  42891. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42892. */
  42893. distanceModel?: string;
  42894. /**
  42895. * Defines the playback speed (1 by default)
  42896. */
  42897. playbackRate?: number;
  42898. /**
  42899. * Defines if the sound is from a streaming source
  42900. */
  42901. streaming?: boolean;
  42902. /**
  42903. * Defines an optional length (in seconds) inside the sound file
  42904. */
  42905. length?: number;
  42906. /**
  42907. * Defines an optional offset (in seconds) inside the sound file
  42908. */
  42909. offset?: number;
  42910. /**
  42911. * If true, URLs will not be required to state the audio file codec to use.
  42912. */
  42913. skipCodecCheck?: boolean;
  42914. }
  42915. /**
  42916. * Defines a sound that can be played in the application.
  42917. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  42918. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  42919. */
  42920. export class Sound {
  42921. /**
  42922. * The name of the sound in the scene.
  42923. */
  42924. name: string;
  42925. /**
  42926. * Does the sound autoplay once loaded.
  42927. */
  42928. autoplay: boolean;
  42929. /**
  42930. * Does the sound loop after it finishes playing once.
  42931. */
  42932. loop: boolean;
  42933. /**
  42934. * Does the sound use a custom attenuation curve to simulate the falloff
  42935. * happening when the source gets further away from the camera.
  42936. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42937. */
  42938. useCustomAttenuation: boolean;
  42939. /**
  42940. * The sound track id this sound belongs to.
  42941. */
  42942. soundTrackId: number;
  42943. /**
  42944. * Is this sound currently played.
  42945. */
  42946. isPlaying: boolean;
  42947. /**
  42948. * Is this sound currently paused.
  42949. */
  42950. isPaused: boolean;
  42951. /**
  42952. * Does this sound enables spatial sound.
  42953. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42954. */
  42955. spatialSound: boolean;
  42956. /**
  42957. * Define the reference distance the sound should be heard perfectly.
  42958. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42959. */
  42960. refDistance: number;
  42961. /**
  42962. * Define the roll off factor of spatial sounds.
  42963. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42964. */
  42965. rolloffFactor: number;
  42966. /**
  42967. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  42968. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42969. */
  42970. maxDistance: number;
  42971. /**
  42972. * Define the distance attenuation model the sound will follow.
  42973. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42974. */
  42975. distanceModel: string;
  42976. /**
  42977. * @hidden
  42978. * Back Compat
  42979. **/
  42980. onended: () => any;
  42981. /**
  42982. * Gets or sets an object used to store user defined information for the sound.
  42983. */
  42984. metadata: any;
  42985. /**
  42986. * Observable event when the current playing sound finishes.
  42987. */
  42988. onEndedObservable: Observable<Sound>;
  42989. private _panningModel;
  42990. private _playbackRate;
  42991. private _streaming;
  42992. private _startTime;
  42993. private _startOffset;
  42994. private _position;
  42995. /** @hidden */
  42996. _positionInEmitterSpace: boolean;
  42997. private _localDirection;
  42998. private _volume;
  42999. private _isReadyToPlay;
  43000. private _isDirectional;
  43001. private _readyToPlayCallback;
  43002. private _audioBuffer;
  43003. private _soundSource;
  43004. private _streamingSource;
  43005. private _soundPanner;
  43006. private _soundGain;
  43007. private _inputAudioNode;
  43008. private _outputAudioNode;
  43009. private _coneInnerAngle;
  43010. private _coneOuterAngle;
  43011. private _coneOuterGain;
  43012. private _scene;
  43013. private _connectedTransformNode;
  43014. private _customAttenuationFunction;
  43015. private _registerFunc;
  43016. private _isOutputConnected;
  43017. private _htmlAudioElement;
  43018. private _urlType;
  43019. private _length?;
  43020. private _offset?;
  43021. /** @hidden */
  43022. static _SceneComponentInitialization: (scene: Scene) => void;
  43023. /**
  43024. * Create a sound and attach it to a scene
  43025. * @param name Name of your sound
  43026. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  43027. * @param scene defines the scene the sound belongs to
  43028. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  43029. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  43030. */
  43031. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  43032. /**
  43033. * Release the sound and its associated resources
  43034. */
  43035. dispose(): void;
  43036. /**
  43037. * Gets if the sounds is ready to be played or not.
  43038. * @returns true if ready, otherwise false
  43039. */
  43040. isReady(): boolean;
  43041. private _soundLoaded;
  43042. /**
  43043. * Sets the data of the sound from an audiobuffer
  43044. * @param audioBuffer The audioBuffer containing the data
  43045. */
  43046. setAudioBuffer(audioBuffer: AudioBuffer): void;
  43047. /**
  43048. * Updates the current sounds options such as maxdistance, loop...
  43049. * @param options A JSON object containing values named as the object properties
  43050. */
  43051. updateOptions(options: ISoundOptions): void;
  43052. private _createSpatialParameters;
  43053. private _updateSpatialParameters;
  43054. /**
  43055. * Switch the panning model to HRTF:
  43056. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43057. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43058. */
  43059. switchPanningModelToHRTF(): void;
  43060. /**
  43061. * Switch the panning model to Equal Power:
  43062. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43063. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43064. */
  43065. switchPanningModelToEqualPower(): void;
  43066. private _switchPanningModel;
  43067. /**
  43068. * Connect this sound to a sound track audio node like gain...
  43069. * @param soundTrackAudioNode the sound track audio node to connect to
  43070. */
  43071. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  43072. /**
  43073. * Transform this sound into a directional source
  43074. * @param coneInnerAngle Size of the inner cone in degree
  43075. * @param coneOuterAngle Size of the outer cone in degree
  43076. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  43077. */
  43078. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  43079. /**
  43080. * Gets or sets the inner angle for the directional cone.
  43081. */
  43082. get directionalConeInnerAngle(): number;
  43083. /**
  43084. * Gets or sets the inner angle for the directional cone.
  43085. */
  43086. set directionalConeInnerAngle(value: number);
  43087. /**
  43088. * Gets or sets the outer angle for the directional cone.
  43089. */
  43090. get directionalConeOuterAngle(): number;
  43091. /**
  43092. * Gets or sets the outer angle for the directional cone.
  43093. */
  43094. set directionalConeOuterAngle(value: number);
  43095. /**
  43096. * Sets the position of the emitter if spatial sound is enabled
  43097. * @param newPosition Defines the new posisiton
  43098. */
  43099. setPosition(newPosition: Vector3): void;
  43100. /**
  43101. * Sets the local direction of the emitter if spatial sound is enabled
  43102. * @param newLocalDirection Defines the new local direction
  43103. */
  43104. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  43105. private _updateDirection;
  43106. /** @hidden */
  43107. updateDistanceFromListener(): void;
  43108. /**
  43109. * Sets a new custom attenuation function for the sound.
  43110. * @param callback Defines the function used for the attenuation
  43111. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43112. */
  43113. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  43114. /**
  43115. * Play the sound
  43116. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  43117. * @param offset (optional) Start the sound at a specific time in seconds
  43118. * @param length (optional) Sound duration (in seconds)
  43119. */
  43120. play(time?: number, offset?: number, length?: number): void;
  43121. private _onended;
  43122. /**
  43123. * Stop the sound
  43124. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  43125. */
  43126. stop(time?: number): void;
  43127. /**
  43128. * Put the sound in pause
  43129. */
  43130. pause(): void;
  43131. /**
  43132. * Sets a dedicated volume for this sounds
  43133. * @param newVolume Define the new volume of the sound
  43134. * @param time Define time for gradual change to new volume
  43135. */
  43136. setVolume(newVolume: number, time?: number): void;
  43137. /**
  43138. * Set the sound play back rate
  43139. * @param newPlaybackRate Define the playback rate the sound should be played at
  43140. */
  43141. setPlaybackRate(newPlaybackRate: number): void;
  43142. /**
  43143. * Gets the volume of the sound.
  43144. * @returns the volume of the sound
  43145. */
  43146. getVolume(): number;
  43147. /**
  43148. * Attach the sound to a dedicated mesh
  43149. * @param transformNode The transform node to connect the sound with
  43150. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43151. */
  43152. attachToMesh(transformNode: TransformNode): void;
  43153. /**
  43154. * Detach the sound from the previously attached mesh
  43155. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43156. */
  43157. detachFromMesh(): void;
  43158. private _onRegisterAfterWorldMatrixUpdate;
  43159. /**
  43160. * Clone the current sound in the scene.
  43161. * @returns the new sound clone
  43162. */
  43163. clone(): Nullable<Sound>;
  43164. /**
  43165. * Gets the current underlying audio buffer containing the data
  43166. * @returns the audio buffer
  43167. */
  43168. getAudioBuffer(): Nullable<AudioBuffer>;
  43169. /**
  43170. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  43171. * @returns the source node
  43172. */
  43173. getSoundSource(): Nullable<AudioBufferSourceNode>;
  43174. /**
  43175. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  43176. * @returns the gain node
  43177. */
  43178. getSoundGain(): Nullable<GainNode>;
  43179. /**
  43180. * Serializes the Sound in a JSON representation
  43181. * @returns the JSON representation of the sound
  43182. */
  43183. serialize(): any;
  43184. /**
  43185. * Parse a JSON representation of a sound to innstantiate in a given scene
  43186. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  43187. * @param scene Define the scene the new parsed sound should be created in
  43188. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  43189. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  43190. * @returns the newly parsed sound
  43191. */
  43192. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  43193. }
  43194. }
  43195. declare module "babylonjs/Actions/directAudioActions" {
  43196. import { Action } from "babylonjs/Actions/action";
  43197. import { Condition } from "babylonjs/Actions/condition";
  43198. import { Sound } from "babylonjs/Audio/sound";
  43199. /**
  43200. * This defines an action helpful to play a defined sound on a triggered action.
  43201. */
  43202. export class PlaySoundAction extends Action {
  43203. private _sound;
  43204. /**
  43205. * Instantiate the action
  43206. * @param triggerOptions defines the trigger options
  43207. * @param sound defines the sound to play
  43208. * @param condition defines the trigger related conditions
  43209. */
  43210. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43211. /** @hidden */
  43212. _prepare(): void;
  43213. /**
  43214. * Execute the action and play the sound.
  43215. */
  43216. execute(): void;
  43217. /**
  43218. * Serializes the actions and its related information.
  43219. * @param parent defines the object to serialize in
  43220. * @returns the serialized object
  43221. */
  43222. serialize(parent: any): any;
  43223. }
  43224. /**
  43225. * This defines an action helpful to stop a defined sound on a triggered action.
  43226. */
  43227. export class StopSoundAction extends Action {
  43228. private _sound;
  43229. /**
  43230. * Instantiate the action
  43231. * @param triggerOptions defines the trigger options
  43232. * @param sound defines the sound to stop
  43233. * @param condition defines the trigger related conditions
  43234. */
  43235. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43236. /** @hidden */
  43237. _prepare(): void;
  43238. /**
  43239. * Execute the action and stop the sound.
  43240. */
  43241. execute(): void;
  43242. /**
  43243. * Serializes the actions and its related information.
  43244. * @param parent defines the object to serialize in
  43245. * @returns the serialized object
  43246. */
  43247. serialize(parent: any): any;
  43248. }
  43249. }
  43250. declare module "babylonjs/Actions/interpolateValueAction" {
  43251. import { Action } from "babylonjs/Actions/action";
  43252. import { Condition } from "babylonjs/Actions/condition";
  43253. import { Observable } from "babylonjs/Misc/observable";
  43254. /**
  43255. * This defines an action responsible to change the value of a property
  43256. * by interpolating between its current value and the newly set one once triggered.
  43257. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43258. */
  43259. export class InterpolateValueAction extends Action {
  43260. /**
  43261. * Defines the path of the property where the value should be interpolated
  43262. */
  43263. propertyPath: string;
  43264. /**
  43265. * Defines the target value at the end of the interpolation.
  43266. */
  43267. value: any;
  43268. /**
  43269. * Defines the time it will take for the property to interpolate to the value.
  43270. */
  43271. duration: number;
  43272. /**
  43273. * Defines if the other scene animations should be stopped when the action has been triggered
  43274. */
  43275. stopOtherAnimations?: boolean;
  43276. /**
  43277. * Defines a callback raised once the interpolation animation has been done.
  43278. */
  43279. onInterpolationDone?: () => void;
  43280. /**
  43281. * Observable triggered once the interpolation animation has been done.
  43282. */
  43283. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43284. private _target;
  43285. private _effectiveTarget;
  43286. private _property;
  43287. /**
  43288. * Instantiate the action
  43289. * @param triggerOptions defines the trigger options
  43290. * @param target defines the object containing the value to interpolate
  43291. * @param propertyPath defines the path to the property in the target object
  43292. * @param value defines the target value at the end of the interpolation
  43293. * @param duration deines the time it will take for the property to interpolate to the value.
  43294. * @param condition defines the trigger related conditions
  43295. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43296. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43297. */
  43298. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43299. /** @hidden */
  43300. _prepare(): void;
  43301. /**
  43302. * Execute the action starts the value interpolation.
  43303. */
  43304. execute(): void;
  43305. /**
  43306. * Serializes the actions and its related information.
  43307. * @param parent defines the object to serialize in
  43308. * @returns the serialized object
  43309. */
  43310. serialize(parent: any): any;
  43311. }
  43312. }
  43313. declare module "babylonjs/Actions/index" {
  43314. export * from "babylonjs/Actions/abstractActionManager";
  43315. export * from "babylonjs/Actions/action";
  43316. export * from "babylonjs/Actions/actionEvent";
  43317. export * from "babylonjs/Actions/actionManager";
  43318. export * from "babylonjs/Actions/condition";
  43319. export * from "babylonjs/Actions/directActions";
  43320. export * from "babylonjs/Actions/directAudioActions";
  43321. export * from "babylonjs/Actions/interpolateValueAction";
  43322. }
  43323. declare module "babylonjs/Animations/index" {
  43324. export * from "babylonjs/Animations/animatable";
  43325. export * from "babylonjs/Animations/animation";
  43326. export * from "babylonjs/Animations/animationGroup";
  43327. export * from "babylonjs/Animations/animationPropertiesOverride";
  43328. export * from "babylonjs/Animations/easing";
  43329. export * from "babylonjs/Animations/runtimeAnimation";
  43330. export * from "babylonjs/Animations/animationEvent";
  43331. export * from "babylonjs/Animations/animationGroup";
  43332. export * from "babylonjs/Animations/animationKey";
  43333. export * from "babylonjs/Animations/animationRange";
  43334. export * from "babylonjs/Animations/animatable.interface";
  43335. }
  43336. declare module "babylonjs/Audio/soundTrack" {
  43337. import { Sound } from "babylonjs/Audio/sound";
  43338. import { Analyser } from "babylonjs/Audio/analyser";
  43339. import { Scene } from "babylonjs/scene";
  43340. /**
  43341. * Options allowed during the creation of a sound track.
  43342. */
  43343. export interface ISoundTrackOptions {
  43344. /**
  43345. * The volume the sound track should take during creation
  43346. */
  43347. volume?: number;
  43348. /**
  43349. * Define if the sound track is the main sound track of the scene
  43350. */
  43351. mainTrack?: boolean;
  43352. }
  43353. /**
  43354. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43355. * It will be also used in a future release to apply effects on a specific track.
  43356. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43357. */
  43358. export class SoundTrack {
  43359. /**
  43360. * The unique identifier of the sound track in the scene.
  43361. */
  43362. id: number;
  43363. /**
  43364. * The list of sounds included in the sound track.
  43365. */
  43366. soundCollection: Array<Sound>;
  43367. private _outputAudioNode;
  43368. private _scene;
  43369. private _connectedAnalyser;
  43370. private _options;
  43371. private _isInitialized;
  43372. /**
  43373. * Creates a new sound track.
  43374. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43375. * @param scene Define the scene the sound track belongs to
  43376. * @param options
  43377. */
  43378. constructor(scene: Scene, options?: ISoundTrackOptions);
  43379. private _initializeSoundTrackAudioGraph;
  43380. /**
  43381. * Release the sound track and its associated resources
  43382. */
  43383. dispose(): void;
  43384. /**
  43385. * Adds a sound to this sound track
  43386. * @param sound define the cound to add
  43387. * @ignoreNaming
  43388. */
  43389. AddSound(sound: Sound): void;
  43390. /**
  43391. * Removes a sound to this sound track
  43392. * @param sound define the cound to remove
  43393. * @ignoreNaming
  43394. */
  43395. RemoveSound(sound: Sound): void;
  43396. /**
  43397. * Set a global volume for the full sound track.
  43398. * @param newVolume Define the new volume of the sound track
  43399. */
  43400. setVolume(newVolume: number): void;
  43401. /**
  43402. * Switch the panning model to HRTF:
  43403. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43404. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43405. */
  43406. switchPanningModelToHRTF(): void;
  43407. /**
  43408. * Switch the panning model to Equal Power:
  43409. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43410. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43411. */
  43412. switchPanningModelToEqualPower(): void;
  43413. /**
  43414. * Connect the sound track to an audio analyser allowing some amazing
  43415. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43416. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43417. * @param analyser The analyser to connect to the engine
  43418. */
  43419. connectToAnalyser(analyser: Analyser): void;
  43420. }
  43421. }
  43422. declare module "babylonjs/Audio/audioSceneComponent" {
  43423. import { Sound } from "babylonjs/Audio/sound";
  43424. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43425. import { Nullable } from "babylonjs/types";
  43426. import { Vector3 } from "babylonjs/Maths/math.vector";
  43427. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43428. import { Scene } from "babylonjs/scene";
  43429. import { AbstractScene } from "babylonjs/abstractScene";
  43430. import "babylonjs/Audio/audioEngine";
  43431. module "babylonjs/abstractScene" {
  43432. interface AbstractScene {
  43433. /**
  43434. * The list of sounds used in the scene.
  43435. */
  43436. sounds: Nullable<Array<Sound>>;
  43437. }
  43438. }
  43439. module "babylonjs/scene" {
  43440. interface Scene {
  43441. /**
  43442. * @hidden
  43443. * Backing field
  43444. */
  43445. _mainSoundTrack: SoundTrack;
  43446. /**
  43447. * The main sound track played by the scene.
  43448. * It cotains your primary collection of sounds.
  43449. */
  43450. mainSoundTrack: SoundTrack;
  43451. /**
  43452. * The list of sound tracks added to the scene
  43453. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43454. */
  43455. soundTracks: Nullable<Array<SoundTrack>>;
  43456. /**
  43457. * Gets a sound using a given name
  43458. * @param name defines the name to search for
  43459. * @return the found sound or null if not found at all.
  43460. */
  43461. getSoundByName(name: string): Nullable<Sound>;
  43462. /**
  43463. * Gets or sets if audio support is enabled
  43464. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43465. */
  43466. audioEnabled: boolean;
  43467. /**
  43468. * Gets or sets if audio will be output to headphones
  43469. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43470. */
  43471. headphone: boolean;
  43472. /**
  43473. * Gets or sets custom audio listener position provider
  43474. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43475. */
  43476. audioListenerPositionProvider: Nullable<() => Vector3>;
  43477. /**
  43478. * Gets or sets a refresh rate when using 3D audio positioning
  43479. */
  43480. audioPositioningRefreshRate: number;
  43481. }
  43482. }
  43483. /**
  43484. * Defines the sound scene component responsible to manage any sounds
  43485. * in a given scene.
  43486. */
  43487. export class AudioSceneComponent implements ISceneSerializableComponent {
  43488. /**
  43489. * The component name helpfull to identify the component in the list of scene components.
  43490. */
  43491. readonly name: string;
  43492. /**
  43493. * The scene the component belongs to.
  43494. */
  43495. scene: Scene;
  43496. private _audioEnabled;
  43497. /**
  43498. * Gets whether audio is enabled or not.
  43499. * Please use related enable/disable method to switch state.
  43500. */
  43501. get audioEnabled(): boolean;
  43502. private _headphone;
  43503. /**
  43504. * Gets whether audio is outputing to headphone or not.
  43505. * Please use the according Switch methods to change output.
  43506. */
  43507. get headphone(): boolean;
  43508. /**
  43509. * Gets or sets a refresh rate when using 3D audio positioning
  43510. */
  43511. audioPositioningRefreshRate: number;
  43512. private _audioListenerPositionProvider;
  43513. /**
  43514. * Gets the current audio listener position provider
  43515. */
  43516. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43517. /**
  43518. * Sets a custom listener position for all sounds in the scene
  43519. * By default, this is the position of the first active camera
  43520. */
  43521. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43522. /**
  43523. * Creates a new instance of the component for the given scene
  43524. * @param scene Defines the scene to register the component in
  43525. */
  43526. constructor(scene: Scene);
  43527. /**
  43528. * Registers the component in a given scene
  43529. */
  43530. register(): void;
  43531. /**
  43532. * Rebuilds the elements related to this component in case of
  43533. * context lost for instance.
  43534. */
  43535. rebuild(): void;
  43536. /**
  43537. * Serializes the component data to the specified json object
  43538. * @param serializationObject The object to serialize to
  43539. */
  43540. serialize(serializationObject: any): void;
  43541. /**
  43542. * Adds all the elements from the container to the scene
  43543. * @param container the container holding the elements
  43544. */
  43545. addFromContainer(container: AbstractScene): void;
  43546. /**
  43547. * Removes all the elements in the container from the scene
  43548. * @param container contains the elements to remove
  43549. * @param dispose if the removed element should be disposed (default: false)
  43550. */
  43551. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43552. /**
  43553. * Disposes the component and the associated ressources.
  43554. */
  43555. dispose(): void;
  43556. /**
  43557. * Disables audio in the associated scene.
  43558. */
  43559. disableAudio(): void;
  43560. /**
  43561. * Enables audio in the associated scene.
  43562. */
  43563. enableAudio(): void;
  43564. /**
  43565. * Switch audio to headphone output.
  43566. */
  43567. switchAudioModeForHeadphones(): void;
  43568. /**
  43569. * Switch audio to normal speakers.
  43570. */
  43571. switchAudioModeForNormalSpeakers(): void;
  43572. private _cachedCameraDirection;
  43573. private _cachedCameraPosition;
  43574. private _lastCheck;
  43575. private _afterRender;
  43576. }
  43577. }
  43578. declare module "babylonjs/Audio/weightedsound" {
  43579. import { Sound } from "babylonjs/Audio/sound";
  43580. /**
  43581. * Wraps one or more Sound objects and selects one with random weight for playback.
  43582. */
  43583. export class WeightedSound {
  43584. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43585. loop: boolean;
  43586. private _coneInnerAngle;
  43587. private _coneOuterAngle;
  43588. private _volume;
  43589. /** A Sound is currently playing. */
  43590. isPlaying: boolean;
  43591. /** A Sound is currently paused. */
  43592. isPaused: boolean;
  43593. private _sounds;
  43594. private _weights;
  43595. private _currentIndex?;
  43596. /**
  43597. * Creates a new WeightedSound from the list of sounds given.
  43598. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43599. * @param sounds Array of Sounds that will be selected from.
  43600. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43601. */
  43602. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43603. /**
  43604. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43605. */
  43606. get directionalConeInnerAngle(): number;
  43607. /**
  43608. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43609. */
  43610. set directionalConeInnerAngle(value: number);
  43611. /**
  43612. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43613. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43614. */
  43615. get directionalConeOuterAngle(): number;
  43616. /**
  43617. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43618. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43619. */
  43620. set directionalConeOuterAngle(value: number);
  43621. /**
  43622. * Playback volume.
  43623. */
  43624. get volume(): number;
  43625. /**
  43626. * Playback volume.
  43627. */
  43628. set volume(value: number);
  43629. private _onended;
  43630. /**
  43631. * Suspend playback
  43632. */
  43633. pause(): void;
  43634. /**
  43635. * Stop playback
  43636. */
  43637. stop(): void;
  43638. /**
  43639. * Start playback.
  43640. * @param startOffset Position the clip head at a specific time in seconds.
  43641. */
  43642. play(startOffset?: number): void;
  43643. }
  43644. }
  43645. declare module "babylonjs/Audio/index" {
  43646. export * from "babylonjs/Audio/analyser";
  43647. export * from "babylonjs/Audio/audioEngine";
  43648. export * from "babylonjs/Audio/audioSceneComponent";
  43649. export * from "babylonjs/Audio/sound";
  43650. export * from "babylonjs/Audio/soundTrack";
  43651. export * from "babylonjs/Audio/weightedsound";
  43652. }
  43653. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43654. import { Behavior } from "babylonjs/Behaviors/behavior";
  43655. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43656. import { BackEase } from "babylonjs/Animations/easing";
  43657. /**
  43658. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43659. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43660. */
  43661. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43662. /**
  43663. * Gets the name of the behavior.
  43664. */
  43665. get name(): string;
  43666. /**
  43667. * The easing function used by animations
  43668. */
  43669. static EasingFunction: BackEase;
  43670. /**
  43671. * The easing mode used by animations
  43672. */
  43673. static EasingMode: number;
  43674. /**
  43675. * The duration of the animation, in milliseconds
  43676. */
  43677. transitionDuration: number;
  43678. /**
  43679. * Length of the distance animated by the transition when lower radius is reached
  43680. */
  43681. lowerRadiusTransitionRange: number;
  43682. /**
  43683. * Length of the distance animated by the transition when upper radius is reached
  43684. */
  43685. upperRadiusTransitionRange: number;
  43686. private _autoTransitionRange;
  43687. /**
  43688. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43689. */
  43690. get autoTransitionRange(): boolean;
  43691. /**
  43692. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43693. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43694. */
  43695. set autoTransitionRange(value: boolean);
  43696. private _attachedCamera;
  43697. private _onAfterCheckInputsObserver;
  43698. private _onMeshTargetChangedObserver;
  43699. /**
  43700. * Initializes the behavior.
  43701. */
  43702. init(): void;
  43703. /**
  43704. * Attaches the behavior to its arc rotate camera.
  43705. * @param camera Defines the camera to attach the behavior to
  43706. */
  43707. attach(camera: ArcRotateCamera): void;
  43708. /**
  43709. * Detaches the behavior from its current arc rotate camera.
  43710. */
  43711. detach(): void;
  43712. private _radiusIsAnimating;
  43713. private _radiusBounceTransition;
  43714. private _animatables;
  43715. private _cachedWheelPrecision;
  43716. /**
  43717. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43718. * @param radiusLimit The limit to check against.
  43719. * @return Bool to indicate if at limit.
  43720. */
  43721. private _isRadiusAtLimit;
  43722. /**
  43723. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43724. * @param radiusDelta The delta by which to animate to. Can be negative.
  43725. */
  43726. private _applyBoundRadiusAnimation;
  43727. /**
  43728. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43729. */
  43730. protected _clearAnimationLocks(): void;
  43731. /**
  43732. * Stops and removes all animations that have been applied to the camera
  43733. */
  43734. stopAllAnimations(): void;
  43735. }
  43736. }
  43737. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43738. import { Behavior } from "babylonjs/Behaviors/behavior";
  43739. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43740. import { ExponentialEase } from "babylonjs/Animations/easing";
  43741. import { Nullable } from "babylonjs/types";
  43742. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43743. import { Vector3 } from "babylonjs/Maths/math.vector";
  43744. /**
  43745. * 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.
  43746. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43747. */
  43748. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43749. /**
  43750. * Gets the name of the behavior.
  43751. */
  43752. get name(): string;
  43753. private _mode;
  43754. private _radiusScale;
  43755. private _positionScale;
  43756. private _defaultElevation;
  43757. private _elevationReturnTime;
  43758. private _elevationReturnWaitTime;
  43759. private _zoomStopsAnimation;
  43760. private _framingTime;
  43761. /**
  43762. * The easing function used by animations
  43763. */
  43764. static EasingFunction: ExponentialEase;
  43765. /**
  43766. * The easing mode used by animations
  43767. */
  43768. static EasingMode: number;
  43769. /**
  43770. * Sets the current mode used by the behavior
  43771. */
  43772. set mode(mode: number);
  43773. /**
  43774. * Gets current mode used by the behavior.
  43775. */
  43776. get mode(): number;
  43777. /**
  43778. * Sets the scale applied to the radius (1 by default)
  43779. */
  43780. set radiusScale(radius: number);
  43781. /**
  43782. * Gets the scale applied to the radius
  43783. */
  43784. get radiusScale(): number;
  43785. /**
  43786. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43787. */
  43788. set positionScale(scale: number);
  43789. /**
  43790. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43791. */
  43792. get positionScale(): number;
  43793. /**
  43794. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43795. * behaviour is triggered, in radians.
  43796. */
  43797. set defaultElevation(elevation: number);
  43798. /**
  43799. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43800. * behaviour is triggered, in radians.
  43801. */
  43802. get defaultElevation(): number;
  43803. /**
  43804. * Sets the time (in milliseconds) taken to return to the default beta position.
  43805. * Negative value indicates camera should not return to default.
  43806. */
  43807. set elevationReturnTime(speed: number);
  43808. /**
  43809. * Gets the time (in milliseconds) taken to return to the default beta position.
  43810. * Negative value indicates camera should not return to default.
  43811. */
  43812. get elevationReturnTime(): number;
  43813. /**
  43814. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43815. */
  43816. set elevationReturnWaitTime(time: number);
  43817. /**
  43818. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43819. */
  43820. get elevationReturnWaitTime(): number;
  43821. /**
  43822. * Sets the flag that indicates if user zooming should stop animation.
  43823. */
  43824. set zoomStopsAnimation(flag: boolean);
  43825. /**
  43826. * Gets the flag that indicates if user zooming should stop animation.
  43827. */
  43828. get zoomStopsAnimation(): boolean;
  43829. /**
  43830. * Sets the transition time when framing the mesh, in milliseconds
  43831. */
  43832. set framingTime(time: number);
  43833. /**
  43834. * Gets the transition time when framing the mesh, in milliseconds
  43835. */
  43836. get framingTime(): number;
  43837. /**
  43838. * Define if the behavior should automatically change the configured
  43839. * camera limits and sensibilities.
  43840. */
  43841. autoCorrectCameraLimitsAndSensibility: boolean;
  43842. private _onPrePointerObservableObserver;
  43843. private _onAfterCheckInputsObserver;
  43844. private _onMeshTargetChangedObserver;
  43845. private _attachedCamera;
  43846. private _isPointerDown;
  43847. private _lastInteractionTime;
  43848. /**
  43849. * Initializes the behavior.
  43850. */
  43851. init(): void;
  43852. /**
  43853. * Attaches the behavior to its arc rotate camera.
  43854. * @param camera Defines the camera to attach the behavior to
  43855. */
  43856. attach(camera: ArcRotateCamera): void;
  43857. /**
  43858. * Detaches the behavior from its current arc rotate camera.
  43859. */
  43860. detach(): void;
  43861. private _animatables;
  43862. private _betaIsAnimating;
  43863. private _betaTransition;
  43864. private _radiusTransition;
  43865. private _vectorTransition;
  43866. /**
  43867. * Targets the given mesh and updates zoom level accordingly.
  43868. * @param mesh The mesh to target.
  43869. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43870. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43871. */
  43872. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43873. /**
  43874. * Targets the given mesh with its children and updates zoom level accordingly.
  43875. * @param mesh The mesh to target.
  43876. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43877. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43878. */
  43879. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43880. /**
  43881. * Targets the given meshes with their children and updates zoom level accordingly.
  43882. * @param meshes The mesh to target.
  43883. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43884. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43885. */
  43886. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43887. /**
  43888. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  43889. * @param minimumWorld Determines the smaller position of the bounding box extend
  43890. * @param maximumWorld Determines the bigger position of the bounding box extend
  43891. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43892. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43893. */
  43894. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43895. /**
  43896. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  43897. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  43898. * frustum width.
  43899. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  43900. * to fully enclose the mesh in the viewing frustum.
  43901. */
  43902. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  43903. /**
  43904. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  43905. * is automatically returned to its default position (expected to be above ground plane).
  43906. */
  43907. private _maintainCameraAboveGround;
  43908. /**
  43909. * Returns the frustum slope based on the canvas ratio and camera FOV
  43910. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  43911. */
  43912. private _getFrustumSlope;
  43913. /**
  43914. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  43915. */
  43916. private _clearAnimationLocks;
  43917. /**
  43918. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  43919. */
  43920. private _applyUserInteraction;
  43921. /**
  43922. * Stops and removes all animations that have been applied to the camera
  43923. */
  43924. stopAllAnimations(): void;
  43925. /**
  43926. * Gets a value indicating if the user is moving the camera
  43927. */
  43928. get isUserIsMoving(): boolean;
  43929. /**
  43930. * The camera can move all the way towards the mesh.
  43931. */
  43932. static IgnoreBoundsSizeMode: number;
  43933. /**
  43934. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  43935. */
  43936. static FitFrustumSidesMode: number;
  43937. }
  43938. }
  43939. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  43940. import { Nullable } from "babylonjs/types";
  43941. import { Camera } from "babylonjs/Cameras/camera";
  43942. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43943. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43944. /**
  43945. * Base class for Camera Pointer Inputs.
  43946. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  43947. * for example usage.
  43948. */
  43949. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  43950. /**
  43951. * Defines the camera the input is attached to.
  43952. */
  43953. abstract camera: Camera;
  43954. /**
  43955. * Whether keyboard modifier keys are pressed at time of last mouse event.
  43956. */
  43957. protected _altKey: boolean;
  43958. protected _ctrlKey: boolean;
  43959. protected _metaKey: boolean;
  43960. protected _shiftKey: boolean;
  43961. /**
  43962. * Which mouse buttons were pressed at time of last mouse event.
  43963. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  43964. */
  43965. protected _buttonsPressed: number;
  43966. /**
  43967. * Defines the buttons associated with the input to handle camera move.
  43968. */
  43969. buttons: number[];
  43970. /**
  43971. * Attach the input controls to a specific dom element to get the input from.
  43972. * @param element Defines the element the controls should be listened from
  43973. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43974. */
  43975. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43976. /**
  43977. * Detach the current controls from the specified dom element.
  43978. * @param element Defines the element to stop listening the inputs from
  43979. */
  43980. detachControl(element: Nullable<HTMLElement>): void;
  43981. /**
  43982. * Gets the class name of the current input.
  43983. * @returns the class name
  43984. */
  43985. getClassName(): string;
  43986. /**
  43987. * Get the friendly name associated with the input class.
  43988. * @returns the input friendly name
  43989. */
  43990. getSimpleName(): string;
  43991. /**
  43992. * Called on pointer POINTERDOUBLETAP event.
  43993. * Override this method to provide functionality on POINTERDOUBLETAP event.
  43994. */
  43995. protected onDoubleTap(type: string): void;
  43996. /**
  43997. * Called on pointer POINTERMOVE event if only a single touch is active.
  43998. * Override this method to provide functionality.
  43999. */
  44000. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44001. /**
  44002. * Called on pointer POINTERMOVE event if multiple touches are active.
  44003. * Override this method to provide functionality.
  44004. */
  44005. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44006. /**
  44007. * Called on JS contextmenu event.
  44008. * Override this method to provide functionality.
  44009. */
  44010. protected onContextMenu(evt: PointerEvent): void;
  44011. /**
  44012. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44013. * press.
  44014. * Override this method to provide functionality.
  44015. */
  44016. protected onButtonDown(evt: PointerEvent): void;
  44017. /**
  44018. * Called each time a new POINTERUP event occurs. Ie, for each button
  44019. * release.
  44020. * Override this method to provide functionality.
  44021. */
  44022. protected onButtonUp(evt: PointerEvent): void;
  44023. /**
  44024. * Called when window becomes inactive.
  44025. * Override this method to provide functionality.
  44026. */
  44027. protected onLostFocus(): void;
  44028. private _pointerInput;
  44029. private _observer;
  44030. private _onLostFocus;
  44031. private pointA;
  44032. private pointB;
  44033. }
  44034. }
  44035. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  44036. import { Nullable } from "babylonjs/types";
  44037. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44038. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  44039. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44040. /**
  44041. * Manage the pointers inputs to control an arc rotate camera.
  44042. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44043. */
  44044. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  44045. /**
  44046. * Defines the camera the input is attached to.
  44047. */
  44048. camera: ArcRotateCamera;
  44049. /**
  44050. * Gets the class name of the current input.
  44051. * @returns the class name
  44052. */
  44053. getClassName(): string;
  44054. /**
  44055. * Defines the buttons associated with the input to handle camera move.
  44056. */
  44057. buttons: number[];
  44058. /**
  44059. * Defines the pointer angular sensibility along the X axis or how fast is
  44060. * the camera rotating.
  44061. */
  44062. angularSensibilityX: number;
  44063. /**
  44064. * Defines the pointer angular sensibility along the Y axis or how fast is
  44065. * the camera rotating.
  44066. */
  44067. angularSensibilityY: number;
  44068. /**
  44069. * Defines the pointer pinch precision or how fast is the camera zooming.
  44070. */
  44071. pinchPrecision: number;
  44072. /**
  44073. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  44074. * from 0.
  44075. * It defines the percentage of current camera.radius to use as delta when
  44076. * pinch zoom is used.
  44077. */
  44078. pinchDeltaPercentage: number;
  44079. /**
  44080. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44081. * that any object in the plane at the camera's target point will scale
  44082. * perfectly with finger motion.
  44083. * Overrides pinchDeltaPercentage and pinchPrecision.
  44084. */
  44085. useNaturalPinchZoom: boolean;
  44086. /**
  44087. * Defines the pointer panning sensibility or how fast is the camera moving.
  44088. */
  44089. panningSensibility: number;
  44090. /**
  44091. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  44092. */
  44093. multiTouchPanning: boolean;
  44094. /**
  44095. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  44096. * zoom (pinch) through multitouch.
  44097. */
  44098. multiTouchPanAndZoom: boolean;
  44099. /**
  44100. * Revers pinch action direction.
  44101. */
  44102. pinchInwards: boolean;
  44103. private _isPanClick;
  44104. private _twoFingerActivityCount;
  44105. private _isPinching;
  44106. /**
  44107. * Called on pointer POINTERMOVE event if only a single touch is active.
  44108. */
  44109. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44110. /**
  44111. * Called on pointer POINTERDOUBLETAP event.
  44112. */
  44113. protected onDoubleTap(type: string): void;
  44114. /**
  44115. * Called on pointer POINTERMOVE event if multiple touches are active.
  44116. */
  44117. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44118. /**
  44119. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44120. * press.
  44121. */
  44122. protected onButtonDown(evt: PointerEvent): void;
  44123. /**
  44124. * Called each time a new POINTERUP event occurs. Ie, for each button
  44125. * release.
  44126. */
  44127. protected onButtonUp(evt: PointerEvent): void;
  44128. /**
  44129. * Called when window becomes inactive.
  44130. */
  44131. protected onLostFocus(): void;
  44132. }
  44133. }
  44134. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  44135. import { Nullable } from "babylonjs/types";
  44136. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44137. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44138. /**
  44139. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  44140. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44141. */
  44142. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  44143. /**
  44144. * Defines the camera the input is attached to.
  44145. */
  44146. camera: ArcRotateCamera;
  44147. /**
  44148. * Defines the list of key codes associated with the up action (increase alpha)
  44149. */
  44150. keysUp: number[];
  44151. /**
  44152. * Defines the list of key codes associated with the down action (decrease alpha)
  44153. */
  44154. keysDown: number[];
  44155. /**
  44156. * Defines the list of key codes associated with the left action (increase beta)
  44157. */
  44158. keysLeft: number[];
  44159. /**
  44160. * Defines the list of key codes associated with the right action (decrease beta)
  44161. */
  44162. keysRight: number[];
  44163. /**
  44164. * Defines the list of key codes associated with the reset action.
  44165. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  44166. */
  44167. keysReset: number[];
  44168. /**
  44169. * Defines the panning sensibility of the inputs.
  44170. * (How fast is the camera panning)
  44171. */
  44172. panningSensibility: number;
  44173. /**
  44174. * Defines the zooming sensibility of the inputs.
  44175. * (How fast is the camera zooming)
  44176. */
  44177. zoomingSensibility: number;
  44178. /**
  44179. * Defines whether maintaining the alt key down switch the movement mode from
  44180. * orientation to zoom.
  44181. */
  44182. useAltToZoom: boolean;
  44183. /**
  44184. * Rotation speed of the camera
  44185. */
  44186. angularSpeed: number;
  44187. private _keys;
  44188. private _ctrlPressed;
  44189. private _altPressed;
  44190. private _onCanvasBlurObserver;
  44191. private _onKeyboardObserver;
  44192. private _engine;
  44193. private _scene;
  44194. /**
  44195. * Attach the input controls to a specific dom element to get the input from.
  44196. * @param element Defines the element the controls should be listened from
  44197. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44198. */
  44199. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44200. /**
  44201. * Detach the current controls from the specified dom element.
  44202. * @param element Defines the element to stop listening the inputs from
  44203. */
  44204. detachControl(element: Nullable<HTMLElement>): void;
  44205. /**
  44206. * Update the current camera state depending on the inputs that have been used this frame.
  44207. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44208. */
  44209. checkInputs(): void;
  44210. /**
  44211. * Gets the class name of the current intput.
  44212. * @returns the class name
  44213. */
  44214. getClassName(): string;
  44215. /**
  44216. * Get the friendly name associated with the input class.
  44217. * @returns the input friendly name
  44218. */
  44219. getSimpleName(): string;
  44220. }
  44221. }
  44222. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  44223. import { Nullable } from "babylonjs/types";
  44224. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44225. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44226. /**
  44227. * Manage the mouse wheel inputs to control an arc rotate camera.
  44228. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44229. */
  44230. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  44231. /**
  44232. * Defines the camera the input is attached to.
  44233. */
  44234. camera: ArcRotateCamera;
  44235. /**
  44236. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44237. */
  44238. wheelPrecision: number;
  44239. /**
  44240. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44241. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44242. */
  44243. wheelDeltaPercentage: number;
  44244. private _wheel;
  44245. private _observer;
  44246. private computeDeltaFromMouseWheelLegacyEvent;
  44247. /**
  44248. * Attach the input controls to a specific dom element to get the input from.
  44249. * @param element Defines the element the controls should be listened from
  44250. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44251. */
  44252. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44253. /**
  44254. * Detach the current controls from the specified dom element.
  44255. * @param element Defines the element to stop listening the inputs from
  44256. */
  44257. detachControl(element: Nullable<HTMLElement>): void;
  44258. /**
  44259. * Gets the class name of the current intput.
  44260. * @returns the class name
  44261. */
  44262. getClassName(): string;
  44263. /**
  44264. * Get the friendly name associated with the input class.
  44265. * @returns the input friendly name
  44266. */
  44267. getSimpleName(): string;
  44268. }
  44269. }
  44270. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44271. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44272. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44273. /**
  44274. * Default Inputs manager for the ArcRotateCamera.
  44275. * It groups all the default supported inputs for ease of use.
  44276. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44277. */
  44278. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44279. /**
  44280. * Instantiates a new ArcRotateCameraInputsManager.
  44281. * @param camera Defines the camera the inputs belong to
  44282. */
  44283. constructor(camera: ArcRotateCamera);
  44284. /**
  44285. * Add mouse wheel input support to the input manager.
  44286. * @returns the current input manager
  44287. */
  44288. addMouseWheel(): ArcRotateCameraInputsManager;
  44289. /**
  44290. * Add pointers input support to the input manager.
  44291. * @returns the current input manager
  44292. */
  44293. addPointers(): ArcRotateCameraInputsManager;
  44294. /**
  44295. * Add keyboard input support to the input manager.
  44296. * @returns the current input manager
  44297. */
  44298. addKeyboard(): ArcRotateCameraInputsManager;
  44299. }
  44300. }
  44301. declare module "babylonjs/Cameras/arcRotateCamera" {
  44302. import { Observable } from "babylonjs/Misc/observable";
  44303. import { Nullable } from "babylonjs/types";
  44304. import { Scene } from "babylonjs/scene";
  44305. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44306. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44307. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44308. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44309. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44310. import { Camera } from "babylonjs/Cameras/camera";
  44311. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44312. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44313. import { Collider } from "babylonjs/Collisions/collider";
  44314. /**
  44315. * This represents an orbital type of camera.
  44316. *
  44317. * 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.
  44318. * 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.
  44319. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44320. */
  44321. export class ArcRotateCamera extends TargetCamera {
  44322. /**
  44323. * Defines the rotation angle of the camera along the longitudinal axis.
  44324. */
  44325. alpha: number;
  44326. /**
  44327. * Defines the rotation angle of the camera along the latitudinal axis.
  44328. */
  44329. beta: number;
  44330. /**
  44331. * Defines the radius of the camera from it s target point.
  44332. */
  44333. radius: number;
  44334. protected _target: Vector3;
  44335. protected _targetHost: Nullable<AbstractMesh>;
  44336. /**
  44337. * Defines the target point of the camera.
  44338. * The camera looks towards it form the radius distance.
  44339. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  44340. */
  44341. get target(): Vector3;
  44342. set target(value: Vector3);
  44343. /**
  44344. * Define the current local position of the camera in the scene
  44345. */
  44346. get position(): Vector3;
  44347. set position(newPosition: Vector3);
  44348. protected _upToYMatrix: Matrix;
  44349. protected _YToUpMatrix: Matrix;
  44350. /**
  44351. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44352. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44353. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44354. */
  44355. set upVector(vec: Vector3);
  44356. get upVector(): Vector3;
  44357. /**
  44358. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44359. */
  44360. setMatUp(): void;
  44361. /**
  44362. * Current inertia value on the longitudinal axis.
  44363. * The bigger this number the longer it will take for the camera to stop.
  44364. */
  44365. inertialAlphaOffset: number;
  44366. /**
  44367. * Current inertia value on the latitudinal axis.
  44368. * The bigger this number the longer it will take for the camera to stop.
  44369. */
  44370. inertialBetaOffset: number;
  44371. /**
  44372. * Current inertia value on the radius axis.
  44373. * The bigger this number the longer it will take for the camera to stop.
  44374. */
  44375. inertialRadiusOffset: number;
  44376. /**
  44377. * Minimum allowed angle on the longitudinal axis.
  44378. * This can help limiting how the Camera is able to move in the scene.
  44379. */
  44380. lowerAlphaLimit: Nullable<number>;
  44381. /**
  44382. * Maximum allowed angle on the longitudinal axis.
  44383. * This can help limiting how the Camera is able to move in the scene.
  44384. */
  44385. upperAlphaLimit: Nullable<number>;
  44386. /**
  44387. * Minimum allowed angle on the latitudinal axis.
  44388. * This can help limiting how the Camera is able to move in the scene.
  44389. */
  44390. lowerBetaLimit: number;
  44391. /**
  44392. * Maximum allowed angle on the latitudinal axis.
  44393. * This can help limiting how the Camera is able to move in the scene.
  44394. */
  44395. upperBetaLimit: number;
  44396. /**
  44397. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44398. * This can help limiting how the Camera is able to move in the scene.
  44399. */
  44400. lowerRadiusLimit: Nullable<number>;
  44401. /**
  44402. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44403. * This can help limiting how the Camera is able to move in the scene.
  44404. */
  44405. upperRadiusLimit: Nullable<number>;
  44406. /**
  44407. * Defines the current inertia value used during panning of the camera along the X axis.
  44408. */
  44409. inertialPanningX: number;
  44410. /**
  44411. * Defines the current inertia value used during panning of the camera along the Y axis.
  44412. */
  44413. inertialPanningY: number;
  44414. /**
  44415. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44416. * Basically if your fingers moves away from more than this distance you will be considered
  44417. * in pinch mode.
  44418. */
  44419. pinchToPanMaxDistance: number;
  44420. /**
  44421. * Defines the maximum distance the camera can pan.
  44422. * This could help keeping the cammera always in your scene.
  44423. */
  44424. panningDistanceLimit: Nullable<number>;
  44425. /**
  44426. * Defines the target of the camera before paning.
  44427. */
  44428. panningOriginTarget: Vector3;
  44429. /**
  44430. * Defines the value of the inertia used during panning.
  44431. * 0 would mean stop inertia and one would mean no decelleration at all.
  44432. */
  44433. panningInertia: number;
  44434. /**
  44435. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44436. */
  44437. get angularSensibilityX(): number;
  44438. set angularSensibilityX(value: number);
  44439. /**
  44440. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44441. */
  44442. get angularSensibilityY(): number;
  44443. set angularSensibilityY(value: number);
  44444. /**
  44445. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44446. */
  44447. get pinchPrecision(): number;
  44448. set pinchPrecision(value: number);
  44449. /**
  44450. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44451. * It will be used instead of pinchDeltaPrecision if different from 0.
  44452. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44453. */
  44454. get pinchDeltaPercentage(): number;
  44455. set pinchDeltaPercentage(value: number);
  44456. /**
  44457. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44458. * and pinch delta percentage.
  44459. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44460. * that any object in the plane at the camera's target point will scale
  44461. * perfectly with finger motion.
  44462. */
  44463. get useNaturalPinchZoom(): boolean;
  44464. set useNaturalPinchZoom(value: boolean);
  44465. /**
  44466. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44467. */
  44468. get panningSensibility(): number;
  44469. set panningSensibility(value: number);
  44470. /**
  44471. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44472. */
  44473. get keysUp(): number[];
  44474. set keysUp(value: number[]);
  44475. /**
  44476. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44477. */
  44478. get keysDown(): number[];
  44479. set keysDown(value: number[]);
  44480. /**
  44481. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44482. */
  44483. get keysLeft(): number[];
  44484. set keysLeft(value: number[]);
  44485. /**
  44486. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44487. */
  44488. get keysRight(): number[];
  44489. set keysRight(value: number[]);
  44490. /**
  44491. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44492. */
  44493. get wheelPrecision(): number;
  44494. set wheelPrecision(value: number);
  44495. /**
  44496. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44497. * It will be used instead of pinchDeltaPrecision if different from 0.
  44498. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44499. */
  44500. get wheelDeltaPercentage(): number;
  44501. set wheelDeltaPercentage(value: number);
  44502. /**
  44503. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44504. */
  44505. zoomOnFactor: number;
  44506. /**
  44507. * Defines a screen offset for the camera position.
  44508. */
  44509. targetScreenOffset: Vector2;
  44510. /**
  44511. * Allows the camera to be completely reversed.
  44512. * If false the camera can not arrive upside down.
  44513. */
  44514. allowUpsideDown: boolean;
  44515. /**
  44516. * Define if double tap/click is used to restore the previously saved state of the camera.
  44517. */
  44518. useInputToRestoreState: boolean;
  44519. /** @hidden */
  44520. _viewMatrix: Matrix;
  44521. /** @hidden */
  44522. _useCtrlForPanning: boolean;
  44523. /** @hidden */
  44524. _panningMouseButton: number;
  44525. /**
  44526. * Defines the input associated to the camera.
  44527. */
  44528. inputs: ArcRotateCameraInputsManager;
  44529. /** @hidden */
  44530. _reset: () => void;
  44531. /**
  44532. * Defines the allowed panning axis.
  44533. */
  44534. panningAxis: Vector3;
  44535. protected _localDirection: Vector3;
  44536. protected _transformedDirection: Vector3;
  44537. private _bouncingBehavior;
  44538. /**
  44539. * Gets the bouncing behavior of the camera if it has been enabled.
  44540. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44541. */
  44542. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44543. /**
  44544. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44545. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44546. */
  44547. get useBouncingBehavior(): boolean;
  44548. set useBouncingBehavior(value: boolean);
  44549. private _framingBehavior;
  44550. /**
  44551. * Gets the framing behavior of the camera if it has been enabled.
  44552. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44553. */
  44554. get framingBehavior(): Nullable<FramingBehavior>;
  44555. /**
  44556. * Defines if the framing behavior of the camera is enabled on the camera.
  44557. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44558. */
  44559. get useFramingBehavior(): boolean;
  44560. set useFramingBehavior(value: boolean);
  44561. private _autoRotationBehavior;
  44562. /**
  44563. * Gets the auto rotation behavior of the camera if it has been enabled.
  44564. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44565. */
  44566. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44567. /**
  44568. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44569. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44570. */
  44571. get useAutoRotationBehavior(): boolean;
  44572. set useAutoRotationBehavior(value: boolean);
  44573. /**
  44574. * Observable triggered when the mesh target has been changed on the camera.
  44575. */
  44576. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44577. /**
  44578. * Event raised when the camera is colliding with a mesh.
  44579. */
  44580. onCollide: (collidedMesh: AbstractMesh) => void;
  44581. /**
  44582. * Defines whether the camera should check collision with the objects oh the scene.
  44583. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44584. */
  44585. checkCollisions: boolean;
  44586. /**
  44587. * Defines the collision radius of the camera.
  44588. * This simulates a sphere around the camera.
  44589. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44590. */
  44591. collisionRadius: Vector3;
  44592. protected _collider: Collider;
  44593. protected _previousPosition: Vector3;
  44594. protected _collisionVelocity: Vector3;
  44595. protected _newPosition: Vector3;
  44596. protected _previousAlpha: number;
  44597. protected _previousBeta: number;
  44598. protected _previousRadius: number;
  44599. protected _collisionTriggered: boolean;
  44600. protected _targetBoundingCenter: Nullable<Vector3>;
  44601. private _computationVector;
  44602. /**
  44603. * Instantiates a new ArcRotateCamera in a given scene
  44604. * @param name Defines the name of the camera
  44605. * @param alpha Defines the camera rotation along the logitudinal axis
  44606. * @param beta Defines the camera rotation along the latitudinal axis
  44607. * @param radius Defines the camera distance from its target
  44608. * @param target Defines the camera target
  44609. * @param scene Defines the scene the camera belongs to
  44610. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44611. */
  44612. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44613. /** @hidden */
  44614. _initCache(): void;
  44615. /** @hidden */
  44616. _updateCache(ignoreParentClass?: boolean): void;
  44617. protected _getTargetPosition(): Vector3;
  44618. private _storedAlpha;
  44619. private _storedBeta;
  44620. private _storedRadius;
  44621. private _storedTarget;
  44622. private _storedTargetScreenOffset;
  44623. /**
  44624. * Stores the current state of the camera (alpha, beta, radius and target)
  44625. * @returns the camera itself
  44626. */
  44627. storeState(): Camera;
  44628. /**
  44629. * @hidden
  44630. * Restored camera state. You must call storeState() first
  44631. */
  44632. _restoreStateValues(): boolean;
  44633. /** @hidden */
  44634. _isSynchronizedViewMatrix(): boolean;
  44635. /**
  44636. * Attached controls to the current camera.
  44637. * @param element Defines the element the controls should be listened from
  44638. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44639. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44640. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44641. */
  44642. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44643. /**
  44644. * Detach the current controls from the camera.
  44645. * The camera will stop reacting to inputs.
  44646. * @param element Defines the element to stop listening the inputs from
  44647. */
  44648. detachControl(element: HTMLElement): void;
  44649. /** @hidden */
  44650. _checkInputs(): void;
  44651. protected _checkLimits(): void;
  44652. /**
  44653. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44654. */
  44655. rebuildAnglesAndRadius(): void;
  44656. /**
  44657. * Use a position to define the current camera related information like alpha, beta and radius
  44658. * @param position Defines the position to set the camera at
  44659. */
  44660. setPosition(position: Vector3): void;
  44661. /**
  44662. * Defines the target the camera should look at.
  44663. * This will automatically adapt alpha beta and radius to fit within the new target.
  44664. * @param target Defines the new target as a Vector or a mesh
  44665. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44666. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44667. */
  44668. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44669. /** @hidden */
  44670. _getViewMatrix(): Matrix;
  44671. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44672. /**
  44673. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44674. * @param meshes Defines the mesh to zoom on
  44675. * @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)
  44676. */
  44677. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44678. /**
  44679. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44680. * The target will be changed but the radius
  44681. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44682. * @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)
  44683. */
  44684. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44685. min: Vector3;
  44686. max: Vector3;
  44687. distance: number;
  44688. }, doNotUpdateMaxZ?: boolean): void;
  44689. /**
  44690. * @override
  44691. * Override Camera.createRigCamera
  44692. */
  44693. createRigCamera(name: string, cameraIndex: number): Camera;
  44694. /**
  44695. * @hidden
  44696. * @override
  44697. * Override Camera._updateRigCameras
  44698. */
  44699. _updateRigCameras(): void;
  44700. /**
  44701. * Destroy the camera and release the current resources hold by it.
  44702. */
  44703. dispose(): void;
  44704. /**
  44705. * Gets the current object class name.
  44706. * @return the class name
  44707. */
  44708. getClassName(): string;
  44709. }
  44710. }
  44711. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44712. import { Behavior } from "babylonjs/Behaviors/behavior";
  44713. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44714. /**
  44715. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44716. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44717. */
  44718. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44719. /**
  44720. * Gets the name of the behavior.
  44721. */
  44722. get name(): string;
  44723. private _zoomStopsAnimation;
  44724. private _idleRotationSpeed;
  44725. private _idleRotationWaitTime;
  44726. private _idleRotationSpinupTime;
  44727. /**
  44728. * Sets the flag that indicates if user zooming should stop animation.
  44729. */
  44730. set zoomStopsAnimation(flag: boolean);
  44731. /**
  44732. * Gets the flag that indicates if user zooming should stop animation.
  44733. */
  44734. get zoomStopsAnimation(): boolean;
  44735. /**
  44736. * Sets the default speed at which the camera rotates around the model.
  44737. */
  44738. set idleRotationSpeed(speed: number);
  44739. /**
  44740. * Gets the default speed at which the camera rotates around the model.
  44741. */
  44742. get idleRotationSpeed(): number;
  44743. /**
  44744. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44745. */
  44746. set idleRotationWaitTime(time: number);
  44747. /**
  44748. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44749. */
  44750. get idleRotationWaitTime(): number;
  44751. /**
  44752. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44753. */
  44754. set idleRotationSpinupTime(time: number);
  44755. /**
  44756. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44757. */
  44758. get idleRotationSpinupTime(): number;
  44759. /**
  44760. * Gets a value indicating if the camera is currently rotating because of this behavior
  44761. */
  44762. get rotationInProgress(): boolean;
  44763. private _onPrePointerObservableObserver;
  44764. private _onAfterCheckInputsObserver;
  44765. private _attachedCamera;
  44766. private _isPointerDown;
  44767. private _lastFrameTime;
  44768. private _lastInteractionTime;
  44769. private _cameraRotationSpeed;
  44770. /**
  44771. * Initializes the behavior.
  44772. */
  44773. init(): void;
  44774. /**
  44775. * Attaches the behavior to its arc rotate camera.
  44776. * @param camera Defines the camera to attach the behavior to
  44777. */
  44778. attach(camera: ArcRotateCamera): void;
  44779. /**
  44780. * Detaches the behavior from its current arc rotate camera.
  44781. */
  44782. detach(): void;
  44783. /**
  44784. * Returns true if user is scrolling.
  44785. * @return true if user is scrolling.
  44786. */
  44787. private _userIsZooming;
  44788. private _lastFrameRadius;
  44789. private _shouldAnimationStopForInteraction;
  44790. /**
  44791. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44792. */
  44793. private _applyUserInteraction;
  44794. private _userIsMoving;
  44795. }
  44796. }
  44797. declare module "babylonjs/Behaviors/Cameras/index" {
  44798. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44799. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44800. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44801. }
  44802. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44803. import { Mesh } from "babylonjs/Meshes/mesh";
  44804. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44805. import { Behavior } from "babylonjs/Behaviors/behavior";
  44806. /**
  44807. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44808. */
  44809. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44810. private ui;
  44811. /**
  44812. * The name of the behavior
  44813. */
  44814. name: string;
  44815. /**
  44816. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44817. */
  44818. distanceAwayFromFace: number;
  44819. /**
  44820. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44821. */
  44822. distanceAwayFromBottomOfFace: number;
  44823. private _faceVectors;
  44824. private _target;
  44825. private _scene;
  44826. private _onRenderObserver;
  44827. private _tmpMatrix;
  44828. private _tmpVector;
  44829. /**
  44830. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44831. * @param ui The transform node that should be attched to the mesh
  44832. */
  44833. constructor(ui: TransformNode);
  44834. /**
  44835. * Initializes the behavior
  44836. */
  44837. init(): void;
  44838. private _closestFace;
  44839. private _zeroVector;
  44840. private _lookAtTmpMatrix;
  44841. private _lookAtToRef;
  44842. /**
  44843. * Attaches the AttachToBoxBehavior to the passed in mesh
  44844. * @param target The mesh that the specified node will be attached to
  44845. */
  44846. attach(target: Mesh): void;
  44847. /**
  44848. * Detaches the behavior from the mesh
  44849. */
  44850. detach(): void;
  44851. }
  44852. }
  44853. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44854. import { Behavior } from "babylonjs/Behaviors/behavior";
  44855. import { Mesh } from "babylonjs/Meshes/mesh";
  44856. /**
  44857. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44858. */
  44859. export class FadeInOutBehavior implements Behavior<Mesh> {
  44860. /**
  44861. * Time in milliseconds to delay before fading in (Default: 0)
  44862. */
  44863. delay: number;
  44864. /**
  44865. * Time in milliseconds for the mesh to fade in (Default: 300)
  44866. */
  44867. fadeInTime: number;
  44868. private _millisecondsPerFrame;
  44869. private _hovered;
  44870. private _hoverValue;
  44871. private _ownerNode;
  44872. /**
  44873. * Instatiates the FadeInOutBehavior
  44874. */
  44875. constructor();
  44876. /**
  44877. * The name of the behavior
  44878. */
  44879. get name(): string;
  44880. /**
  44881. * Initializes the behavior
  44882. */
  44883. init(): void;
  44884. /**
  44885. * Attaches the fade behavior on the passed in mesh
  44886. * @param ownerNode The mesh that will be faded in/out once attached
  44887. */
  44888. attach(ownerNode: Mesh): void;
  44889. /**
  44890. * Detaches the behavior from the mesh
  44891. */
  44892. detach(): void;
  44893. /**
  44894. * Triggers the mesh to begin fading in or out
  44895. * @param value if the object should fade in or out (true to fade in)
  44896. */
  44897. fadeIn(value: boolean): void;
  44898. private _update;
  44899. private _setAllVisibility;
  44900. }
  44901. }
  44902. declare module "babylonjs/Misc/pivotTools" {
  44903. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44904. /**
  44905. * Class containing a set of static utilities functions for managing Pivots
  44906. * @hidden
  44907. */
  44908. export class PivotTools {
  44909. private static _PivotCached;
  44910. private static _OldPivotPoint;
  44911. private static _PivotTranslation;
  44912. private static _PivotTmpVector;
  44913. /** @hidden */
  44914. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  44915. /** @hidden */
  44916. static _RestorePivotPoint(mesh: AbstractMesh): void;
  44917. }
  44918. }
  44919. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  44920. import { Scene } from "babylonjs/scene";
  44921. import { Vector4 } from "babylonjs/Maths/math.vector";
  44922. import { Mesh } from "babylonjs/Meshes/mesh";
  44923. import { Nullable } from "babylonjs/types";
  44924. import { Plane } from "babylonjs/Maths/math.plane";
  44925. /**
  44926. * Class containing static functions to help procedurally build meshes
  44927. */
  44928. export class PlaneBuilder {
  44929. /**
  44930. * Creates a plane mesh
  44931. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  44932. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  44933. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  44934. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44935. * * 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
  44936. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44937. * @param name defines the name of the mesh
  44938. * @param options defines the options used to create the mesh
  44939. * @param scene defines the hosting scene
  44940. * @returns the plane mesh
  44941. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  44942. */
  44943. static CreatePlane(name: string, options: {
  44944. size?: number;
  44945. width?: number;
  44946. height?: number;
  44947. sideOrientation?: number;
  44948. frontUVs?: Vector4;
  44949. backUVs?: Vector4;
  44950. updatable?: boolean;
  44951. sourcePlane?: Plane;
  44952. }, scene?: Nullable<Scene>): Mesh;
  44953. }
  44954. }
  44955. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  44956. import { Behavior } from "babylonjs/Behaviors/behavior";
  44957. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44958. import { Observable } from "babylonjs/Misc/observable";
  44959. import { Vector3 } from "babylonjs/Maths/math.vector";
  44960. import { Ray } from "babylonjs/Culling/ray";
  44961. import "babylonjs/Meshes/Builders/planeBuilder";
  44962. /**
  44963. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  44964. */
  44965. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  44966. private static _AnyMouseID;
  44967. /**
  44968. * Abstract mesh the behavior is set on
  44969. */
  44970. attachedNode: AbstractMesh;
  44971. private _dragPlane;
  44972. private _scene;
  44973. private _pointerObserver;
  44974. private _beforeRenderObserver;
  44975. private static _planeScene;
  44976. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  44977. /**
  44978. * 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)
  44979. */
  44980. maxDragAngle: number;
  44981. /**
  44982. * @hidden
  44983. */
  44984. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  44985. /**
  44986. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44987. */
  44988. currentDraggingPointerID: number;
  44989. /**
  44990. * The last position where the pointer hit the drag plane in world space
  44991. */
  44992. lastDragPosition: Vector3;
  44993. /**
  44994. * If the behavior is currently in a dragging state
  44995. */
  44996. dragging: boolean;
  44997. /**
  44998. * 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)
  44999. */
  45000. dragDeltaRatio: number;
  45001. /**
  45002. * If the drag plane orientation should be updated during the dragging (Default: true)
  45003. */
  45004. updateDragPlane: boolean;
  45005. private _debugMode;
  45006. private _moving;
  45007. /**
  45008. * Fires each time the attached mesh is dragged with the pointer
  45009. * * delta between last drag position and current drag position in world space
  45010. * * dragDistance along the drag axis
  45011. * * dragPlaneNormal normal of the current drag plane used during the drag
  45012. * * dragPlanePoint in world space where the drag intersects the drag plane
  45013. */
  45014. onDragObservable: Observable<{
  45015. delta: Vector3;
  45016. dragPlanePoint: Vector3;
  45017. dragPlaneNormal: Vector3;
  45018. dragDistance: number;
  45019. pointerId: number;
  45020. }>;
  45021. /**
  45022. * Fires each time a drag begins (eg. mouse down on mesh)
  45023. */
  45024. onDragStartObservable: Observable<{
  45025. dragPlanePoint: Vector3;
  45026. pointerId: number;
  45027. }>;
  45028. /**
  45029. * Fires each time a drag ends (eg. mouse release after drag)
  45030. */
  45031. onDragEndObservable: Observable<{
  45032. dragPlanePoint: Vector3;
  45033. pointerId: number;
  45034. }>;
  45035. /**
  45036. * If the attached mesh should be moved when dragged
  45037. */
  45038. moveAttached: boolean;
  45039. /**
  45040. * If the drag behavior will react to drag events (Default: true)
  45041. */
  45042. enabled: boolean;
  45043. /**
  45044. * If pointer events should start and release the drag (Default: true)
  45045. */
  45046. startAndReleaseDragOnPointerEvents: boolean;
  45047. /**
  45048. * If camera controls should be detached during the drag
  45049. */
  45050. detachCameraControls: boolean;
  45051. /**
  45052. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  45053. */
  45054. useObjectOrientationForDragging: boolean;
  45055. private _options;
  45056. /**
  45057. * Gets the options used by the behavior
  45058. */
  45059. get options(): {
  45060. dragAxis?: Vector3;
  45061. dragPlaneNormal?: Vector3;
  45062. };
  45063. /**
  45064. * Sets the options used by the behavior
  45065. */
  45066. set options(options: {
  45067. dragAxis?: Vector3;
  45068. dragPlaneNormal?: Vector3;
  45069. });
  45070. /**
  45071. * Creates a pointer drag behavior that can be attached to a mesh
  45072. * @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)
  45073. */
  45074. constructor(options?: {
  45075. dragAxis?: Vector3;
  45076. dragPlaneNormal?: Vector3;
  45077. });
  45078. /**
  45079. * Predicate to determine if it is valid to move the object to a new position when it is moved
  45080. */
  45081. validateDrag: (targetPosition: Vector3) => boolean;
  45082. /**
  45083. * The name of the behavior
  45084. */
  45085. get name(): string;
  45086. /**
  45087. * Initializes the behavior
  45088. */
  45089. init(): void;
  45090. private _tmpVector;
  45091. private _alternatePickedPoint;
  45092. private _worldDragAxis;
  45093. private _targetPosition;
  45094. private _attachedElement;
  45095. /**
  45096. * Attaches the drag behavior the passed in mesh
  45097. * @param ownerNode The mesh that will be dragged around once attached
  45098. * @param predicate Predicate to use for pick filtering
  45099. */
  45100. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  45101. /**
  45102. * Force relase the drag action by code.
  45103. */
  45104. releaseDrag(): void;
  45105. private _startDragRay;
  45106. private _lastPointerRay;
  45107. /**
  45108. * Simulates the start of a pointer drag event on the behavior
  45109. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  45110. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  45111. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  45112. */
  45113. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45114. private _startDrag;
  45115. private _dragDelta;
  45116. private _moveDrag;
  45117. private _pickWithRayOnDragPlane;
  45118. private _pointA;
  45119. private _pointC;
  45120. private _localAxis;
  45121. private _lookAt;
  45122. private _updateDragPlanePosition;
  45123. /**
  45124. * Detaches the behavior from the mesh
  45125. */
  45126. detach(): void;
  45127. }
  45128. }
  45129. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  45130. import { Mesh } from "babylonjs/Meshes/mesh";
  45131. import { Behavior } from "babylonjs/Behaviors/behavior";
  45132. /**
  45133. * A behavior that when attached to a mesh will allow the mesh to be scaled
  45134. */
  45135. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  45136. private _dragBehaviorA;
  45137. private _dragBehaviorB;
  45138. private _startDistance;
  45139. private _initialScale;
  45140. private _targetScale;
  45141. private _ownerNode;
  45142. private _sceneRenderObserver;
  45143. /**
  45144. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  45145. */
  45146. constructor();
  45147. /**
  45148. * The name of the behavior
  45149. */
  45150. get name(): string;
  45151. /**
  45152. * Initializes the behavior
  45153. */
  45154. init(): void;
  45155. private _getCurrentDistance;
  45156. /**
  45157. * Attaches the scale behavior the passed in mesh
  45158. * @param ownerNode The mesh that will be scaled around once attached
  45159. */
  45160. attach(ownerNode: Mesh): void;
  45161. /**
  45162. * Detaches the behavior from the mesh
  45163. */
  45164. detach(): void;
  45165. }
  45166. }
  45167. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  45168. import { Behavior } from "babylonjs/Behaviors/behavior";
  45169. import { Mesh } from "babylonjs/Meshes/mesh";
  45170. import { Observable } from "babylonjs/Misc/observable";
  45171. /**
  45172. * 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
  45173. */
  45174. export class SixDofDragBehavior implements Behavior<Mesh> {
  45175. private static _virtualScene;
  45176. private _ownerNode;
  45177. private _sceneRenderObserver;
  45178. private _scene;
  45179. private _targetPosition;
  45180. private _virtualOriginMesh;
  45181. private _virtualDragMesh;
  45182. private _pointerObserver;
  45183. private _moving;
  45184. private _startingOrientation;
  45185. private _attachedElement;
  45186. /**
  45187. * 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)
  45188. */
  45189. private zDragFactor;
  45190. /**
  45191. * If the object should rotate to face the drag origin
  45192. */
  45193. rotateDraggedObject: boolean;
  45194. /**
  45195. * If the behavior is currently in a dragging state
  45196. */
  45197. dragging: boolean;
  45198. /**
  45199. * 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)
  45200. */
  45201. dragDeltaRatio: number;
  45202. /**
  45203. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45204. */
  45205. currentDraggingPointerID: number;
  45206. /**
  45207. * If camera controls should be detached during the drag
  45208. */
  45209. detachCameraControls: boolean;
  45210. /**
  45211. * Fires each time a drag starts
  45212. */
  45213. onDragStartObservable: Observable<{}>;
  45214. /**
  45215. * Fires each time a drag ends (eg. mouse release after drag)
  45216. */
  45217. onDragEndObservable: Observable<{}>;
  45218. /**
  45219. * 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
  45220. */
  45221. constructor();
  45222. /**
  45223. * The name of the behavior
  45224. */
  45225. get name(): string;
  45226. /**
  45227. * Initializes the behavior
  45228. */
  45229. init(): void;
  45230. /**
  45231. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  45232. */
  45233. private get _pointerCamera();
  45234. /**
  45235. * Attaches the scale behavior the passed in mesh
  45236. * @param ownerNode The mesh that will be scaled around once attached
  45237. */
  45238. attach(ownerNode: Mesh): void;
  45239. /**
  45240. * Detaches the behavior from the mesh
  45241. */
  45242. detach(): void;
  45243. }
  45244. }
  45245. declare module "babylonjs/Behaviors/Meshes/index" {
  45246. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  45247. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  45248. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  45249. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45250. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  45251. }
  45252. declare module "babylonjs/Behaviors/index" {
  45253. export * from "babylonjs/Behaviors/behavior";
  45254. export * from "babylonjs/Behaviors/Cameras/index";
  45255. export * from "babylonjs/Behaviors/Meshes/index";
  45256. }
  45257. declare module "babylonjs/Bones/boneIKController" {
  45258. import { Bone } from "babylonjs/Bones/bone";
  45259. import { Vector3 } from "babylonjs/Maths/math.vector";
  45260. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45261. import { Nullable } from "babylonjs/types";
  45262. /**
  45263. * Class used to apply inverse kinematics to bones
  45264. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  45265. */
  45266. export class BoneIKController {
  45267. private static _tmpVecs;
  45268. private static _tmpQuat;
  45269. private static _tmpMats;
  45270. /**
  45271. * Gets or sets the target mesh
  45272. */
  45273. targetMesh: AbstractMesh;
  45274. /** Gets or sets the mesh used as pole */
  45275. poleTargetMesh: AbstractMesh;
  45276. /**
  45277. * Gets or sets the bone used as pole
  45278. */
  45279. poleTargetBone: Nullable<Bone>;
  45280. /**
  45281. * Gets or sets the target position
  45282. */
  45283. targetPosition: Vector3;
  45284. /**
  45285. * Gets or sets the pole target position
  45286. */
  45287. poleTargetPosition: Vector3;
  45288. /**
  45289. * Gets or sets the pole target local offset
  45290. */
  45291. poleTargetLocalOffset: Vector3;
  45292. /**
  45293. * Gets or sets the pole angle
  45294. */
  45295. poleAngle: number;
  45296. /**
  45297. * Gets or sets the mesh associated with the controller
  45298. */
  45299. mesh: AbstractMesh;
  45300. /**
  45301. * 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)
  45302. */
  45303. slerpAmount: number;
  45304. private _bone1Quat;
  45305. private _bone1Mat;
  45306. private _bone2Ang;
  45307. private _bone1;
  45308. private _bone2;
  45309. private _bone1Length;
  45310. private _bone2Length;
  45311. private _maxAngle;
  45312. private _maxReach;
  45313. private _rightHandedSystem;
  45314. private _bendAxis;
  45315. private _slerping;
  45316. private _adjustRoll;
  45317. /**
  45318. * Gets or sets maximum allowed angle
  45319. */
  45320. get maxAngle(): number;
  45321. set maxAngle(value: number);
  45322. /**
  45323. * Creates a new BoneIKController
  45324. * @param mesh defines the mesh to control
  45325. * @param bone defines the bone to control
  45326. * @param options defines options to set up the controller
  45327. */
  45328. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45329. targetMesh?: AbstractMesh;
  45330. poleTargetMesh?: AbstractMesh;
  45331. poleTargetBone?: Bone;
  45332. poleTargetLocalOffset?: Vector3;
  45333. poleAngle?: number;
  45334. bendAxis?: Vector3;
  45335. maxAngle?: number;
  45336. slerpAmount?: number;
  45337. });
  45338. private _setMaxAngle;
  45339. /**
  45340. * Force the controller to update the bones
  45341. */
  45342. update(): void;
  45343. }
  45344. }
  45345. declare module "babylonjs/Bones/boneLookController" {
  45346. import { Vector3 } from "babylonjs/Maths/math.vector";
  45347. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45348. import { Bone } from "babylonjs/Bones/bone";
  45349. import { Space } from "babylonjs/Maths/math.axis";
  45350. /**
  45351. * Class used to make a bone look toward a point in space
  45352. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45353. */
  45354. export class BoneLookController {
  45355. private static _tmpVecs;
  45356. private static _tmpQuat;
  45357. private static _tmpMats;
  45358. /**
  45359. * The target Vector3 that the bone will look at
  45360. */
  45361. target: Vector3;
  45362. /**
  45363. * The mesh that the bone is attached to
  45364. */
  45365. mesh: AbstractMesh;
  45366. /**
  45367. * The bone that will be looking to the target
  45368. */
  45369. bone: Bone;
  45370. /**
  45371. * The up axis of the coordinate system that is used when the bone is rotated
  45372. */
  45373. upAxis: Vector3;
  45374. /**
  45375. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45376. */
  45377. upAxisSpace: Space;
  45378. /**
  45379. * Used to make an adjustment to the yaw of the bone
  45380. */
  45381. adjustYaw: number;
  45382. /**
  45383. * Used to make an adjustment to the pitch of the bone
  45384. */
  45385. adjustPitch: number;
  45386. /**
  45387. * Used to make an adjustment to the roll of the bone
  45388. */
  45389. adjustRoll: number;
  45390. /**
  45391. * 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)
  45392. */
  45393. slerpAmount: number;
  45394. private _minYaw;
  45395. private _maxYaw;
  45396. private _minPitch;
  45397. private _maxPitch;
  45398. private _minYawSin;
  45399. private _minYawCos;
  45400. private _maxYawSin;
  45401. private _maxYawCos;
  45402. private _midYawConstraint;
  45403. private _minPitchTan;
  45404. private _maxPitchTan;
  45405. private _boneQuat;
  45406. private _slerping;
  45407. private _transformYawPitch;
  45408. private _transformYawPitchInv;
  45409. private _firstFrameSkipped;
  45410. private _yawRange;
  45411. private _fowardAxis;
  45412. /**
  45413. * Gets or sets the minimum yaw angle that the bone can look to
  45414. */
  45415. get minYaw(): number;
  45416. set minYaw(value: number);
  45417. /**
  45418. * Gets or sets the maximum yaw angle that the bone can look to
  45419. */
  45420. get maxYaw(): number;
  45421. set maxYaw(value: number);
  45422. /**
  45423. * Gets or sets the minimum pitch angle that the bone can look to
  45424. */
  45425. get minPitch(): number;
  45426. set minPitch(value: number);
  45427. /**
  45428. * Gets or sets the maximum pitch angle that the bone can look to
  45429. */
  45430. get maxPitch(): number;
  45431. set maxPitch(value: number);
  45432. /**
  45433. * Create a BoneLookController
  45434. * @param mesh the mesh that the bone belongs to
  45435. * @param bone the bone that will be looking to the target
  45436. * @param target the target Vector3 to look at
  45437. * @param options optional settings:
  45438. * * maxYaw: the maximum angle the bone will yaw to
  45439. * * minYaw: the minimum angle the bone will yaw to
  45440. * * maxPitch: the maximum angle the bone will pitch to
  45441. * * minPitch: the minimum angle the bone will yaw to
  45442. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45443. * * upAxis: the up axis of the coordinate system
  45444. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45445. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45446. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45447. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45448. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45449. * * adjustRoll: used to make an adjustment to the roll of the bone
  45450. **/
  45451. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45452. maxYaw?: number;
  45453. minYaw?: number;
  45454. maxPitch?: number;
  45455. minPitch?: number;
  45456. slerpAmount?: number;
  45457. upAxis?: Vector3;
  45458. upAxisSpace?: Space;
  45459. yawAxis?: Vector3;
  45460. pitchAxis?: Vector3;
  45461. adjustYaw?: number;
  45462. adjustPitch?: number;
  45463. adjustRoll?: number;
  45464. });
  45465. /**
  45466. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45467. */
  45468. update(): void;
  45469. private _getAngleDiff;
  45470. private _getAngleBetween;
  45471. private _isAngleBetween;
  45472. }
  45473. }
  45474. declare module "babylonjs/Bones/index" {
  45475. export * from "babylonjs/Bones/bone";
  45476. export * from "babylonjs/Bones/boneIKController";
  45477. export * from "babylonjs/Bones/boneLookController";
  45478. export * from "babylonjs/Bones/skeleton";
  45479. }
  45480. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45481. import { Nullable } from "babylonjs/types";
  45482. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45483. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45484. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45485. /**
  45486. * Manage the gamepad inputs to control an arc rotate camera.
  45487. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45488. */
  45489. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45490. /**
  45491. * Defines the camera the input is attached to.
  45492. */
  45493. camera: ArcRotateCamera;
  45494. /**
  45495. * Defines the gamepad the input is gathering event from.
  45496. */
  45497. gamepad: Nullable<Gamepad>;
  45498. /**
  45499. * Defines the gamepad rotation sensiblity.
  45500. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45501. */
  45502. gamepadRotationSensibility: number;
  45503. /**
  45504. * Defines the gamepad move sensiblity.
  45505. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45506. */
  45507. gamepadMoveSensibility: number;
  45508. private _yAxisScale;
  45509. /**
  45510. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45511. */
  45512. get invertYAxis(): boolean;
  45513. set invertYAxis(value: boolean);
  45514. private _onGamepadConnectedObserver;
  45515. private _onGamepadDisconnectedObserver;
  45516. /**
  45517. * Attach the input controls to a specific dom element to get the input from.
  45518. * @param element Defines the element the controls should be listened from
  45519. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45520. */
  45521. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45522. /**
  45523. * Detach the current controls from the specified dom element.
  45524. * @param element Defines the element to stop listening the inputs from
  45525. */
  45526. detachControl(element: Nullable<HTMLElement>): void;
  45527. /**
  45528. * Update the current camera state depending on the inputs that have been used this frame.
  45529. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45530. */
  45531. checkInputs(): void;
  45532. /**
  45533. * Gets the class name of the current intput.
  45534. * @returns the class name
  45535. */
  45536. getClassName(): string;
  45537. /**
  45538. * Get the friendly name associated with the input class.
  45539. * @returns the input friendly name
  45540. */
  45541. getSimpleName(): string;
  45542. }
  45543. }
  45544. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45545. import { Nullable } from "babylonjs/types";
  45546. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45547. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45548. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45549. interface ArcRotateCameraInputsManager {
  45550. /**
  45551. * Add orientation input support to the input manager.
  45552. * @returns the current input manager
  45553. */
  45554. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45555. }
  45556. }
  45557. /**
  45558. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45559. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45560. */
  45561. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45562. /**
  45563. * Defines the camera the input is attached to.
  45564. */
  45565. camera: ArcRotateCamera;
  45566. /**
  45567. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45568. */
  45569. alphaCorrection: number;
  45570. /**
  45571. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45572. */
  45573. gammaCorrection: number;
  45574. private _alpha;
  45575. private _gamma;
  45576. private _dirty;
  45577. private _deviceOrientationHandler;
  45578. /**
  45579. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45580. */
  45581. constructor();
  45582. /**
  45583. * Attach the input controls to a specific dom element to get the input from.
  45584. * @param element Defines the element the controls should be listened from
  45585. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45586. */
  45587. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45588. /** @hidden */
  45589. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45590. /**
  45591. * Update the current camera state depending on the inputs that have been used this frame.
  45592. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45593. */
  45594. checkInputs(): void;
  45595. /**
  45596. * Detach the current controls from the specified dom element.
  45597. * @param element Defines the element to stop listening the inputs from
  45598. */
  45599. detachControl(element: Nullable<HTMLElement>): void;
  45600. /**
  45601. * Gets the class name of the current intput.
  45602. * @returns the class name
  45603. */
  45604. getClassName(): string;
  45605. /**
  45606. * Get the friendly name associated with the input class.
  45607. * @returns the input friendly name
  45608. */
  45609. getSimpleName(): string;
  45610. }
  45611. }
  45612. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45613. import { Nullable } from "babylonjs/types";
  45614. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45615. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45616. /**
  45617. * Listen to mouse events to control the camera.
  45618. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45619. */
  45620. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45621. /**
  45622. * Defines the camera the input is attached to.
  45623. */
  45624. camera: FlyCamera;
  45625. /**
  45626. * Defines if touch is enabled. (Default is true.)
  45627. */
  45628. touchEnabled: boolean;
  45629. /**
  45630. * Defines the buttons associated with the input to handle camera rotation.
  45631. */
  45632. buttons: number[];
  45633. /**
  45634. * Assign buttons for Yaw control.
  45635. */
  45636. buttonsYaw: number[];
  45637. /**
  45638. * Assign buttons for Pitch control.
  45639. */
  45640. buttonsPitch: number[];
  45641. /**
  45642. * Assign buttons for Roll control.
  45643. */
  45644. buttonsRoll: number[];
  45645. /**
  45646. * Detect if any button is being pressed while mouse is moved.
  45647. * -1 = Mouse locked.
  45648. * 0 = Left button.
  45649. * 1 = Middle Button.
  45650. * 2 = Right Button.
  45651. */
  45652. activeButton: number;
  45653. /**
  45654. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45655. * Higher values reduce its sensitivity.
  45656. */
  45657. angularSensibility: number;
  45658. private _mousemoveCallback;
  45659. private _observer;
  45660. private _rollObserver;
  45661. private previousPosition;
  45662. private noPreventDefault;
  45663. private element;
  45664. /**
  45665. * Listen to mouse events to control the camera.
  45666. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45667. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45668. */
  45669. constructor(touchEnabled?: boolean);
  45670. /**
  45671. * Attach the mouse control to the HTML DOM element.
  45672. * @param element Defines the element that listens to the input events.
  45673. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45674. */
  45675. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45676. /**
  45677. * Detach the current controls from the specified dom element.
  45678. * @param element Defines the element to stop listening the inputs from
  45679. */
  45680. detachControl(element: Nullable<HTMLElement>): void;
  45681. /**
  45682. * Gets the class name of the current input.
  45683. * @returns the class name.
  45684. */
  45685. getClassName(): string;
  45686. /**
  45687. * Get the friendly name associated with the input class.
  45688. * @returns the input's friendly name.
  45689. */
  45690. getSimpleName(): string;
  45691. private _pointerInput;
  45692. private _onMouseMove;
  45693. /**
  45694. * Rotate camera by mouse offset.
  45695. */
  45696. private rotateCamera;
  45697. }
  45698. }
  45699. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45700. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45701. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45702. /**
  45703. * Default Inputs manager for the FlyCamera.
  45704. * It groups all the default supported inputs for ease of use.
  45705. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45706. */
  45707. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45708. /**
  45709. * Instantiates a new FlyCameraInputsManager.
  45710. * @param camera Defines the camera the inputs belong to.
  45711. */
  45712. constructor(camera: FlyCamera);
  45713. /**
  45714. * Add keyboard input support to the input manager.
  45715. * @returns the new FlyCameraKeyboardMoveInput().
  45716. */
  45717. addKeyboard(): FlyCameraInputsManager;
  45718. /**
  45719. * Add mouse input support to the input manager.
  45720. * @param touchEnabled Enable touch screen support.
  45721. * @returns the new FlyCameraMouseInput().
  45722. */
  45723. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45724. }
  45725. }
  45726. declare module "babylonjs/Cameras/flyCamera" {
  45727. import { Scene } from "babylonjs/scene";
  45728. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45729. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45730. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45731. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45732. /**
  45733. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45734. * such as in a 3D Space Shooter or a Flight Simulator.
  45735. */
  45736. export class FlyCamera extends TargetCamera {
  45737. /**
  45738. * Define the collision ellipsoid of the camera.
  45739. * This is helpful for simulating a camera body, like a player's body.
  45740. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45741. */
  45742. ellipsoid: Vector3;
  45743. /**
  45744. * Define an offset for the position of the ellipsoid around the camera.
  45745. * This can be helpful if the camera is attached away from the player's body center,
  45746. * such as at its head.
  45747. */
  45748. ellipsoidOffset: Vector3;
  45749. /**
  45750. * Enable or disable collisions of the camera with the rest of the scene objects.
  45751. */
  45752. checkCollisions: boolean;
  45753. /**
  45754. * Enable or disable gravity on the camera.
  45755. */
  45756. applyGravity: boolean;
  45757. /**
  45758. * Define the current direction the camera is moving to.
  45759. */
  45760. cameraDirection: Vector3;
  45761. /**
  45762. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45763. * This overrides and empties cameraRotation.
  45764. */
  45765. rotationQuaternion: Quaternion;
  45766. /**
  45767. * Track Roll to maintain the wanted Rolling when looking around.
  45768. */
  45769. _trackRoll: number;
  45770. /**
  45771. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45772. */
  45773. rollCorrect: number;
  45774. /**
  45775. * Mimic a banked turn, Rolling the camera when Yawing.
  45776. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45777. */
  45778. bankedTurn: boolean;
  45779. /**
  45780. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45781. */
  45782. bankedTurnLimit: number;
  45783. /**
  45784. * Value of 0 disables the banked Roll.
  45785. * Value of 1 is equal to the Yaw angle in radians.
  45786. */
  45787. bankedTurnMultiplier: number;
  45788. /**
  45789. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45790. */
  45791. inputs: FlyCameraInputsManager;
  45792. /**
  45793. * Gets the input sensibility for mouse input.
  45794. * Higher values reduce sensitivity.
  45795. */
  45796. get angularSensibility(): number;
  45797. /**
  45798. * Sets the input sensibility for a mouse input.
  45799. * Higher values reduce sensitivity.
  45800. */
  45801. set angularSensibility(value: number);
  45802. /**
  45803. * Get the keys for camera movement forward.
  45804. */
  45805. get keysForward(): number[];
  45806. /**
  45807. * Set the keys for camera movement forward.
  45808. */
  45809. set keysForward(value: number[]);
  45810. /**
  45811. * Get the keys for camera movement backward.
  45812. */
  45813. get keysBackward(): number[];
  45814. set keysBackward(value: number[]);
  45815. /**
  45816. * Get the keys for camera movement up.
  45817. */
  45818. get keysUp(): number[];
  45819. /**
  45820. * Set the keys for camera movement up.
  45821. */
  45822. set keysUp(value: number[]);
  45823. /**
  45824. * Get the keys for camera movement down.
  45825. */
  45826. get keysDown(): number[];
  45827. /**
  45828. * Set the keys for camera movement down.
  45829. */
  45830. set keysDown(value: number[]);
  45831. /**
  45832. * Get the keys for camera movement left.
  45833. */
  45834. get keysLeft(): number[];
  45835. /**
  45836. * Set the keys for camera movement left.
  45837. */
  45838. set keysLeft(value: number[]);
  45839. /**
  45840. * Set the keys for camera movement right.
  45841. */
  45842. get keysRight(): number[];
  45843. /**
  45844. * Set the keys for camera movement right.
  45845. */
  45846. set keysRight(value: number[]);
  45847. /**
  45848. * Event raised when the camera collides with a mesh in the scene.
  45849. */
  45850. onCollide: (collidedMesh: AbstractMesh) => void;
  45851. private _collider;
  45852. private _needMoveForGravity;
  45853. private _oldPosition;
  45854. private _diffPosition;
  45855. private _newPosition;
  45856. /** @hidden */
  45857. _localDirection: Vector3;
  45858. /** @hidden */
  45859. _transformedDirection: Vector3;
  45860. /**
  45861. * Instantiates a FlyCamera.
  45862. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45863. * such as in a 3D Space Shooter or a Flight Simulator.
  45864. * @param name Define the name of the camera in the scene.
  45865. * @param position Define the starting position of the camera in the scene.
  45866. * @param scene Define the scene the camera belongs to.
  45867. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45868. */
  45869. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45870. /**
  45871. * Attach a control to the HTML DOM element.
  45872. * @param element Defines the element that listens to the input events.
  45873. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  45874. */
  45875. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45876. /**
  45877. * Detach a control from the HTML DOM element.
  45878. * The camera will stop reacting to that input.
  45879. * @param element Defines the element that listens to the input events.
  45880. */
  45881. detachControl(element: HTMLElement): void;
  45882. private _collisionMask;
  45883. /**
  45884. * Get the mask that the camera ignores in collision events.
  45885. */
  45886. get collisionMask(): number;
  45887. /**
  45888. * Set the mask that the camera ignores in collision events.
  45889. */
  45890. set collisionMask(mask: number);
  45891. /** @hidden */
  45892. _collideWithWorld(displacement: Vector3): void;
  45893. /** @hidden */
  45894. private _onCollisionPositionChange;
  45895. /** @hidden */
  45896. _checkInputs(): void;
  45897. /** @hidden */
  45898. _decideIfNeedsToMove(): boolean;
  45899. /** @hidden */
  45900. _updatePosition(): void;
  45901. /**
  45902. * Restore the Roll to its target value at the rate specified.
  45903. * @param rate - Higher means slower restoring.
  45904. * @hidden
  45905. */
  45906. restoreRoll(rate: number): void;
  45907. /**
  45908. * Destroy the camera and release the current resources held by it.
  45909. */
  45910. dispose(): void;
  45911. /**
  45912. * Get the current object class name.
  45913. * @returns the class name.
  45914. */
  45915. getClassName(): string;
  45916. }
  45917. }
  45918. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  45919. import { Nullable } from "babylonjs/types";
  45920. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45921. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45922. /**
  45923. * Listen to keyboard events to control the camera.
  45924. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45925. */
  45926. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  45927. /**
  45928. * Defines the camera the input is attached to.
  45929. */
  45930. camera: FlyCamera;
  45931. /**
  45932. * The list of keyboard keys used to control the forward move of the camera.
  45933. */
  45934. keysForward: number[];
  45935. /**
  45936. * The list of keyboard keys used to control the backward move of the camera.
  45937. */
  45938. keysBackward: number[];
  45939. /**
  45940. * The list of keyboard keys used to control the forward move of the camera.
  45941. */
  45942. keysUp: number[];
  45943. /**
  45944. * The list of keyboard keys used to control the backward move of the camera.
  45945. */
  45946. keysDown: number[];
  45947. /**
  45948. * The list of keyboard keys used to control the right strafe move of the camera.
  45949. */
  45950. keysRight: number[];
  45951. /**
  45952. * The list of keyboard keys used to control the left strafe move of the camera.
  45953. */
  45954. keysLeft: number[];
  45955. private _keys;
  45956. private _onCanvasBlurObserver;
  45957. private _onKeyboardObserver;
  45958. private _engine;
  45959. private _scene;
  45960. /**
  45961. * Attach the input controls to a specific dom element to get the input from.
  45962. * @param element Defines the element the controls should be listened from
  45963. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45964. */
  45965. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45966. /**
  45967. * Detach the current controls from the specified dom element.
  45968. * @param element Defines the element to stop listening the inputs from
  45969. */
  45970. detachControl(element: Nullable<HTMLElement>): void;
  45971. /**
  45972. * Gets the class name of the current intput.
  45973. * @returns the class name
  45974. */
  45975. getClassName(): string;
  45976. /** @hidden */
  45977. _onLostFocus(e: FocusEvent): void;
  45978. /**
  45979. * Get the friendly name associated with the input class.
  45980. * @returns the input friendly name
  45981. */
  45982. getSimpleName(): string;
  45983. /**
  45984. * Update the current camera state depending on the inputs that have been used this frame.
  45985. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45986. */
  45987. checkInputs(): void;
  45988. }
  45989. }
  45990. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  45991. import { Nullable } from "babylonjs/types";
  45992. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45993. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45994. /**
  45995. * Manage the mouse wheel inputs to control a follow camera.
  45996. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45997. */
  45998. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  45999. /**
  46000. * Defines the camera the input is attached to.
  46001. */
  46002. camera: FollowCamera;
  46003. /**
  46004. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  46005. */
  46006. axisControlRadius: boolean;
  46007. /**
  46008. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  46009. */
  46010. axisControlHeight: boolean;
  46011. /**
  46012. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  46013. */
  46014. axisControlRotation: boolean;
  46015. /**
  46016. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  46017. * relation to mouseWheel events.
  46018. */
  46019. wheelPrecision: number;
  46020. /**
  46021. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  46022. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  46023. */
  46024. wheelDeltaPercentage: number;
  46025. private _wheel;
  46026. private _observer;
  46027. /**
  46028. * Attach the input controls to a specific dom element to get the input from.
  46029. * @param element Defines the element the controls should be listened from
  46030. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46031. */
  46032. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46033. /**
  46034. * Detach the current controls from the specified dom element.
  46035. * @param element Defines the element to stop listening the inputs from
  46036. */
  46037. detachControl(element: Nullable<HTMLElement>): void;
  46038. /**
  46039. * Gets the class name of the current intput.
  46040. * @returns the class name
  46041. */
  46042. getClassName(): string;
  46043. /**
  46044. * Get the friendly name associated with the input class.
  46045. * @returns the input friendly name
  46046. */
  46047. getSimpleName(): string;
  46048. }
  46049. }
  46050. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  46051. import { Nullable } from "babylonjs/types";
  46052. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46053. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  46054. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  46055. /**
  46056. * Manage the pointers inputs to control an follow camera.
  46057. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46058. */
  46059. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  46060. /**
  46061. * Defines the camera the input is attached to.
  46062. */
  46063. camera: FollowCamera;
  46064. /**
  46065. * Gets the class name of the current input.
  46066. * @returns the class name
  46067. */
  46068. getClassName(): string;
  46069. /**
  46070. * Defines the pointer angular sensibility along the X axis or how fast is
  46071. * the camera rotating.
  46072. * A negative number will reverse the axis direction.
  46073. */
  46074. angularSensibilityX: number;
  46075. /**
  46076. * Defines the pointer angular sensibility along the Y axis or how fast is
  46077. * the camera rotating.
  46078. * A negative number will reverse the axis direction.
  46079. */
  46080. angularSensibilityY: number;
  46081. /**
  46082. * Defines the pointer pinch precision or how fast is the camera zooming.
  46083. * A negative number will reverse the axis direction.
  46084. */
  46085. pinchPrecision: number;
  46086. /**
  46087. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  46088. * from 0.
  46089. * It defines the percentage of current camera.radius to use as delta when
  46090. * pinch zoom is used.
  46091. */
  46092. pinchDeltaPercentage: number;
  46093. /**
  46094. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  46095. */
  46096. axisXControlRadius: boolean;
  46097. /**
  46098. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  46099. */
  46100. axisXControlHeight: boolean;
  46101. /**
  46102. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  46103. */
  46104. axisXControlRotation: boolean;
  46105. /**
  46106. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  46107. */
  46108. axisYControlRadius: boolean;
  46109. /**
  46110. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  46111. */
  46112. axisYControlHeight: boolean;
  46113. /**
  46114. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  46115. */
  46116. axisYControlRotation: boolean;
  46117. /**
  46118. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  46119. */
  46120. axisPinchControlRadius: boolean;
  46121. /**
  46122. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  46123. */
  46124. axisPinchControlHeight: boolean;
  46125. /**
  46126. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  46127. */
  46128. axisPinchControlRotation: boolean;
  46129. /**
  46130. * Log error messages if basic misconfiguration has occurred.
  46131. */
  46132. warningEnable: boolean;
  46133. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46134. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46135. private _warningCounter;
  46136. private _warning;
  46137. }
  46138. }
  46139. declare module "babylonjs/Cameras/followCameraInputsManager" {
  46140. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  46141. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46142. /**
  46143. * Default Inputs manager for the FollowCamera.
  46144. * It groups all the default supported inputs for ease of use.
  46145. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46146. */
  46147. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  46148. /**
  46149. * Instantiates a new FollowCameraInputsManager.
  46150. * @param camera Defines the camera the inputs belong to
  46151. */
  46152. constructor(camera: FollowCamera);
  46153. /**
  46154. * Add keyboard input support to the input manager.
  46155. * @returns the current input manager
  46156. */
  46157. addKeyboard(): FollowCameraInputsManager;
  46158. /**
  46159. * Add mouse wheel input support to the input manager.
  46160. * @returns the current input manager
  46161. */
  46162. addMouseWheel(): FollowCameraInputsManager;
  46163. /**
  46164. * Add pointers input support to the input manager.
  46165. * @returns the current input manager
  46166. */
  46167. addPointers(): FollowCameraInputsManager;
  46168. /**
  46169. * Add orientation input support to the input manager.
  46170. * @returns the current input manager
  46171. */
  46172. addVRDeviceOrientation(): FollowCameraInputsManager;
  46173. }
  46174. }
  46175. declare module "babylonjs/Cameras/followCamera" {
  46176. import { Nullable } from "babylonjs/types";
  46177. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  46178. import { Scene } from "babylonjs/scene";
  46179. import { Vector3 } from "babylonjs/Maths/math.vector";
  46180. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46181. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  46182. /**
  46183. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  46184. * an arc rotate version arcFollowCamera are available.
  46185. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46186. */
  46187. export class FollowCamera extends TargetCamera {
  46188. /**
  46189. * Distance the follow camera should follow an object at
  46190. */
  46191. radius: number;
  46192. /**
  46193. * Minimum allowed distance of the camera to the axis of rotation
  46194. * (The camera can not get closer).
  46195. * This can help limiting how the Camera is able to move in the scene.
  46196. */
  46197. lowerRadiusLimit: Nullable<number>;
  46198. /**
  46199. * Maximum allowed distance of the camera to the axis of rotation
  46200. * (The camera can not get further).
  46201. * This can help limiting how the Camera is able to move in the scene.
  46202. */
  46203. upperRadiusLimit: Nullable<number>;
  46204. /**
  46205. * Define a rotation offset between the camera and the object it follows
  46206. */
  46207. rotationOffset: number;
  46208. /**
  46209. * Minimum allowed angle to camera position relative to target object.
  46210. * This can help limiting how the Camera is able to move in the scene.
  46211. */
  46212. lowerRotationOffsetLimit: Nullable<number>;
  46213. /**
  46214. * Maximum allowed angle to camera position relative to target object.
  46215. * This can help limiting how the Camera is able to move in the scene.
  46216. */
  46217. upperRotationOffsetLimit: Nullable<number>;
  46218. /**
  46219. * Define a height offset between the camera and the object it follows.
  46220. * It can help following an object from the top (like a car chaing a plane)
  46221. */
  46222. heightOffset: number;
  46223. /**
  46224. * Minimum allowed height of camera position relative to target object.
  46225. * This can help limiting how the Camera is able to move in the scene.
  46226. */
  46227. lowerHeightOffsetLimit: Nullable<number>;
  46228. /**
  46229. * Maximum allowed height of camera position relative to target object.
  46230. * This can help limiting how the Camera is able to move in the scene.
  46231. */
  46232. upperHeightOffsetLimit: Nullable<number>;
  46233. /**
  46234. * Define how fast the camera can accelerate to follow it s target.
  46235. */
  46236. cameraAcceleration: number;
  46237. /**
  46238. * Define the speed limit of the camera following an object.
  46239. */
  46240. maxCameraSpeed: number;
  46241. /**
  46242. * Define the target of the camera.
  46243. */
  46244. lockedTarget: Nullable<AbstractMesh>;
  46245. /**
  46246. * Defines the input associated with the camera.
  46247. */
  46248. inputs: FollowCameraInputsManager;
  46249. /**
  46250. * Instantiates the follow camera.
  46251. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46252. * @param name Define the name of the camera in the scene
  46253. * @param position Define the position of the camera
  46254. * @param scene Define the scene the camera belong to
  46255. * @param lockedTarget Define the target of the camera
  46256. */
  46257. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  46258. private _follow;
  46259. /**
  46260. * Attached controls to the current camera.
  46261. * @param element Defines the element the controls should be listened from
  46262. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46263. */
  46264. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46265. /**
  46266. * Detach the current controls from the camera.
  46267. * The camera will stop reacting to inputs.
  46268. * @param element Defines the element to stop listening the inputs from
  46269. */
  46270. detachControl(element: HTMLElement): void;
  46271. /** @hidden */
  46272. _checkInputs(): void;
  46273. private _checkLimits;
  46274. /**
  46275. * Gets the camera class name.
  46276. * @returns the class name
  46277. */
  46278. getClassName(): string;
  46279. }
  46280. /**
  46281. * Arc Rotate version of the follow camera.
  46282. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46283. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46284. */
  46285. export class ArcFollowCamera extends TargetCamera {
  46286. /** The longitudinal angle of the camera */
  46287. alpha: number;
  46288. /** The latitudinal angle of the camera */
  46289. beta: number;
  46290. /** The radius of the camera from its target */
  46291. radius: number;
  46292. private _cartesianCoordinates;
  46293. /** Define the camera target (the mesh it should follow) */
  46294. private _meshTarget;
  46295. /**
  46296. * Instantiates a new ArcFollowCamera
  46297. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46298. * @param name Define the name of the camera
  46299. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46300. * @param beta Define the rotation angle of the camera around the elevation axis
  46301. * @param radius Define the radius of the camera from its target point
  46302. * @param target Define the target of the camera
  46303. * @param scene Define the scene the camera belongs to
  46304. */
  46305. constructor(name: string,
  46306. /** The longitudinal angle of the camera */
  46307. alpha: number,
  46308. /** The latitudinal angle of the camera */
  46309. beta: number,
  46310. /** The radius of the camera from its target */
  46311. radius: number,
  46312. /** Define the camera target (the mesh it should follow) */
  46313. target: Nullable<AbstractMesh>, scene: Scene);
  46314. private _follow;
  46315. /** @hidden */
  46316. _checkInputs(): void;
  46317. /**
  46318. * Returns the class name of the object.
  46319. * It is mostly used internally for serialization purposes.
  46320. */
  46321. getClassName(): string;
  46322. }
  46323. }
  46324. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46325. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46326. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46327. import { Nullable } from "babylonjs/types";
  46328. /**
  46329. * Manage the keyboard inputs to control the movement of a follow camera.
  46330. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46331. */
  46332. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46333. /**
  46334. * Defines the camera the input is attached to.
  46335. */
  46336. camera: FollowCamera;
  46337. /**
  46338. * Defines the list of key codes associated with the up action (increase heightOffset)
  46339. */
  46340. keysHeightOffsetIncr: number[];
  46341. /**
  46342. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46343. */
  46344. keysHeightOffsetDecr: number[];
  46345. /**
  46346. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46347. */
  46348. keysHeightOffsetModifierAlt: boolean;
  46349. /**
  46350. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46351. */
  46352. keysHeightOffsetModifierCtrl: boolean;
  46353. /**
  46354. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46355. */
  46356. keysHeightOffsetModifierShift: boolean;
  46357. /**
  46358. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46359. */
  46360. keysRotationOffsetIncr: number[];
  46361. /**
  46362. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46363. */
  46364. keysRotationOffsetDecr: number[];
  46365. /**
  46366. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46367. */
  46368. keysRotationOffsetModifierAlt: boolean;
  46369. /**
  46370. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46371. */
  46372. keysRotationOffsetModifierCtrl: boolean;
  46373. /**
  46374. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46375. */
  46376. keysRotationOffsetModifierShift: boolean;
  46377. /**
  46378. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46379. */
  46380. keysRadiusIncr: number[];
  46381. /**
  46382. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46383. */
  46384. keysRadiusDecr: number[];
  46385. /**
  46386. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46387. */
  46388. keysRadiusModifierAlt: boolean;
  46389. /**
  46390. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46391. */
  46392. keysRadiusModifierCtrl: boolean;
  46393. /**
  46394. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46395. */
  46396. keysRadiusModifierShift: boolean;
  46397. /**
  46398. * Defines the rate of change of heightOffset.
  46399. */
  46400. heightSensibility: number;
  46401. /**
  46402. * Defines the rate of change of rotationOffset.
  46403. */
  46404. rotationSensibility: number;
  46405. /**
  46406. * Defines the rate of change of radius.
  46407. */
  46408. radiusSensibility: number;
  46409. private _keys;
  46410. private _ctrlPressed;
  46411. private _altPressed;
  46412. private _shiftPressed;
  46413. private _onCanvasBlurObserver;
  46414. private _onKeyboardObserver;
  46415. private _engine;
  46416. private _scene;
  46417. /**
  46418. * Attach the input controls to a specific dom element to get the input from.
  46419. * @param element Defines the element the controls should be listened from
  46420. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46421. */
  46422. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46423. /**
  46424. * Detach the current controls from the specified dom element.
  46425. * @param element Defines the element to stop listening the inputs from
  46426. */
  46427. detachControl(element: Nullable<HTMLElement>): void;
  46428. /**
  46429. * Update the current camera state depending on the inputs that have been used this frame.
  46430. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46431. */
  46432. checkInputs(): void;
  46433. /**
  46434. * Gets the class name of the current input.
  46435. * @returns the class name
  46436. */
  46437. getClassName(): string;
  46438. /**
  46439. * Get the friendly name associated with the input class.
  46440. * @returns the input friendly name
  46441. */
  46442. getSimpleName(): string;
  46443. /**
  46444. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46445. * allow modification of the heightOffset value.
  46446. */
  46447. private _modifierHeightOffset;
  46448. /**
  46449. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46450. * allow modification of the rotationOffset value.
  46451. */
  46452. private _modifierRotationOffset;
  46453. /**
  46454. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46455. * allow modification of the radius value.
  46456. */
  46457. private _modifierRadius;
  46458. }
  46459. }
  46460. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46461. import { Nullable } from "babylonjs/types";
  46462. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46463. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46464. import { Observable } from "babylonjs/Misc/observable";
  46465. module "babylonjs/Cameras/freeCameraInputsManager" {
  46466. interface FreeCameraInputsManager {
  46467. /**
  46468. * @hidden
  46469. */
  46470. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46471. /**
  46472. * Add orientation input support to the input manager.
  46473. * @returns the current input manager
  46474. */
  46475. addDeviceOrientation(): FreeCameraInputsManager;
  46476. }
  46477. }
  46478. /**
  46479. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46480. * Screen rotation is taken into account.
  46481. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46482. */
  46483. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46484. private _camera;
  46485. private _screenOrientationAngle;
  46486. private _constantTranform;
  46487. private _screenQuaternion;
  46488. private _alpha;
  46489. private _beta;
  46490. private _gamma;
  46491. /**
  46492. * Can be used to detect if a device orientation sensor is available on a device
  46493. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46494. * @returns a promise that will resolve on orientation change
  46495. */
  46496. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46497. /**
  46498. * @hidden
  46499. */
  46500. _onDeviceOrientationChangedObservable: Observable<void>;
  46501. /**
  46502. * Instantiates a new input
  46503. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46504. */
  46505. constructor();
  46506. /**
  46507. * Define the camera controlled by the input.
  46508. */
  46509. get camera(): FreeCamera;
  46510. set camera(camera: FreeCamera);
  46511. /**
  46512. * Attach the input controls to a specific dom element to get the input from.
  46513. * @param element Defines the element the controls should be listened from
  46514. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46515. */
  46516. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46517. private _orientationChanged;
  46518. private _deviceOrientation;
  46519. /**
  46520. * Detach the current controls from the specified dom element.
  46521. * @param element Defines the element to stop listening the inputs from
  46522. */
  46523. detachControl(element: Nullable<HTMLElement>): void;
  46524. /**
  46525. * Update the current camera state depending on the inputs that have been used this frame.
  46526. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46527. */
  46528. checkInputs(): void;
  46529. /**
  46530. * Gets the class name of the current intput.
  46531. * @returns the class name
  46532. */
  46533. getClassName(): string;
  46534. /**
  46535. * Get the friendly name associated with the input class.
  46536. * @returns the input friendly name
  46537. */
  46538. getSimpleName(): string;
  46539. }
  46540. }
  46541. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46542. import { Nullable } from "babylonjs/types";
  46543. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46544. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46545. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46546. /**
  46547. * Manage the gamepad inputs to control a free camera.
  46548. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46549. */
  46550. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46551. /**
  46552. * Define the camera the input is attached to.
  46553. */
  46554. camera: FreeCamera;
  46555. /**
  46556. * Define the Gamepad controlling the input
  46557. */
  46558. gamepad: Nullable<Gamepad>;
  46559. /**
  46560. * Defines the gamepad rotation sensiblity.
  46561. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46562. */
  46563. gamepadAngularSensibility: number;
  46564. /**
  46565. * Defines the gamepad move sensiblity.
  46566. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46567. */
  46568. gamepadMoveSensibility: number;
  46569. private _yAxisScale;
  46570. /**
  46571. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46572. */
  46573. get invertYAxis(): boolean;
  46574. set invertYAxis(value: boolean);
  46575. private _onGamepadConnectedObserver;
  46576. private _onGamepadDisconnectedObserver;
  46577. private _cameraTransform;
  46578. private _deltaTransform;
  46579. private _vector3;
  46580. private _vector2;
  46581. /**
  46582. * Attach the input controls to a specific dom element to get the input from.
  46583. * @param element Defines the element the controls should be listened from
  46584. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46585. */
  46586. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46587. /**
  46588. * Detach the current controls from the specified dom element.
  46589. * @param element Defines the element to stop listening the inputs from
  46590. */
  46591. detachControl(element: Nullable<HTMLElement>): void;
  46592. /**
  46593. * Update the current camera state depending on the inputs that have been used this frame.
  46594. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46595. */
  46596. checkInputs(): void;
  46597. /**
  46598. * Gets the class name of the current intput.
  46599. * @returns the class name
  46600. */
  46601. getClassName(): string;
  46602. /**
  46603. * Get the friendly name associated with the input class.
  46604. * @returns the input friendly name
  46605. */
  46606. getSimpleName(): string;
  46607. }
  46608. }
  46609. declare module "babylonjs/Misc/virtualJoystick" {
  46610. import { Nullable } from "babylonjs/types";
  46611. import { Vector3 } from "babylonjs/Maths/math.vector";
  46612. /**
  46613. * Defines the potential axis of a Joystick
  46614. */
  46615. export enum JoystickAxis {
  46616. /** X axis */
  46617. X = 0,
  46618. /** Y axis */
  46619. Y = 1,
  46620. /** Z axis */
  46621. Z = 2
  46622. }
  46623. /**
  46624. * Represents the different customization options available
  46625. * for VirtualJoystick
  46626. */
  46627. interface VirtualJoystickCustomizations {
  46628. /**
  46629. * Size of the joystick's puck
  46630. */
  46631. puckSize: number;
  46632. /**
  46633. * Size of the joystick's container
  46634. */
  46635. containerSize: number;
  46636. /**
  46637. * Color of the joystick && puck
  46638. */
  46639. color: string;
  46640. /**
  46641. * Image URL for the joystick's puck
  46642. */
  46643. puckImage?: string;
  46644. /**
  46645. * Image URL for the joystick's container
  46646. */
  46647. containerImage?: string;
  46648. /**
  46649. * Defines the unmoving position of the joystick container
  46650. */
  46651. position?: {
  46652. x: number;
  46653. y: number;
  46654. };
  46655. /**
  46656. * Defines whether or not the joystick container is always visible
  46657. */
  46658. alwaysVisible: boolean;
  46659. /**
  46660. * Defines whether or not to limit the movement of the puck to the joystick's container
  46661. */
  46662. limitToContainer: boolean;
  46663. }
  46664. /**
  46665. * Class used to define virtual joystick (used in touch mode)
  46666. */
  46667. export class VirtualJoystick {
  46668. /**
  46669. * Gets or sets a boolean indicating that left and right values must be inverted
  46670. */
  46671. reverseLeftRight: boolean;
  46672. /**
  46673. * Gets or sets a boolean indicating that up and down values must be inverted
  46674. */
  46675. reverseUpDown: boolean;
  46676. /**
  46677. * Gets the offset value for the position (ie. the change of the position value)
  46678. */
  46679. deltaPosition: Vector3;
  46680. /**
  46681. * Gets a boolean indicating if the virtual joystick was pressed
  46682. */
  46683. pressed: boolean;
  46684. /**
  46685. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46686. */
  46687. static Canvas: Nullable<HTMLCanvasElement>;
  46688. /**
  46689. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46690. */
  46691. limitToContainer: boolean;
  46692. private static _globalJoystickIndex;
  46693. private static _alwaysVisibleSticks;
  46694. private static vjCanvasContext;
  46695. private static vjCanvasWidth;
  46696. private static vjCanvasHeight;
  46697. private static halfWidth;
  46698. private static _GetDefaultOptions;
  46699. private _action;
  46700. private _axisTargetedByLeftAndRight;
  46701. private _axisTargetedByUpAndDown;
  46702. private _joystickSensibility;
  46703. private _inversedSensibility;
  46704. private _joystickPointerID;
  46705. private _joystickColor;
  46706. private _joystickPointerPos;
  46707. private _joystickPreviousPointerPos;
  46708. private _joystickPointerStartPos;
  46709. private _deltaJoystickVector;
  46710. private _leftJoystick;
  46711. private _touches;
  46712. private _joystickPosition;
  46713. private _alwaysVisible;
  46714. private _puckImage;
  46715. private _containerImage;
  46716. private _joystickPuckSize;
  46717. private _joystickContainerSize;
  46718. private _clearPuckSize;
  46719. private _clearContainerSize;
  46720. private _clearPuckSizeOffset;
  46721. private _clearContainerSizeOffset;
  46722. private _onPointerDownHandlerRef;
  46723. private _onPointerMoveHandlerRef;
  46724. private _onPointerUpHandlerRef;
  46725. private _onResize;
  46726. /**
  46727. * Creates a new virtual joystick
  46728. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46729. * @param customizations Defines the options we want to customize the VirtualJoystick
  46730. */
  46731. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46732. /**
  46733. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46734. * @param newJoystickSensibility defines the new sensibility
  46735. */
  46736. setJoystickSensibility(newJoystickSensibility: number): void;
  46737. private _onPointerDown;
  46738. private _onPointerMove;
  46739. private _onPointerUp;
  46740. /**
  46741. * Change the color of the virtual joystick
  46742. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46743. */
  46744. setJoystickColor(newColor: string): void;
  46745. /**
  46746. * Size of the joystick's container
  46747. */
  46748. set containerSize(newSize: number);
  46749. get containerSize(): number;
  46750. /**
  46751. * Size of the joystick's puck
  46752. */
  46753. set puckSize(newSize: number);
  46754. get puckSize(): number;
  46755. /**
  46756. * Clears the set position of the joystick
  46757. */
  46758. clearPosition(): void;
  46759. /**
  46760. * Defines whether or not the joystick container is always visible
  46761. */
  46762. set alwaysVisible(value: boolean);
  46763. get alwaysVisible(): boolean;
  46764. /**
  46765. * Sets the constant position of the Joystick container
  46766. * @param x X axis coordinate
  46767. * @param y Y axis coordinate
  46768. */
  46769. setPosition(x: number, y: number): void;
  46770. /**
  46771. * Defines a callback to call when the joystick is touched
  46772. * @param action defines the callback
  46773. */
  46774. setActionOnTouch(action: () => any): void;
  46775. /**
  46776. * Defines which axis you'd like to control for left & right
  46777. * @param axis defines the axis to use
  46778. */
  46779. setAxisForLeftRight(axis: JoystickAxis): void;
  46780. /**
  46781. * Defines which axis you'd like to control for up & down
  46782. * @param axis defines the axis to use
  46783. */
  46784. setAxisForUpDown(axis: JoystickAxis): void;
  46785. /**
  46786. * Clears the canvas from the previous puck / container draw
  46787. */
  46788. private _clearPreviousDraw;
  46789. /**
  46790. * Loads `urlPath` to be used for the container's image
  46791. * @param urlPath defines the urlPath of an image to use
  46792. */
  46793. setContainerImage(urlPath: string): void;
  46794. /**
  46795. * Loads `urlPath` to be used for the puck's image
  46796. * @param urlPath defines the urlPath of an image to use
  46797. */
  46798. setPuckImage(urlPath: string): void;
  46799. /**
  46800. * Draws the Virtual Joystick's container
  46801. */
  46802. private _drawContainer;
  46803. /**
  46804. * Draws the Virtual Joystick's puck
  46805. */
  46806. private _drawPuck;
  46807. private _drawVirtualJoystick;
  46808. /**
  46809. * Release internal HTML canvas
  46810. */
  46811. releaseCanvas(): void;
  46812. }
  46813. }
  46814. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46815. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46816. import { Nullable } from "babylonjs/types";
  46817. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46818. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46819. module "babylonjs/Cameras/freeCameraInputsManager" {
  46820. interface FreeCameraInputsManager {
  46821. /**
  46822. * Add virtual joystick input support to the input manager.
  46823. * @returns the current input manager
  46824. */
  46825. addVirtualJoystick(): FreeCameraInputsManager;
  46826. }
  46827. }
  46828. /**
  46829. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46830. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46831. */
  46832. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46833. /**
  46834. * Defines the camera the input is attached to.
  46835. */
  46836. camera: FreeCamera;
  46837. private _leftjoystick;
  46838. private _rightjoystick;
  46839. /**
  46840. * Gets the left stick of the virtual joystick.
  46841. * @returns The virtual Joystick
  46842. */
  46843. getLeftJoystick(): VirtualJoystick;
  46844. /**
  46845. * Gets the right stick of the virtual joystick.
  46846. * @returns The virtual Joystick
  46847. */
  46848. getRightJoystick(): VirtualJoystick;
  46849. /**
  46850. * Update the current camera state depending on the inputs that have been used this frame.
  46851. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46852. */
  46853. checkInputs(): void;
  46854. /**
  46855. * Attach the input controls to a specific dom element to get the input from.
  46856. * @param element Defines the element the controls should be listened from
  46857. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46858. */
  46859. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46860. /**
  46861. * Detach the current controls from the specified dom element.
  46862. * @param element Defines the element to stop listening the inputs from
  46863. */
  46864. detachControl(element: Nullable<HTMLElement>): void;
  46865. /**
  46866. * Gets the class name of the current intput.
  46867. * @returns the class name
  46868. */
  46869. getClassName(): string;
  46870. /**
  46871. * Get the friendly name associated with the input class.
  46872. * @returns the input friendly name
  46873. */
  46874. getSimpleName(): string;
  46875. }
  46876. }
  46877. declare module "babylonjs/Cameras/Inputs/index" {
  46878. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  46879. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  46880. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  46881. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  46882. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  46883. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  46884. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  46885. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  46886. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  46887. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  46888. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46889. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  46890. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  46891. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  46892. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  46893. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  46894. }
  46895. declare module "babylonjs/Cameras/touchCamera" {
  46896. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46897. import { Scene } from "babylonjs/scene";
  46898. import { Vector3 } from "babylonjs/Maths/math.vector";
  46899. /**
  46900. * This represents a FPS type of camera controlled by touch.
  46901. * This is like a universal camera minus the Gamepad controls.
  46902. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46903. */
  46904. export class TouchCamera extends FreeCamera {
  46905. /**
  46906. * Defines the touch sensibility for rotation.
  46907. * The higher the faster.
  46908. */
  46909. get touchAngularSensibility(): number;
  46910. set touchAngularSensibility(value: number);
  46911. /**
  46912. * Defines the touch sensibility for move.
  46913. * The higher the faster.
  46914. */
  46915. get touchMoveSensibility(): number;
  46916. set touchMoveSensibility(value: number);
  46917. /**
  46918. * Instantiates a new touch camera.
  46919. * This represents a FPS type of camera controlled by touch.
  46920. * This is like a universal camera minus the Gamepad controls.
  46921. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46922. * @param name Define the name of the camera in the scene
  46923. * @param position Define the start position of the camera in the scene
  46924. * @param scene Define the scene the camera belongs to
  46925. */
  46926. constructor(name: string, position: Vector3, scene: Scene);
  46927. /**
  46928. * Gets the current object class name.
  46929. * @return the class name
  46930. */
  46931. getClassName(): string;
  46932. /** @hidden */
  46933. _setupInputs(): void;
  46934. }
  46935. }
  46936. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  46937. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46938. import { Scene } from "babylonjs/scene";
  46939. import { Vector3 } from "babylonjs/Maths/math.vector";
  46940. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46941. import { Axis } from "babylonjs/Maths/math.axis";
  46942. /**
  46943. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  46944. * being tilted forward or back and left or right.
  46945. */
  46946. export class DeviceOrientationCamera extends FreeCamera {
  46947. private _initialQuaternion;
  46948. private _quaternionCache;
  46949. private _tmpDragQuaternion;
  46950. private _disablePointerInputWhenUsingDeviceOrientation;
  46951. /**
  46952. * Creates a new device orientation camera
  46953. * @param name The name of the camera
  46954. * @param position The start position camera
  46955. * @param scene The scene the camera belongs to
  46956. */
  46957. constructor(name: string, position: Vector3, scene: Scene);
  46958. /**
  46959. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  46960. */
  46961. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  46962. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  46963. private _dragFactor;
  46964. /**
  46965. * Enabled turning on the y axis when the orientation sensor is active
  46966. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  46967. */
  46968. enableHorizontalDragging(dragFactor?: number): void;
  46969. /**
  46970. * Gets the current instance class name ("DeviceOrientationCamera").
  46971. * This helps avoiding instanceof at run time.
  46972. * @returns the class name
  46973. */
  46974. getClassName(): string;
  46975. /**
  46976. * @hidden
  46977. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  46978. */
  46979. _checkInputs(): void;
  46980. /**
  46981. * Reset the camera to its default orientation on the specified axis only.
  46982. * @param axis The axis to reset
  46983. */
  46984. resetToCurrentRotation(axis?: Axis): void;
  46985. }
  46986. }
  46987. declare module "babylonjs/Gamepads/xboxGamepad" {
  46988. import { Observable } from "babylonjs/Misc/observable";
  46989. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46990. /**
  46991. * Defines supported buttons for XBox360 compatible gamepads
  46992. */
  46993. export enum Xbox360Button {
  46994. /** A */
  46995. A = 0,
  46996. /** B */
  46997. B = 1,
  46998. /** X */
  46999. X = 2,
  47000. /** Y */
  47001. Y = 3,
  47002. /** Left button */
  47003. LB = 4,
  47004. /** Right button */
  47005. RB = 5,
  47006. /** Back */
  47007. Back = 8,
  47008. /** Start */
  47009. Start = 9,
  47010. /** Left stick */
  47011. LeftStick = 10,
  47012. /** Right stick */
  47013. RightStick = 11
  47014. }
  47015. /** Defines values for XBox360 DPad */
  47016. export enum Xbox360Dpad {
  47017. /** Up */
  47018. Up = 12,
  47019. /** Down */
  47020. Down = 13,
  47021. /** Left */
  47022. Left = 14,
  47023. /** Right */
  47024. Right = 15
  47025. }
  47026. /**
  47027. * Defines a XBox360 gamepad
  47028. */
  47029. export class Xbox360Pad extends Gamepad {
  47030. private _leftTrigger;
  47031. private _rightTrigger;
  47032. private _onlefttriggerchanged;
  47033. private _onrighttriggerchanged;
  47034. private _onbuttondown;
  47035. private _onbuttonup;
  47036. private _ondpaddown;
  47037. private _ondpadup;
  47038. /** Observable raised when a button is pressed */
  47039. onButtonDownObservable: Observable<Xbox360Button>;
  47040. /** Observable raised when a button is released */
  47041. onButtonUpObservable: Observable<Xbox360Button>;
  47042. /** Observable raised when a pad is pressed */
  47043. onPadDownObservable: Observable<Xbox360Dpad>;
  47044. /** Observable raised when a pad is released */
  47045. onPadUpObservable: Observable<Xbox360Dpad>;
  47046. private _buttonA;
  47047. private _buttonB;
  47048. private _buttonX;
  47049. private _buttonY;
  47050. private _buttonBack;
  47051. private _buttonStart;
  47052. private _buttonLB;
  47053. private _buttonRB;
  47054. private _buttonLeftStick;
  47055. private _buttonRightStick;
  47056. private _dPadUp;
  47057. private _dPadDown;
  47058. private _dPadLeft;
  47059. private _dPadRight;
  47060. private _isXboxOnePad;
  47061. /**
  47062. * Creates a new XBox360 gamepad object
  47063. * @param id defines the id of this gamepad
  47064. * @param index defines its index
  47065. * @param gamepad defines the internal HTML gamepad object
  47066. * @param xboxOne defines if it is a XBox One gamepad
  47067. */
  47068. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  47069. /**
  47070. * Defines the callback to call when left trigger is pressed
  47071. * @param callback defines the callback to use
  47072. */
  47073. onlefttriggerchanged(callback: (value: number) => void): void;
  47074. /**
  47075. * Defines the callback to call when right trigger is pressed
  47076. * @param callback defines the callback to use
  47077. */
  47078. onrighttriggerchanged(callback: (value: number) => void): void;
  47079. /**
  47080. * Gets the left trigger value
  47081. */
  47082. get leftTrigger(): number;
  47083. /**
  47084. * Sets the left trigger value
  47085. */
  47086. set leftTrigger(newValue: number);
  47087. /**
  47088. * Gets the right trigger value
  47089. */
  47090. get rightTrigger(): number;
  47091. /**
  47092. * Sets the right trigger value
  47093. */
  47094. set rightTrigger(newValue: number);
  47095. /**
  47096. * Defines the callback to call when a button is pressed
  47097. * @param callback defines the callback to use
  47098. */
  47099. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  47100. /**
  47101. * Defines the callback to call when a button is released
  47102. * @param callback defines the callback to use
  47103. */
  47104. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  47105. /**
  47106. * Defines the callback to call when a pad is pressed
  47107. * @param callback defines the callback to use
  47108. */
  47109. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  47110. /**
  47111. * Defines the callback to call when a pad is released
  47112. * @param callback defines the callback to use
  47113. */
  47114. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  47115. private _setButtonValue;
  47116. private _setDPadValue;
  47117. /**
  47118. * Gets the value of the `A` button
  47119. */
  47120. get buttonA(): number;
  47121. /**
  47122. * Sets the value of the `A` button
  47123. */
  47124. set buttonA(value: number);
  47125. /**
  47126. * Gets the value of the `B` button
  47127. */
  47128. get buttonB(): number;
  47129. /**
  47130. * Sets the value of the `B` button
  47131. */
  47132. set buttonB(value: number);
  47133. /**
  47134. * Gets the value of the `X` button
  47135. */
  47136. get buttonX(): number;
  47137. /**
  47138. * Sets the value of the `X` button
  47139. */
  47140. set buttonX(value: number);
  47141. /**
  47142. * Gets the value of the `Y` button
  47143. */
  47144. get buttonY(): number;
  47145. /**
  47146. * Sets the value of the `Y` button
  47147. */
  47148. set buttonY(value: number);
  47149. /**
  47150. * Gets the value of the `Start` button
  47151. */
  47152. get buttonStart(): number;
  47153. /**
  47154. * Sets the value of the `Start` button
  47155. */
  47156. set buttonStart(value: number);
  47157. /**
  47158. * Gets the value of the `Back` button
  47159. */
  47160. get buttonBack(): number;
  47161. /**
  47162. * Sets the value of the `Back` button
  47163. */
  47164. set buttonBack(value: number);
  47165. /**
  47166. * Gets the value of the `Left` button
  47167. */
  47168. get buttonLB(): number;
  47169. /**
  47170. * Sets the value of the `Left` button
  47171. */
  47172. set buttonLB(value: number);
  47173. /**
  47174. * Gets the value of the `Right` button
  47175. */
  47176. get buttonRB(): number;
  47177. /**
  47178. * Sets the value of the `Right` button
  47179. */
  47180. set buttonRB(value: number);
  47181. /**
  47182. * Gets the value of the Left joystick
  47183. */
  47184. get buttonLeftStick(): number;
  47185. /**
  47186. * Sets the value of the Left joystick
  47187. */
  47188. set buttonLeftStick(value: number);
  47189. /**
  47190. * Gets the value of the Right joystick
  47191. */
  47192. get buttonRightStick(): number;
  47193. /**
  47194. * Sets the value of the Right joystick
  47195. */
  47196. set buttonRightStick(value: number);
  47197. /**
  47198. * Gets the value of D-pad up
  47199. */
  47200. get dPadUp(): number;
  47201. /**
  47202. * Sets the value of D-pad up
  47203. */
  47204. set dPadUp(value: number);
  47205. /**
  47206. * Gets the value of D-pad down
  47207. */
  47208. get dPadDown(): number;
  47209. /**
  47210. * Sets the value of D-pad down
  47211. */
  47212. set dPadDown(value: number);
  47213. /**
  47214. * Gets the value of D-pad left
  47215. */
  47216. get dPadLeft(): number;
  47217. /**
  47218. * Sets the value of D-pad left
  47219. */
  47220. set dPadLeft(value: number);
  47221. /**
  47222. * Gets the value of D-pad right
  47223. */
  47224. get dPadRight(): number;
  47225. /**
  47226. * Sets the value of D-pad right
  47227. */
  47228. set dPadRight(value: number);
  47229. /**
  47230. * Force the gamepad to synchronize with device values
  47231. */
  47232. update(): void;
  47233. /**
  47234. * Disposes the gamepad
  47235. */
  47236. dispose(): void;
  47237. }
  47238. }
  47239. declare module "babylonjs/Gamepads/dualShockGamepad" {
  47240. import { Observable } from "babylonjs/Misc/observable";
  47241. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47242. /**
  47243. * Defines supported buttons for DualShock compatible gamepads
  47244. */
  47245. export enum DualShockButton {
  47246. /** Cross */
  47247. Cross = 0,
  47248. /** Circle */
  47249. Circle = 1,
  47250. /** Square */
  47251. Square = 2,
  47252. /** Triangle */
  47253. Triangle = 3,
  47254. /** L1 */
  47255. L1 = 4,
  47256. /** R1 */
  47257. R1 = 5,
  47258. /** Share */
  47259. Share = 8,
  47260. /** Options */
  47261. Options = 9,
  47262. /** Left stick */
  47263. LeftStick = 10,
  47264. /** Right stick */
  47265. RightStick = 11
  47266. }
  47267. /** Defines values for DualShock DPad */
  47268. export enum DualShockDpad {
  47269. /** Up */
  47270. Up = 12,
  47271. /** Down */
  47272. Down = 13,
  47273. /** Left */
  47274. Left = 14,
  47275. /** Right */
  47276. Right = 15
  47277. }
  47278. /**
  47279. * Defines a DualShock gamepad
  47280. */
  47281. export class DualShockPad extends Gamepad {
  47282. private _leftTrigger;
  47283. private _rightTrigger;
  47284. private _onlefttriggerchanged;
  47285. private _onrighttriggerchanged;
  47286. private _onbuttondown;
  47287. private _onbuttonup;
  47288. private _ondpaddown;
  47289. private _ondpadup;
  47290. /** Observable raised when a button is pressed */
  47291. onButtonDownObservable: Observable<DualShockButton>;
  47292. /** Observable raised when a button is released */
  47293. onButtonUpObservable: Observable<DualShockButton>;
  47294. /** Observable raised when a pad is pressed */
  47295. onPadDownObservable: Observable<DualShockDpad>;
  47296. /** Observable raised when a pad is released */
  47297. onPadUpObservable: Observable<DualShockDpad>;
  47298. private _buttonCross;
  47299. private _buttonCircle;
  47300. private _buttonSquare;
  47301. private _buttonTriangle;
  47302. private _buttonShare;
  47303. private _buttonOptions;
  47304. private _buttonL1;
  47305. private _buttonR1;
  47306. private _buttonLeftStick;
  47307. private _buttonRightStick;
  47308. private _dPadUp;
  47309. private _dPadDown;
  47310. private _dPadLeft;
  47311. private _dPadRight;
  47312. /**
  47313. * Creates a new DualShock gamepad object
  47314. * @param id defines the id of this gamepad
  47315. * @param index defines its index
  47316. * @param gamepad defines the internal HTML gamepad object
  47317. */
  47318. constructor(id: string, index: number, gamepad: any);
  47319. /**
  47320. * Defines the callback to call when left trigger is pressed
  47321. * @param callback defines the callback to use
  47322. */
  47323. onlefttriggerchanged(callback: (value: number) => void): void;
  47324. /**
  47325. * Defines the callback to call when right trigger is pressed
  47326. * @param callback defines the callback to use
  47327. */
  47328. onrighttriggerchanged(callback: (value: number) => void): void;
  47329. /**
  47330. * Gets the left trigger value
  47331. */
  47332. get leftTrigger(): number;
  47333. /**
  47334. * Sets the left trigger value
  47335. */
  47336. set leftTrigger(newValue: number);
  47337. /**
  47338. * Gets the right trigger value
  47339. */
  47340. get rightTrigger(): number;
  47341. /**
  47342. * Sets the right trigger value
  47343. */
  47344. set rightTrigger(newValue: number);
  47345. /**
  47346. * Defines the callback to call when a button is pressed
  47347. * @param callback defines the callback to use
  47348. */
  47349. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47350. /**
  47351. * Defines the callback to call when a button is released
  47352. * @param callback defines the callback to use
  47353. */
  47354. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47355. /**
  47356. * Defines the callback to call when a pad is pressed
  47357. * @param callback defines the callback to use
  47358. */
  47359. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47360. /**
  47361. * Defines the callback to call when a pad is released
  47362. * @param callback defines the callback to use
  47363. */
  47364. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47365. private _setButtonValue;
  47366. private _setDPadValue;
  47367. /**
  47368. * Gets the value of the `Cross` button
  47369. */
  47370. get buttonCross(): number;
  47371. /**
  47372. * Sets the value of the `Cross` button
  47373. */
  47374. set buttonCross(value: number);
  47375. /**
  47376. * Gets the value of the `Circle` button
  47377. */
  47378. get buttonCircle(): number;
  47379. /**
  47380. * Sets the value of the `Circle` button
  47381. */
  47382. set buttonCircle(value: number);
  47383. /**
  47384. * Gets the value of the `Square` button
  47385. */
  47386. get buttonSquare(): number;
  47387. /**
  47388. * Sets the value of the `Square` button
  47389. */
  47390. set buttonSquare(value: number);
  47391. /**
  47392. * Gets the value of the `Triangle` button
  47393. */
  47394. get buttonTriangle(): number;
  47395. /**
  47396. * Sets the value of the `Triangle` button
  47397. */
  47398. set buttonTriangle(value: number);
  47399. /**
  47400. * Gets the value of the `Options` button
  47401. */
  47402. get buttonOptions(): number;
  47403. /**
  47404. * Sets the value of the `Options` button
  47405. */
  47406. set buttonOptions(value: number);
  47407. /**
  47408. * Gets the value of the `Share` button
  47409. */
  47410. get buttonShare(): number;
  47411. /**
  47412. * Sets the value of the `Share` button
  47413. */
  47414. set buttonShare(value: number);
  47415. /**
  47416. * Gets the value of the `L1` button
  47417. */
  47418. get buttonL1(): number;
  47419. /**
  47420. * Sets the value of the `L1` button
  47421. */
  47422. set buttonL1(value: number);
  47423. /**
  47424. * Gets the value of the `R1` button
  47425. */
  47426. get buttonR1(): number;
  47427. /**
  47428. * Sets the value of the `R1` button
  47429. */
  47430. set buttonR1(value: number);
  47431. /**
  47432. * Gets the value of the Left joystick
  47433. */
  47434. get buttonLeftStick(): number;
  47435. /**
  47436. * Sets the value of the Left joystick
  47437. */
  47438. set buttonLeftStick(value: number);
  47439. /**
  47440. * Gets the value of the Right joystick
  47441. */
  47442. get buttonRightStick(): number;
  47443. /**
  47444. * Sets the value of the Right joystick
  47445. */
  47446. set buttonRightStick(value: number);
  47447. /**
  47448. * Gets the value of D-pad up
  47449. */
  47450. get dPadUp(): number;
  47451. /**
  47452. * Sets the value of D-pad up
  47453. */
  47454. set dPadUp(value: number);
  47455. /**
  47456. * Gets the value of D-pad down
  47457. */
  47458. get dPadDown(): number;
  47459. /**
  47460. * Sets the value of D-pad down
  47461. */
  47462. set dPadDown(value: number);
  47463. /**
  47464. * Gets the value of D-pad left
  47465. */
  47466. get dPadLeft(): number;
  47467. /**
  47468. * Sets the value of D-pad left
  47469. */
  47470. set dPadLeft(value: number);
  47471. /**
  47472. * Gets the value of D-pad right
  47473. */
  47474. get dPadRight(): number;
  47475. /**
  47476. * Sets the value of D-pad right
  47477. */
  47478. set dPadRight(value: number);
  47479. /**
  47480. * Force the gamepad to synchronize with device values
  47481. */
  47482. update(): void;
  47483. /**
  47484. * Disposes the gamepad
  47485. */
  47486. dispose(): void;
  47487. }
  47488. }
  47489. declare module "babylonjs/Gamepads/gamepadManager" {
  47490. import { Observable } from "babylonjs/Misc/observable";
  47491. import { Nullable } from "babylonjs/types";
  47492. import { Scene } from "babylonjs/scene";
  47493. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47494. /**
  47495. * Manager for handling gamepads
  47496. */
  47497. export class GamepadManager {
  47498. private _scene?;
  47499. private _babylonGamepads;
  47500. private _oneGamepadConnected;
  47501. /** @hidden */
  47502. _isMonitoring: boolean;
  47503. private _gamepadEventSupported;
  47504. private _gamepadSupport?;
  47505. /**
  47506. * observable to be triggered when the gamepad controller has been connected
  47507. */
  47508. onGamepadConnectedObservable: Observable<Gamepad>;
  47509. /**
  47510. * observable to be triggered when the gamepad controller has been disconnected
  47511. */
  47512. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47513. private _onGamepadConnectedEvent;
  47514. private _onGamepadDisconnectedEvent;
  47515. /**
  47516. * Initializes the gamepad manager
  47517. * @param _scene BabylonJS scene
  47518. */
  47519. constructor(_scene?: Scene | undefined);
  47520. /**
  47521. * The gamepads in the game pad manager
  47522. */
  47523. get gamepads(): Gamepad[];
  47524. /**
  47525. * Get the gamepad controllers based on type
  47526. * @param type The type of gamepad controller
  47527. * @returns Nullable gamepad
  47528. */
  47529. getGamepadByType(type?: number): Nullable<Gamepad>;
  47530. /**
  47531. * Disposes the gamepad manager
  47532. */
  47533. dispose(): void;
  47534. private _addNewGamepad;
  47535. private _startMonitoringGamepads;
  47536. private _stopMonitoringGamepads;
  47537. /** @hidden */
  47538. _checkGamepadsStatus(): void;
  47539. private _updateGamepadObjects;
  47540. }
  47541. }
  47542. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47543. import { Nullable } from "babylonjs/types";
  47544. import { Scene } from "babylonjs/scene";
  47545. import { ISceneComponent } from "babylonjs/sceneComponent";
  47546. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47547. module "babylonjs/scene" {
  47548. interface Scene {
  47549. /** @hidden */
  47550. _gamepadManager: Nullable<GamepadManager>;
  47551. /**
  47552. * Gets the gamepad manager associated with the scene
  47553. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47554. */
  47555. gamepadManager: GamepadManager;
  47556. }
  47557. }
  47558. module "babylonjs/Cameras/freeCameraInputsManager" {
  47559. /**
  47560. * Interface representing a free camera inputs manager
  47561. */
  47562. interface FreeCameraInputsManager {
  47563. /**
  47564. * Adds gamepad input support to the FreeCameraInputsManager.
  47565. * @returns the FreeCameraInputsManager
  47566. */
  47567. addGamepad(): FreeCameraInputsManager;
  47568. }
  47569. }
  47570. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47571. /**
  47572. * Interface representing an arc rotate camera inputs manager
  47573. */
  47574. interface ArcRotateCameraInputsManager {
  47575. /**
  47576. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47577. * @returns the camera inputs manager
  47578. */
  47579. addGamepad(): ArcRotateCameraInputsManager;
  47580. }
  47581. }
  47582. /**
  47583. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47584. */
  47585. export class GamepadSystemSceneComponent implements ISceneComponent {
  47586. /**
  47587. * The component name helpfull to identify the component in the list of scene components.
  47588. */
  47589. readonly name: string;
  47590. /**
  47591. * The scene the component belongs to.
  47592. */
  47593. scene: Scene;
  47594. /**
  47595. * Creates a new instance of the component for the given scene
  47596. * @param scene Defines the scene to register the component in
  47597. */
  47598. constructor(scene: Scene);
  47599. /**
  47600. * Registers the component in a given scene
  47601. */
  47602. register(): void;
  47603. /**
  47604. * Rebuilds the elements related to this component in case of
  47605. * context lost for instance.
  47606. */
  47607. rebuild(): void;
  47608. /**
  47609. * Disposes the component and the associated ressources
  47610. */
  47611. dispose(): void;
  47612. private _beforeCameraUpdate;
  47613. }
  47614. }
  47615. declare module "babylonjs/Cameras/universalCamera" {
  47616. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47617. import { Scene } from "babylonjs/scene";
  47618. import { Vector3 } from "babylonjs/Maths/math.vector";
  47619. import "babylonjs/Gamepads/gamepadSceneComponent";
  47620. /**
  47621. * 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,
  47622. * which still works and will still be found in many Playgrounds.
  47623. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47624. */
  47625. export class UniversalCamera extends TouchCamera {
  47626. /**
  47627. * Defines the gamepad rotation sensiblity.
  47628. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47629. */
  47630. get gamepadAngularSensibility(): number;
  47631. set gamepadAngularSensibility(value: number);
  47632. /**
  47633. * Defines the gamepad move sensiblity.
  47634. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47635. */
  47636. get gamepadMoveSensibility(): number;
  47637. set gamepadMoveSensibility(value: number);
  47638. /**
  47639. * 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,
  47640. * which still works and will still be found in many Playgrounds.
  47641. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47642. * @param name Define the name of the camera in the scene
  47643. * @param position Define the start position of the camera in the scene
  47644. * @param scene Define the scene the camera belongs to
  47645. */
  47646. constructor(name: string, position: Vector3, scene: Scene);
  47647. /**
  47648. * Gets the current object class name.
  47649. * @return the class name
  47650. */
  47651. getClassName(): string;
  47652. }
  47653. }
  47654. declare module "babylonjs/Cameras/gamepadCamera" {
  47655. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47656. import { Scene } from "babylonjs/scene";
  47657. import { Vector3 } from "babylonjs/Maths/math.vector";
  47658. /**
  47659. * This represents a FPS type of camera. This is only here for back compat purpose.
  47660. * Please use the UniversalCamera instead as both are identical.
  47661. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47662. */
  47663. export class GamepadCamera extends UniversalCamera {
  47664. /**
  47665. * Instantiates a new Gamepad Camera
  47666. * This represents a FPS type of camera. This is only here for back compat purpose.
  47667. * Please use the UniversalCamera instead as both are identical.
  47668. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47669. * @param name Define the name of the camera in the scene
  47670. * @param position Define the start position of the camera in the scene
  47671. * @param scene Define the scene the camera belongs to
  47672. */
  47673. constructor(name: string, position: Vector3, scene: Scene);
  47674. /**
  47675. * Gets the current object class name.
  47676. * @return the class name
  47677. */
  47678. getClassName(): string;
  47679. }
  47680. }
  47681. declare module "babylonjs/Shaders/pass.fragment" {
  47682. /** @hidden */
  47683. export var passPixelShader: {
  47684. name: string;
  47685. shader: string;
  47686. };
  47687. }
  47688. declare module "babylonjs/Shaders/passCube.fragment" {
  47689. /** @hidden */
  47690. export var passCubePixelShader: {
  47691. name: string;
  47692. shader: string;
  47693. };
  47694. }
  47695. declare module "babylonjs/PostProcesses/passPostProcess" {
  47696. import { Nullable } from "babylonjs/types";
  47697. import { Camera } from "babylonjs/Cameras/camera";
  47698. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47699. import { Engine } from "babylonjs/Engines/engine";
  47700. import "babylonjs/Shaders/pass.fragment";
  47701. import "babylonjs/Shaders/passCube.fragment";
  47702. import { Scene } from "babylonjs/scene";
  47703. /**
  47704. * PassPostProcess which produces an output the same as it's input
  47705. */
  47706. export class PassPostProcess extends PostProcess {
  47707. /**
  47708. * Gets a string identifying the name of the class
  47709. * @returns "PassPostProcess" string
  47710. */
  47711. getClassName(): string;
  47712. /**
  47713. * Creates the PassPostProcess
  47714. * @param name The name of the effect.
  47715. * @param options The required width/height ratio to downsize to before computing the render pass.
  47716. * @param camera The camera to apply the render pass to.
  47717. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47718. * @param engine The engine which the post process will be applied. (default: current engine)
  47719. * @param reusable If the post process can be reused on the same frame. (default: false)
  47720. * @param textureType The type of texture to be used when performing the post processing.
  47721. * @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)
  47722. */
  47723. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47724. /** @hidden */
  47725. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  47726. }
  47727. /**
  47728. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47729. */
  47730. export class PassCubePostProcess extends PostProcess {
  47731. private _face;
  47732. /**
  47733. * Gets or sets the cube face to display.
  47734. * * 0 is +X
  47735. * * 1 is -X
  47736. * * 2 is +Y
  47737. * * 3 is -Y
  47738. * * 4 is +Z
  47739. * * 5 is -Z
  47740. */
  47741. get face(): number;
  47742. set face(value: number);
  47743. /**
  47744. * Gets a string identifying the name of the class
  47745. * @returns "PassCubePostProcess" string
  47746. */
  47747. getClassName(): string;
  47748. /**
  47749. * Creates the PassCubePostProcess
  47750. * @param name The name of the effect.
  47751. * @param options The required width/height ratio to downsize to before computing the render pass.
  47752. * @param camera The camera to apply the render pass to.
  47753. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47754. * @param engine The engine which the post process will be applied. (default: current engine)
  47755. * @param reusable If the post process can be reused on the same frame. (default: false)
  47756. * @param textureType The type of texture to be used when performing the post processing.
  47757. * @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)
  47758. */
  47759. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47760. /** @hidden */
  47761. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  47762. }
  47763. }
  47764. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47765. /** @hidden */
  47766. export var anaglyphPixelShader: {
  47767. name: string;
  47768. shader: string;
  47769. };
  47770. }
  47771. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47772. import { Engine } from "babylonjs/Engines/engine";
  47773. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47774. import { Camera } from "babylonjs/Cameras/camera";
  47775. import "babylonjs/Shaders/anaglyph.fragment";
  47776. /**
  47777. * Postprocess used to generate anaglyphic rendering
  47778. */
  47779. export class AnaglyphPostProcess extends PostProcess {
  47780. private _passedProcess;
  47781. /**
  47782. * Gets a string identifying the name of the class
  47783. * @returns "AnaglyphPostProcess" string
  47784. */
  47785. getClassName(): string;
  47786. /**
  47787. * Creates a new AnaglyphPostProcess
  47788. * @param name defines postprocess name
  47789. * @param options defines creation options or target ratio scale
  47790. * @param rigCameras defines cameras using this postprocess
  47791. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47792. * @param engine defines hosting engine
  47793. * @param reusable defines if the postprocess will be reused multiple times per frame
  47794. */
  47795. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47796. }
  47797. }
  47798. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47799. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47800. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47801. import { Scene } from "babylonjs/scene";
  47802. import { Vector3 } from "babylonjs/Maths/math.vector";
  47803. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47804. /**
  47805. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47806. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47807. */
  47808. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47809. /**
  47810. * Creates a new AnaglyphArcRotateCamera
  47811. * @param name defines camera name
  47812. * @param alpha defines alpha angle (in radians)
  47813. * @param beta defines beta angle (in radians)
  47814. * @param radius defines radius
  47815. * @param target defines camera target
  47816. * @param interaxialDistance defines distance between each color axis
  47817. * @param scene defines the hosting scene
  47818. */
  47819. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47820. /**
  47821. * Gets camera class name
  47822. * @returns AnaglyphArcRotateCamera
  47823. */
  47824. getClassName(): string;
  47825. }
  47826. }
  47827. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47828. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47829. import { Scene } from "babylonjs/scene";
  47830. import { Vector3 } from "babylonjs/Maths/math.vector";
  47831. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47832. /**
  47833. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47834. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47835. */
  47836. export class AnaglyphFreeCamera extends FreeCamera {
  47837. /**
  47838. * Creates a new AnaglyphFreeCamera
  47839. * @param name defines camera name
  47840. * @param position defines initial position
  47841. * @param interaxialDistance defines distance between each color axis
  47842. * @param scene defines the hosting scene
  47843. */
  47844. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47845. /**
  47846. * Gets camera class name
  47847. * @returns AnaglyphFreeCamera
  47848. */
  47849. getClassName(): string;
  47850. }
  47851. }
  47852. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47853. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47854. import { Scene } from "babylonjs/scene";
  47855. import { Vector3 } from "babylonjs/Maths/math.vector";
  47856. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47857. /**
  47858. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47859. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47860. */
  47861. export class AnaglyphGamepadCamera extends GamepadCamera {
  47862. /**
  47863. * Creates a new AnaglyphGamepadCamera
  47864. * @param name defines camera name
  47865. * @param position defines initial position
  47866. * @param interaxialDistance defines distance between each color axis
  47867. * @param scene defines the hosting scene
  47868. */
  47869. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47870. /**
  47871. * Gets camera class name
  47872. * @returns AnaglyphGamepadCamera
  47873. */
  47874. getClassName(): string;
  47875. }
  47876. }
  47877. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  47878. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47879. import { Scene } from "babylonjs/scene";
  47880. import { Vector3 } from "babylonjs/Maths/math.vector";
  47881. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47882. /**
  47883. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  47884. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47885. */
  47886. export class AnaglyphUniversalCamera extends UniversalCamera {
  47887. /**
  47888. * Creates a new AnaglyphUniversalCamera
  47889. * @param name defines camera name
  47890. * @param position defines initial position
  47891. * @param interaxialDistance defines distance between each color axis
  47892. * @param scene defines the hosting scene
  47893. */
  47894. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47895. /**
  47896. * Gets camera class name
  47897. * @returns AnaglyphUniversalCamera
  47898. */
  47899. getClassName(): string;
  47900. }
  47901. }
  47902. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  47903. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  47904. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47905. import { Scene } from "babylonjs/scene";
  47906. import { Vector3 } from "babylonjs/Maths/math.vector";
  47907. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47908. /**
  47909. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  47910. * @see https://doc.babylonjs.com/features/cameras
  47911. */
  47912. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  47913. /**
  47914. * Creates a new StereoscopicArcRotateCamera
  47915. * @param name defines camera name
  47916. * @param alpha defines alpha angle (in radians)
  47917. * @param beta defines beta angle (in radians)
  47918. * @param radius defines radius
  47919. * @param target defines camera target
  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, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47925. /**
  47926. * Gets camera class name
  47927. * @returns StereoscopicArcRotateCamera
  47928. */
  47929. getClassName(): string;
  47930. }
  47931. }
  47932. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  47933. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  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 FreeCamera)
  47939. * @see https://doc.babylonjs.com/features/cameras
  47940. */
  47941. export class StereoscopicFreeCamera extends FreeCamera {
  47942. /**
  47943. * Creates a new StereoscopicFreeCamera
  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 StereoscopicFreeCamera
  47954. */
  47955. getClassName(): string;
  47956. }
  47957. }
  47958. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  47959. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  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 GamepadCamera)
  47965. * @see https://doc.babylonjs.com/features/cameras
  47966. */
  47967. export class StereoscopicGamepadCamera extends GamepadCamera {
  47968. /**
  47969. * Creates a new StereoscopicGamepadCamera
  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 StereoscopicGamepadCamera
  47980. */
  47981. getClassName(): string;
  47982. }
  47983. }
  47984. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  47985. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47986. import { Scene } from "babylonjs/scene";
  47987. import { Vector3 } from "babylonjs/Maths/math.vector";
  47988. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47989. /**
  47990. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  47991. * @see https://doc.babylonjs.com/features/cameras
  47992. */
  47993. export class StereoscopicUniversalCamera extends UniversalCamera {
  47994. /**
  47995. * Creates a new StereoscopicUniversalCamera
  47996. * @param name defines camera name
  47997. * @param position defines initial position
  47998. * @param interaxialDistance defines distance between each color axis
  47999. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  48000. * @param scene defines the hosting scene
  48001. */
  48002. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  48003. /**
  48004. * Gets camera class name
  48005. * @returns StereoscopicUniversalCamera
  48006. */
  48007. getClassName(): string;
  48008. }
  48009. }
  48010. declare module "babylonjs/Cameras/Stereoscopic/index" {
  48011. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  48012. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  48013. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  48014. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  48015. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  48016. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  48017. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  48018. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  48019. }
  48020. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  48021. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48022. import { Scene } from "babylonjs/scene";
  48023. import { Vector3 } from "babylonjs/Maths/math.vector";
  48024. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  48025. /**
  48026. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  48027. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48028. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48029. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48030. */
  48031. export class VirtualJoysticksCamera extends FreeCamera {
  48032. /**
  48033. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  48034. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48035. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48036. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48037. * @param name Define the name of the camera in the scene
  48038. * @param position Define the start position of the camera in the scene
  48039. * @param scene Define the scene the camera belongs to
  48040. */
  48041. constructor(name: string, position: Vector3, scene: Scene);
  48042. /**
  48043. * Gets the current object class name.
  48044. * @return the class name
  48045. */
  48046. getClassName(): string;
  48047. }
  48048. }
  48049. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  48050. import { Matrix } from "babylonjs/Maths/math.vector";
  48051. /**
  48052. * This represents all the required metrics to create a VR camera.
  48053. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  48054. */
  48055. export class VRCameraMetrics {
  48056. /**
  48057. * Define the horizontal resolution off the screen.
  48058. */
  48059. hResolution: number;
  48060. /**
  48061. * Define the vertical resolution off the screen.
  48062. */
  48063. vResolution: number;
  48064. /**
  48065. * Define the horizontal screen size.
  48066. */
  48067. hScreenSize: number;
  48068. /**
  48069. * Define the vertical screen size.
  48070. */
  48071. vScreenSize: number;
  48072. /**
  48073. * Define the vertical screen center position.
  48074. */
  48075. vScreenCenter: number;
  48076. /**
  48077. * Define the distance of the eyes to the screen.
  48078. */
  48079. eyeToScreenDistance: number;
  48080. /**
  48081. * Define the distance between both lenses
  48082. */
  48083. lensSeparationDistance: number;
  48084. /**
  48085. * Define the distance between both viewer's eyes.
  48086. */
  48087. interpupillaryDistance: number;
  48088. /**
  48089. * Define the distortion factor of the VR postprocess.
  48090. * Please, touch with care.
  48091. */
  48092. distortionK: number[];
  48093. /**
  48094. * Define the chromatic aberration correction factors for the VR post process.
  48095. */
  48096. chromaAbCorrection: number[];
  48097. /**
  48098. * Define the scale factor of the post process.
  48099. * The smaller the better but the slower.
  48100. */
  48101. postProcessScaleFactor: number;
  48102. /**
  48103. * Define an offset for the lens center.
  48104. */
  48105. lensCenterOffset: number;
  48106. /**
  48107. * Define if the current vr camera should compensate the distortion of the lense or not.
  48108. */
  48109. compensateDistortion: boolean;
  48110. /**
  48111. * Defines if multiview should be enabled when rendering (Default: false)
  48112. */
  48113. multiviewEnabled: boolean;
  48114. /**
  48115. * Gets the rendering aspect ratio based on the provided resolutions.
  48116. */
  48117. get aspectRatio(): number;
  48118. /**
  48119. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  48120. */
  48121. get aspectRatioFov(): number;
  48122. /**
  48123. * @hidden
  48124. */
  48125. get leftHMatrix(): Matrix;
  48126. /**
  48127. * @hidden
  48128. */
  48129. get rightHMatrix(): Matrix;
  48130. /**
  48131. * @hidden
  48132. */
  48133. get leftPreViewMatrix(): Matrix;
  48134. /**
  48135. * @hidden
  48136. */
  48137. get rightPreViewMatrix(): Matrix;
  48138. /**
  48139. * Get the default VRMetrics based on the most generic setup.
  48140. * @returns the default vr metrics
  48141. */
  48142. static GetDefault(): VRCameraMetrics;
  48143. }
  48144. }
  48145. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  48146. /** @hidden */
  48147. export var vrDistortionCorrectionPixelShader: {
  48148. name: string;
  48149. shader: string;
  48150. };
  48151. }
  48152. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  48153. import { Camera } from "babylonjs/Cameras/camera";
  48154. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48155. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  48156. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  48157. /**
  48158. * VRDistortionCorrectionPostProcess used for mobile VR
  48159. */
  48160. export class VRDistortionCorrectionPostProcess extends PostProcess {
  48161. private _isRightEye;
  48162. private _distortionFactors;
  48163. private _postProcessScaleFactor;
  48164. private _lensCenterOffset;
  48165. private _scaleIn;
  48166. private _scaleFactor;
  48167. private _lensCenter;
  48168. /**
  48169. * Gets a string identifying the name of the class
  48170. * @returns "VRDistortionCorrectionPostProcess" string
  48171. */
  48172. getClassName(): string;
  48173. /**
  48174. * Initializes the VRDistortionCorrectionPostProcess
  48175. * @param name The name of the effect.
  48176. * @param camera The camera to apply the render pass to.
  48177. * @param isRightEye If this is for the right eye distortion
  48178. * @param vrMetrics All the required metrics for the VR camera
  48179. */
  48180. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  48181. }
  48182. }
  48183. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  48184. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  48185. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48186. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48187. import { Scene } from "babylonjs/scene";
  48188. import { Vector3 } from "babylonjs/Maths/math.vector";
  48189. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  48190. import "babylonjs/Cameras/RigModes/vrRigMode";
  48191. /**
  48192. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  48193. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48194. */
  48195. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  48196. /**
  48197. * Creates a new VRDeviceOrientationArcRotateCamera
  48198. * @param name defines camera name
  48199. * @param alpha defines the camera rotation along the logitudinal axis
  48200. * @param beta defines the camera rotation along the latitudinal axis
  48201. * @param radius defines the camera distance from its target
  48202. * @param target defines the camera target
  48203. * @param scene defines the scene the camera belongs to
  48204. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48205. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48206. */
  48207. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48208. /**
  48209. * Gets camera class name
  48210. * @returns VRDeviceOrientationArcRotateCamera
  48211. */
  48212. getClassName(): string;
  48213. }
  48214. }
  48215. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  48216. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  48217. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48218. import { Scene } from "babylonjs/scene";
  48219. import { Vector3 } from "babylonjs/Maths/math.vector";
  48220. import "babylonjs/Cameras/RigModes/vrRigMode";
  48221. /**
  48222. * Camera used to simulate VR rendering (based on FreeCamera)
  48223. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48224. */
  48225. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  48226. /**
  48227. * Creates a new VRDeviceOrientationFreeCamera
  48228. * @param name defines camera name
  48229. * @param position defines the start position of the camera
  48230. * @param scene defines the scene the camera belongs to
  48231. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48232. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48233. */
  48234. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48235. /**
  48236. * Gets camera class name
  48237. * @returns VRDeviceOrientationFreeCamera
  48238. */
  48239. getClassName(): string;
  48240. }
  48241. }
  48242. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  48243. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  48244. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48245. import { Scene } from "babylonjs/scene";
  48246. import { Vector3 } from "babylonjs/Maths/math.vector";
  48247. import "babylonjs/Gamepads/gamepadSceneComponent";
  48248. /**
  48249. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  48250. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48251. */
  48252. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  48253. /**
  48254. * Creates a new VRDeviceOrientationGamepadCamera
  48255. * @param name defines camera name
  48256. * @param position defines the start position of the camera
  48257. * @param scene defines the scene the camera belongs to
  48258. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48259. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48260. */
  48261. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48262. /**
  48263. * Gets camera class name
  48264. * @returns VRDeviceOrientationGamepadCamera
  48265. */
  48266. getClassName(): string;
  48267. }
  48268. }
  48269. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  48270. import { Scene } from "babylonjs/scene";
  48271. import { Texture } from "babylonjs/Materials/Textures/texture";
  48272. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  48273. /**
  48274. * A class extending Texture allowing drawing on a texture
  48275. * @see https://doc.babylonjs.com/how_to/dynamictexture
  48276. */
  48277. export class DynamicTexture extends Texture {
  48278. private _generateMipMaps;
  48279. private _canvas;
  48280. private _context;
  48281. /**
  48282. * Creates a DynamicTexture
  48283. * @param name defines the name of the texture
  48284. * @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
  48285. * @param scene defines the scene where you want the texture
  48286. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  48287. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  48288. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  48289. */
  48290. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48291. /**
  48292. * Get the current class name of the texture useful for serialization or dynamic coding.
  48293. * @returns "DynamicTexture"
  48294. */
  48295. getClassName(): string;
  48296. /**
  48297. * Gets the current state of canRescale
  48298. */
  48299. get canRescale(): boolean;
  48300. private _recreate;
  48301. /**
  48302. * Scales the texture
  48303. * @param ratio the scale factor to apply to both width and height
  48304. */
  48305. scale(ratio: number): void;
  48306. /**
  48307. * Resizes the texture
  48308. * @param width the new width
  48309. * @param height the new height
  48310. */
  48311. scaleTo(width: number, height: number): void;
  48312. /**
  48313. * Gets the context of the canvas used by the texture
  48314. * @returns the canvas context of the dynamic texture
  48315. */
  48316. getContext(): CanvasRenderingContext2D;
  48317. /**
  48318. * Clears the texture
  48319. */
  48320. clear(): void;
  48321. /**
  48322. * Updates the texture
  48323. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48324. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48325. */
  48326. update(invertY?: boolean, premulAlpha?: boolean): void;
  48327. /**
  48328. * Draws text onto the texture
  48329. * @param text defines the text to be drawn
  48330. * @param x defines the placement of the text from the left
  48331. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48332. * @param font defines the font to be used with font-style, font-size, font-name
  48333. * @param color defines the color used for the text
  48334. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48335. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48336. * @param update defines whether texture is immediately update (default is true)
  48337. */
  48338. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48339. /**
  48340. * Clones the texture
  48341. * @returns the clone of the texture.
  48342. */
  48343. clone(): DynamicTexture;
  48344. /**
  48345. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48346. * @returns a serialized dynamic texture object
  48347. */
  48348. serialize(): any;
  48349. private _IsCanvasElement;
  48350. /** @hidden */
  48351. _rebuild(): void;
  48352. }
  48353. }
  48354. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48355. import { Scene } from "babylonjs/scene";
  48356. import { Color3 } from "babylonjs/Maths/math.color";
  48357. import { Mesh } from "babylonjs/Meshes/mesh";
  48358. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48359. import { Nullable } from "babylonjs/types";
  48360. /**
  48361. * Class containing static functions to help procedurally build meshes
  48362. */
  48363. export class GroundBuilder {
  48364. /**
  48365. * Creates a ground mesh
  48366. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48367. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48368. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48369. * @param name defines the name of the mesh
  48370. * @param options defines the options used to create the mesh
  48371. * @param scene defines the hosting scene
  48372. * @returns the ground mesh
  48373. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48374. */
  48375. static CreateGround(name: string, options: {
  48376. width?: number;
  48377. height?: number;
  48378. subdivisions?: number;
  48379. subdivisionsX?: number;
  48380. subdivisionsY?: number;
  48381. updatable?: boolean;
  48382. }, scene: any): Mesh;
  48383. /**
  48384. * Creates a tiled ground mesh
  48385. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48386. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48387. * * 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
  48388. * * 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
  48389. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48390. * @param name defines the name of the mesh
  48391. * @param options defines the options used to create the mesh
  48392. * @param scene defines the hosting scene
  48393. * @returns the tiled ground mesh
  48394. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48395. */
  48396. static CreateTiledGround(name: string, options: {
  48397. xmin: number;
  48398. zmin: number;
  48399. xmax: number;
  48400. zmax: number;
  48401. subdivisions?: {
  48402. w: number;
  48403. h: number;
  48404. };
  48405. precision?: {
  48406. w: number;
  48407. h: number;
  48408. };
  48409. updatable?: boolean;
  48410. }, scene?: Nullable<Scene>): Mesh;
  48411. /**
  48412. * Creates a ground mesh from a height map
  48413. * * The parameter `url` sets the URL of the height map image resource.
  48414. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48415. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48416. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48417. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48418. * * 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.
  48419. * * 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).
  48420. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48421. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48422. * @param name defines the name of the mesh
  48423. * @param url defines the url to the height map
  48424. * @param options defines the options used to create the mesh
  48425. * @param scene defines the hosting scene
  48426. * @returns the ground mesh
  48427. * @see https://doc.babylonjs.com/babylon101/height_map
  48428. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48429. */
  48430. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48431. width?: number;
  48432. height?: number;
  48433. subdivisions?: number;
  48434. minHeight?: number;
  48435. maxHeight?: number;
  48436. colorFilter?: Color3;
  48437. alphaFilter?: number;
  48438. updatable?: boolean;
  48439. onReady?: (mesh: GroundMesh) => void;
  48440. }, scene?: Nullable<Scene>): GroundMesh;
  48441. }
  48442. }
  48443. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48444. import { Vector4 } from "babylonjs/Maths/math.vector";
  48445. import { Mesh } from "babylonjs/Meshes/mesh";
  48446. /**
  48447. * Class containing static functions to help procedurally build meshes
  48448. */
  48449. export class TorusBuilder {
  48450. /**
  48451. * Creates a torus mesh
  48452. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48453. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48454. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48455. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48456. * * 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
  48457. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48458. * @param name defines the name of the mesh
  48459. * @param options defines the options used to create the mesh
  48460. * @param scene defines the hosting scene
  48461. * @returns the torus mesh
  48462. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48463. */
  48464. static CreateTorus(name: string, options: {
  48465. diameter?: number;
  48466. thickness?: number;
  48467. tessellation?: number;
  48468. updatable?: boolean;
  48469. sideOrientation?: number;
  48470. frontUVs?: Vector4;
  48471. backUVs?: Vector4;
  48472. }, scene: any): Mesh;
  48473. }
  48474. }
  48475. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48476. import { Vector4 } from "babylonjs/Maths/math.vector";
  48477. import { Color4 } from "babylonjs/Maths/math.color";
  48478. import { Mesh } from "babylonjs/Meshes/mesh";
  48479. /**
  48480. * Class containing static functions to help procedurally build meshes
  48481. */
  48482. export class CylinderBuilder {
  48483. /**
  48484. * Creates a cylinder or a cone mesh
  48485. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48486. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48487. * * 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.
  48488. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48489. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48490. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48491. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48492. * * 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).
  48493. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48494. * * 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).
  48495. * * 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
  48496. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48497. * * 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
  48498. * * 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.
  48499. * * If `enclose` is false, a ring surface is one element.
  48500. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48501. * * 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
  48502. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48503. * * 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
  48504. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48505. * @param name defines the name of the mesh
  48506. * @param options defines the options used to create the mesh
  48507. * @param scene defines the hosting scene
  48508. * @returns the cylinder mesh
  48509. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48510. */
  48511. static CreateCylinder(name: string, options: {
  48512. height?: number;
  48513. diameterTop?: number;
  48514. diameterBottom?: number;
  48515. diameter?: number;
  48516. tessellation?: number;
  48517. subdivisions?: number;
  48518. arc?: number;
  48519. faceColors?: Color4[];
  48520. faceUV?: Vector4[];
  48521. updatable?: boolean;
  48522. hasRings?: boolean;
  48523. enclose?: boolean;
  48524. cap?: number;
  48525. sideOrientation?: number;
  48526. frontUVs?: Vector4;
  48527. backUVs?: Vector4;
  48528. }, scene: any): Mesh;
  48529. }
  48530. }
  48531. declare module "babylonjs/XR/webXRTypes" {
  48532. import { Nullable } from "babylonjs/types";
  48533. import { IDisposable } from "babylonjs/scene";
  48534. /**
  48535. * States of the webXR experience
  48536. */
  48537. export enum WebXRState {
  48538. /**
  48539. * Transitioning to being in XR mode
  48540. */
  48541. ENTERING_XR = 0,
  48542. /**
  48543. * Transitioning to non XR mode
  48544. */
  48545. EXITING_XR = 1,
  48546. /**
  48547. * In XR mode and presenting
  48548. */
  48549. IN_XR = 2,
  48550. /**
  48551. * Not entered XR mode
  48552. */
  48553. NOT_IN_XR = 3
  48554. }
  48555. /**
  48556. * Abstraction of the XR render target
  48557. */
  48558. export interface WebXRRenderTarget extends IDisposable {
  48559. /**
  48560. * xrpresent context of the canvas which can be used to display/mirror xr content
  48561. */
  48562. canvasContext: WebGLRenderingContext;
  48563. /**
  48564. * xr layer for the canvas
  48565. */
  48566. xrLayer: Nullable<XRWebGLLayer>;
  48567. /**
  48568. * Initializes the xr layer for the session
  48569. * @param xrSession xr session
  48570. * @returns a promise that will resolve once the XR Layer has been created
  48571. */
  48572. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48573. }
  48574. }
  48575. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48576. import { Nullable } from "babylonjs/types";
  48577. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  48578. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48579. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48580. import { Observable } from "babylonjs/Misc/observable";
  48581. /**
  48582. * COnfiguration object for WebXR output canvas
  48583. */
  48584. export class WebXRManagedOutputCanvasOptions {
  48585. /**
  48586. * An optional canvas in case you wish to create it yourself and provide it here.
  48587. * If not provided, a new canvas will be created
  48588. */
  48589. canvasElement?: HTMLCanvasElement;
  48590. /**
  48591. * Options for this XR Layer output
  48592. */
  48593. canvasOptions?: XRWebGLLayerOptions;
  48594. /**
  48595. * CSS styling for a newly created canvas (if not provided)
  48596. */
  48597. newCanvasCssStyle?: string;
  48598. /**
  48599. * Get the default values of the configuration object
  48600. * @param engine defines the engine to use (can be null)
  48601. * @returns default values of this configuration object
  48602. */
  48603. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  48604. }
  48605. /**
  48606. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48607. */
  48608. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48609. private _options;
  48610. private _canvas;
  48611. private _engine;
  48612. private _originalCanvasSize;
  48613. /**
  48614. * Rendering context of the canvas which can be used to display/mirror xr content
  48615. */
  48616. canvasContext: WebGLRenderingContext;
  48617. /**
  48618. * xr layer for the canvas
  48619. */
  48620. xrLayer: Nullable<XRWebGLLayer>;
  48621. /**
  48622. * Obseervers registered here will be triggered when the xr layer was initialized
  48623. */
  48624. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48625. /**
  48626. * Initializes the canvas to be added/removed upon entering/exiting xr
  48627. * @param _xrSessionManager The XR Session manager
  48628. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48629. */
  48630. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48631. /**
  48632. * Disposes of the object
  48633. */
  48634. dispose(): void;
  48635. /**
  48636. * Initializes the xr layer for the session
  48637. * @param xrSession xr session
  48638. * @returns a promise that will resolve once the XR Layer has been created
  48639. */
  48640. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48641. private _addCanvas;
  48642. private _removeCanvas;
  48643. private _setCanvasSize;
  48644. private _setManagedOutputCanvas;
  48645. }
  48646. }
  48647. declare module "babylonjs/XR/webXRSessionManager" {
  48648. import { Observable } from "babylonjs/Misc/observable";
  48649. import { Nullable } from "babylonjs/types";
  48650. import { IDisposable, Scene } from "babylonjs/scene";
  48651. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48652. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48653. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48654. /**
  48655. * Manages an XRSession to work with Babylon's engine
  48656. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48657. */
  48658. export class WebXRSessionManager implements IDisposable {
  48659. /** The scene which the session should be created for */
  48660. scene: Scene;
  48661. private _referenceSpace;
  48662. private _rttProvider;
  48663. private _sessionEnded;
  48664. private _xrNavigator;
  48665. private baseLayer;
  48666. /**
  48667. * The base reference space from which the session started. good if you want to reset your
  48668. * reference space
  48669. */
  48670. baseReferenceSpace: XRReferenceSpace;
  48671. /**
  48672. * Current XR frame
  48673. */
  48674. currentFrame: Nullable<XRFrame>;
  48675. /** WebXR timestamp updated every frame */
  48676. currentTimestamp: number;
  48677. /**
  48678. * Used just in case of a failure to initialize an immersive session.
  48679. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48680. */
  48681. defaultHeightCompensation: number;
  48682. /**
  48683. * Fires every time a new xrFrame arrives which can be used to update the camera
  48684. */
  48685. onXRFrameObservable: Observable<XRFrame>;
  48686. /**
  48687. * Fires when the reference space changed
  48688. */
  48689. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48690. /**
  48691. * Fires when the xr session is ended either by the device or manually done
  48692. */
  48693. onXRSessionEnded: Observable<any>;
  48694. /**
  48695. * Fires when the xr session is ended either by the device or manually done
  48696. */
  48697. onXRSessionInit: Observable<XRSession>;
  48698. /**
  48699. * Underlying xr session
  48700. */
  48701. session: XRSession;
  48702. /**
  48703. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48704. * or get the offset the player is currently at.
  48705. */
  48706. viewerReferenceSpace: XRReferenceSpace;
  48707. /**
  48708. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48709. * @param scene The scene which the session should be created for
  48710. */
  48711. constructor(
  48712. /** The scene which the session should be created for */
  48713. scene: Scene);
  48714. /**
  48715. * The current reference space used in this session. This reference space can constantly change!
  48716. * It is mainly used to offset the camera's position.
  48717. */
  48718. get referenceSpace(): XRReferenceSpace;
  48719. /**
  48720. * Set a new reference space and triggers the observable
  48721. */
  48722. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48723. /**
  48724. * Disposes of the session manager
  48725. */
  48726. dispose(): void;
  48727. /**
  48728. * Stops the xrSession and restores the render loop
  48729. * @returns Promise which resolves after it exits XR
  48730. */
  48731. exitXRAsync(): Promise<void>;
  48732. /**
  48733. * Gets the correct render target texture to be rendered this frame for this eye
  48734. * @param eye the eye for which to get the render target
  48735. * @returns the render target for the specified eye
  48736. */
  48737. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48738. /**
  48739. * Creates a WebXRRenderTarget object for the XR session
  48740. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48741. * @param options optional options to provide when creating a new render target
  48742. * @returns a WebXR render target to which the session can render
  48743. */
  48744. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48745. /**
  48746. * Initializes the manager
  48747. * After initialization enterXR can be called to start an XR session
  48748. * @returns Promise which resolves after it is initialized
  48749. */
  48750. initializeAsync(): Promise<void>;
  48751. /**
  48752. * Initializes an xr session
  48753. * @param xrSessionMode mode to initialize
  48754. * @param xrSessionInit defines optional and required values to pass to the session builder
  48755. * @returns a promise which will resolve once the session has been initialized
  48756. */
  48757. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48758. /**
  48759. * Checks if a session would be supported for the creation options specified
  48760. * @param sessionMode session mode to check if supported eg. immersive-vr
  48761. * @returns A Promise that resolves to true if supported and false if not
  48762. */
  48763. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48764. /**
  48765. * Resets the reference space to the one started the session
  48766. */
  48767. resetReferenceSpace(): void;
  48768. /**
  48769. * Starts rendering to the xr layer
  48770. */
  48771. runXRRenderLoop(): void;
  48772. /**
  48773. * Sets the reference space on the xr session
  48774. * @param referenceSpaceType space to set
  48775. * @returns a promise that will resolve once the reference space has been set
  48776. */
  48777. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48778. /**
  48779. * Updates the render state of the session
  48780. * @param state state to set
  48781. * @returns a promise that resolves once the render state has been updated
  48782. */
  48783. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48784. /**
  48785. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48786. * @param sessionMode defines the session to test
  48787. * @returns a promise with boolean as final value
  48788. */
  48789. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48790. private _createRenderTargetTexture;
  48791. }
  48792. }
  48793. declare module "babylonjs/XR/webXRCamera" {
  48794. import { Vector3 } from "babylonjs/Maths/math.vector";
  48795. import { Scene } from "babylonjs/scene";
  48796. import { Camera } from "babylonjs/Cameras/camera";
  48797. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48798. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48799. import { Observable } from "babylonjs/Misc/observable";
  48800. /**
  48801. * WebXR Camera which holds the views for the xrSession
  48802. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48803. */
  48804. export class WebXRCamera extends FreeCamera {
  48805. private _xrSessionManager;
  48806. private _firstFrame;
  48807. private _referenceQuaternion;
  48808. private _referencedPosition;
  48809. private _xrInvPositionCache;
  48810. private _xrInvQuaternionCache;
  48811. /**
  48812. * Observable raised before camera teleportation
  48813. */
  48814. onBeforeCameraTeleport: Observable<Vector3>;
  48815. /**
  48816. * Observable raised after camera teleportation
  48817. */
  48818. onAfterCameraTeleport: Observable<Vector3>;
  48819. /**
  48820. * Should position compensation execute on first frame.
  48821. * This is used when copying the position from a native (non XR) camera
  48822. */
  48823. compensateOnFirstFrame: boolean;
  48824. /**
  48825. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48826. * @param name the name of the camera
  48827. * @param scene the scene to add the camera to
  48828. * @param _xrSessionManager a constructed xr session manager
  48829. */
  48830. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48831. /**
  48832. * Return the user's height, unrelated to the current ground.
  48833. * This will be the y position of this camera, when ground level is 0.
  48834. */
  48835. get realWorldHeight(): number;
  48836. /** @hidden */
  48837. _updateForDualEyeDebugging(): void;
  48838. /**
  48839. * Sets this camera's transformation based on a non-vr camera
  48840. * @param otherCamera the non-vr camera to copy the transformation from
  48841. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48842. */
  48843. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48844. /**
  48845. * Gets the current instance class name ("WebXRCamera").
  48846. * @returns the class name
  48847. */
  48848. getClassName(): string;
  48849. private _rotate180;
  48850. private _updateFromXRSession;
  48851. private _updateNumberOfRigCameras;
  48852. private _updateReferenceSpace;
  48853. private _updateReferenceSpaceOffset;
  48854. }
  48855. }
  48856. declare module "babylonjs/XR/webXRFeaturesManager" {
  48857. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48858. import { IDisposable } from "babylonjs/scene";
  48859. /**
  48860. * Defining the interface required for a (webxr) feature
  48861. */
  48862. export interface IWebXRFeature extends IDisposable {
  48863. /**
  48864. * Is this feature attached
  48865. */
  48866. attached: boolean;
  48867. /**
  48868. * Should auto-attach be disabled?
  48869. */
  48870. disableAutoAttach: boolean;
  48871. /**
  48872. * Attach the feature to the session
  48873. * Will usually be called by the features manager
  48874. *
  48875. * @param force should attachment be forced (even when already attached)
  48876. * @returns true if successful.
  48877. */
  48878. attach(force?: boolean): boolean;
  48879. /**
  48880. * Detach the feature from the session
  48881. * Will usually be called by the features manager
  48882. *
  48883. * @returns true if successful.
  48884. */
  48885. detach(): boolean;
  48886. /**
  48887. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  48888. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  48889. *
  48890. * @returns whether or not the feature is compatible in this environment
  48891. */
  48892. isCompatible(): boolean;
  48893. /**
  48894. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  48895. */
  48896. xrNativeFeatureName?: string;
  48897. /**
  48898. * A list of (Babylon WebXR) features this feature depends on
  48899. */
  48900. dependsOn?: string[];
  48901. }
  48902. /**
  48903. * A list of the currently available features without referencing them
  48904. */
  48905. export class WebXRFeatureName {
  48906. /**
  48907. * The name of the anchor system feature
  48908. */
  48909. static readonly ANCHOR_SYSTEM: string;
  48910. /**
  48911. * The name of the background remover feature
  48912. */
  48913. static readonly BACKGROUND_REMOVER: string;
  48914. /**
  48915. * The name of the hit test feature
  48916. */
  48917. static readonly HIT_TEST: string;
  48918. /**
  48919. * physics impostors for xr controllers feature
  48920. */
  48921. static readonly PHYSICS_CONTROLLERS: string;
  48922. /**
  48923. * The name of the plane detection feature
  48924. */
  48925. static readonly PLANE_DETECTION: string;
  48926. /**
  48927. * The name of the pointer selection feature
  48928. */
  48929. static readonly POINTER_SELECTION: string;
  48930. /**
  48931. * The name of the teleportation feature
  48932. */
  48933. static readonly TELEPORTATION: string;
  48934. /**
  48935. * The name of the feature points feature.
  48936. */
  48937. static readonly FEATURE_POINTS: string;
  48938. /**
  48939. * The name of the hand tracking feature.
  48940. */
  48941. static readonly HAND_TRACKING: string;
  48942. }
  48943. /**
  48944. * Defining the constructor of a feature. Used to register the modules.
  48945. */
  48946. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  48947. /**
  48948. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  48949. * It is mainly used in AR sessions.
  48950. *
  48951. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  48952. */
  48953. export class WebXRFeaturesManager implements IDisposable {
  48954. private _xrSessionManager;
  48955. private static readonly _AvailableFeatures;
  48956. private _features;
  48957. /**
  48958. * constructs a new features manages.
  48959. *
  48960. * @param _xrSessionManager an instance of WebXRSessionManager
  48961. */
  48962. constructor(_xrSessionManager: WebXRSessionManager);
  48963. /**
  48964. * Used to register a module. After calling this function a developer can use this feature in the scene.
  48965. * Mainly used internally.
  48966. *
  48967. * @param featureName the name of the feature to register
  48968. * @param constructorFunction the function used to construct the module
  48969. * @param version the (babylon) version of the module
  48970. * @param stable is that a stable version of this module
  48971. */
  48972. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  48973. /**
  48974. * Returns a constructor of a specific feature.
  48975. *
  48976. * @param featureName the name of the feature to construct
  48977. * @param version the version of the feature to load
  48978. * @param xrSessionManager the xrSessionManager. Used to construct the module
  48979. * @param options optional options provided to the module.
  48980. * @returns a function that, when called, will return a new instance of this feature
  48981. */
  48982. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  48983. /**
  48984. * Can be used to return the list of features currently registered
  48985. *
  48986. * @returns an Array of available features
  48987. */
  48988. static GetAvailableFeatures(): string[];
  48989. /**
  48990. * Gets the versions available for a specific feature
  48991. * @param featureName the name of the feature
  48992. * @returns an array with the available versions
  48993. */
  48994. static GetAvailableVersions(featureName: string): string[];
  48995. /**
  48996. * Return the latest unstable version of this feature
  48997. * @param featureName the name of the feature to search
  48998. * @returns the version number. if not found will return -1
  48999. */
  49000. static GetLatestVersionOfFeature(featureName: string): number;
  49001. /**
  49002. * Return the latest stable version of this feature
  49003. * @param featureName the name of the feature to search
  49004. * @returns the version number. if not found will return -1
  49005. */
  49006. static GetStableVersionOfFeature(featureName: string): number;
  49007. /**
  49008. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  49009. * Can be used during a session to start a feature
  49010. * @param featureName the name of feature to attach
  49011. */
  49012. attachFeature(featureName: string): void;
  49013. /**
  49014. * Can be used inside a session or when the session ends to detach a specific feature
  49015. * @param featureName the name of the feature to detach
  49016. */
  49017. detachFeature(featureName: string): void;
  49018. /**
  49019. * Used to disable an already-enabled feature
  49020. * The feature will be disposed and will be recreated once enabled.
  49021. * @param featureName the feature to disable
  49022. * @returns true if disable was successful
  49023. */
  49024. disableFeature(featureName: string | {
  49025. Name: string;
  49026. }): boolean;
  49027. /**
  49028. * dispose this features manager
  49029. */
  49030. dispose(): void;
  49031. /**
  49032. * 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.
  49033. * 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.
  49034. *
  49035. * @param featureName the name of the feature to load or the class of the feature
  49036. * @param version optional version to load. if not provided the latest version will be enabled
  49037. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  49038. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  49039. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  49040. * @returns a new constructed feature or throws an error if feature not found.
  49041. */
  49042. enableFeature(featureName: string | {
  49043. Name: string;
  49044. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  49045. /**
  49046. * get the implementation of an enabled feature.
  49047. * @param featureName the name of the feature to load
  49048. * @returns the feature class, if found
  49049. */
  49050. getEnabledFeature(featureName: string): IWebXRFeature;
  49051. /**
  49052. * Get the list of enabled features
  49053. * @returns an array of enabled features
  49054. */
  49055. getEnabledFeatures(): string[];
  49056. /**
  49057. * This function will exten the session creation configuration object with enabled features.
  49058. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  49059. * according to the defined "required" variable, provided during enableFeature call
  49060. * @param xrSessionInit the xr Session init object to extend
  49061. *
  49062. * @returns an extended XRSessionInit object
  49063. */
  49064. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  49065. }
  49066. }
  49067. declare module "babylonjs/XR/webXRExperienceHelper" {
  49068. import { Observable } from "babylonjs/Misc/observable";
  49069. import { IDisposable, Scene } from "babylonjs/scene";
  49070. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49071. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  49072. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  49073. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  49074. /**
  49075. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  49076. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  49077. */
  49078. export class WebXRExperienceHelper implements IDisposable {
  49079. private scene;
  49080. private _nonVRCamera;
  49081. private _originalSceneAutoClear;
  49082. private _supported;
  49083. /**
  49084. * Camera used to render xr content
  49085. */
  49086. camera: WebXRCamera;
  49087. /** A features manager for this xr session */
  49088. featuresManager: WebXRFeaturesManager;
  49089. /**
  49090. * Observers registered here will be triggered after the camera's initial transformation is set
  49091. * This can be used to set a different ground level or an extra rotation.
  49092. *
  49093. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  49094. * to the position set after this observable is done executing.
  49095. */
  49096. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  49097. /**
  49098. * Fires when the state of the experience helper has changed
  49099. */
  49100. onStateChangedObservable: Observable<WebXRState>;
  49101. /** Session manager used to keep track of xr session */
  49102. sessionManager: WebXRSessionManager;
  49103. /**
  49104. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  49105. */
  49106. state: WebXRState;
  49107. /**
  49108. * Creates a WebXRExperienceHelper
  49109. * @param scene The scene the helper should be created in
  49110. */
  49111. private constructor();
  49112. /**
  49113. * Creates the experience helper
  49114. * @param scene the scene to attach the experience helper to
  49115. * @returns a promise for the experience helper
  49116. */
  49117. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  49118. /**
  49119. * Disposes of the experience helper
  49120. */
  49121. dispose(): void;
  49122. /**
  49123. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  49124. * @param sessionMode options for the XR session
  49125. * @param referenceSpaceType frame of reference of the XR session
  49126. * @param renderTarget the output canvas that will be used to enter XR mode
  49127. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  49128. * @returns promise that resolves after xr mode has entered
  49129. */
  49130. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  49131. /**
  49132. * Exits XR mode and returns the scene to its original state
  49133. * @returns promise that resolves after xr mode has exited
  49134. */
  49135. exitXRAsync(): Promise<void>;
  49136. private _nonXRToXRCamera;
  49137. private _setState;
  49138. }
  49139. }
  49140. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  49141. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49142. import { Observable } from "babylonjs/Misc/observable";
  49143. import { IDisposable } from "babylonjs/scene";
  49144. /**
  49145. * X-Y values for axes in WebXR
  49146. */
  49147. export interface IWebXRMotionControllerAxesValue {
  49148. /**
  49149. * The value of the x axis
  49150. */
  49151. x: number;
  49152. /**
  49153. * The value of the y-axis
  49154. */
  49155. y: number;
  49156. }
  49157. /**
  49158. * changed / previous values for the values of this component
  49159. */
  49160. export interface IWebXRMotionControllerComponentChangesValues<T> {
  49161. /**
  49162. * current (this frame) value
  49163. */
  49164. current: T;
  49165. /**
  49166. * previous (last change) value
  49167. */
  49168. previous: T;
  49169. }
  49170. /**
  49171. * Represents changes in the component between current frame and last values recorded
  49172. */
  49173. export interface IWebXRMotionControllerComponentChanges {
  49174. /**
  49175. * will be populated with previous and current values if axes changed
  49176. */
  49177. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  49178. /**
  49179. * will be populated with previous and current values if pressed changed
  49180. */
  49181. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49182. /**
  49183. * will be populated with previous and current values if touched changed
  49184. */
  49185. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49186. /**
  49187. * will be populated with previous and current values if value changed
  49188. */
  49189. value?: IWebXRMotionControllerComponentChangesValues<number>;
  49190. }
  49191. /**
  49192. * This class represents a single component (for example button or thumbstick) of a motion controller
  49193. */
  49194. export class WebXRControllerComponent implements IDisposable {
  49195. /**
  49196. * the id of this component
  49197. */
  49198. id: string;
  49199. /**
  49200. * the type of the component
  49201. */
  49202. type: MotionControllerComponentType;
  49203. private _buttonIndex;
  49204. private _axesIndices;
  49205. private _axes;
  49206. private _changes;
  49207. private _currentValue;
  49208. private _hasChanges;
  49209. private _pressed;
  49210. private _touched;
  49211. /**
  49212. * button component type
  49213. */
  49214. static BUTTON_TYPE: MotionControllerComponentType;
  49215. /**
  49216. * squeeze component type
  49217. */
  49218. static SQUEEZE_TYPE: MotionControllerComponentType;
  49219. /**
  49220. * Thumbstick component type
  49221. */
  49222. static THUMBSTICK_TYPE: MotionControllerComponentType;
  49223. /**
  49224. * Touchpad component type
  49225. */
  49226. static TOUCHPAD_TYPE: MotionControllerComponentType;
  49227. /**
  49228. * trigger component type
  49229. */
  49230. static TRIGGER_TYPE: MotionControllerComponentType;
  49231. /**
  49232. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  49233. * the axes data changes
  49234. */
  49235. onAxisValueChangedObservable: Observable<{
  49236. x: number;
  49237. y: number;
  49238. }>;
  49239. /**
  49240. * Observers registered here will be triggered when the state of a button changes
  49241. * State change is either pressed / touched / value
  49242. */
  49243. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  49244. /**
  49245. * Creates a new component for a motion controller.
  49246. * It is created by the motion controller itself
  49247. *
  49248. * @param id the id of this component
  49249. * @param type the type of the component
  49250. * @param _buttonIndex index in the buttons array of the gamepad
  49251. * @param _axesIndices indices of the values in the axes array of the gamepad
  49252. */
  49253. constructor(
  49254. /**
  49255. * the id of this component
  49256. */
  49257. id: string,
  49258. /**
  49259. * the type of the component
  49260. */
  49261. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  49262. /**
  49263. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  49264. */
  49265. get axes(): IWebXRMotionControllerAxesValue;
  49266. /**
  49267. * Get the changes. Elements will be populated only if they changed with their previous and current value
  49268. */
  49269. get changes(): IWebXRMotionControllerComponentChanges;
  49270. /**
  49271. * Return whether or not the component changed the last frame
  49272. */
  49273. get hasChanges(): boolean;
  49274. /**
  49275. * is the button currently pressed
  49276. */
  49277. get pressed(): boolean;
  49278. /**
  49279. * is the button currently touched
  49280. */
  49281. get touched(): boolean;
  49282. /**
  49283. * Get the current value of this component
  49284. */
  49285. get value(): number;
  49286. /**
  49287. * Dispose this component
  49288. */
  49289. dispose(): void;
  49290. /**
  49291. * Are there axes correlating to this component
  49292. * @return true is axes data is available
  49293. */
  49294. isAxes(): boolean;
  49295. /**
  49296. * Is this component a button (hence - pressable)
  49297. * @returns true if can be pressed
  49298. */
  49299. isButton(): boolean;
  49300. /**
  49301. * update this component using the gamepad object it is in. Called on every frame
  49302. * @param nativeController the native gamepad controller object
  49303. */
  49304. update(nativeController: IMinimalMotionControllerObject): void;
  49305. }
  49306. }
  49307. declare module "babylonjs/Loading/sceneLoader" {
  49308. import { Observable } from "babylonjs/Misc/observable";
  49309. import { Nullable } from "babylonjs/types";
  49310. import { Scene } from "babylonjs/scene";
  49311. import { Engine } from "babylonjs/Engines/engine";
  49312. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49313. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  49314. import { AssetContainer } from "babylonjs/assetContainer";
  49315. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  49316. import { Skeleton } from "babylonjs/Bones/skeleton";
  49317. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  49318. import { WebRequest } from "babylonjs/Misc/webRequest";
  49319. /**
  49320. * Interface used to represent data loading progression
  49321. */
  49322. export interface ISceneLoaderProgressEvent {
  49323. /**
  49324. * Defines if data length to load can be evaluated
  49325. */
  49326. readonly lengthComputable: boolean;
  49327. /**
  49328. * Defines the loaded data length
  49329. */
  49330. readonly loaded: number;
  49331. /**
  49332. * Defines the data length to load
  49333. */
  49334. readonly total: number;
  49335. }
  49336. /**
  49337. * Interface used by SceneLoader plugins to define supported file extensions
  49338. */
  49339. export interface ISceneLoaderPluginExtensions {
  49340. /**
  49341. * Defines the list of supported extensions
  49342. */
  49343. [extension: string]: {
  49344. isBinary: boolean;
  49345. };
  49346. }
  49347. /**
  49348. * Interface used by SceneLoader plugin factory
  49349. */
  49350. export interface ISceneLoaderPluginFactory {
  49351. /**
  49352. * Defines the name of the factory
  49353. */
  49354. name: string;
  49355. /**
  49356. * Function called to create a new plugin
  49357. * @return the new plugin
  49358. */
  49359. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49360. /**
  49361. * The callback that returns true if the data can be directly loaded.
  49362. * @param data string containing the file data
  49363. * @returns if the data can be loaded directly
  49364. */
  49365. canDirectLoad?(data: string): boolean;
  49366. }
  49367. /**
  49368. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49369. */
  49370. export interface ISceneLoaderPluginBase {
  49371. /**
  49372. * The friendly name of this plugin.
  49373. */
  49374. name: string;
  49375. /**
  49376. * The file extensions supported by this plugin.
  49377. */
  49378. extensions: string | ISceneLoaderPluginExtensions;
  49379. /**
  49380. * The callback called when loading from a url.
  49381. * @param scene scene loading this url
  49382. * @param url url to load
  49383. * @param onSuccess callback called when the file successfully loads
  49384. * @param onProgress callback called while file is loading (if the server supports this mode)
  49385. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49386. * @param onError callback called when the file fails to load
  49387. * @returns a file request object
  49388. */
  49389. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49390. /**
  49391. * The callback called when loading from a file object.
  49392. * @param scene scene loading this file
  49393. * @param file defines the file to load
  49394. * @param onSuccess defines the callback to call when data is loaded
  49395. * @param onProgress defines the callback to call during loading process
  49396. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49397. * @param onError defines the callback to call when an error occurs
  49398. * @returns a file request object
  49399. */
  49400. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49401. /**
  49402. * The callback that returns true if the data can be directly loaded.
  49403. * @param data string containing the file data
  49404. * @returns if the data can be loaded directly
  49405. */
  49406. canDirectLoad?(data: string): boolean;
  49407. /**
  49408. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49409. * @param scene scene loading this data
  49410. * @param data string containing the data
  49411. * @returns data to pass to the plugin
  49412. */
  49413. directLoad?(scene: Scene, data: string): any;
  49414. /**
  49415. * The callback that allows custom handling of the root url based on the response url.
  49416. * @param rootUrl the original root url
  49417. * @param responseURL the response url if available
  49418. * @returns the new root url
  49419. */
  49420. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49421. }
  49422. /**
  49423. * Interface used to define a SceneLoader plugin
  49424. */
  49425. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49426. /**
  49427. * Import meshes into a scene.
  49428. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49429. * @param scene The scene to import into
  49430. * @param data The data to import
  49431. * @param rootUrl The root url for scene and resources
  49432. * @param meshes The meshes array to import into
  49433. * @param particleSystems The particle systems array to import into
  49434. * @param skeletons The skeletons array to import into
  49435. * @param onError The callback when import fails
  49436. * @returns True if successful or false otherwise
  49437. */
  49438. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49439. /**
  49440. * Load into a scene.
  49441. * @param scene The scene to load into
  49442. * @param data The data to import
  49443. * @param rootUrl The root url for scene and resources
  49444. * @param onError The callback when import fails
  49445. * @returns True if successful or false otherwise
  49446. */
  49447. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49448. /**
  49449. * Load into an asset container.
  49450. * @param scene The scene to load into
  49451. * @param data The data to import
  49452. * @param rootUrl The root url for scene and resources
  49453. * @param onError The callback when import fails
  49454. * @returns The loaded asset container
  49455. */
  49456. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49457. }
  49458. /**
  49459. * Interface used to define an async SceneLoader plugin
  49460. */
  49461. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49462. /**
  49463. * Import meshes into a scene.
  49464. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49465. * @param scene The scene to import into
  49466. * @param data The data to import
  49467. * @param rootUrl The root url for scene and resources
  49468. * @param onProgress The callback when the load progresses
  49469. * @param fileName Defines the name of the file to load
  49470. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49471. */
  49472. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49473. meshes: AbstractMesh[];
  49474. particleSystems: IParticleSystem[];
  49475. skeletons: Skeleton[];
  49476. animationGroups: AnimationGroup[];
  49477. }>;
  49478. /**
  49479. * Load into a scene.
  49480. * @param scene The scene to load into
  49481. * @param data The data to import
  49482. * @param rootUrl The root url for scene and resources
  49483. * @param onProgress The callback when the load progresses
  49484. * @param fileName Defines the name of the file to load
  49485. * @returns Nothing
  49486. */
  49487. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49488. /**
  49489. * Load into an asset container.
  49490. * @param scene The scene to load into
  49491. * @param data The data to import
  49492. * @param rootUrl The root url for scene and resources
  49493. * @param onProgress The callback when the load progresses
  49494. * @param fileName Defines the name of the file to load
  49495. * @returns The loaded asset container
  49496. */
  49497. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49498. }
  49499. /**
  49500. * Mode that determines how to handle old animation groups before loading new ones.
  49501. */
  49502. export enum SceneLoaderAnimationGroupLoadingMode {
  49503. /**
  49504. * Reset all old animations to initial state then dispose them.
  49505. */
  49506. Clean = 0,
  49507. /**
  49508. * Stop all old animations.
  49509. */
  49510. Stop = 1,
  49511. /**
  49512. * Restart old animations from first frame.
  49513. */
  49514. Sync = 2,
  49515. /**
  49516. * Old animations remains untouched.
  49517. */
  49518. NoSync = 3
  49519. }
  49520. /**
  49521. * Defines a plugin registered by the SceneLoader
  49522. */
  49523. interface IRegisteredPlugin {
  49524. /**
  49525. * Defines the plugin to use
  49526. */
  49527. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49528. /**
  49529. * Defines if the plugin supports binary data
  49530. */
  49531. isBinary: boolean;
  49532. }
  49533. /**
  49534. * Class used to load scene from various file formats using registered plugins
  49535. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49536. */
  49537. export class SceneLoader {
  49538. /**
  49539. * No logging while loading
  49540. */
  49541. static readonly NO_LOGGING: number;
  49542. /**
  49543. * Minimal logging while loading
  49544. */
  49545. static readonly MINIMAL_LOGGING: number;
  49546. /**
  49547. * Summary logging while loading
  49548. */
  49549. static readonly SUMMARY_LOGGING: number;
  49550. /**
  49551. * Detailled logging while loading
  49552. */
  49553. static readonly DETAILED_LOGGING: number;
  49554. /**
  49555. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49556. */
  49557. static get ForceFullSceneLoadingForIncremental(): boolean;
  49558. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49559. /**
  49560. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49561. */
  49562. static get ShowLoadingScreen(): boolean;
  49563. static set ShowLoadingScreen(value: boolean);
  49564. /**
  49565. * Defines the current logging level (while loading the scene)
  49566. * @ignorenaming
  49567. */
  49568. static get loggingLevel(): number;
  49569. static set loggingLevel(value: number);
  49570. /**
  49571. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49572. */
  49573. static get CleanBoneMatrixWeights(): boolean;
  49574. static set CleanBoneMatrixWeights(value: boolean);
  49575. /**
  49576. * Event raised when a plugin is used to load a scene
  49577. */
  49578. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49579. private static _registeredPlugins;
  49580. private static _showingLoadingScreen;
  49581. /**
  49582. * Gets the default plugin (used to load Babylon files)
  49583. * @returns the .babylon plugin
  49584. */
  49585. static GetDefaultPlugin(): IRegisteredPlugin;
  49586. private static _GetPluginForExtension;
  49587. private static _GetPluginForDirectLoad;
  49588. private static _GetPluginForFilename;
  49589. private static _GetDirectLoad;
  49590. private static _LoadData;
  49591. private static _GetFileInfo;
  49592. /**
  49593. * Gets a plugin that can load the given extension
  49594. * @param extension defines the extension to load
  49595. * @returns a plugin or null if none works
  49596. */
  49597. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49598. /**
  49599. * Gets a boolean indicating that the given extension can be loaded
  49600. * @param extension defines the extension to load
  49601. * @returns true if the extension is supported
  49602. */
  49603. static IsPluginForExtensionAvailable(extension: string): boolean;
  49604. /**
  49605. * Adds a new plugin to the list of registered plugins
  49606. * @param plugin defines the plugin to add
  49607. */
  49608. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49609. /**
  49610. * Import meshes into a scene
  49611. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49612. * @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)
  49613. * @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)
  49614. * @param scene the instance of BABYLON.Scene to append to
  49615. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  49616. * @param onProgress a callback with a progress event for each file being loaded
  49617. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49618. * @param pluginExtension the extension used to determine the plugin
  49619. * @returns The loaded plugin
  49620. */
  49621. 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>;
  49622. /**
  49623. * Import meshes into a scene
  49624. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49625. * @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)
  49626. * @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)
  49627. * @param scene the instance of BABYLON.Scene to append to
  49628. * @param onProgress a callback with a progress event for each file being loaded
  49629. * @param pluginExtension the extension used to determine the plugin
  49630. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49631. */
  49632. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49633. meshes: AbstractMesh[];
  49634. particleSystems: IParticleSystem[];
  49635. skeletons: Skeleton[];
  49636. animationGroups: AnimationGroup[];
  49637. }>;
  49638. /**
  49639. * Load a scene
  49640. * @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)
  49641. * @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)
  49642. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49643. * @param onSuccess a callback with the scene when import succeeds
  49644. * @param onProgress a callback with a progress event for each file being loaded
  49645. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49646. * @param pluginExtension the extension used to determine the plugin
  49647. * @returns The loaded plugin
  49648. */
  49649. 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>;
  49650. /**
  49651. * Load a scene
  49652. * @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)
  49653. * @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)
  49654. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49655. * @param onProgress a callback with a progress event for each file being loaded
  49656. * @param pluginExtension the extension used to determine the plugin
  49657. * @returns The loaded scene
  49658. */
  49659. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49660. /**
  49661. * Append a scene
  49662. * @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)
  49663. * @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)
  49664. * @param scene is the instance of BABYLON.Scene to append to
  49665. * @param onSuccess a callback with the scene when import succeeds
  49666. * @param onProgress a callback with a progress event for each file being loaded
  49667. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49668. * @param pluginExtension the extension used to determine the plugin
  49669. * @returns The loaded plugin
  49670. */
  49671. 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>;
  49672. /**
  49673. * Append a scene
  49674. * @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)
  49675. * @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)
  49676. * @param scene is the instance of BABYLON.Scene to append to
  49677. * @param onProgress a callback with a progress event for each file being loaded
  49678. * @param pluginExtension the extension used to determine the plugin
  49679. * @returns The given scene
  49680. */
  49681. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49682. /**
  49683. * Load a scene into an asset container
  49684. * @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)
  49685. * @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)
  49686. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49687. * @param onSuccess a callback with the scene when import succeeds
  49688. * @param onProgress a callback with a progress event for each file being loaded
  49689. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49690. * @param pluginExtension the extension used to determine the plugin
  49691. * @returns The loaded plugin
  49692. */
  49693. 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>;
  49694. /**
  49695. * Load a scene into an asset container
  49696. * @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)
  49697. * @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)
  49698. * @param scene is the instance of Scene to append to
  49699. * @param onProgress a callback with a progress event for each file being loaded
  49700. * @param pluginExtension the extension used to determine the plugin
  49701. * @returns The loaded asset container
  49702. */
  49703. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49704. /**
  49705. * Import animations from a file into a scene
  49706. * @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)
  49707. * @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)
  49708. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49709. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49710. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49711. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49712. * @param onSuccess a callback with the scene when import succeeds
  49713. * @param onProgress a callback with a progress event for each file being loaded
  49714. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49715. * @param pluginExtension the extension used to determine the plugin
  49716. */
  49717. 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;
  49718. /**
  49719. * Import animations from a file into a scene
  49720. * @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)
  49721. * @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)
  49722. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49723. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49724. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49725. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49726. * @param onSuccess a callback with the scene when import succeeds
  49727. * @param onProgress a callback with a progress event for each file being loaded
  49728. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49729. * @param pluginExtension the extension used to determine the plugin
  49730. * @returns the updated scene with imported animations
  49731. */
  49732. 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>;
  49733. }
  49734. }
  49735. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49736. import { IDisposable, Scene } from "babylonjs/scene";
  49737. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49738. import { Observable } from "babylonjs/Misc/observable";
  49739. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49740. import { Nullable } from "babylonjs/types";
  49741. /**
  49742. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49743. */
  49744. export type MotionControllerHandedness = "none" | "left" | "right";
  49745. /**
  49746. * The type of components available in motion controllers.
  49747. * This is not the name of the component.
  49748. */
  49749. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49750. /**
  49751. * The state of a controller component
  49752. */
  49753. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49754. /**
  49755. * The schema of motion controller layout.
  49756. * No object will be initialized using this interface
  49757. * This is used just to define the profile.
  49758. */
  49759. export interface IMotionControllerLayout {
  49760. /**
  49761. * Path to load the assets. Usually relative to the base path
  49762. */
  49763. assetPath: string;
  49764. /**
  49765. * Available components (unsorted)
  49766. */
  49767. components: {
  49768. /**
  49769. * A map of component Ids
  49770. */
  49771. [componentId: string]: {
  49772. /**
  49773. * The type of input the component outputs
  49774. */
  49775. type: MotionControllerComponentType;
  49776. /**
  49777. * The indices of this component in the gamepad object
  49778. */
  49779. gamepadIndices: {
  49780. /**
  49781. * Index of button
  49782. */
  49783. button?: number;
  49784. /**
  49785. * If available, index of x-axis
  49786. */
  49787. xAxis?: number;
  49788. /**
  49789. * If available, index of y-axis
  49790. */
  49791. yAxis?: number;
  49792. };
  49793. /**
  49794. * The mesh's root node name
  49795. */
  49796. rootNodeName: string;
  49797. /**
  49798. * Animation definitions for this model
  49799. */
  49800. visualResponses: {
  49801. [stateKey: string]: {
  49802. /**
  49803. * What property will be animated
  49804. */
  49805. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49806. /**
  49807. * What states influence this visual response
  49808. */
  49809. states: MotionControllerComponentStateType[];
  49810. /**
  49811. * Type of animation - movement or visibility
  49812. */
  49813. valueNodeProperty: "transform" | "visibility";
  49814. /**
  49815. * Base node name to move. Its position will be calculated according to the min and max nodes
  49816. */
  49817. valueNodeName?: string;
  49818. /**
  49819. * Minimum movement node
  49820. */
  49821. minNodeName?: string;
  49822. /**
  49823. * Max movement node
  49824. */
  49825. maxNodeName?: string;
  49826. };
  49827. };
  49828. /**
  49829. * If touch enabled, what is the name of node to display user feedback
  49830. */
  49831. touchPointNodeName?: string;
  49832. };
  49833. };
  49834. /**
  49835. * Is it xr standard mapping or not
  49836. */
  49837. gamepadMapping: "" | "xr-standard";
  49838. /**
  49839. * Base root node of this entire model
  49840. */
  49841. rootNodeName: string;
  49842. /**
  49843. * Defines the main button component id
  49844. */
  49845. selectComponentId: string;
  49846. }
  49847. /**
  49848. * A definition for the layout map in the input profile
  49849. */
  49850. export interface IMotionControllerLayoutMap {
  49851. /**
  49852. * Layouts with handedness type as a key
  49853. */
  49854. [handedness: string]: IMotionControllerLayout;
  49855. }
  49856. /**
  49857. * The XR Input profile schema
  49858. * Profiles can be found here:
  49859. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49860. */
  49861. export interface IMotionControllerProfile {
  49862. /**
  49863. * fallback profiles for this profileId
  49864. */
  49865. fallbackProfileIds: string[];
  49866. /**
  49867. * The layout map, with handedness as key
  49868. */
  49869. layouts: IMotionControllerLayoutMap;
  49870. /**
  49871. * The id of this profile
  49872. * correlates to the profile(s) in the xrInput.profiles array
  49873. */
  49874. profileId: string;
  49875. }
  49876. /**
  49877. * A helper-interface for the 3 meshes needed for controller button animation
  49878. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  49879. */
  49880. export interface IMotionControllerButtonMeshMap {
  49881. /**
  49882. * the mesh that defines the pressed value mesh position.
  49883. * This is used to find the max-position of this button
  49884. */
  49885. pressedMesh: AbstractMesh;
  49886. /**
  49887. * the mesh that defines the unpressed value mesh position.
  49888. * This is used to find the min (or initial) position of this button
  49889. */
  49890. unpressedMesh: AbstractMesh;
  49891. /**
  49892. * The mesh that will be changed when value changes
  49893. */
  49894. valueMesh: AbstractMesh;
  49895. }
  49896. /**
  49897. * A helper-interface for the 3 meshes needed for controller axis animation.
  49898. * This will be expanded when touchpad animations are fully supported
  49899. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  49900. */
  49901. export interface IMotionControllerMeshMap {
  49902. /**
  49903. * the mesh that defines the maximum value mesh position.
  49904. */
  49905. maxMesh?: AbstractMesh;
  49906. /**
  49907. * the mesh that defines the minimum value mesh position.
  49908. */
  49909. minMesh?: AbstractMesh;
  49910. /**
  49911. * The mesh that will be changed when axis value changes
  49912. */
  49913. valueMesh?: AbstractMesh;
  49914. }
  49915. /**
  49916. * The elements needed for change-detection of the gamepad objects in motion controllers
  49917. */
  49918. export interface IMinimalMotionControllerObject {
  49919. /**
  49920. * Available axes of this controller
  49921. */
  49922. axes: number[];
  49923. /**
  49924. * An array of available buttons
  49925. */
  49926. buttons: Array<{
  49927. /**
  49928. * Value of the button/trigger
  49929. */
  49930. value: number;
  49931. /**
  49932. * If the button/trigger is currently touched
  49933. */
  49934. touched: boolean;
  49935. /**
  49936. * If the button/trigger is currently pressed
  49937. */
  49938. pressed: boolean;
  49939. }>;
  49940. /**
  49941. * EXPERIMENTAL haptic support.
  49942. */
  49943. hapticActuators?: Array<{
  49944. pulse: (value: number, duration: number) => Promise<boolean>;
  49945. }>;
  49946. }
  49947. /**
  49948. * An Abstract Motion controller
  49949. * This class receives an xrInput and a profile layout and uses those to initialize the components
  49950. * Each component has an observable to check for changes in value and state
  49951. */
  49952. export abstract class WebXRAbstractMotionController implements IDisposable {
  49953. protected scene: Scene;
  49954. protected layout: IMotionControllerLayout;
  49955. /**
  49956. * The gamepad object correlating to this controller
  49957. */
  49958. gamepadObject: IMinimalMotionControllerObject;
  49959. /**
  49960. * handedness (left/right/none) of this controller
  49961. */
  49962. handedness: MotionControllerHandedness;
  49963. private _initComponent;
  49964. private _modelReady;
  49965. /**
  49966. * A map of components (WebXRControllerComponent) in this motion controller
  49967. * Components have a ComponentType and can also have both button and axis definitions
  49968. */
  49969. readonly components: {
  49970. [id: string]: WebXRControllerComponent;
  49971. };
  49972. /**
  49973. * Disable the model's animation. Can be set at any time.
  49974. */
  49975. disableAnimation: boolean;
  49976. /**
  49977. * Observers registered here will be triggered when the model of this controller is done loading
  49978. */
  49979. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  49980. /**
  49981. * The profile id of this motion controller
  49982. */
  49983. abstract profileId: string;
  49984. /**
  49985. * The root mesh of the model. It is null if the model was not yet initialized
  49986. */
  49987. rootMesh: Nullable<AbstractMesh>;
  49988. /**
  49989. * constructs a new abstract motion controller
  49990. * @param scene the scene to which the model of the controller will be added
  49991. * @param layout The profile layout to load
  49992. * @param gamepadObject The gamepad object correlating to this controller
  49993. * @param handedness handedness (left/right/none) of this controller
  49994. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  49995. */
  49996. constructor(scene: Scene, layout: IMotionControllerLayout,
  49997. /**
  49998. * The gamepad object correlating to this controller
  49999. */
  50000. gamepadObject: IMinimalMotionControllerObject,
  50001. /**
  50002. * handedness (left/right/none) of this controller
  50003. */
  50004. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  50005. /**
  50006. * Dispose this controller, the model mesh and all its components
  50007. */
  50008. dispose(): void;
  50009. /**
  50010. * Returns all components of specific type
  50011. * @param type the type to search for
  50012. * @return an array of components with this type
  50013. */
  50014. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  50015. /**
  50016. * get a component based an its component id as defined in layout.components
  50017. * @param id the id of the component
  50018. * @returns the component correlates to the id or undefined if not found
  50019. */
  50020. getComponent(id: string): WebXRControllerComponent;
  50021. /**
  50022. * Get the list of components available in this motion controller
  50023. * @returns an array of strings correlating to available components
  50024. */
  50025. getComponentIds(): string[];
  50026. /**
  50027. * Get the first component of specific type
  50028. * @param type type of component to find
  50029. * @return a controller component or null if not found
  50030. */
  50031. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  50032. /**
  50033. * Get the main (Select) component of this controller as defined in the layout
  50034. * @returns the main component of this controller
  50035. */
  50036. getMainComponent(): WebXRControllerComponent;
  50037. /**
  50038. * Loads the model correlating to this controller
  50039. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  50040. * @returns A promise fulfilled with the result of the model loading
  50041. */
  50042. loadModel(): Promise<boolean>;
  50043. /**
  50044. * Update this model using the current XRFrame
  50045. * @param xrFrame the current xr frame to use and update the model
  50046. */
  50047. updateFromXRFrame(xrFrame: XRFrame): void;
  50048. /**
  50049. * Backwards compatibility due to a deeply-integrated typo
  50050. */
  50051. get handness(): XREye;
  50052. /**
  50053. * Pulse (vibrate) this controller
  50054. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  50055. * Consecutive calls to this function will cancel the last pulse call
  50056. *
  50057. * @param value the strength of the pulse in 0.0...1.0 range
  50058. * @param duration Duration of the pulse in milliseconds
  50059. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  50060. * @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
  50061. */
  50062. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  50063. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50064. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50065. /**
  50066. * Moves the axis on the controller mesh based on its current state
  50067. * @param axis the index of the axis
  50068. * @param axisValue the value of the axis which determines the meshes new position
  50069. * @hidden
  50070. */
  50071. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  50072. /**
  50073. * Update the model itself with the current frame data
  50074. * @param xrFrame the frame to use for updating the model mesh
  50075. */
  50076. protected updateModel(xrFrame: XRFrame): void;
  50077. /**
  50078. * Get the filename and path for this controller's model
  50079. * @returns a map of filename and path
  50080. */
  50081. protected abstract _getFilenameAndPath(): {
  50082. filename: string;
  50083. path: string;
  50084. };
  50085. /**
  50086. * This function is called before the mesh is loaded. It checks for loading constraints.
  50087. * For example, this function can check if the GLB loader is available
  50088. * If this function returns false, the generic controller will be loaded instead
  50089. * @returns Is the client ready to load the mesh
  50090. */
  50091. protected abstract _getModelLoadingConstraints(): boolean;
  50092. /**
  50093. * This function will be called after the model was successfully loaded and can be used
  50094. * for mesh transformations before it is available for the user
  50095. * @param meshes the loaded meshes
  50096. */
  50097. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  50098. /**
  50099. * Set the root mesh for this controller. Important for the WebXR controller class
  50100. * @param meshes the loaded meshes
  50101. */
  50102. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  50103. /**
  50104. * A function executed each frame that updates the mesh (if needed)
  50105. * @param xrFrame the current xrFrame
  50106. */
  50107. protected abstract _updateModel(xrFrame: XRFrame): void;
  50108. private _getGenericFilenameAndPath;
  50109. private _getGenericParentMesh;
  50110. }
  50111. }
  50112. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  50113. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50114. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50115. import { Scene } from "babylonjs/scene";
  50116. /**
  50117. * A generic trigger-only motion controller for WebXR
  50118. */
  50119. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  50120. /**
  50121. * Static version of the profile id of this controller
  50122. */
  50123. static ProfileId: string;
  50124. profileId: string;
  50125. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  50126. protected _getFilenameAndPath(): {
  50127. filename: string;
  50128. path: string;
  50129. };
  50130. protected _getModelLoadingConstraints(): boolean;
  50131. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  50132. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50133. protected _updateModel(): void;
  50134. }
  50135. }
  50136. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  50137. import { Vector4 } from "babylonjs/Maths/math.vector";
  50138. import { Mesh } from "babylonjs/Meshes/mesh";
  50139. import { Scene } from "babylonjs/scene";
  50140. import { Nullable } from "babylonjs/types";
  50141. /**
  50142. * Class containing static functions to help procedurally build meshes
  50143. */
  50144. export class SphereBuilder {
  50145. /**
  50146. * Creates a sphere mesh
  50147. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  50148. * * 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`)
  50149. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  50150. * * 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
  50151. * * 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)
  50152. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50153. * * 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
  50154. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50155. * @param name defines the name of the mesh
  50156. * @param options defines the options used to create the mesh
  50157. * @param scene defines the hosting scene
  50158. * @returns the sphere mesh
  50159. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  50160. */
  50161. static CreateSphere(name: string, options: {
  50162. segments?: number;
  50163. diameter?: number;
  50164. diameterX?: number;
  50165. diameterY?: number;
  50166. diameterZ?: number;
  50167. arc?: number;
  50168. slice?: number;
  50169. sideOrientation?: number;
  50170. frontUVs?: Vector4;
  50171. backUVs?: Vector4;
  50172. updatable?: boolean;
  50173. }, scene?: Nullable<Scene>): Mesh;
  50174. }
  50175. }
  50176. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  50177. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50178. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50179. import { Scene } from "babylonjs/scene";
  50180. /**
  50181. * A profiled motion controller has its profile loaded from an online repository.
  50182. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  50183. */
  50184. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  50185. private _repositoryUrl;
  50186. private _buttonMeshMapping;
  50187. private _touchDots;
  50188. /**
  50189. * The profile ID of this controller. Will be populated when the controller initializes.
  50190. */
  50191. profileId: string;
  50192. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  50193. dispose(): void;
  50194. protected _getFilenameAndPath(): {
  50195. filename: string;
  50196. path: string;
  50197. };
  50198. protected _getModelLoadingConstraints(): boolean;
  50199. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  50200. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50201. protected _updateModel(_xrFrame: XRFrame): void;
  50202. }
  50203. }
  50204. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  50205. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50206. import { Scene } from "babylonjs/scene";
  50207. /**
  50208. * A construction function type to create a new controller based on an xrInput object
  50209. */
  50210. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  50211. /**
  50212. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  50213. *
  50214. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  50215. * it should be replaced with auto-loaded controllers.
  50216. *
  50217. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  50218. */
  50219. export class WebXRMotionControllerManager {
  50220. private static _AvailableControllers;
  50221. private static _Fallbacks;
  50222. private static _ProfileLoadingPromises;
  50223. private static _ProfilesList;
  50224. /**
  50225. * The base URL of the online controller repository. Can be changed at any time.
  50226. */
  50227. static BaseRepositoryUrl: string;
  50228. /**
  50229. * Which repository gets priority - local or online
  50230. */
  50231. static PrioritizeOnlineRepository: boolean;
  50232. /**
  50233. * Use the online repository, or use only locally-defined controllers
  50234. */
  50235. static UseOnlineRepository: boolean;
  50236. /**
  50237. * Clear the cache used for profile loading and reload when requested again
  50238. */
  50239. static ClearProfilesCache(): void;
  50240. /**
  50241. * Register the default fallbacks.
  50242. * This function is called automatically when this file is imported.
  50243. */
  50244. static DefaultFallbacks(): void;
  50245. /**
  50246. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  50247. * @param profileId the profile to which a fallback needs to be found
  50248. * @return an array with corresponding fallback profiles
  50249. */
  50250. static FindFallbackWithProfileId(profileId: string): string[];
  50251. /**
  50252. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  50253. * The order of search:
  50254. *
  50255. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  50256. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  50257. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  50258. * 4) return the generic trigger controller if none were found
  50259. *
  50260. * @param xrInput the xrInput to which a new controller is initialized
  50261. * @param scene the scene to which the model will be added
  50262. * @param forceProfile force a certain profile for this controller
  50263. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  50264. */
  50265. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  50266. /**
  50267. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  50268. *
  50269. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  50270. *
  50271. * @param type the profile type to register
  50272. * @param constructFunction the function to be called when loading this profile
  50273. */
  50274. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  50275. /**
  50276. * Register a fallback to a specific profile.
  50277. * @param profileId the profileId that will receive the fallbacks
  50278. * @param fallbacks A list of fallback profiles
  50279. */
  50280. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  50281. /**
  50282. * Will update the list of profiles available in the repository
  50283. * @return a promise that resolves to a map of profiles available online
  50284. */
  50285. static UpdateProfilesList(): Promise<{
  50286. [profile: string]: string;
  50287. }>;
  50288. private static _LoadProfileFromRepository;
  50289. private static _LoadProfilesFromAvailableControllers;
  50290. }
  50291. }
  50292. declare module "babylonjs/XR/webXRInputSource" {
  50293. import { Observable } from "babylonjs/Misc/observable";
  50294. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50295. import { Ray } from "babylonjs/Culling/ray";
  50296. import { Scene } from "babylonjs/scene";
  50297. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50298. /**
  50299. * Configuration options for the WebXR controller creation
  50300. */
  50301. export interface IWebXRControllerOptions {
  50302. /**
  50303. * Should the controller mesh be animated when a user interacts with it
  50304. * The pressed buttons / thumbstick and touchpad animations will be disabled
  50305. */
  50306. disableMotionControllerAnimation?: boolean;
  50307. /**
  50308. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  50309. */
  50310. doNotLoadControllerMesh?: boolean;
  50311. /**
  50312. * Force a specific controller type for this controller.
  50313. * This can be used when creating your own profile or when testing different controllers
  50314. */
  50315. forceControllerProfile?: string;
  50316. /**
  50317. * Defines a rendering group ID for meshes that will be loaded.
  50318. * This is for the default controllers only.
  50319. */
  50320. renderingGroupId?: number;
  50321. }
  50322. /**
  50323. * Represents an XR controller
  50324. */
  50325. export class WebXRInputSource {
  50326. private _scene;
  50327. /** The underlying input source for the controller */
  50328. inputSource: XRInputSource;
  50329. private _options;
  50330. private _tmpVector;
  50331. private _uniqueId;
  50332. private _disposed;
  50333. /**
  50334. * 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
  50335. */
  50336. grip?: AbstractMesh;
  50337. /**
  50338. * If available, this is the gamepad object related to this controller.
  50339. * Using this object it is possible to get click events and trackpad changes of the
  50340. * webxr controller that is currently being used.
  50341. */
  50342. motionController?: WebXRAbstractMotionController;
  50343. /**
  50344. * Event that fires when the controller is removed/disposed.
  50345. * The object provided as event data is this controller, after associated assets were disposed.
  50346. * uniqueId is still available.
  50347. */
  50348. onDisposeObservable: Observable<WebXRInputSource>;
  50349. /**
  50350. * Will be triggered when the mesh associated with the motion controller is done loading.
  50351. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  50352. * A shortened version of controller -> motion controller -> on mesh loaded.
  50353. */
  50354. onMeshLoadedObservable: Observable<AbstractMesh>;
  50355. /**
  50356. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50357. */
  50358. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50359. /**
  50360. * Pointer which can be used to select objects or attach a visible laser to
  50361. */
  50362. pointer: AbstractMesh;
  50363. /**
  50364. * Creates the input source object
  50365. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50366. * @param _scene the scene which the controller should be associated to
  50367. * @param inputSource the underlying input source for the controller
  50368. * @param _options options for this controller creation
  50369. */
  50370. constructor(_scene: Scene,
  50371. /** The underlying input source for the controller */
  50372. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50373. /**
  50374. * Get this controllers unique id
  50375. */
  50376. get uniqueId(): string;
  50377. /**
  50378. * Disposes of the object
  50379. */
  50380. dispose(): void;
  50381. /**
  50382. * Gets a world space ray coming from the pointer or grip
  50383. * @param result the resulting ray
  50384. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50385. */
  50386. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50387. /**
  50388. * Updates the controller pose based on the given XRFrame
  50389. * @param xrFrame xr frame to update the pose with
  50390. * @param referenceSpace reference space to use
  50391. */
  50392. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50393. }
  50394. }
  50395. declare module "babylonjs/XR/webXRInput" {
  50396. import { Observable } from "babylonjs/Misc/observable";
  50397. import { IDisposable } from "babylonjs/scene";
  50398. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50399. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50400. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50401. /**
  50402. * The schema for initialization options of the XR Input class
  50403. */
  50404. export interface IWebXRInputOptions {
  50405. /**
  50406. * If set to true no model will be automatically loaded
  50407. */
  50408. doNotLoadControllerMeshes?: boolean;
  50409. /**
  50410. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50411. * If not found, the xr input profile data will be used.
  50412. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50413. */
  50414. forceInputProfile?: string;
  50415. /**
  50416. * Do not send a request to the controller repository to load the profile.
  50417. *
  50418. * Instead, use the controllers available in babylon itself.
  50419. */
  50420. disableOnlineControllerRepository?: boolean;
  50421. /**
  50422. * A custom URL for the controllers repository
  50423. */
  50424. customControllersRepositoryURL?: string;
  50425. /**
  50426. * Should the controller model's components not move according to the user input
  50427. */
  50428. disableControllerAnimation?: boolean;
  50429. /**
  50430. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50431. */
  50432. controllerOptions?: IWebXRControllerOptions;
  50433. }
  50434. /**
  50435. * XR input used to track XR inputs such as controllers/rays
  50436. */
  50437. export class WebXRInput implements IDisposable {
  50438. /**
  50439. * the xr session manager for this session
  50440. */
  50441. xrSessionManager: WebXRSessionManager;
  50442. /**
  50443. * the WebXR camera for this session. Mainly used for teleportation
  50444. */
  50445. xrCamera: WebXRCamera;
  50446. private readonly options;
  50447. /**
  50448. * XR controllers being tracked
  50449. */
  50450. controllers: Array<WebXRInputSource>;
  50451. private _frameObserver;
  50452. private _sessionEndedObserver;
  50453. private _sessionInitObserver;
  50454. /**
  50455. * Event when a controller has been connected/added
  50456. */
  50457. onControllerAddedObservable: Observable<WebXRInputSource>;
  50458. /**
  50459. * Event when a controller has been removed/disconnected
  50460. */
  50461. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50462. /**
  50463. * Initializes the WebXRInput
  50464. * @param xrSessionManager the xr session manager for this session
  50465. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50466. * @param options = initialization options for this xr input
  50467. */
  50468. constructor(
  50469. /**
  50470. * the xr session manager for this session
  50471. */
  50472. xrSessionManager: WebXRSessionManager,
  50473. /**
  50474. * the WebXR camera for this session. Mainly used for teleportation
  50475. */
  50476. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50477. private _onInputSourcesChange;
  50478. private _addAndRemoveControllers;
  50479. /**
  50480. * Disposes of the object
  50481. */
  50482. dispose(): void;
  50483. }
  50484. }
  50485. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50486. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50487. import { Observable, EventState } from "babylonjs/Misc/observable";
  50488. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50489. /**
  50490. * This is the base class for all WebXR features.
  50491. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50492. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50493. */
  50494. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50495. protected _xrSessionManager: WebXRSessionManager;
  50496. private _attached;
  50497. private _removeOnDetach;
  50498. /**
  50499. * Should auto-attach be disabled?
  50500. */
  50501. disableAutoAttach: boolean;
  50502. /**
  50503. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  50504. */
  50505. xrNativeFeatureName: string;
  50506. /**
  50507. * Construct a new (abstract) WebXR feature
  50508. * @param _xrSessionManager the xr session manager for this feature
  50509. */
  50510. constructor(_xrSessionManager: WebXRSessionManager);
  50511. /**
  50512. * Is this feature attached
  50513. */
  50514. get attached(): boolean;
  50515. /**
  50516. * attach this feature
  50517. *
  50518. * @param force should attachment be forced (even when already attached)
  50519. * @returns true if successful, false is failed or already attached
  50520. */
  50521. attach(force?: boolean): boolean;
  50522. /**
  50523. * detach this feature.
  50524. *
  50525. * @returns true if successful, false if failed or already detached
  50526. */
  50527. detach(): boolean;
  50528. /**
  50529. * Dispose this feature and all of the resources attached
  50530. */
  50531. dispose(): void;
  50532. /**
  50533. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50534. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50535. *
  50536. * @returns whether or not the feature is compatible in this environment
  50537. */
  50538. isCompatible(): boolean;
  50539. /**
  50540. * This is used to register callbacks that will automatically be removed when detach is called.
  50541. * @param observable the observable to which the observer will be attached
  50542. * @param callback the callback to register
  50543. */
  50544. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50545. /**
  50546. * Code in this function will be executed on each xrFrame received from the browser.
  50547. * This function will not execute after the feature is detached.
  50548. * @param _xrFrame the current frame
  50549. */
  50550. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50551. }
  50552. }
  50553. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50554. import { IDisposable, Scene } from "babylonjs/scene";
  50555. import { Nullable } from "babylonjs/types";
  50556. import { Observable } from "babylonjs/Misc/observable";
  50557. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50558. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50559. import { Camera } from "babylonjs/Cameras/camera";
  50560. /**
  50561. * Renders a layer on top of an existing scene
  50562. */
  50563. export class UtilityLayerRenderer implements IDisposable {
  50564. /** the original scene that will be rendered on top of */
  50565. originalScene: Scene;
  50566. private _pointerCaptures;
  50567. private _lastPointerEvents;
  50568. private static _DefaultUtilityLayer;
  50569. private static _DefaultKeepDepthUtilityLayer;
  50570. private _sharedGizmoLight;
  50571. private _renderCamera;
  50572. /**
  50573. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50574. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50575. * @returns the camera that is used when rendering the utility layer
  50576. */
  50577. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50578. /**
  50579. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50580. * @param cam the camera that should be used when rendering the utility layer
  50581. */
  50582. setRenderCamera(cam: Nullable<Camera>): void;
  50583. /**
  50584. * @hidden
  50585. * Light which used by gizmos to get light shading
  50586. */
  50587. _getSharedGizmoLight(): HemisphericLight;
  50588. /**
  50589. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50590. */
  50591. pickUtilitySceneFirst: boolean;
  50592. /**
  50593. * 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)
  50594. */
  50595. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50596. /**
  50597. * 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)
  50598. */
  50599. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50600. /**
  50601. * The scene that is rendered on top of the original scene
  50602. */
  50603. utilityLayerScene: Scene;
  50604. /**
  50605. * If the utility layer should automatically be rendered on top of existing scene
  50606. */
  50607. shouldRender: boolean;
  50608. /**
  50609. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50610. */
  50611. onlyCheckPointerDownEvents: boolean;
  50612. /**
  50613. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50614. */
  50615. processAllEvents: boolean;
  50616. /**
  50617. * Observable raised when the pointer move from the utility layer scene to the main scene
  50618. */
  50619. onPointerOutObservable: Observable<number>;
  50620. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50621. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50622. private _afterRenderObserver;
  50623. private _sceneDisposeObserver;
  50624. private _originalPointerObserver;
  50625. /**
  50626. * Instantiates a UtilityLayerRenderer
  50627. * @param originalScene the original scene that will be rendered on top of
  50628. * @param handleEvents boolean indicating if the utility layer should handle events
  50629. */
  50630. constructor(
  50631. /** the original scene that will be rendered on top of */
  50632. originalScene: Scene, handleEvents?: boolean);
  50633. private _notifyObservers;
  50634. /**
  50635. * Renders the utility layers scene on top of the original scene
  50636. */
  50637. render(): void;
  50638. /**
  50639. * Disposes of the renderer
  50640. */
  50641. dispose(): void;
  50642. private _updateCamera;
  50643. }
  50644. }
  50645. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50646. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50647. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50648. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50649. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50650. import { Scene } from "babylonjs/scene";
  50651. import { Nullable } from "babylonjs/types";
  50652. import { Color3 } from "babylonjs/Maths/math.color";
  50653. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50654. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50655. /**
  50656. * Options interface for the pointer selection module
  50657. */
  50658. export interface IWebXRControllerPointerSelectionOptions {
  50659. /**
  50660. * if provided, this scene will be used to render meshes.
  50661. */
  50662. customUtilityLayerScene?: Scene;
  50663. /**
  50664. * 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)
  50665. * If not disabled, the last picked point will be used to execute a pointer up event
  50666. * If disabled, pointer up event will be triggered right after the pointer down event.
  50667. * Used in screen and gaze target ray mode only
  50668. */
  50669. disablePointerUpOnTouchOut: boolean;
  50670. /**
  50671. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  50672. */
  50673. forceGazeMode: boolean;
  50674. /**
  50675. * 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
  50676. * to start a new countdown to the pointer down event.
  50677. * Defaults to 1.
  50678. */
  50679. gazeModePointerMovedFactor?: number;
  50680. /**
  50681. * Different button type to use instead of the main component
  50682. */
  50683. overrideButtonId?: string;
  50684. /**
  50685. * use this rendering group id for the meshes (optional)
  50686. */
  50687. renderingGroupId?: number;
  50688. /**
  50689. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50690. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50691. * 3000 means 3 seconds between pointing at something and selecting it
  50692. */
  50693. timeToSelect?: number;
  50694. /**
  50695. * Should meshes created here be added to a utility layer or the main scene
  50696. */
  50697. useUtilityLayer?: boolean;
  50698. /**
  50699. * Optional WebXR camera to be used for gaze selection
  50700. */
  50701. gazeCamera?: WebXRCamera;
  50702. /**
  50703. * the xr input to use with this pointer selection
  50704. */
  50705. xrInput: WebXRInput;
  50706. }
  50707. /**
  50708. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50709. */
  50710. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50711. private readonly _options;
  50712. private static _idCounter;
  50713. private _attachController;
  50714. private _controllers;
  50715. private _scene;
  50716. private _tmpVectorForPickCompare;
  50717. /**
  50718. * The module's name
  50719. */
  50720. static readonly Name: string;
  50721. /**
  50722. * The (Babylon) version of this module.
  50723. * This is an integer representing the implementation version.
  50724. * This number does not correspond to the WebXR specs version
  50725. */
  50726. static readonly Version: number;
  50727. /**
  50728. * Disable lighting on the laser pointer (so it will always be visible)
  50729. */
  50730. disablePointerLighting: boolean;
  50731. /**
  50732. * Disable lighting on the selection mesh (so it will always be visible)
  50733. */
  50734. disableSelectionMeshLighting: boolean;
  50735. /**
  50736. * Should the laser pointer be displayed
  50737. */
  50738. displayLaserPointer: boolean;
  50739. /**
  50740. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50741. */
  50742. displaySelectionMesh: boolean;
  50743. /**
  50744. * This color will be set to the laser pointer when selection is triggered
  50745. */
  50746. laserPointerPickedColor: Color3;
  50747. /**
  50748. * Default color of the laser pointer
  50749. */
  50750. laserPointerDefaultColor: Color3;
  50751. /**
  50752. * default color of the selection ring
  50753. */
  50754. selectionMeshDefaultColor: Color3;
  50755. /**
  50756. * This color will be applied to the selection ring when selection is triggered
  50757. */
  50758. selectionMeshPickedColor: Color3;
  50759. /**
  50760. * Optional filter to be used for ray selection. This predicate shares behavior with
  50761. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50762. */
  50763. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50764. /**
  50765. * constructs a new background remover module
  50766. * @param _xrSessionManager the session manager for this module
  50767. * @param _options read-only options to be used in this module
  50768. */
  50769. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50770. /**
  50771. * attach this feature
  50772. * Will usually be called by the features manager
  50773. *
  50774. * @returns true if successful.
  50775. */
  50776. attach(): boolean;
  50777. /**
  50778. * detach this feature.
  50779. * Will usually be called by the features manager
  50780. *
  50781. * @returns true if successful.
  50782. */
  50783. detach(): boolean;
  50784. /**
  50785. * Will get the mesh under a specific pointer.
  50786. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50787. * @param controllerId the controllerId to check
  50788. * @returns The mesh under pointer or null if no mesh is under the pointer
  50789. */
  50790. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50791. /**
  50792. * Get the xr controller that correlates to the pointer id in the pointer event
  50793. *
  50794. * @param id the pointer id to search for
  50795. * @returns the controller that correlates to this id or null if not found
  50796. */
  50797. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50798. protected _onXRFrame(_xrFrame: XRFrame): void;
  50799. private _attachGazeMode;
  50800. private _attachScreenRayMode;
  50801. private _attachTrackedPointerRayMode;
  50802. private _convertNormalToDirectionOfRay;
  50803. private _detachController;
  50804. private _generateNewMeshPair;
  50805. private _pickingMoved;
  50806. private _updatePointerDistance;
  50807. /** @hidden */
  50808. get lasterPointerDefaultColor(): Color3;
  50809. }
  50810. }
  50811. declare module "babylonjs/XR/webXREnterExitUI" {
  50812. import { Nullable } from "babylonjs/types";
  50813. import { Observable } from "babylonjs/Misc/observable";
  50814. import { IDisposable, Scene } from "babylonjs/scene";
  50815. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50816. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50817. /**
  50818. * Button which can be used to enter a different mode of XR
  50819. */
  50820. export class WebXREnterExitUIButton {
  50821. /** button element */
  50822. element: HTMLElement;
  50823. /** XR initialization options for the button */
  50824. sessionMode: XRSessionMode;
  50825. /** Reference space type */
  50826. referenceSpaceType: XRReferenceSpaceType;
  50827. /**
  50828. * Creates a WebXREnterExitUIButton
  50829. * @param element button element
  50830. * @param sessionMode XR initialization session mode
  50831. * @param referenceSpaceType the type of reference space to be used
  50832. */
  50833. constructor(
  50834. /** button element */
  50835. element: HTMLElement,
  50836. /** XR initialization options for the button */
  50837. sessionMode: XRSessionMode,
  50838. /** Reference space type */
  50839. referenceSpaceType: XRReferenceSpaceType);
  50840. /**
  50841. * Extendable function which can be used to update the button's visuals when the state changes
  50842. * @param activeButton the current active button in the UI
  50843. */
  50844. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50845. }
  50846. /**
  50847. * Options to create the webXR UI
  50848. */
  50849. export class WebXREnterExitUIOptions {
  50850. /**
  50851. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50852. */
  50853. customButtons?: Array<WebXREnterExitUIButton>;
  50854. /**
  50855. * A reference space type to use when creating the default button.
  50856. * Default is local-floor
  50857. */
  50858. referenceSpaceType?: XRReferenceSpaceType;
  50859. /**
  50860. * Context to enter xr with
  50861. */
  50862. renderTarget?: Nullable<WebXRRenderTarget>;
  50863. /**
  50864. * A session mode to use when creating the default button.
  50865. * Default is immersive-vr
  50866. */
  50867. sessionMode?: XRSessionMode;
  50868. /**
  50869. * A list of optional features to init the session with
  50870. */
  50871. optionalFeatures?: string[];
  50872. /**
  50873. * A list of optional features to init the session with
  50874. */
  50875. requiredFeatures?: string[];
  50876. }
  50877. /**
  50878. * UI to allow the user to enter/exit XR mode
  50879. */
  50880. export class WebXREnterExitUI implements IDisposable {
  50881. private scene;
  50882. /** version of the options passed to this UI */
  50883. options: WebXREnterExitUIOptions;
  50884. private _activeButton;
  50885. private _buttons;
  50886. /**
  50887. * The HTML Div Element to which buttons are added.
  50888. */
  50889. readonly overlay: HTMLDivElement;
  50890. /**
  50891. * Fired every time the active button is changed.
  50892. *
  50893. * When xr is entered via a button that launches xr that button will be the callback parameter
  50894. *
  50895. * When exiting xr the callback parameter will be null)
  50896. */
  50897. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  50898. /**
  50899. *
  50900. * @param scene babylon scene object to use
  50901. * @param options (read-only) version of the options passed to this UI
  50902. */
  50903. private constructor();
  50904. /**
  50905. * Creates UI to allow the user to enter/exit XR mode
  50906. * @param scene the scene to add the ui to
  50907. * @param helper the xr experience helper to enter/exit xr with
  50908. * @param options options to configure the UI
  50909. * @returns the created ui
  50910. */
  50911. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  50912. /**
  50913. * Disposes of the XR UI component
  50914. */
  50915. dispose(): void;
  50916. private _updateButtons;
  50917. }
  50918. }
  50919. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  50920. import { Vector3 } from "babylonjs/Maths/math.vector";
  50921. import { Color4 } from "babylonjs/Maths/math.color";
  50922. import { Nullable } from "babylonjs/types";
  50923. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  50924. import { Scene } from "babylonjs/scene";
  50925. /**
  50926. * Class containing static functions to help procedurally build meshes
  50927. */
  50928. export class LinesBuilder {
  50929. /**
  50930. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  50931. * * 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
  50932. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  50933. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  50934. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  50935. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  50936. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50937. * * 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
  50938. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  50939. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50940. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  50941. * @param name defines the name of the new line system
  50942. * @param options defines the options used to create the line system
  50943. * @param scene defines the hosting scene
  50944. * @returns a new line system mesh
  50945. */
  50946. static CreateLineSystem(name: string, options: {
  50947. lines: Vector3[][];
  50948. updatable?: boolean;
  50949. instance?: Nullable<LinesMesh>;
  50950. colors?: Nullable<Color4[][]>;
  50951. useVertexAlpha?: boolean;
  50952. }, scene: Nullable<Scene>): LinesMesh;
  50953. /**
  50954. * Creates a line mesh
  50955. * 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
  50956. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50957. * * The parameter `points` is an array successive Vector3
  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 `colors` is an array of successive Color4, one per line point
  50960. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  50961. * * When updating an instance, remember that only point positions can change, not the number of points
  50962. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50963. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  50964. * @param name defines the name of the new line system
  50965. * @param options defines the options used to create the line system
  50966. * @param scene defines the hosting scene
  50967. * @returns a new line mesh
  50968. */
  50969. static CreateLines(name: string, options: {
  50970. points: Vector3[];
  50971. updatable?: boolean;
  50972. instance?: Nullable<LinesMesh>;
  50973. colors?: Color4[];
  50974. useVertexAlpha?: boolean;
  50975. }, scene?: Nullable<Scene>): LinesMesh;
  50976. /**
  50977. * Creates a dashed line mesh
  50978. * * 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
  50979. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50980. * * The parameter `points` is an array successive Vector3
  50981. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  50982. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  50983. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  50984. * * 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
  50985. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50986. * * When updating an instance, remember that only point positions can change, not the number of points
  50987. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50988. * @param name defines the name of the mesh
  50989. * @param options defines the options used to create the mesh
  50990. * @param scene defines the hosting scene
  50991. * @returns the dashed line mesh
  50992. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  50993. */
  50994. static CreateDashedLines(name: string, options: {
  50995. points: Vector3[];
  50996. dashSize?: number;
  50997. gapSize?: number;
  50998. dashNb?: number;
  50999. updatable?: boolean;
  51000. instance?: LinesMesh;
  51001. useVertexAlpha?: boolean;
  51002. }, scene?: Nullable<Scene>): LinesMesh;
  51003. }
  51004. }
  51005. declare module "babylonjs/Misc/timer" {
  51006. import { Observable, Observer } from "babylonjs/Misc/observable";
  51007. import { Nullable } from "babylonjs/types";
  51008. import { IDisposable } from "babylonjs/scene";
  51009. /**
  51010. * Construction options for a timer
  51011. */
  51012. export interface ITimerOptions<T> {
  51013. /**
  51014. * Time-to-end
  51015. */
  51016. timeout: number;
  51017. /**
  51018. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  51019. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  51020. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  51021. */
  51022. contextObservable: Observable<T>;
  51023. /**
  51024. * Optional parameters when adding an observer to the observable
  51025. */
  51026. observableParameters?: {
  51027. mask?: number;
  51028. insertFirst?: boolean;
  51029. scope?: any;
  51030. };
  51031. /**
  51032. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  51033. */
  51034. breakCondition?: (data?: ITimerData<T>) => boolean;
  51035. /**
  51036. * Will be triggered when the time condition has met
  51037. */
  51038. onEnded?: (data: ITimerData<any>) => void;
  51039. /**
  51040. * Will be triggered when the break condition has met (prematurely ended)
  51041. */
  51042. onAborted?: (data: ITimerData<any>) => void;
  51043. /**
  51044. * Optional function to execute on each tick (or count)
  51045. */
  51046. onTick?: (data: ITimerData<any>) => void;
  51047. }
  51048. /**
  51049. * An interface defining the data sent by the timer
  51050. */
  51051. export interface ITimerData<T> {
  51052. /**
  51053. * When did it start
  51054. */
  51055. startTime: number;
  51056. /**
  51057. * Time now
  51058. */
  51059. currentTime: number;
  51060. /**
  51061. * Time passed since started
  51062. */
  51063. deltaTime: number;
  51064. /**
  51065. * How much is completed, in [0.0...1.0].
  51066. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  51067. */
  51068. completeRate: number;
  51069. /**
  51070. * What the registered observable sent in the last count
  51071. */
  51072. payload: T;
  51073. }
  51074. /**
  51075. * The current state of the timer
  51076. */
  51077. export enum TimerState {
  51078. /**
  51079. * Timer initialized, not yet started
  51080. */
  51081. INIT = 0,
  51082. /**
  51083. * Timer started and counting
  51084. */
  51085. STARTED = 1,
  51086. /**
  51087. * Timer ended (whether aborted or time reached)
  51088. */
  51089. ENDED = 2
  51090. }
  51091. /**
  51092. * A simple version of the timer. Will take options and start the timer immediately after calling it
  51093. *
  51094. * @param options options with which to initialize this timer
  51095. */
  51096. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  51097. /**
  51098. * An advanced implementation of a timer class
  51099. */
  51100. export class AdvancedTimer<T = any> implements IDisposable {
  51101. /**
  51102. * Will notify each time the timer calculates the remaining time
  51103. */
  51104. onEachCountObservable: Observable<ITimerData<T>>;
  51105. /**
  51106. * Will trigger when the timer was aborted due to the break condition
  51107. */
  51108. onTimerAbortedObservable: Observable<ITimerData<T>>;
  51109. /**
  51110. * Will trigger when the timer ended successfully
  51111. */
  51112. onTimerEndedObservable: Observable<ITimerData<T>>;
  51113. /**
  51114. * Will trigger when the timer state has changed
  51115. */
  51116. onStateChangedObservable: Observable<TimerState>;
  51117. private _observer;
  51118. private _contextObservable;
  51119. private _observableParameters;
  51120. private _startTime;
  51121. private _timer;
  51122. private _state;
  51123. private _breakCondition;
  51124. private _timeToEnd;
  51125. private _breakOnNextTick;
  51126. /**
  51127. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  51128. * @param options construction options for this advanced timer
  51129. */
  51130. constructor(options: ITimerOptions<T>);
  51131. /**
  51132. * set a breaking condition for this timer. Default is to never break during count
  51133. * @param predicate the new break condition. Returns true to break, false otherwise
  51134. */
  51135. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  51136. /**
  51137. * Reset ALL associated observables in this advanced timer
  51138. */
  51139. clearObservables(): void;
  51140. /**
  51141. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  51142. *
  51143. * @param timeToEnd how much time to measure until timer ended
  51144. */
  51145. start(timeToEnd?: number): void;
  51146. /**
  51147. * Will force a stop on the next tick.
  51148. */
  51149. stop(): void;
  51150. /**
  51151. * Dispose this timer, clearing all resources
  51152. */
  51153. dispose(): void;
  51154. private _setState;
  51155. private _tick;
  51156. private _stop;
  51157. }
  51158. }
  51159. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  51160. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  51161. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  51162. import { WebXRInput } from "babylonjs/XR/webXRInput";
  51163. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51164. import { Vector3 } from "babylonjs/Maths/math.vector";
  51165. import { Material } from "babylonjs/Materials/material";
  51166. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  51167. import { Scene } from "babylonjs/scene";
  51168. /**
  51169. * The options container for the teleportation module
  51170. */
  51171. export interface IWebXRTeleportationOptions {
  51172. /**
  51173. * if provided, this scene will be used to render meshes.
  51174. */
  51175. customUtilityLayerScene?: Scene;
  51176. /**
  51177. * Values to configure the default target mesh
  51178. */
  51179. defaultTargetMeshOptions?: {
  51180. /**
  51181. * Fill color of the teleportation area
  51182. */
  51183. teleportationFillColor?: string;
  51184. /**
  51185. * Border color for the teleportation area
  51186. */
  51187. teleportationBorderColor?: string;
  51188. /**
  51189. * Disable the mesh's animation sequence
  51190. */
  51191. disableAnimation?: boolean;
  51192. /**
  51193. * Disable lighting on the material or the ring and arrow
  51194. */
  51195. disableLighting?: boolean;
  51196. /**
  51197. * Override the default material of the torus and arrow
  51198. */
  51199. torusArrowMaterial?: Material;
  51200. };
  51201. /**
  51202. * A list of meshes to use as floor meshes.
  51203. * Meshes can be added and removed after initializing the feature using the
  51204. * addFloorMesh and removeFloorMesh functions
  51205. * If empty, rotation will still work
  51206. */
  51207. floorMeshes?: AbstractMesh[];
  51208. /**
  51209. * use this rendering group id for the meshes (optional)
  51210. */
  51211. renderingGroupId?: number;
  51212. /**
  51213. * Should teleportation move only to snap points
  51214. */
  51215. snapPointsOnly?: boolean;
  51216. /**
  51217. * An array of points to which the teleportation will snap to.
  51218. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  51219. */
  51220. snapPositions?: Vector3[];
  51221. /**
  51222. * How close should the teleportation ray be in order to snap to position.
  51223. * Default to 0.8 units (meters)
  51224. */
  51225. snapToPositionRadius?: number;
  51226. /**
  51227. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  51228. * If you want to support rotation, make sure your mesh has a direction indicator.
  51229. *
  51230. * When left untouched, the default mesh will be initialized.
  51231. */
  51232. teleportationTargetMesh?: AbstractMesh;
  51233. /**
  51234. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  51235. */
  51236. timeToTeleport?: number;
  51237. /**
  51238. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  51239. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  51240. */
  51241. useMainComponentOnly?: boolean;
  51242. /**
  51243. * Should meshes created here be added to a utility layer or the main scene
  51244. */
  51245. useUtilityLayer?: boolean;
  51246. /**
  51247. * Babylon XR Input class for controller
  51248. */
  51249. xrInput: WebXRInput;
  51250. }
  51251. /**
  51252. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  51253. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  51254. * the input of the attached controllers.
  51255. */
  51256. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  51257. private _options;
  51258. private _controllers;
  51259. private _currentTeleportationControllerId;
  51260. private _floorMeshes;
  51261. private _quadraticBezierCurve;
  51262. private _selectionFeature;
  51263. private _snapToPositions;
  51264. private _snappedToPoint;
  51265. private _teleportationRingMaterial?;
  51266. private _tmpRay;
  51267. private _tmpVector;
  51268. /**
  51269. * The module's name
  51270. */
  51271. static readonly Name: string;
  51272. /**
  51273. * The (Babylon) version of this module.
  51274. * This is an integer representing the implementation version.
  51275. * This number does not correspond to the webxr specs version
  51276. */
  51277. static readonly Version: number;
  51278. /**
  51279. * Is movement backwards enabled
  51280. */
  51281. backwardsMovementEnabled: boolean;
  51282. /**
  51283. * Distance to travel when moving backwards
  51284. */
  51285. backwardsTeleportationDistance: number;
  51286. /**
  51287. * The distance from the user to the inspection point in the direction of the controller
  51288. * A higher number will allow the user to move further
  51289. * defaults to 5 (meters, in xr units)
  51290. */
  51291. parabolicCheckRadius: number;
  51292. /**
  51293. * Should the module support parabolic ray on top of direct ray
  51294. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  51295. * Very helpful when moving between floors / different heights
  51296. */
  51297. parabolicRayEnabled: boolean;
  51298. /**
  51299. * How much rotation should be applied when rotating right and left
  51300. */
  51301. rotationAngle: number;
  51302. /**
  51303. * Is rotation enabled when moving forward?
  51304. * Disabling this feature will prevent the user from deciding the direction when teleporting
  51305. */
  51306. rotationEnabled: boolean;
  51307. /**
  51308. * constructs a new anchor system
  51309. * @param _xrSessionManager an instance of WebXRSessionManager
  51310. * @param _options configuration object for this feature
  51311. */
  51312. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  51313. /**
  51314. * Get the snapPointsOnly flag
  51315. */
  51316. get snapPointsOnly(): boolean;
  51317. /**
  51318. * Sets the snapPointsOnly flag
  51319. * @param snapToPoints should teleportation be exclusively to snap points
  51320. */
  51321. set snapPointsOnly(snapToPoints: boolean);
  51322. /**
  51323. * Add a new mesh to the floor meshes array
  51324. * @param mesh the mesh to use as floor mesh
  51325. */
  51326. addFloorMesh(mesh: AbstractMesh): void;
  51327. /**
  51328. * Add a new snap-to point to fix teleportation to this position
  51329. * @param newSnapPoint The new Snap-To point
  51330. */
  51331. addSnapPoint(newSnapPoint: Vector3): void;
  51332. attach(): boolean;
  51333. detach(): boolean;
  51334. dispose(): void;
  51335. /**
  51336. * Remove a mesh from the floor meshes array
  51337. * @param mesh the mesh to remove
  51338. */
  51339. removeFloorMesh(mesh: AbstractMesh): void;
  51340. /**
  51341. * Remove a mesh from the floor meshes array using its name
  51342. * @param name the mesh name to remove
  51343. */
  51344. removeFloorMeshByName(name: string): void;
  51345. /**
  51346. * 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
  51347. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  51348. * @returns was the point found and removed or not
  51349. */
  51350. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  51351. /**
  51352. * This function sets a selection feature that will be disabled when
  51353. * the forward ray is shown and will be reattached when hidden.
  51354. * This is used to remove the selection rays when moving.
  51355. * @param selectionFeature the feature to disable when forward movement is enabled
  51356. */
  51357. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  51358. protected _onXRFrame(_xrFrame: XRFrame): void;
  51359. private _attachController;
  51360. private _createDefaultTargetMesh;
  51361. private _detachController;
  51362. private _findClosestSnapPointWithRadius;
  51363. private _setTargetMeshPosition;
  51364. private _setTargetMeshVisibility;
  51365. private _showParabolicPath;
  51366. private _teleportForward;
  51367. }
  51368. }
  51369. declare module "babylonjs/XR/webXRDefaultExperience" {
  51370. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  51371. import { Scene } from "babylonjs/scene";
  51372. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51373. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51374. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51375. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51376. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51377. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51378. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51379. /**
  51380. * Options for the default xr helper
  51381. */
  51382. export class WebXRDefaultExperienceOptions {
  51383. /**
  51384. * Enable or disable default UI to enter XR
  51385. */
  51386. disableDefaultUI?: boolean;
  51387. /**
  51388. * Should teleportation not initialize. defaults to false.
  51389. */
  51390. disableTeleportation?: boolean;
  51391. /**
  51392. * Floor meshes that will be used for teleport
  51393. */
  51394. floorMeshes?: Array<AbstractMesh>;
  51395. /**
  51396. * If set to true, the first frame will not be used to reset position
  51397. * The first frame is mainly used when copying transformation from the old camera
  51398. * Mainly used in AR
  51399. */
  51400. ignoreNativeCameraTransformation?: boolean;
  51401. /**
  51402. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51403. */
  51404. inputOptions?: IWebXRInputOptions;
  51405. /**
  51406. * optional configuration for the output canvas
  51407. */
  51408. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51409. /**
  51410. * optional UI options. This can be used among other to change session mode and reference space type
  51411. */
  51412. uiOptions?: WebXREnterExitUIOptions;
  51413. /**
  51414. * When loading teleportation and pointer select, use stable versions instead of latest.
  51415. */
  51416. useStablePlugins?: boolean;
  51417. /**
  51418. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51419. */
  51420. renderingGroupId?: number;
  51421. /**
  51422. * A list of optional features to init the session with
  51423. * If set to true, all features we support will be added
  51424. */
  51425. optionalFeatures?: boolean | string[];
  51426. }
  51427. /**
  51428. * Default experience which provides a similar setup to the previous webVRExperience
  51429. */
  51430. export class WebXRDefaultExperience {
  51431. /**
  51432. * Base experience
  51433. */
  51434. baseExperience: WebXRExperienceHelper;
  51435. /**
  51436. * Enables ui for entering/exiting xr
  51437. */
  51438. enterExitUI: WebXREnterExitUI;
  51439. /**
  51440. * Input experience extension
  51441. */
  51442. input: WebXRInput;
  51443. /**
  51444. * Enables laser pointer and selection
  51445. */
  51446. pointerSelection: WebXRControllerPointerSelection;
  51447. /**
  51448. * Default target xr should render to
  51449. */
  51450. renderTarget: WebXRRenderTarget;
  51451. /**
  51452. * Enables teleportation
  51453. */
  51454. teleportation: WebXRMotionControllerTeleportation;
  51455. private constructor();
  51456. /**
  51457. * Creates the default xr experience
  51458. * @param scene scene
  51459. * @param options options for basic configuration
  51460. * @returns resulting WebXRDefaultExperience
  51461. */
  51462. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51463. /**
  51464. * DIsposes of the experience helper
  51465. */
  51466. dispose(): void;
  51467. }
  51468. }
  51469. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51470. import { Observable } from "babylonjs/Misc/observable";
  51471. import { Nullable } from "babylonjs/types";
  51472. import { Camera } from "babylonjs/Cameras/camera";
  51473. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51474. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51475. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51476. import { Scene } from "babylonjs/scene";
  51477. import { Vector3 } from "babylonjs/Maths/math.vector";
  51478. import { Color3 } from "babylonjs/Maths/math.color";
  51479. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51480. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51481. import { Mesh } from "babylonjs/Meshes/mesh";
  51482. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51483. import { EasingFunction } from "babylonjs/Animations/easing";
  51484. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51485. import "babylonjs/Meshes/Builders/groundBuilder";
  51486. import "babylonjs/Meshes/Builders/torusBuilder";
  51487. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51488. import "babylonjs/Gamepads/gamepadSceneComponent";
  51489. import "babylonjs/Animations/animatable";
  51490. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51491. /**
  51492. * Options to modify the vr teleportation behavior.
  51493. */
  51494. export interface VRTeleportationOptions {
  51495. /**
  51496. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51497. */
  51498. floorMeshName?: string;
  51499. /**
  51500. * A list of meshes to be used as the teleportation floor. (default: empty)
  51501. */
  51502. floorMeshes?: Mesh[];
  51503. /**
  51504. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51505. */
  51506. teleportationMode?: number;
  51507. /**
  51508. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51509. */
  51510. teleportationTime?: number;
  51511. /**
  51512. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51513. */
  51514. teleportationSpeed?: number;
  51515. /**
  51516. * The easing function used in the animation or null for Linear. (default CircleEase)
  51517. */
  51518. easingFunction?: EasingFunction;
  51519. }
  51520. /**
  51521. * Options to modify the vr experience helper's behavior.
  51522. */
  51523. export interface VRExperienceHelperOptions extends WebVROptions {
  51524. /**
  51525. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51526. */
  51527. createDeviceOrientationCamera?: boolean;
  51528. /**
  51529. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51530. */
  51531. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51532. /**
  51533. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51534. */
  51535. laserToggle?: boolean;
  51536. /**
  51537. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51538. */
  51539. floorMeshes?: Mesh[];
  51540. /**
  51541. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51542. */
  51543. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51544. /**
  51545. * Defines if WebXR should be used instead of WebVR (if available)
  51546. */
  51547. useXR?: boolean;
  51548. }
  51549. /**
  51550. * Event containing information after VR has been entered
  51551. */
  51552. export class OnAfterEnteringVRObservableEvent {
  51553. /**
  51554. * If entering vr was successful
  51555. */
  51556. success: boolean;
  51557. }
  51558. /**
  51559. * Helps to quickly add VR support to an existing scene.
  51560. * See https://doc.babylonjs.com/how_to/webvr_helper
  51561. */
  51562. export class VRExperienceHelper {
  51563. /** Options to modify the vr experience helper's behavior. */
  51564. webVROptions: VRExperienceHelperOptions;
  51565. private _scene;
  51566. private _position;
  51567. private _btnVR;
  51568. private _btnVRDisplayed;
  51569. private _webVRsupported;
  51570. private _webVRready;
  51571. private _webVRrequesting;
  51572. private _webVRpresenting;
  51573. private _hasEnteredVR;
  51574. private _fullscreenVRpresenting;
  51575. private _inputElement;
  51576. private _webVRCamera;
  51577. private _vrDeviceOrientationCamera;
  51578. private _deviceOrientationCamera;
  51579. private _existingCamera;
  51580. private _onKeyDown;
  51581. private _onVrDisplayPresentChange;
  51582. private _onVRDisplayChanged;
  51583. private _onVRRequestPresentStart;
  51584. private _onVRRequestPresentComplete;
  51585. /**
  51586. * 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)
  51587. */
  51588. enableGazeEvenWhenNoPointerLock: boolean;
  51589. /**
  51590. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51591. */
  51592. exitVROnDoubleTap: boolean;
  51593. /**
  51594. * Observable raised right before entering VR.
  51595. */
  51596. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51597. /**
  51598. * Observable raised when entering VR has completed.
  51599. */
  51600. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51601. /**
  51602. * Observable raised when exiting VR.
  51603. */
  51604. onExitingVRObservable: Observable<VRExperienceHelper>;
  51605. /**
  51606. * Observable raised when controller mesh is loaded.
  51607. */
  51608. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51609. /** Return this.onEnteringVRObservable
  51610. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51611. */
  51612. get onEnteringVR(): Observable<VRExperienceHelper>;
  51613. /** Return this.onExitingVRObservable
  51614. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51615. */
  51616. get onExitingVR(): Observable<VRExperienceHelper>;
  51617. /** Return this.onControllerMeshLoadedObservable
  51618. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51619. */
  51620. get onControllerMeshLoaded(): Observable<WebVRController>;
  51621. private _rayLength;
  51622. private _useCustomVRButton;
  51623. private _teleportationRequested;
  51624. private _teleportActive;
  51625. private _floorMeshName;
  51626. private _floorMeshesCollection;
  51627. private _teleportationMode;
  51628. private _teleportationTime;
  51629. private _teleportationSpeed;
  51630. private _teleportationEasing;
  51631. private _rotationAllowed;
  51632. private _teleportBackwardsVector;
  51633. private _teleportationTarget;
  51634. private _isDefaultTeleportationTarget;
  51635. private _postProcessMove;
  51636. private _teleportationFillColor;
  51637. private _teleportationBorderColor;
  51638. private _rotationAngle;
  51639. private _haloCenter;
  51640. private _cameraGazer;
  51641. private _padSensibilityUp;
  51642. private _padSensibilityDown;
  51643. private _leftController;
  51644. private _rightController;
  51645. private _gazeColor;
  51646. private _laserColor;
  51647. private _pickedLaserColor;
  51648. private _pickedGazeColor;
  51649. /**
  51650. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51651. */
  51652. onNewMeshSelected: Observable<AbstractMesh>;
  51653. /**
  51654. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51655. * This observable will provide the mesh and the controller used to select the mesh
  51656. */
  51657. onMeshSelectedWithController: Observable<{
  51658. mesh: AbstractMesh;
  51659. controller: WebVRController;
  51660. }>;
  51661. /**
  51662. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51663. */
  51664. onNewMeshPicked: Observable<PickingInfo>;
  51665. private _circleEase;
  51666. /**
  51667. * Observable raised before camera teleportation
  51668. */
  51669. onBeforeCameraTeleport: Observable<Vector3>;
  51670. /**
  51671. * Observable raised after camera teleportation
  51672. */
  51673. onAfterCameraTeleport: Observable<Vector3>;
  51674. /**
  51675. * Observable raised when current selected mesh gets unselected
  51676. */
  51677. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51678. private _raySelectionPredicate;
  51679. /**
  51680. * To be optionaly changed by user to define custom ray selection
  51681. */
  51682. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51683. /**
  51684. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51685. */
  51686. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51687. /**
  51688. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51689. */
  51690. teleportationEnabled: boolean;
  51691. private _defaultHeight;
  51692. private _teleportationInitialized;
  51693. private _interactionsEnabled;
  51694. private _interactionsRequested;
  51695. private _displayGaze;
  51696. private _displayLaserPointer;
  51697. /**
  51698. * The mesh used to display where the user is going to teleport.
  51699. */
  51700. get teleportationTarget(): Mesh;
  51701. /**
  51702. * Sets the mesh to be used to display where the user is going to teleport.
  51703. */
  51704. set teleportationTarget(value: Mesh);
  51705. /**
  51706. * 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
  51707. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51708. * See https://doc.babylonjs.com/resources/baking_transformations
  51709. */
  51710. get gazeTrackerMesh(): Mesh;
  51711. set gazeTrackerMesh(value: Mesh);
  51712. /**
  51713. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51714. */
  51715. updateGazeTrackerScale: boolean;
  51716. /**
  51717. * If the gaze trackers color should be updated when selecting meshes
  51718. */
  51719. updateGazeTrackerColor: boolean;
  51720. /**
  51721. * If the controller laser color should be updated when selecting meshes
  51722. */
  51723. updateControllerLaserColor: boolean;
  51724. /**
  51725. * The gaze tracking mesh corresponding to the left controller
  51726. */
  51727. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51728. /**
  51729. * The gaze tracking mesh corresponding to the right controller
  51730. */
  51731. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51732. /**
  51733. * If the ray of the gaze should be displayed.
  51734. */
  51735. get displayGaze(): boolean;
  51736. /**
  51737. * Sets if the ray of the gaze should be displayed.
  51738. */
  51739. set displayGaze(value: boolean);
  51740. /**
  51741. * If the ray of the LaserPointer should be displayed.
  51742. */
  51743. get displayLaserPointer(): boolean;
  51744. /**
  51745. * Sets if the ray of the LaserPointer should be displayed.
  51746. */
  51747. set displayLaserPointer(value: boolean);
  51748. /**
  51749. * The deviceOrientationCamera used as the camera when not in VR.
  51750. */
  51751. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51752. /**
  51753. * Based on the current WebVR support, returns the current VR camera used.
  51754. */
  51755. get currentVRCamera(): Nullable<Camera>;
  51756. /**
  51757. * The webVRCamera which is used when in VR.
  51758. */
  51759. get webVRCamera(): WebVRFreeCamera;
  51760. /**
  51761. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51762. */
  51763. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51764. /**
  51765. * The html button that is used to trigger entering into VR.
  51766. */
  51767. get vrButton(): Nullable<HTMLButtonElement>;
  51768. private get _teleportationRequestInitiated();
  51769. /**
  51770. * Defines whether or not Pointer lock should be requested when switching to
  51771. * full screen.
  51772. */
  51773. requestPointerLockOnFullScreen: boolean;
  51774. /**
  51775. * If asking to force XR, this will be populated with the default xr experience
  51776. */
  51777. xr: WebXRDefaultExperience;
  51778. /**
  51779. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51780. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51781. */
  51782. xrTestDone: boolean;
  51783. /**
  51784. * Instantiates a VRExperienceHelper.
  51785. * Helps to quickly add VR support to an existing scene.
  51786. * @param scene The scene the VRExperienceHelper belongs to.
  51787. * @param webVROptions Options to modify the vr experience helper's behavior.
  51788. */
  51789. constructor(scene: Scene,
  51790. /** Options to modify the vr experience helper's behavior. */
  51791. webVROptions?: VRExperienceHelperOptions);
  51792. private completeVRInit;
  51793. private _onDefaultMeshLoaded;
  51794. private _onResize;
  51795. private _onFullscreenChange;
  51796. /**
  51797. * Gets a value indicating if we are currently in VR mode.
  51798. */
  51799. get isInVRMode(): boolean;
  51800. private onVrDisplayPresentChange;
  51801. private onVRDisplayChanged;
  51802. private moveButtonToBottomRight;
  51803. private displayVRButton;
  51804. private updateButtonVisibility;
  51805. private _cachedAngularSensibility;
  51806. /**
  51807. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51808. * Otherwise, will use the fullscreen API.
  51809. */
  51810. enterVR(): void;
  51811. /**
  51812. * Attempt to exit VR, or fullscreen.
  51813. */
  51814. exitVR(): void;
  51815. /**
  51816. * The position of the vr experience helper.
  51817. */
  51818. get position(): Vector3;
  51819. /**
  51820. * Sets the position of the vr experience helper.
  51821. */
  51822. set position(value: Vector3);
  51823. /**
  51824. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51825. */
  51826. enableInteractions(): void;
  51827. private get _noControllerIsActive();
  51828. private beforeRender;
  51829. private _isTeleportationFloor;
  51830. /**
  51831. * Adds a floor mesh to be used for teleportation.
  51832. * @param floorMesh the mesh to be used for teleportation.
  51833. */
  51834. addFloorMesh(floorMesh: Mesh): void;
  51835. /**
  51836. * Removes a floor mesh from being used for teleportation.
  51837. * @param floorMesh the mesh to be removed.
  51838. */
  51839. removeFloorMesh(floorMesh: Mesh): void;
  51840. /**
  51841. * Enables interactions and teleportation using the VR controllers and gaze.
  51842. * @param vrTeleportationOptions options to modify teleportation behavior.
  51843. */
  51844. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51845. private _onNewGamepadConnected;
  51846. private _tryEnableInteractionOnController;
  51847. private _onNewGamepadDisconnected;
  51848. private _enableInteractionOnController;
  51849. private _checkTeleportWithRay;
  51850. private _checkRotate;
  51851. private _checkTeleportBackwards;
  51852. private _enableTeleportationOnController;
  51853. private _createTeleportationCircles;
  51854. private _displayTeleportationTarget;
  51855. private _hideTeleportationTarget;
  51856. private _rotateCamera;
  51857. private _moveTeleportationSelectorTo;
  51858. private _workingVector;
  51859. private _workingQuaternion;
  51860. private _workingMatrix;
  51861. /**
  51862. * Time Constant Teleportation Mode
  51863. */
  51864. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  51865. /**
  51866. * Speed Constant Teleportation Mode
  51867. */
  51868. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  51869. /**
  51870. * Teleports the users feet to the desired location
  51871. * @param location The location where the user's feet should be placed
  51872. */
  51873. teleportCamera(location: Vector3): void;
  51874. private _convertNormalToDirectionOfRay;
  51875. private _castRayAndSelectObject;
  51876. private _notifySelectedMeshUnselected;
  51877. /**
  51878. * Permanently set new colors for the laser pointer
  51879. * @param color the new laser color
  51880. * @param pickedColor the new laser color when picked mesh detected
  51881. */
  51882. setLaserColor(color: Color3, pickedColor?: Color3): void;
  51883. /**
  51884. * Set lighting enabled / disabled on the laser pointer of both controllers
  51885. * @param enabled should the lighting be enabled on the laser pointer
  51886. */
  51887. setLaserLightingState(enabled?: boolean): void;
  51888. /**
  51889. * Permanently set new colors for the gaze pointer
  51890. * @param color the new gaze color
  51891. * @param pickedColor the new gaze color when picked mesh detected
  51892. */
  51893. setGazeColor(color: Color3, pickedColor?: Color3): void;
  51894. /**
  51895. * Sets the color of the laser ray from the vr controllers.
  51896. * @param color new color for the ray.
  51897. */
  51898. changeLaserColor(color: Color3): void;
  51899. /**
  51900. * Sets the color of the ray from the vr headsets gaze.
  51901. * @param color new color for the ray.
  51902. */
  51903. changeGazeColor(color: Color3): void;
  51904. /**
  51905. * Exits VR and disposes of the vr experience helper
  51906. */
  51907. dispose(): void;
  51908. /**
  51909. * Gets the name of the VRExperienceHelper class
  51910. * @returns "VRExperienceHelper"
  51911. */
  51912. getClassName(): string;
  51913. }
  51914. }
  51915. declare module "babylonjs/Cameras/VR/index" {
  51916. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  51917. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  51918. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51919. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  51920. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  51921. export * from "babylonjs/Cameras/VR/webVRCamera";
  51922. }
  51923. declare module "babylonjs/Cameras/RigModes/index" {
  51924. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51925. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51926. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  51927. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  51928. }
  51929. declare module "babylonjs/Cameras/index" {
  51930. export * from "babylonjs/Cameras/Inputs/index";
  51931. export * from "babylonjs/Cameras/cameraInputsManager";
  51932. export * from "babylonjs/Cameras/camera";
  51933. export * from "babylonjs/Cameras/targetCamera";
  51934. export * from "babylonjs/Cameras/freeCamera";
  51935. export * from "babylonjs/Cameras/freeCameraInputsManager";
  51936. export * from "babylonjs/Cameras/touchCamera";
  51937. export * from "babylonjs/Cameras/arcRotateCamera";
  51938. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  51939. export * from "babylonjs/Cameras/deviceOrientationCamera";
  51940. export * from "babylonjs/Cameras/flyCamera";
  51941. export * from "babylonjs/Cameras/flyCameraInputsManager";
  51942. export * from "babylonjs/Cameras/followCamera";
  51943. export * from "babylonjs/Cameras/followCameraInputsManager";
  51944. export * from "babylonjs/Cameras/gamepadCamera";
  51945. export * from "babylonjs/Cameras/Stereoscopic/index";
  51946. export * from "babylonjs/Cameras/universalCamera";
  51947. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  51948. export * from "babylonjs/Cameras/VR/index";
  51949. export * from "babylonjs/Cameras/RigModes/index";
  51950. }
  51951. declare module "babylonjs/Collisions/index" {
  51952. export * from "babylonjs/Collisions/collider";
  51953. export * from "babylonjs/Collisions/collisionCoordinator";
  51954. export * from "babylonjs/Collisions/pickingInfo";
  51955. export * from "babylonjs/Collisions/intersectionInfo";
  51956. export * from "babylonjs/Collisions/meshCollisionData";
  51957. }
  51958. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  51959. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  51960. import { Vector3 } from "babylonjs/Maths/math.vector";
  51961. import { Ray } from "babylonjs/Culling/ray";
  51962. import { Plane } from "babylonjs/Maths/math.plane";
  51963. /**
  51964. * Contains an array of blocks representing the octree
  51965. */
  51966. export interface IOctreeContainer<T> {
  51967. /**
  51968. * Blocks within the octree
  51969. */
  51970. blocks: Array<OctreeBlock<T>>;
  51971. }
  51972. /**
  51973. * Class used to store a cell in an octree
  51974. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51975. */
  51976. export class OctreeBlock<T> {
  51977. /**
  51978. * Gets the content of the current block
  51979. */
  51980. entries: T[];
  51981. /**
  51982. * Gets the list of block children
  51983. */
  51984. blocks: Array<OctreeBlock<T>>;
  51985. private _depth;
  51986. private _maxDepth;
  51987. private _capacity;
  51988. private _minPoint;
  51989. private _maxPoint;
  51990. private _boundingVectors;
  51991. private _creationFunc;
  51992. /**
  51993. * Creates a new block
  51994. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  51995. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  51996. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51997. * @param depth defines the current depth of this block in the octree
  51998. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  51999. * @param creationFunc defines a callback to call when an element is added to the block
  52000. */
  52001. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  52002. /**
  52003. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  52004. */
  52005. get capacity(): number;
  52006. /**
  52007. * Gets the minimum vector (in world space) of the block's bounding box
  52008. */
  52009. get minPoint(): Vector3;
  52010. /**
  52011. * Gets the maximum vector (in world space) of the block's bounding box
  52012. */
  52013. get maxPoint(): Vector3;
  52014. /**
  52015. * Add a new element to this block
  52016. * @param entry defines the element to add
  52017. */
  52018. addEntry(entry: T): void;
  52019. /**
  52020. * Remove an element from this block
  52021. * @param entry defines the element to remove
  52022. */
  52023. removeEntry(entry: T): void;
  52024. /**
  52025. * Add an array of elements to this block
  52026. * @param entries defines the array of elements to add
  52027. */
  52028. addEntries(entries: T[]): void;
  52029. /**
  52030. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  52031. * @param frustumPlanes defines the frustum planes to test
  52032. * @param selection defines the array to store current content if selection is positive
  52033. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52034. */
  52035. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52036. /**
  52037. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  52038. * @param sphereCenter defines the bounding sphere center
  52039. * @param sphereRadius defines the bounding sphere radius
  52040. * @param selection defines the array to store current content if selection is positive
  52041. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52042. */
  52043. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52044. /**
  52045. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  52046. * @param ray defines the ray to test with
  52047. * @param selection defines the array to store current content if selection is positive
  52048. */
  52049. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  52050. /**
  52051. * Subdivide the content into child blocks (this block will then be empty)
  52052. */
  52053. createInnerBlocks(): void;
  52054. /**
  52055. * @hidden
  52056. */
  52057. 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;
  52058. }
  52059. }
  52060. declare module "babylonjs/Culling/Octrees/octree" {
  52061. import { SmartArray } from "babylonjs/Misc/smartArray";
  52062. import { Vector3 } from "babylonjs/Maths/math.vector";
  52063. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52064. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52065. import { Ray } from "babylonjs/Culling/ray";
  52066. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  52067. import { Plane } from "babylonjs/Maths/math.plane";
  52068. /**
  52069. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  52070. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52071. */
  52072. export class Octree<T> {
  52073. /** 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.) */
  52074. maxDepth: number;
  52075. /**
  52076. * Blocks within the octree containing objects
  52077. */
  52078. blocks: Array<OctreeBlock<T>>;
  52079. /**
  52080. * Content stored in the octree
  52081. */
  52082. dynamicContent: T[];
  52083. private _maxBlockCapacity;
  52084. private _selectionContent;
  52085. private _creationFunc;
  52086. /**
  52087. * Creates a octree
  52088. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52089. * @param creationFunc function to be used to instatiate the octree
  52090. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  52091. * @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.)
  52092. */
  52093. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  52094. /** 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.) */
  52095. maxDepth?: number);
  52096. /**
  52097. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  52098. * @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);
  52099. * @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);
  52100. * @param entries meshes to be added to the octree blocks
  52101. */
  52102. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  52103. /**
  52104. * Adds a mesh to the octree
  52105. * @param entry Mesh to add to the octree
  52106. */
  52107. addMesh(entry: T): void;
  52108. /**
  52109. * Remove an element from the octree
  52110. * @param entry defines the element to remove
  52111. */
  52112. removeMesh(entry: T): void;
  52113. /**
  52114. * Selects an array of meshes within the frustum
  52115. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  52116. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  52117. * @returns array of meshes within the frustum
  52118. */
  52119. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  52120. /**
  52121. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  52122. * @param sphereCenter defines the bounding sphere center
  52123. * @param sphereRadius defines the bounding sphere radius
  52124. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52125. * @returns an array of objects that intersect the sphere
  52126. */
  52127. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  52128. /**
  52129. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  52130. * @param ray defines the ray to test with
  52131. * @returns array of intersected objects
  52132. */
  52133. intersectsRay(ray: Ray): SmartArray<T>;
  52134. /**
  52135. * Adds a mesh into the octree block if it intersects the block
  52136. */
  52137. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  52138. /**
  52139. * Adds a submesh into the octree block if it intersects the block
  52140. */
  52141. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  52142. }
  52143. }
  52144. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  52145. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  52146. import { Scene } from "babylonjs/scene";
  52147. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52148. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52149. import { Ray } from "babylonjs/Culling/ray";
  52150. import { Octree } from "babylonjs/Culling/Octrees/octree";
  52151. import { Collider } from "babylonjs/Collisions/collider";
  52152. module "babylonjs/scene" {
  52153. interface Scene {
  52154. /**
  52155. * @hidden
  52156. * Backing Filed
  52157. */
  52158. _selectionOctree: Octree<AbstractMesh>;
  52159. /**
  52160. * Gets the octree used to boost mesh selection (picking)
  52161. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52162. */
  52163. selectionOctree: Octree<AbstractMesh>;
  52164. /**
  52165. * Creates or updates the octree used to boost selection (picking)
  52166. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52167. * @param maxCapacity defines the maximum capacity per leaf
  52168. * @param maxDepth defines the maximum depth of the octree
  52169. * @returns an octree of AbstractMesh
  52170. */
  52171. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  52172. }
  52173. }
  52174. module "babylonjs/Meshes/abstractMesh" {
  52175. interface AbstractMesh {
  52176. /**
  52177. * @hidden
  52178. * Backing Field
  52179. */
  52180. _submeshesOctree: Octree<SubMesh>;
  52181. /**
  52182. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  52183. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  52184. * @param maxCapacity defines the maximum size of each block (64 by default)
  52185. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  52186. * @returns the new octree
  52187. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  52188. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52189. */
  52190. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  52191. }
  52192. }
  52193. /**
  52194. * Defines the octree scene component responsible to manage any octrees
  52195. * in a given scene.
  52196. */
  52197. export class OctreeSceneComponent {
  52198. /**
  52199. * The component name help to identify the component in the list of scene components.
  52200. */
  52201. readonly name: string;
  52202. /**
  52203. * The scene the component belongs to.
  52204. */
  52205. scene: Scene;
  52206. /**
  52207. * Indicates if the meshes have been checked to make sure they are isEnabled()
  52208. */
  52209. readonly checksIsEnabled: boolean;
  52210. /**
  52211. * Creates a new instance of the component for the given scene
  52212. * @param scene Defines the scene to register the component in
  52213. */
  52214. constructor(scene: Scene);
  52215. /**
  52216. * Registers the component in a given scene
  52217. */
  52218. register(): void;
  52219. /**
  52220. * Return the list of active meshes
  52221. * @returns the list of active meshes
  52222. */
  52223. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  52224. /**
  52225. * Return the list of active sub meshes
  52226. * @param mesh The mesh to get the candidates sub meshes from
  52227. * @returns the list of active sub meshes
  52228. */
  52229. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  52230. private _tempRay;
  52231. /**
  52232. * Return the list of sub meshes intersecting with a given local ray
  52233. * @param mesh defines the mesh to find the submesh for
  52234. * @param localRay defines the ray in local space
  52235. * @returns the list of intersecting sub meshes
  52236. */
  52237. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  52238. /**
  52239. * Return the list of sub meshes colliding with a collider
  52240. * @param mesh defines the mesh to find the submesh for
  52241. * @param collider defines the collider to evaluate the collision against
  52242. * @returns the list of colliding sub meshes
  52243. */
  52244. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  52245. /**
  52246. * Rebuilds the elements related to this component in case of
  52247. * context lost for instance.
  52248. */
  52249. rebuild(): void;
  52250. /**
  52251. * Disposes the component and the associated ressources.
  52252. */
  52253. dispose(): void;
  52254. }
  52255. }
  52256. declare module "babylonjs/Culling/Octrees/index" {
  52257. export * from "babylonjs/Culling/Octrees/octree";
  52258. export * from "babylonjs/Culling/Octrees/octreeBlock";
  52259. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  52260. }
  52261. declare module "babylonjs/Culling/index" {
  52262. export * from "babylonjs/Culling/boundingBox";
  52263. export * from "babylonjs/Culling/boundingInfo";
  52264. export * from "babylonjs/Culling/boundingSphere";
  52265. export * from "babylonjs/Culling/Octrees/index";
  52266. export * from "babylonjs/Culling/ray";
  52267. }
  52268. declare module "babylonjs/Gizmos/gizmo" {
  52269. import { Nullable } from "babylonjs/types";
  52270. import { IDisposable } from "babylonjs/scene";
  52271. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52272. import { Mesh } from "babylonjs/Meshes/mesh";
  52273. import { Node } from "babylonjs/node";
  52274. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52275. /**
  52276. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  52277. */
  52278. export class Gizmo implements IDisposable {
  52279. /** The utility layer the gizmo will be added to */
  52280. gizmoLayer: UtilityLayerRenderer;
  52281. /**
  52282. * The root mesh of the gizmo
  52283. */
  52284. _rootMesh: Mesh;
  52285. private _attachedMesh;
  52286. private _attachedNode;
  52287. /**
  52288. * Ratio for the scale of the gizmo (Default: 1)
  52289. */
  52290. protected _scaleRatio: number;
  52291. /**
  52292. * Ratio for the scale of the gizmo (Default: 1)
  52293. */
  52294. set scaleRatio(value: number);
  52295. get scaleRatio(): number;
  52296. /**
  52297. * If a custom mesh has been set (Default: false)
  52298. */
  52299. protected _customMeshSet: boolean;
  52300. /**
  52301. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  52302. * * When set, interactions will be enabled
  52303. */
  52304. get attachedMesh(): Nullable<AbstractMesh>;
  52305. set attachedMesh(value: Nullable<AbstractMesh>);
  52306. /**
  52307. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  52308. * * When set, interactions will be enabled
  52309. */
  52310. get attachedNode(): Nullable<Node>;
  52311. set attachedNode(value: Nullable<Node>);
  52312. /**
  52313. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  52314. * @param mesh The mesh to replace the default mesh of the gizmo
  52315. */
  52316. setCustomMesh(mesh: Mesh): void;
  52317. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  52318. /**
  52319. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  52320. */
  52321. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52322. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52323. /**
  52324. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  52325. */
  52326. updateGizmoPositionToMatchAttachedMesh: boolean;
  52327. /**
  52328. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  52329. */
  52330. updateScale: boolean;
  52331. protected _interactionsEnabled: boolean;
  52332. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52333. private _beforeRenderObserver;
  52334. private _tempQuaternion;
  52335. private _tempVector;
  52336. private _tempVector2;
  52337. /**
  52338. * Creates a gizmo
  52339. * @param gizmoLayer The utility layer the gizmo will be added to
  52340. */
  52341. constructor(
  52342. /** The utility layer the gizmo will be added to */
  52343. gizmoLayer?: UtilityLayerRenderer);
  52344. /**
  52345. * Updates the gizmo to match the attached mesh's position/rotation
  52346. */
  52347. protected _update(): void;
  52348. /**
  52349. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  52350. * @param value Node, TransformNode or mesh
  52351. */
  52352. protected _matrixChanged(): void;
  52353. /**
  52354. * Disposes of the gizmo
  52355. */
  52356. dispose(): void;
  52357. }
  52358. }
  52359. declare module "babylonjs/Gizmos/planeDragGizmo" {
  52360. import { Observable } from "babylonjs/Misc/observable";
  52361. import { Nullable } from "babylonjs/types";
  52362. import { Vector3 } from "babylonjs/Maths/math.vector";
  52363. import { Color3 } from "babylonjs/Maths/math.color";
  52364. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52365. import { Node } from "babylonjs/node";
  52366. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52367. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52368. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52369. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52370. import { Scene } from "babylonjs/scene";
  52371. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52372. /**
  52373. * Single plane drag gizmo
  52374. */
  52375. export class PlaneDragGizmo extends Gizmo {
  52376. /**
  52377. * Drag behavior responsible for the gizmos dragging interactions
  52378. */
  52379. dragBehavior: PointerDragBehavior;
  52380. private _pointerObserver;
  52381. /**
  52382. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52383. */
  52384. snapDistance: number;
  52385. /**
  52386. * Event that fires each time the gizmo snaps to a new location.
  52387. * * snapDistance is the the change in distance
  52388. */
  52389. onSnapObservable: Observable<{
  52390. snapDistance: number;
  52391. }>;
  52392. private _plane;
  52393. private _coloredMaterial;
  52394. private _hoverMaterial;
  52395. private _isEnabled;
  52396. private _parent;
  52397. /** @hidden */
  52398. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52399. /** @hidden */
  52400. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52401. /**
  52402. * Creates a PlaneDragGizmo
  52403. * @param gizmoLayer The utility layer the gizmo will be added to
  52404. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52405. * @param color The color of the gizmo
  52406. */
  52407. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52408. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52409. /**
  52410. * If the gizmo is enabled
  52411. */
  52412. set isEnabled(value: boolean);
  52413. get isEnabled(): boolean;
  52414. /**
  52415. * Disposes of the gizmo
  52416. */
  52417. dispose(): void;
  52418. }
  52419. }
  52420. declare module "babylonjs/Gizmos/positionGizmo" {
  52421. import { Observable } from "babylonjs/Misc/observable";
  52422. import { Nullable } from "babylonjs/types";
  52423. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52424. import { Node } from "babylonjs/node";
  52425. import { Mesh } from "babylonjs/Meshes/mesh";
  52426. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52427. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52428. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52429. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52430. /**
  52431. * Gizmo that enables dragging a mesh along 3 axis
  52432. */
  52433. export class PositionGizmo extends Gizmo {
  52434. /**
  52435. * Internal gizmo used for interactions on the x axis
  52436. */
  52437. xGizmo: AxisDragGizmo;
  52438. /**
  52439. * Internal gizmo used for interactions on the y axis
  52440. */
  52441. yGizmo: AxisDragGizmo;
  52442. /**
  52443. * Internal gizmo used for interactions on the z axis
  52444. */
  52445. zGizmo: AxisDragGizmo;
  52446. /**
  52447. * Internal gizmo used for interactions on the yz plane
  52448. */
  52449. xPlaneGizmo: PlaneDragGizmo;
  52450. /**
  52451. * Internal gizmo used for interactions on the xz plane
  52452. */
  52453. yPlaneGizmo: PlaneDragGizmo;
  52454. /**
  52455. * Internal gizmo used for interactions on the xy plane
  52456. */
  52457. zPlaneGizmo: PlaneDragGizmo;
  52458. /**
  52459. * private variables
  52460. */
  52461. private _meshAttached;
  52462. private _nodeAttached;
  52463. private _snapDistance;
  52464. /** Fires an event when any of it's sub gizmos are dragged */
  52465. onDragStartObservable: Observable<unknown>;
  52466. /** Fires an event when any of it's sub gizmos are released from dragging */
  52467. onDragEndObservable: Observable<unknown>;
  52468. /**
  52469. * If set to true, planar drag is enabled
  52470. */
  52471. private _planarGizmoEnabled;
  52472. get attachedMesh(): Nullable<AbstractMesh>;
  52473. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52474. get attachedNode(): Nullable<Node>;
  52475. set attachedNode(node: Nullable<Node>);
  52476. /**
  52477. * Creates a PositionGizmo
  52478. * @param gizmoLayer The utility layer the gizmo will be added to
  52479. @param thickness display gizmo axis thickness
  52480. */
  52481. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52482. /**
  52483. * If the planar drag gizmo is enabled
  52484. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52485. */
  52486. set planarGizmoEnabled(value: boolean);
  52487. get planarGizmoEnabled(): boolean;
  52488. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52489. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52490. /**
  52491. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52492. */
  52493. set snapDistance(value: number);
  52494. get snapDistance(): number;
  52495. /**
  52496. * Ratio for the scale of the gizmo (Default: 1)
  52497. */
  52498. set scaleRatio(value: number);
  52499. get scaleRatio(): number;
  52500. /**
  52501. * Disposes of the gizmo
  52502. */
  52503. dispose(): void;
  52504. /**
  52505. * CustomMeshes are not supported by this gizmo
  52506. * @param mesh The mesh to replace the default mesh of the gizmo
  52507. */
  52508. setCustomMesh(mesh: Mesh): void;
  52509. }
  52510. }
  52511. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52512. import { Observable } from "babylonjs/Misc/observable";
  52513. import { Nullable } from "babylonjs/types";
  52514. import { Vector3 } from "babylonjs/Maths/math.vector";
  52515. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52516. import { Node } from "babylonjs/node";
  52517. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52518. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52519. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52520. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52521. import { Scene } from "babylonjs/scene";
  52522. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52523. import { Color3 } from "babylonjs/Maths/math.color";
  52524. /**
  52525. * Single axis drag gizmo
  52526. */
  52527. export class AxisDragGizmo extends Gizmo {
  52528. /**
  52529. * Drag behavior responsible for the gizmos dragging interactions
  52530. */
  52531. dragBehavior: PointerDragBehavior;
  52532. private _pointerObserver;
  52533. /**
  52534. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52535. */
  52536. snapDistance: number;
  52537. /**
  52538. * Event that fires each time the gizmo snaps to a new location.
  52539. * * snapDistance is the the change in distance
  52540. */
  52541. onSnapObservable: Observable<{
  52542. snapDistance: number;
  52543. }>;
  52544. private _isEnabled;
  52545. private _parent;
  52546. private _arrow;
  52547. private _coloredMaterial;
  52548. private _hoverMaterial;
  52549. /** @hidden */
  52550. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52551. /** @hidden */
  52552. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52553. /**
  52554. * Creates an AxisDragGizmo
  52555. * @param gizmoLayer The utility layer the gizmo will be added to
  52556. * @param dragAxis The axis which the gizmo will be able to drag on
  52557. * @param color The color of the gizmo
  52558. * @param thickness display gizmo axis thickness
  52559. */
  52560. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52561. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52562. /**
  52563. * If the gizmo is enabled
  52564. */
  52565. set isEnabled(value: boolean);
  52566. get isEnabled(): boolean;
  52567. /**
  52568. * Disposes of the gizmo
  52569. */
  52570. dispose(): void;
  52571. }
  52572. }
  52573. declare module "babylonjs/Debug/axesViewer" {
  52574. import { Vector3 } from "babylonjs/Maths/math.vector";
  52575. import { Nullable } from "babylonjs/types";
  52576. import { Scene } from "babylonjs/scene";
  52577. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52578. /**
  52579. * The Axes viewer will show 3 axes in a specific point in space
  52580. */
  52581. export class AxesViewer {
  52582. private _xAxis;
  52583. private _yAxis;
  52584. private _zAxis;
  52585. private _scaleLinesFactor;
  52586. private _instanced;
  52587. /**
  52588. * Gets the hosting scene
  52589. */
  52590. scene: Nullable<Scene>;
  52591. /**
  52592. * Gets or sets a number used to scale line length
  52593. */
  52594. scaleLines: number;
  52595. /** Gets the node hierarchy used to render x-axis */
  52596. get xAxis(): TransformNode;
  52597. /** Gets the node hierarchy used to render y-axis */
  52598. get yAxis(): TransformNode;
  52599. /** Gets the node hierarchy used to render z-axis */
  52600. get zAxis(): TransformNode;
  52601. /**
  52602. * Creates a new AxesViewer
  52603. * @param scene defines the hosting scene
  52604. * @param scaleLines defines a number used to scale line length (1 by default)
  52605. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52606. * @param xAxis defines the node hierarchy used to render the x-axis
  52607. * @param yAxis defines the node hierarchy used to render the y-axis
  52608. * @param zAxis defines the node hierarchy used to render the z-axis
  52609. */
  52610. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52611. /**
  52612. * Force the viewer to update
  52613. * @param position defines the position of the viewer
  52614. * @param xaxis defines the x axis of the viewer
  52615. * @param yaxis defines the y axis of the viewer
  52616. * @param zaxis defines the z axis of the viewer
  52617. */
  52618. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52619. /**
  52620. * Creates an instance of this axes viewer.
  52621. * @returns a new axes viewer with instanced meshes
  52622. */
  52623. createInstance(): AxesViewer;
  52624. /** Releases resources */
  52625. dispose(): void;
  52626. private static _SetRenderingGroupId;
  52627. }
  52628. }
  52629. declare module "babylonjs/Debug/boneAxesViewer" {
  52630. import { Nullable } from "babylonjs/types";
  52631. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52632. import { Vector3 } from "babylonjs/Maths/math.vector";
  52633. import { Mesh } from "babylonjs/Meshes/mesh";
  52634. import { Bone } from "babylonjs/Bones/bone";
  52635. import { Scene } from "babylonjs/scene";
  52636. /**
  52637. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52638. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52639. */
  52640. export class BoneAxesViewer extends AxesViewer {
  52641. /**
  52642. * Gets or sets the target mesh where to display the axes viewer
  52643. */
  52644. mesh: Nullable<Mesh>;
  52645. /**
  52646. * Gets or sets the target bone where to display the axes viewer
  52647. */
  52648. bone: Nullable<Bone>;
  52649. /** Gets current position */
  52650. pos: Vector3;
  52651. /** Gets direction of X axis */
  52652. xaxis: Vector3;
  52653. /** Gets direction of Y axis */
  52654. yaxis: Vector3;
  52655. /** Gets direction of Z axis */
  52656. zaxis: Vector3;
  52657. /**
  52658. * Creates a new BoneAxesViewer
  52659. * @param scene defines the hosting scene
  52660. * @param bone defines the target bone
  52661. * @param mesh defines the target mesh
  52662. * @param scaleLines defines a scaling factor for line length (1 by default)
  52663. */
  52664. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52665. /**
  52666. * Force the viewer to update
  52667. */
  52668. update(): void;
  52669. /** Releases resources */
  52670. dispose(): void;
  52671. }
  52672. }
  52673. declare module "babylonjs/Debug/debugLayer" {
  52674. import { Scene } from "babylonjs/scene";
  52675. /**
  52676. * Interface used to define scene explorer extensibility option
  52677. */
  52678. export interface IExplorerExtensibilityOption {
  52679. /**
  52680. * Define the option label
  52681. */
  52682. label: string;
  52683. /**
  52684. * Defines the action to execute on click
  52685. */
  52686. action: (entity: any) => void;
  52687. }
  52688. /**
  52689. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52690. */
  52691. export interface IExplorerExtensibilityGroup {
  52692. /**
  52693. * Defines a predicate to test if a given type mut be extended
  52694. */
  52695. predicate: (entity: any) => boolean;
  52696. /**
  52697. * Gets the list of options added to a type
  52698. */
  52699. entries: IExplorerExtensibilityOption[];
  52700. }
  52701. /**
  52702. * Interface used to define the options to use to create the Inspector
  52703. */
  52704. export interface IInspectorOptions {
  52705. /**
  52706. * Display in overlay mode (default: false)
  52707. */
  52708. overlay?: boolean;
  52709. /**
  52710. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52711. */
  52712. globalRoot?: HTMLElement;
  52713. /**
  52714. * Display the Scene explorer
  52715. */
  52716. showExplorer?: boolean;
  52717. /**
  52718. * Display the property inspector
  52719. */
  52720. showInspector?: boolean;
  52721. /**
  52722. * Display in embed mode (both panes on the right)
  52723. */
  52724. embedMode?: boolean;
  52725. /**
  52726. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52727. */
  52728. handleResize?: boolean;
  52729. /**
  52730. * Allow the panes to popup (default: true)
  52731. */
  52732. enablePopup?: boolean;
  52733. /**
  52734. * Allow the panes to be closed by users (default: true)
  52735. */
  52736. enableClose?: boolean;
  52737. /**
  52738. * Optional list of extensibility entries
  52739. */
  52740. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52741. /**
  52742. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52743. */
  52744. inspectorURL?: string;
  52745. /**
  52746. * Optional initial tab (default to DebugLayerTab.Properties)
  52747. */
  52748. initialTab?: DebugLayerTab;
  52749. }
  52750. module "babylonjs/scene" {
  52751. interface Scene {
  52752. /**
  52753. * @hidden
  52754. * Backing field
  52755. */
  52756. _debugLayer: DebugLayer;
  52757. /**
  52758. * Gets the debug layer (aka Inspector) associated with the scene
  52759. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52760. */
  52761. debugLayer: DebugLayer;
  52762. }
  52763. }
  52764. /**
  52765. * Enum of inspector action tab
  52766. */
  52767. export enum DebugLayerTab {
  52768. /**
  52769. * Properties tag (default)
  52770. */
  52771. Properties = 0,
  52772. /**
  52773. * Debug tab
  52774. */
  52775. Debug = 1,
  52776. /**
  52777. * Statistics tab
  52778. */
  52779. Statistics = 2,
  52780. /**
  52781. * Tools tab
  52782. */
  52783. Tools = 3,
  52784. /**
  52785. * Settings tab
  52786. */
  52787. Settings = 4
  52788. }
  52789. /**
  52790. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52791. * what is happening in your scene
  52792. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52793. */
  52794. export class DebugLayer {
  52795. /**
  52796. * Define the url to get the inspector script from.
  52797. * By default it uses the babylonjs CDN.
  52798. * @ignoreNaming
  52799. */
  52800. static InspectorURL: string;
  52801. private _scene;
  52802. private BJSINSPECTOR;
  52803. private _onPropertyChangedObservable?;
  52804. /**
  52805. * Observable triggered when a property is changed through the inspector.
  52806. */
  52807. get onPropertyChangedObservable(): any;
  52808. /**
  52809. * Instantiates a new debug layer.
  52810. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52811. * what is happening in your scene
  52812. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52813. * @param scene Defines the scene to inspect
  52814. */
  52815. constructor(scene: Scene);
  52816. /** Creates the inspector window. */
  52817. private _createInspector;
  52818. /**
  52819. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52820. * @param entity defines the entity to select
  52821. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52822. */
  52823. select(entity: any, lineContainerTitles?: string | string[]): void;
  52824. /** Get the inspector from bundle or global */
  52825. private _getGlobalInspector;
  52826. /**
  52827. * Get if the inspector is visible or not.
  52828. * @returns true if visible otherwise, false
  52829. */
  52830. isVisible(): boolean;
  52831. /**
  52832. * Hide the inspector and close its window.
  52833. */
  52834. hide(): void;
  52835. /**
  52836. * Update the scene in the inspector
  52837. */
  52838. setAsActiveScene(): void;
  52839. /**
  52840. * Launch the debugLayer.
  52841. * @param config Define the configuration of the inspector
  52842. * @return a promise fulfilled when the debug layer is visible
  52843. */
  52844. show(config?: IInspectorOptions): Promise<DebugLayer>;
  52845. }
  52846. }
  52847. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  52848. import { Nullable } from "babylonjs/types";
  52849. import { Scene } from "babylonjs/scene";
  52850. import { Vector4 } from "babylonjs/Maths/math.vector";
  52851. import { Color4 } from "babylonjs/Maths/math.color";
  52852. import { Mesh } from "babylonjs/Meshes/mesh";
  52853. /**
  52854. * Class containing static functions to help procedurally build meshes
  52855. */
  52856. export class BoxBuilder {
  52857. /**
  52858. * Creates a box mesh
  52859. * * The parameter `size` sets the size (float) of each box side (default 1)
  52860. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  52861. * * 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)
  52862. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  52863. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52864. * * 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
  52865. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52866. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  52867. * @param name defines the name of the mesh
  52868. * @param options defines the options used to create the mesh
  52869. * @param scene defines the hosting scene
  52870. * @returns the box mesh
  52871. */
  52872. static CreateBox(name: string, options: {
  52873. size?: number;
  52874. width?: number;
  52875. height?: number;
  52876. depth?: number;
  52877. faceUV?: Vector4[];
  52878. faceColors?: Color4[];
  52879. sideOrientation?: number;
  52880. frontUVs?: Vector4;
  52881. backUVs?: Vector4;
  52882. wrap?: boolean;
  52883. topBaseAt?: number;
  52884. bottomBaseAt?: number;
  52885. updatable?: boolean;
  52886. }, scene?: Nullable<Scene>): Mesh;
  52887. }
  52888. }
  52889. declare module "babylonjs/Debug/physicsViewer" {
  52890. import { Nullable } from "babylonjs/types";
  52891. import { Scene } from "babylonjs/scene";
  52892. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52893. import { Mesh } from "babylonjs/Meshes/mesh";
  52894. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52895. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52896. /**
  52897. * Used to show the physics impostor around the specific mesh
  52898. */
  52899. export class PhysicsViewer {
  52900. /** @hidden */
  52901. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  52902. /** @hidden */
  52903. protected _meshes: Array<Nullable<AbstractMesh>>;
  52904. /** @hidden */
  52905. protected _scene: Nullable<Scene>;
  52906. /** @hidden */
  52907. protected _numMeshes: number;
  52908. /** @hidden */
  52909. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  52910. private _renderFunction;
  52911. private _utilityLayer;
  52912. private _debugBoxMesh;
  52913. private _debugSphereMesh;
  52914. private _debugCylinderMesh;
  52915. private _debugMaterial;
  52916. private _debugMeshMeshes;
  52917. /**
  52918. * Creates a new PhysicsViewer
  52919. * @param scene defines the hosting scene
  52920. */
  52921. constructor(scene: Scene);
  52922. /** @hidden */
  52923. protected _updateDebugMeshes(): void;
  52924. /**
  52925. * Renders a specified physic impostor
  52926. * @param impostor defines the impostor to render
  52927. * @param targetMesh defines the mesh represented by the impostor
  52928. * @returns the new debug mesh used to render the impostor
  52929. */
  52930. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  52931. /**
  52932. * Hides a specified physic impostor
  52933. * @param impostor defines the impostor to hide
  52934. */
  52935. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  52936. private _getDebugMaterial;
  52937. private _getDebugBoxMesh;
  52938. private _getDebugSphereMesh;
  52939. private _getDebugCylinderMesh;
  52940. private _getDebugMeshMesh;
  52941. private _getDebugMesh;
  52942. /** Releases all resources */
  52943. dispose(): void;
  52944. }
  52945. }
  52946. declare module "babylonjs/Debug/rayHelper" {
  52947. import { Nullable } from "babylonjs/types";
  52948. import { Ray } from "babylonjs/Culling/ray";
  52949. import { Vector3 } from "babylonjs/Maths/math.vector";
  52950. import { Color3 } from "babylonjs/Maths/math.color";
  52951. import { Scene } from "babylonjs/scene";
  52952. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52953. import "babylonjs/Meshes/Builders/linesBuilder";
  52954. /**
  52955. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52956. * in order to better appreciate the issue one might have.
  52957. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52958. */
  52959. export class RayHelper {
  52960. /**
  52961. * Defines the ray we are currently tryin to visualize.
  52962. */
  52963. ray: Nullable<Ray>;
  52964. private _renderPoints;
  52965. private _renderLine;
  52966. private _renderFunction;
  52967. private _scene;
  52968. private _onAfterRenderObserver;
  52969. private _onAfterStepObserver;
  52970. private _attachedToMesh;
  52971. private _meshSpaceDirection;
  52972. private _meshSpaceOrigin;
  52973. /**
  52974. * Helper function to create a colored helper in a scene in one line.
  52975. * @param ray Defines the ray we are currently tryin to visualize
  52976. * @param scene Defines the scene the ray is used in
  52977. * @param color Defines the color we want to see the ray in
  52978. * @returns The newly created ray helper.
  52979. */
  52980. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  52981. /**
  52982. * Instantiate a new ray helper.
  52983. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52984. * in order to better appreciate the issue one might have.
  52985. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52986. * @param ray Defines the ray we are currently tryin to visualize
  52987. */
  52988. constructor(ray: Ray);
  52989. /**
  52990. * Shows the ray we are willing to debug.
  52991. * @param scene Defines the scene the ray needs to be rendered in
  52992. * @param color Defines the color the ray needs to be rendered in
  52993. */
  52994. show(scene: Scene, color?: Color3): void;
  52995. /**
  52996. * Hides the ray we are debugging.
  52997. */
  52998. hide(): void;
  52999. private _render;
  53000. /**
  53001. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  53002. * @param mesh Defines the mesh we want the helper attached to
  53003. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  53004. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  53005. * @param length Defines the length of the ray
  53006. */
  53007. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  53008. /**
  53009. * Detach the ray helper from the mesh it has previously been attached to.
  53010. */
  53011. detachFromMesh(): void;
  53012. private _updateToMesh;
  53013. /**
  53014. * Dispose the helper and release its associated resources.
  53015. */
  53016. dispose(): void;
  53017. }
  53018. }
  53019. declare module "babylonjs/Debug/ISkeletonViewer" {
  53020. /**
  53021. * Defines the options associated with the creation of a SkeletonViewer.
  53022. */
  53023. export interface ISkeletonViewerOptions {
  53024. /** Should the system pause animations before building the Viewer? */
  53025. pauseAnimations: boolean;
  53026. /** Should the system return the skeleton to rest before building? */
  53027. returnToRest: boolean;
  53028. /** public Display Mode of the Viewer */
  53029. displayMode: number;
  53030. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53031. displayOptions: ISkeletonViewerDisplayOptions;
  53032. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53033. computeBonesUsingShaders: boolean;
  53034. }
  53035. /**
  53036. * Defines how to display the various bone meshes for the viewer.
  53037. */
  53038. export interface ISkeletonViewerDisplayOptions {
  53039. /** How far down to start tapering the bone spurs */
  53040. midStep?: number;
  53041. /** How big is the midStep? */
  53042. midStepFactor?: number;
  53043. /** Base for the Sphere Size */
  53044. sphereBaseSize?: number;
  53045. /** The ratio of the sphere to the longest bone in units */
  53046. sphereScaleUnit?: number;
  53047. /** Ratio for the Sphere Size */
  53048. sphereFactor?: number;
  53049. }
  53050. }
  53051. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  53052. import { Nullable } from "babylonjs/types";
  53053. import { Scene } from "babylonjs/scene";
  53054. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  53055. import { Color4 } from "babylonjs/Maths/math.color";
  53056. import { Mesh } from "babylonjs/Meshes/mesh";
  53057. /**
  53058. * Class containing static functions to help procedurally build meshes
  53059. */
  53060. export class RibbonBuilder {
  53061. /**
  53062. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53063. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53064. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53065. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53066. * * 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
  53067. * * 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
  53068. * * 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
  53069. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53070. * * 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
  53071. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53072. * * 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
  53073. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53074. * * 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
  53075. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53076. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53077. * @param name defines the name of the mesh
  53078. * @param options defines the options used to create the mesh
  53079. * @param scene defines the hosting scene
  53080. * @returns the ribbon mesh
  53081. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53082. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53083. */
  53084. static CreateRibbon(name: string, options: {
  53085. pathArray: Vector3[][];
  53086. closeArray?: boolean;
  53087. closePath?: boolean;
  53088. offset?: number;
  53089. updatable?: boolean;
  53090. sideOrientation?: number;
  53091. frontUVs?: Vector4;
  53092. backUVs?: Vector4;
  53093. instance?: Mesh;
  53094. invertUV?: boolean;
  53095. uvs?: Vector2[];
  53096. colors?: Color4[];
  53097. }, scene?: Nullable<Scene>): Mesh;
  53098. }
  53099. }
  53100. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53101. import { Nullable } from "babylonjs/types";
  53102. import { Scene } from "babylonjs/scene";
  53103. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53104. import { Mesh } from "babylonjs/Meshes/mesh";
  53105. /**
  53106. * Class containing static functions to help procedurally build meshes
  53107. */
  53108. export class ShapeBuilder {
  53109. /**
  53110. * 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.
  53111. * * 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.
  53112. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53113. * * 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.
  53114. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53115. * * 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
  53116. * * 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
  53117. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53118. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53119. * * 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
  53120. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53121. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53122. * @param name defines the name of the mesh
  53123. * @param options defines the options used to create the mesh
  53124. * @param scene defines the hosting scene
  53125. * @returns the extruded shape mesh
  53126. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53127. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53128. */
  53129. static ExtrudeShape(name: string, options: {
  53130. shape: Vector3[];
  53131. path: Vector3[];
  53132. scale?: number;
  53133. rotation?: number;
  53134. cap?: number;
  53135. updatable?: boolean;
  53136. sideOrientation?: number;
  53137. frontUVs?: Vector4;
  53138. backUVs?: Vector4;
  53139. instance?: Mesh;
  53140. invertUV?: boolean;
  53141. }, scene?: Nullable<Scene>): Mesh;
  53142. /**
  53143. * Creates an custom extruded shape mesh.
  53144. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53145. * * 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.
  53146. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53147. * * 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
  53148. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53149. * * 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
  53150. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53151. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53152. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53153. * * 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
  53154. * * 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
  53155. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53156. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53157. * * 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
  53158. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53159. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53160. * @param name defines the name of the mesh
  53161. * @param options defines the options used to create the mesh
  53162. * @param scene defines the hosting scene
  53163. * @returns the custom extruded shape mesh
  53164. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53165. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53166. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53167. */
  53168. static ExtrudeShapeCustom(name: string, options: {
  53169. shape: Vector3[];
  53170. path: Vector3[];
  53171. scaleFunction?: any;
  53172. rotationFunction?: any;
  53173. ribbonCloseArray?: boolean;
  53174. ribbonClosePath?: boolean;
  53175. cap?: number;
  53176. updatable?: boolean;
  53177. sideOrientation?: number;
  53178. frontUVs?: Vector4;
  53179. backUVs?: Vector4;
  53180. instance?: Mesh;
  53181. invertUV?: boolean;
  53182. }, scene?: Nullable<Scene>): Mesh;
  53183. private static _ExtrudeShapeGeneric;
  53184. }
  53185. }
  53186. declare module "babylonjs/Debug/skeletonViewer" {
  53187. import { Color3 } from "babylonjs/Maths/math.color";
  53188. import { Scene } from "babylonjs/scene";
  53189. import { Nullable } from "babylonjs/types";
  53190. import { Skeleton } from "babylonjs/Bones/skeleton";
  53191. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53192. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  53193. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  53194. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  53195. import { ISkeletonViewerOptions } from "babylonjs/Debug/ISkeletonViewer";
  53196. /**
  53197. * Class used to render a debug view of a given skeleton
  53198. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  53199. */
  53200. export class SkeletonViewer {
  53201. /** defines the skeleton to render */
  53202. skeleton: Skeleton;
  53203. /** defines the mesh attached to the skeleton */
  53204. mesh: AbstractMesh;
  53205. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53206. autoUpdateBonesMatrices: boolean;
  53207. /** defines the rendering group id to use with the viewer */
  53208. renderingGroupId: number;
  53209. /** is the options for the viewer */
  53210. options: Partial<ISkeletonViewerOptions>;
  53211. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  53212. static readonly DISPLAY_LINES: number;
  53213. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  53214. static readonly DISPLAY_SPHERES: number;
  53215. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  53216. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  53217. /** If SkeletonViewer scene scope. */
  53218. private _scene;
  53219. /** Gets or sets the color used to render the skeleton */
  53220. color: Color3;
  53221. /** Array of the points of the skeleton fo the line view. */
  53222. private _debugLines;
  53223. /** The SkeletonViewers Mesh. */
  53224. private _debugMesh;
  53225. /** If SkeletonViewer is enabled. */
  53226. private _isEnabled;
  53227. /** If SkeletonViewer is ready. */
  53228. private _ready;
  53229. /** SkeletonViewer render observable. */
  53230. private _obs;
  53231. /** The Utility Layer to render the gizmos in. */
  53232. private _utilityLayer;
  53233. private _boneIndices;
  53234. /** Gets the Scene. */
  53235. get scene(): Scene;
  53236. /** Gets the utilityLayer. */
  53237. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  53238. /** Checks Ready Status. */
  53239. get isReady(): Boolean;
  53240. /** Sets Ready Status. */
  53241. set ready(value: boolean);
  53242. /** Gets the debugMesh */
  53243. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  53244. /** Sets the debugMesh */
  53245. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  53246. /** Gets the material */
  53247. get material(): StandardMaterial;
  53248. /** Sets the material */
  53249. set material(value: StandardMaterial);
  53250. /** Gets the material */
  53251. get displayMode(): number;
  53252. /** Sets the material */
  53253. set displayMode(value: number);
  53254. /**
  53255. * Creates a new SkeletonViewer
  53256. * @param skeleton defines the skeleton to render
  53257. * @param mesh defines the mesh attached to the skeleton
  53258. * @param scene defines the hosting scene
  53259. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  53260. * @param renderingGroupId defines the rendering group id to use with the viewer
  53261. * @param options All of the extra constructor options for the SkeletonViewer
  53262. */
  53263. constructor(
  53264. /** defines the skeleton to render */
  53265. skeleton: Skeleton,
  53266. /** defines the mesh attached to the skeleton */
  53267. mesh: AbstractMesh,
  53268. /** The Scene scope*/
  53269. scene: Scene,
  53270. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53271. autoUpdateBonesMatrices?: boolean,
  53272. /** defines the rendering group id to use with the viewer */
  53273. renderingGroupId?: number,
  53274. /** is the options for the viewer */
  53275. options?: Partial<ISkeletonViewerOptions>);
  53276. /** The Dynamic bindings for the update functions */
  53277. private _bindObs;
  53278. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  53279. update(): void;
  53280. /** Gets or sets a boolean indicating if the viewer is enabled */
  53281. set isEnabled(value: boolean);
  53282. get isEnabled(): boolean;
  53283. private _getBonePosition;
  53284. private _getLinesForBonesWithLength;
  53285. private _getLinesForBonesNoLength;
  53286. /** function to revert the mesh and scene back to the initial state. */
  53287. private _revert;
  53288. /** function to build and bind sphere joint points and spur bone representations. */
  53289. private _buildSpheresAndSpurs;
  53290. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  53291. private _displayLinesUpdate;
  53292. /** Changes the displayMode of the skeleton viewer
  53293. * @param mode The displayMode numerical value
  53294. */
  53295. changeDisplayMode(mode: number): void;
  53296. /** Changes the displayMode of the skeleton viewer
  53297. * @param option String of the option name
  53298. * @param value The numerical option value
  53299. */
  53300. changeDisplayOptions(option: string, value: number): void;
  53301. /** Release associated resources */
  53302. dispose(): void;
  53303. }
  53304. }
  53305. declare module "babylonjs/Debug/index" {
  53306. export * from "babylonjs/Debug/axesViewer";
  53307. export * from "babylonjs/Debug/boneAxesViewer";
  53308. export * from "babylonjs/Debug/debugLayer";
  53309. export * from "babylonjs/Debug/physicsViewer";
  53310. export * from "babylonjs/Debug/rayHelper";
  53311. export * from "babylonjs/Debug/skeletonViewer";
  53312. export * from "babylonjs/Debug/ISkeletonViewer";
  53313. }
  53314. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  53315. /**
  53316. * Enum for Device Types
  53317. */
  53318. export enum DeviceType {
  53319. /** Generic */
  53320. Generic = 0,
  53321. /** Keyboard */
  53322. Keyboard = 1,
  53323. /** Mouse */
  53324. Mouse = 2,
  53325. /** Touch Pointers */
  53326. Touch = 3,
  53327. /** PS4 Dual Shock */
  53328. DualShock = 4,
  53329. /** Xbox */
  53330. Xbox = 5,
  53331. /** Switch Controller */
  53332. Switch = 6
  53333. }
  53334. /**
  53335. * Enum for All Pointers (Touch/Mouse)
  53336. */
  53337. export enum PointerInput {
  53338. /** Horizontal Axis */
  53339. Horizontal = 0,
  53340. /** Vertical Axis */
  53341. Vertical = 1,
  53342. /** Left Click or Touch */
  53343. LeftClick = 2,
  53344. /** Middle Click */
  53345. MiddleClick = 3,
  53346. /** Right Click */
  53347. RightClick = 4,
  53348. /** Browser Back */
  53349. BrowserBack = 5,
  53350. /** Browser Forward */
  53351. BrowserForward = 6
  53352. }
  53353. /**
  53354. * Enum for Dual Shock Gamepad
  53355. */
  53356. export enum DualShockInput {
  53357. /** Cross */
  53358. Cross = 0,
  53359. /** Circle */
  53360. Circle = 1,
  53361. /** Square */
  53362. Square = 2,
  53363. /** Triangle */
  53364. Triangle = 3,
  53365. /** L1 */
  53366. L1 = 4,
  53367. /** R1 */
  53368. R1 = 5,
  53369. /** L2 */
  53370. L2 = 6,
  53371. /** R2 */
  53372. R2 = 7,
  53373. /** Share */
  53374. Share = 8,
  53375. /** Options */
  53376. Options = 9,
  53377. /** L3 */
  53378. L3 = 10,
  53379. /** R3 */
  53380. R3 = 11,
  53381. /** DPadUp */
  53382. DPadUp = 12,
  53383. /** DPadDown */
  53384. DPadDown = 13,
  53385. /** DPadLeft */
  53386. DPadLeft = 14,
  53387. /** DRight */
  53388. DPadRight = 15,
  53389. /** Home */
  53390. Home = 16,
  53391. /** TouchPad */
  53392. TouchPad = 17,
  53393. /** LStickXAxis */
  53394. LStickXAxis = 18,
  53395. /** LStickYAxis */
  53396. LStickYAxis = 19,
  53397. /** RStickXAxis */
  53398. RStickXAxis = 20,
  53399. /** RStickYAxis */
  53400. RStickYAxis = 21
  53401. }
  53402. /**
  53403. * Enum for Xbox Gamepad
  53404. */
  53405. export enum XboxInput {
  53406. /** A */
  53407. A = 0,
  53408. /** B */
  53409. B = 1,
  53410. /** X */
  53411. X = 2,
  53412. /** Y */
  53413. Y = 3,
  53414. /** LB */
  53415. LB = 4,
  53416. /** RB */
  53417. RB = 5,
  53418. /** LT */
  53419. LT = 6,
  53420. /** RT */
  53421. RT = 7,
  53422. /** Back */
  53423. Back = 8,
  53424. /** Start */
  53425. Start = 9,
  53426. /** LS */
  53427. LS = 10,
  53428. /** RS */
  53429. RS = 11,
  53430. /** DPadUp */
  53431. DPadUp = 12,
  53432. /** DPadDown */
  53433. DPadDown = 13,
  53434. /** DPadLeft */
  53435. DPadLeft = 14,
  53436. /** DRight */
  53437. DPadRight = 15,
  53438. /** Home */
  53439. Home = 16,
  53440. /** LStickXAxis */
  53441. LStickXAxis = 17,
  53442. /** LStickYAxis */
  53443. LStickYAxis = 18,
  53444. /** RStickXAxis */
  53445. RStickXAxis = 19,
  53446. /** RStickYAxis */
  53447. RStickYAxis = 20
  53448. }
  53449. /**
  53450. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  53451. */
  53452. export enum SwitchInput {
  53453. /** B */
  53454. B = 0,
  53455. /** A */
  53456. A = 1,
  53457. /** Y */
  53458. Y = 2,
  53459. /** X */
  53460. X = 3,
  53461. /** L */
  53462. L = 4,
  53463. /** R */
  53464. R = 5,
  53465. /** ZL */
  53466. ZL = 6,
  53467. /** ZR */
  53468. ZR = 7,
  53469. /** Minus */
  53470. Minus = 8,
  53471. /** Plus */
  53472. Plus = 9,
  53473. /** LS */
  53474. LS = 10,
  53475. /** RS */
  53476. RS = 11,
  53477. /** DPadUp */
  53478. DPadUp = 12,
  53479. /** DPadDown */
  53480. DPadDown = 13,
  53481. /** DPadLeft */
  53482. DPadLeft = 14,
  53483. /** DRight */
  53484. DPadRight = 15,
  53485. /** Home */
  53486. Home = 16,
  53487. /** Capture */
  53488. Capture = 17,
  53489. /** LStickXAxis */
  53490. LStickXAxis = 18,
  53491. /** LStickYAxis */
  53492. LStickYAxis = 19,
  53493. /** RStickXAxis */
  53494. RStickXAxis = 20,
  53495. /** RStickYAxis */
  53496. RStickYAxis = 21
  53497. }
  53498. }
  53499. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  53500. import { Engine } from "babylonjs/Engines/engine";
  53501. import { IDisposable } from "babylonjs/scene";
  53502. import { Nullable } from "babylonjs/types";
  53503. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53504. /**
  53505. * This class will take all inputs from Keyboard, Pointer, and
  53506. * any Gamepads and provide a polling system that all devices
  53507. * will use. This class assumes that there will only be one
  53508. * pointer device and one keyboard.
  53509. */
  53510. export class DeviceInputSystem implements IDisposable {
  53511. /**
  53512. * Callback to be triggered when a device is connected
  53513. */
  53514. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53515. /**
  53516. * Callback to be triggered when a device is disconnected
  53517. */
  53518. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53519. /**
  53520. * Callback to be triggered when event driven input is updated
  53521. */
  53522. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  53523. private _inputs;
  53524. private _gamepads;
  53525. private _keyboardActive;
  53526. private _pointerActive;
  53527. private _elementToAttachTo;
  53528. private _keyboardDownEvent;
  53529. private _keyboardUpEvent;
  53530. private _pointerMoveEvent;
  53531. private _pointerDownEvent;
  53532. private _pointerUpEvent;
  53533. private _gamepadConnectedEvent;
  53534. private _gamepadDisconnectedEvent;
  53535. private static _MAX_KEYCODES;
  53536. private static _MAX_POINTER_INPUTS;
  53537. private constructor();
  53538. /**
  53539. * Creates a new DeviceInputSystem instance
  53540. * @param engine Engine to pull input element from
  53541. * @returns The new instance
  53542. */
  53543. static Create(engine: Engine): DeviceInputSystem;
  53544. /**
  53545. * Checks for current device input value, given an id and input index
  53546. * @param deviceName Id of connected device
  53547. * @param inputIndex Index of device input
  53548. * @returns Current value of input
  53549. */
  53550. /**
  53551. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  53552. * @param deviceType Enum specifiying device type
  53553. * @param deviceSlot "Slot" or index that device is referenced in
  53554. * @param inputIndex Id of input to be checked
  53555. * @returns Current value of input
  53556. */
  53557. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  53558. /**
  53559. * Dispose of all the eventlisteners
  53560. */
  53561. dispose(): void;
  53562. /**
  53563. * Add device and inputs to device array
  53564. * @param deviceType Enum specifiying device type
  53565. * @param deviceSlot "Slot" or index that device is referenced in
  53566. * @param numberOfInputs Number of input entries to create for given device
  53567. */
  53568. private _registerDevice;
  53569. /**
  53570. * Given a specific device name, remove that device from the device map
  53571. * @param deviceType Enum specifiying device type
  53572. * @param deviceSlot "Slot" or index that device is referenced in
  53573. */
  53574. private _unregisterDevice;
  53575. /**
  53576. * Handle all actions that come from keyboard interaction
  53577. */
  53578. private _handleKeyActions;
  53579. /**
  53580. * Handle all actions that come from pointer interaction
  53581. */
  53582. private _handlePointerActions;
  53583. /**
  53584. * Handle all actions that come from gamepad interaction
  53585. */
  53586. private _handleGamepadActions;
  53587. /**
  53588. * Update all non-event based devices with each frame
  53589. * @param deviceType Enum specifiying device type
  53590. * @param deviceSlot "Slot" or index that device is referenced in
  53591. * @param inputIndex Id of input to be checked
  53592. */
  53593. private _updateDevice;
  53594. /**
  53595. * Gets DeviceType from the device name
  53596. * @param deviceName Name of Device from DeviceInputSystem
  53597. * @returns DeviceType enum value
  53598. */
  53599. private _getGamepadDeviceType;
  53600. }
  53601. }
  53602. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  53603. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53604. /**
  53605. * Type to handle enforcement of inputs
  53606. */
  53607. 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;
  53608. }
  53609. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53610. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53611. import { Engine } from "babylonjs/Engines/engine";
  53612. import { IDisposable } from "babylonjs/scene";
  53613. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53614. import { Nullable } from "babylonjs/types";
  53615. import { Observable } from "babylonjs/Misc/observable";
  53616. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53617. /**
  53618. * Class that handles all input for a specific device
  53619. */
  53620. export class DeviceSource<T extends DeviceType> {
  53621. /** Type of device */
  53622. readonly deviceType: DeviceType;
  53623. /** "Slot" or index that device is referenced in */
  53624. readonly deviceSlot: number;
  53625. /**
  53626. * Observable to handle device input changes per device
  53627. */
  53628. readonly onInputChangedObservable: Observable<{
  53629. inputIndex: DeviceInput<T>;
  53630. previousState: Nullable<number>;
  53631. currentState: Nullable<number>;
  53632. }>;
  53633. private readonly _deviceInputSystem;
  53634. /**
  53635. * Default Constructor
  53636. * @param deviceInputSystem Reference to DeviceInputSystem
  53637. * @param deviceType Type of device
  53638. * @param deviceSlot "Slot" or index that device is referenced in
  53639. */
  53640. constructor(deviceInputSystem: DeviceInputSystem,
  53641. /** Type of device */
  53642. deviceType: DeviceType,
  53643. /** "Slot" or index that device is referenced in */
  53644. deviceSlot?: number);
  53645. /**
  53646. * Get input for specific input
  53647. * @param inputIndex index of specific input on device
  53648. * @returns Input value from DeviceInputSystem
  53649. */
  53650. getInput(inputIndex: DeviceInput<T>): number;
  53651. }
  53652. /**
  53653. * Class to keep track of devices
  53654. */
  53655. export class DeviceSourceManager implements IDisposable {
  53656. /**
  53657. * Observable to be triggered when before a device is connected
  53658. */
  53659. readonly onBeforeDeviceConnectedObservable: Observable<{
  53660. deviceType: DeviceType;
  53661. deviceSlot: number;
  53662. }>;
  53663. /**
  53664. * Observable to be triggered when before a device is disconnected
  53665. */
  53666. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53667. deviceType: DeviceType;
  53668. deviceSlot: number;
  53669. }>;
  53670. /**
  53671. * Observable to be triggered when after a device is connected
  53672. */
  53673. readonly onAfterDeviceConnectedObservable: Observable<{
  53674. deviceType: DeviceType;
  53675. deviceSlot: number;
  53676. }>;
  53677. /**
  53678. * Observable to be triggered when after a device is disconnected
  53679. */
  53680. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53681. deviceType: DeviceType;
  53682. deviceSlot: number;
  53683. }>;
  53684. private readonly _devices;
  53685. private readonly _firstDevice;
  53686. private readonly _deviceInputSystem;
  53687. /**
  53688. * Default Constructor
  53689. * @param engine engine to pull input element from
  53690. */
  53691. constructor(engine: Engine);
  53692. /**
  53693. * Gets a DeviceSource, given a type and slot
  53694. * @param deviceType Enum specifying device type
  53695. * @param deviceSlot "Slot" or index that device is referenced in
  53696. * @returns DeviceSource object
  53697. */
  53698. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53699. /**
  53700. * Gets an array of DeviceSource objects for a given device type
  53701. * @param deviceType Enum specifying device type
  53702. * @returns Array of DeviceSource objects
  53703. */
  53704. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53705. /**
  53706. * Dispose of DeviceInputSystem and other parts
  53707. */
  53708. dispose(): void;
  53709. /**
  53710. * Function to add device name to device list
  53711. * @param deviceType Enum specifying device type
  53712. * @param deviceSlot "Slot" or index that device is referenced in
  53713. */
  53714. private _addDevice;
  53715. /**
  53716. * Function to remove device name to device list
  53717. * @param deviceType Enum specifying device type
  53718. * @param deviceSlot "Slot" or index that device is referenced in
  53719. */
  53720. private _removeDevice;
  53721. /**
  53722. * Updates array storing first connected device of each type
  53723. * @param type Type of Device
  53724. */
  53725. private _updateFirstDevices;
  53726. }
  53727. }
  53728. declare module "babylonjs/DeviceInput/index" {
  53729. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53730. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53731. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53732. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53733. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53734. }
  53735. declare module "babylonjs/Engines/nullEngine" {
  53736. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53737. import { Engine } from "babylonjs/Engines/engine";
  53738. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53739. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53740. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53741. import { Effect } from "babylonjs/Materials/effect";
  53742. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53743. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53744. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53745. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53746. /**
  53747. * Options to create the null engine
  53748. */
  53749. export class NullEngineOptions {
  53750. /**
  53751. * Render width (Default: 512)
  53752. */
  53753. renderWidth: number;
  53754. /**
  53755. * Render height (Default: 256)
  53756. */
  53757. renderHeight: number;
  53758. /**
  53759. * Texture size (Default: 512)
  53760. */
  53761. textureSize: number;
  53762. /**
  53763. * If delta time between frames should be constant
  53764. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53765. */
  53766. deterministicLockstep: boolean;
  53767. /**
  53768. * Maximum about of steps between frames (Default: 4)
  53769. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53770. */
  53771. lockstepMaxSteps: number;
  53772. /**
  53773. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  53774. */
  53775. useHighPrecisionMatrix?: boolean;
  53776. }
  53777. /**
  53778. * The null engine class provides support for headless version of babylon.js.
  53779. * This can be used in server side scenario or for testing purposes
  53780. */
  53781. export class NullEngine extends Engine {
  53782. private _options;
  53783. /**
  53784. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  53785. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53786. * @returns true if engine is in deterministic lock step mode
  53787. */
  53788. isDeterministicLockStep(): boolean;
  53789. /**
  53790. * Gets the max steps when engine is running in deterministic lock step
  53791. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53792. * @returns the max steps
  53793. */
  53794. getLockstepMaxSteps(): number;
  53795. /**
  53796. * Gets the current hardware scaling level.
  53797. * By default the hardware scaling level is computed from the window device ratio.
  53798. * 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.
  53799. * @returns a number indicating the current hardware scaling level
  53800. */
  53801. getHardwareScalingLevel(): number;
  53802. constructor(options?: NullEngineOptions);
  53803. /**
  53804. * Creates a vertex buffer
  53805. * @param vertices the data for the vertex buffer
  53806. * @returns the new WebGL static buffer
  53807. */
  53808. createVertexBuffer(vertices: FloatArray): DataBuffer;
  53809. /**
  53810. * Creates a new index buffer
  53811. * @param indices defines the content of the index buffer
  53812. * @param updatable defines if the index buffer must be updatable
  53813. * @returns a new webGL buffer
  53814. */
  53815. createIndexBuffer(indices: IndicesArray): DataBuffer;
  53816. /**
  53817. * Clear the current render buffer or the current render target (if any is set up)
  53818. * @param color defines the color to use
  53819. * @param backBuffer defines if the back buffer must be cleared
  53820. * @param depth defines if the depth buffer must be cleared
  53821. * @param stencil defines if the stencil buffer must be cleared
  53822. */
  53823. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  53824. /**
  53825. * Gets the current render width
  53826. * @param useScreen defines if screen size must be used (or the current render target if any)
  53827. * @returns a number defining the current render width
  53828. */
  53829. getRenderWidth(useScreen?: boolean): number;
  53830. /**
  53831. * Gets the current render height
  53832. * @param useScreen defines if screen size must be used (or the current render target if any)
  53833. * @returns a number defining the current render height
  53834. */
  53835. getRenderHeight(useScreen?: boolean): number;
  53836. /**
  53837. * Set the WebGL's viewport
  53838. * @param viewport defines the viewport element to be used
  53839. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  53840. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  53841. */
  53842. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  53843. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  53844. /**
  53845. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  53846. * @param pipelineContext defines the pipeline context to use
  53847. * @param uniformsNames defines the list of uniform names
  53848. * @returns an array of webGL uniform locations
  53849. */
  53850. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  53851. /**
  53852. * Gets the lsit of active attributes for a given webGL program
  53853. * @param pipelineContext defines the pipeline context to use
  53854. * @param attributesNames defines the list of attribute names to get
  53855. * @returns an array of indices indicating the offset of each attribute
  53856. */
  53857. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  53858. /**
  53859. * Binds an effect to the webGL context
  53860. * @param effect defines the effect to bind
  53861. */
  53862. bindSamplers(effect: Effect): void;
  53863. /**
  53864. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  53865. * @param effect defines the effect to activate
  53866. */
  53867. enableEffect(effect: Effect): void;
  53868. /**
  53869. * Set various states to the webGL context
  53870. * @param culling defines backface culling state
  53871. * @param zOffset defines the value to apply to zOffset (0 by default)
  53872. * @param force defines if states must be applied even if cache is up to date
  53873. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  53874. */
  53875. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  53876. /**
  53877. * Set the value of an uniform to an array of int32
  53878. * @param uniform defines the webGL uniform location where to store the value
  53879. * @param array defines the array of int32 to store
  53880. */
  53881. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  53882. /**
  53883. * Set the value of an uniform to an array of int32 (stored as vec2)
  53884. * @param uniform defines the webGL uniform location where to store the value
  53885. * @param array defines the array of int32 to store
  53886. */
  53887. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  53888. /**
  53889. * Set the value of an uniform to an array of int32 (stored as vec3)
  53890. * @param uniform defines the webGL uniform location where to store the value
  53891. * @param array defines the array of int32 to store
  53892. */
  53893. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  53894. /**
  53895. * Set the value of an uniform to an array of int32 (stored as vec4)
  53896. * @param uniform defines the webGL uniform location where to store the value
  53897. * @param array defines the array of int32 to store
  53898. */
  53899. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  53900. /**
  53901. * Set the value of an uniform to an array of float32
  53902. * @param uniform defines the webGL uniform location where to store the value
  53903. * @param array defines the array of float32 to store
  53904. */
  53905. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  53906. /**
  53907. * Set the value of an uniform to an array of float32 (stored as vec2)
  53908. * @param uniform defines the webGL uniform location where to store the value
  53909. * @param array defines the array of float32 to store
  53910. */
  53911. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  53912. /**
  53913. * Set the value of an uniform to an array of float32 (stored as vec3)
  53914. * @param uniform defines the webGL uniform location where to store the value
  53915. * @param array defines the array of float32 to store
  53916. */
  53917. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  53918. /**
  53919. * Set the value of an uniform to an array of float32 (stored as vec4)
  53920. * @param uniform defines the webGL uniform location where to store the value
  53921. * @param array defines the array of float32 to store
  53922. */
  53923. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  53924. /**
  53925. * Set the value of an uniform to an array of number
  53926. * @param uniform defines the webGL uniform location where to store the value
  53927. * @param array defines the array of number to store
  53928. */
  53929. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  53930. /**
  53931. * Set the value of an uniform to an array of number (stored as vec2)
  53932. * @param uniform defines the webGL uniform location where to store the value
  53933. * @param array defines the array of number to store
  53934. */
  53935. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  53936. /**
  53937. * Set the value of an uniform to an array of number (stored as vec3)
  53938. * @param uniform defines the webGL uniform location where to store the value
  53939. * @param array defines the array of number to store
  53940. */
  53941. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  53942. /**
  53943. * Set the value of an uniform to an array of number (stored as vec4)
  53944. * @param uniform defines the webGL uniform location where to store the value
  53945. * @param array defines the array of number to store
  53946. */
  53947. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  53948. /**
  53949. * Set the value of an uniform to an array of float32 (stored as matrices)
  53950. * @param uniform defines the webGL uniform location where to store the value
  53951. * @param matrices defines the array of float32 to store
  53952. */
  53953. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  53954. /**
  53955. * Set the value of an uniform to a matrix (3x3)
  53956. * @param uniform defines the webGL uniform location where to store the value
  53957. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  53958. */
  53959. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53960. /**
  53961. * Set the value of an uniform to a matrix (2x2)
  53962. * @param uniform defines the webGL uniform location where to store the value
  53963. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  53964. */
  53965. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53966. /**
  53967. * Set the value of an uniform to a number (float)
  53968. * @param uniform defines the webGL uniform location where to store the value
  53969. * @param value defines the float number to store
  53970. */
  53971. setFloat(uniform: WebGLUniformLocation, value: number): void;
  53972. /**
  53973. * Set the value of an uniform to a vec2
  53974. * @param uniform defines the webGL uniform location where to store the value
  53975. * @param x defines the 1st component of the value
  53976. * @param y defines the 2nd component of the value
  53977. */
  53978. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  53979. /**
  53980. * Set the value of an uniform to a vec3
  53981. * @param uniform defines the webGL uniform location where to store the value
  53982. * @param x defines the 1st component of the value
  53983. * @param y defines the 2nd component of the value
  53984. * @param z defines the 3rd component of the value
  53985. */
  53986. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  53987. /**
  53988. * Set the value of an uniform to a boolean
  53989. * @param uniform defines the webGL uniform location where to store the value
  53990. * @param bool defines the boolean to store
  53991. */
  53992. setBool(uniform: WebGLUniformLocation, bool: number): void;
  53993. /**
  53994. * Set the value of an uniform to a vec4
  53995. * @param uniform defines the webGL uniform location where to store the value
  53996. * @param x defines the 1st component of the value
  53997. * @param y defines the 2nd component of the value
  53998. * @param z defines the 3rd component of the value
  53999. * @param w defines the 4th component of the value
  54000. */
  54001. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54002. /**
  54003. * Sets the current alpha mode
  54004. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  54005. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54006. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54007. */
  54008. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54009. /**
  54010. * Bind webGl buffers directly to the webGL context
  54011. * @param vertexBuffers defines the vertex buffer to bind
  54012. * @param indexBuffer defines the index buffer to bind
  54013. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  54014. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  54015. * @param effect defines the effect associated with the vertex buffer
  54016. */
  54017. bindBuffers(vertexBuffers: {
  54018. [key: string]: VertexBuffer;
  54019. }, indexBuffer: DataBuffer, effect: Effect): void;
  54020. /**
  54021. * Force the entire cache to be cleared
  54022. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  54023. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  54024. */
  54025. wipeCaches(bruteForce?: boolean): void;
  54026. /**
  54027. * Send a draw order
  54028. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  54029. * @param indexStart defines the starting index
  54030. * @param indexCount defines the number of index to draw
  54031. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54032. */
  54033. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  54034. /**
  54035. * Draw a list of indexed primitives
  54036. * @param fillMode defines the primitive to use
  54037. * @param indexStart defines the starting index
  54038. * @param indexCount defines the number of index to draw
  54039. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54040. */
  54041. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54042. /**
  54043. * Draw a list of unindexed primitives
  54044. * @param fillMode defines the primitive to use
  54045. * @param verticesStart defines the index of first vertex to draw
  54046. * @param verticesCount defines the count of vertices to draw
  54047. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54048. */
  54049. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54050. /** @hidden */
  54051. _createTexture(): WebGLTexture;
  54052. /** @hidden */
  54053. _releaseTexture(texture: InternalTexture): void;
  54054. /**
  54055. * Usually called from Texture.ts.
  54056. * Passed information to create a WebGLTexture
  54057. * @param urlArg defines a value which contains one of the following:
  54058. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54059. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54060. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54061. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54062. * @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)
  54063. * @param scene needed for loading to the correct scene
  54064. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54065. * @param onLoad optional callback to be called upon successful completion
  54066. * @param onError optional callback to be called upon failure
  54067. * @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
  54068. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54069. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54070. * @param forcedExtension defines the extension to use to pick the right loader
  54071. * @param mimeType defines an optional mime type
  54072. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54073. */
  54074. 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;
  54075. /**
  54076. * Creates a new render target texture
  54077. * @param size defines the size of the texture
  54078. * @param options defines the options used to create the texture
  54079. * @returns a new render target texture stored in an InternalTexture
  54080. */
  54081. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  54082. /**
  54083. * Update the sampling mode of a given texture
  54084. * @param samplingMode defines the required sampling mode
  54085. * @param texture defines the texture to update
  54086. */
  54087. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54088. /**
  54089. * Binds the frame buffer to the specified texture.
  54090. * @param texture The texture to render to or null for the default canvas
  54091. * @param faceIndex The face of the texture to render to in case of cube texture
  54092. * @param requiredWidth The width of the target to render to
  54093. * @param requiredHeight The height of the target to render to
  54094. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  54095. * @param lodLevel defines le lod level to bind to the frame buffer
  54096. */
  54097. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54098. /**
  54099. * Unbind the current render target texture from the webGL context
  54100. * @param texture defines the render target texture to unbind
  54101. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  54102. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  54103. */
  54104. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54105. /**
  54106. * Creates a dynamic vertex buffer
  54107. * @param vertices the data for the dynamic vertex buffer
  54108. * @returns the new WebGL dynamic buffer
  54109. */
  54110. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  54111. /**
  54112. * Update the content of a dynamic texture
  54113. * @param texture defines the texture to update
  54114. * @param canvas defines the canvas containing the source
  54115. * @param invertY defines if data must be stored with Y axis inverted
  54116. * @param premulAlpha defines if alpha is stored as premultiplied
  54117. * @param format defines the format of the data
  54118. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  54119. */
  54120. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  54121. /**
  54122. * Gets a boolean indicating if all created effects are ready
  54123. * @returns true if all effects are ready
  54124. */
  54125. areAllEffectsReady(): boolean;
  54126. /**
  54127. * @hidden
  54128. * Get the current error code of the webGL context
  54129. * @returns the error code
  54130. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  54131. */
  54132. getError(): number;
  54133. /** @hidden */
  54134. _getUnpackAlignement(): number;
  54135. /** @hidden */
  54136. _unpackFlipY(value: boolean): void;
  54137. /**
  54138. * Update a dynamic index buffer
  54139. * @param indexBuffer defines the target index buffer
  54140. * @param indices defines the data to update
  54141. * @param offset defines the offset in the target index buffer where update should start
  54142. */
  54143. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  54144. /**
  54145. * Updates a dynamic vertex buffer.
  54146. * @param vertexBuffer the vertex buffer to update
  54147. * @param vertices the data used to update the vertex buffer
  54148. * @param byteOffset the byte offset of the data (optional)
  54149. * @param byteLength the byte length of the data (optional)
  54150. */
  54151. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  54152. /** @hidden */
  54153. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  54154. /** @hidden */
  54155. _bindTexture(channel: number, texture: InternalTexture): void;
  54156. protected _deleteBuffer(buffer: WebGLBuffer): void;
  54157. /**
  54158. * 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
  54159. */
  54160. releaseEffects(): void;
  54161. displayLoadingUI(): void;
  54162. hideLoadingUI(): void;
  54163. /** @hidden */
  54164. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54165. /** @hidden */
  54166. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54167. /** @hidden */
  54168. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54169. /** @hidden */
  54170. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54171. }
  54172. }
  54173. declare module "babylonjs/Instrumentation/timeToken" {
  54174. import { Nullable } from "babylonjs/types";
  54175. /**
  54176. * @hidden
  54177. **/
  54178. export class _TimeToken {
  54179. _startTimeQuery: Nullable<WebGLQuery>;
  54180. _endTimeQuery: Nullable<WebGLQuery>;
  54181. _timeElapsedQuery: Nullable<WebGLQuery>;
  54182. _timeElapsedQueryEnded: boolean;
  54183. }
  54184. }
  54185. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  54186. import { Nullable, int } from "babylonjs/types";
  54187. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  54188. /** @hidden */
  54189. export class _OcclusionDataStorage {
  54190. /** @hidden */
  54191. occlusionInternalRetryCounter: number;
  54192. /** @hidden */
  54193. isOcclusionQueryInProgress: boolean;
  54194. /** @hidden */
  54195. isOccluded: boolean;
  54196. /** @hidden */
  54197. occlusionRetryCount: number;
  54198. /** @hidden */
  54199. occlusionType: number;
  54200. /** @hidden */
  54201. occlusionQueryAlgorithmType: number;
  54202. }
  54203. module "babylonjs/Engines/engine" {
  54204. interface Engine {
  54205. /**
  54206. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  54207. * @return the new query
  54208. */
  54209. createQuery(): WebGLQuery;
  54210. /**
  54211. * Delete and release a webGL query
  54212. * @param query defines the query to delete
  54213. * @return the current engine
  54214. */
  54215. deleteQuery(query: WebGLQuery): Engine;
  54216. /**
  54217. * Check if a given query has resolved and got its value
  54218. * @param query defines the query to check
  54219. * @returns true if the query got its value
  54220. */
  54221. isQueryResultAvailable(query: WebGLQuery): boolean;
  54222. /**
  54223. * Gets the value of a given query
  54224. * @param query defines the query to check
  54225. * @returns the value of the query
  54226. */
  54227. getQueryResult(query: WebGLQuery): number;
  54228. /**
  54229. * Initiates an occlusion query
  54230. * @param algorithmType defines the algorithm to use
  54231. * @param query defines the query to use
  54232. * @returns the current engine
  54233. * @see https://doc.babylonjs.com/features/occlusionquery
  54234. */
  54235. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  54236. /**
  54237. * Ends an occlusion query
  54238. * @see https://doc.babylonjs.com/features/occlusionquery
  54239. * @param algorithmType defines the algorithm to use
  54240. * @returns the current engine
  54241. */
  54242. endOcclusionQuery(algorithmType: number): Engine;
  54243. /**
  54244. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  54245. * Please note that only one query can be issued at a time
  54246. * @returns a time token used to track the time span
  54247. */
  54248. startTimeQuery(): Nullable<_TimeToken>;
  54249. /**
  54250. * Ends a time query
  54251. * @param token defines the token used to measure the time span
  54252. * @returns the time spent (in ns)
  54253. */
  54254. endTimeQuery(token: _TimeToken): int;
  54255. /** @hidden */
  54256. _currentNonTimestampToken: Nullable<_TimeToken>;
  54257. /** @hidden */
  54258. _createTimeQuery(): WebGLQuery;
  54259. /** @hidden */
  54260. _deleteTimeQuery(query: WebGLQuery): void;
  54261. /** @hidden */
  54262. _getGlAlgorithmType(algorithmType: number): number;
  54263. /** @hidden */
  54264. _getTimeQueryResult(query: WebGLQuery): any;
  54265. /** @hidden */
  54266. _getTimeQueryAvailability(query: WebGLQuery): any;
  54267. }
  54268. }
  54269. module "babylonjs/Meshes/abstractMesh" {
  54270. interface AbstractMesh {
  54271. /**
  54272. * Backing filed
  54273. * @hidden
  54274. */
  54275. __occlusionDataStorage: _OcclusionDataStorage;
  54276. /**
  54277. * Access property
  54278. * @hidden
  54279. */
  54280. _occlusionDataStorage: _OcclusionDataStorage;
  54281. /**
  54282. * 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.
  54283. * The default value is -1 which means don't break the query and wait till the result
  54284. * @see https://doc.babylonjs.com/features/occlusionquery
  54285. */
  54286. occlusionRetryCount: number;
  54287. /**
  54288. * 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:
  54289. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  54290. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  54291. * * 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.
  54292. * @see https://doc.babylonjs.com/features/occlusionquery
  54293. */
  54294. occlusionType: number;
  54295. /**
  54296. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  54297. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  54298. * * 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.
  54299. * @see https://doc.babylonjs.com/features/occlusionquery
  54300. */
  54301. occlusionQueryAlgorithmType: number;
  54302. /**
  54303. * 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
  54304. * @see https://doc.babylonjs.com/features/occlusionquery
  54305. */
  54306. isOccluded: boolean;
  54307. /**
  54308. * Flag to check the progress status of the query
  54309. * @see https://doc.babylonjs.com/features/occlusionquery
  54310. */
  54311. isOcclusionQueryInProgress: boolean;
  54312. }
  54313. }
  54314. }
  54315. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  54316. import { Nullable } from "babylonjs/types";
  54317. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54318. /** @hidden */
  54319. export var _forceTransformFeedbackToBundle: boolean;
  54320. module "babylonjs/Engines/engine" {
  54321. interface Engine {
  54322. /**
  54323. * Creates a webGL transform feedback object
  54324. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  54325. * @returns the webGL transform feedback object
  54326. */
  54327. createTransformFeedback(): WebGLTransformFeedback;
  54328. /**
  54329. * Delete a webGL transform feedback object
  54330. * @param value defines the webGL transform feedback object to delete
  54331. */
  54332. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  54333. /**
  54334. * Bind a webGL transform feedback object to the webgl context
  54335. * @param value defines the webGL transform feedback object to bind
  54336. */
  54337. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  54338. /**
  54339. * Begins a transform feedback operation
  54340. * @param usePoints defines if points or triangles must be used
  54341. */
  54342. beginTransformFeedback(usePoints: boolean): void;
  54343. /**
  54344. * Ends a transform feedback operation
  54345. */
  54346. endTransformFeedback(): void;
  54347. /**
  54348. * Specify the varyings to use with transform feedback
  54349. * @param program defines the associated webGL program
  54350. * @param value defines the list of strings representing the varying names
  54351. */
  54352. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  54353. /**
  54354. * Bind a webGL buffer for a transform feedback operation
  54355. * @param value defines the webGL buffer to bind
  54356. */
  54357. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  54358. }
  54359. }
  54360. }
  54361. declare module "babylonjs/Engines/Extensions/engine.views" {
  54362. import { Camera } from "babylonjs/Cameras/camera";
  54363. import { Nullable } from "babylonjs/types";
  54364. /**
  54365. * Class used to define an additional view for the engine
  54366. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54367. */
  54368. export class EngineView {
  54369. /** Defines the canvas where to render the view */
  54370. target: HTMLCanvasElement;
  54371. /** Defines an optional camera used to render the view (will use active camera else) */
  54372. camera?: Camera;
  54373. }
  54374. module "babylonjs/Engines/engine" {
  54375. interface Engine {
  54376. /**
  54377. * Gets or sets the HTML element to use for attaching events
  54378. */
  54379. inputElement: Nullable<HTMLElement>;
  54380. /**
  54381. * Gets the current engine view
  54382. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54383. */
  54384. activeView: Nullable<EngineView>;
  54385. /** Gets or sets the list of views */
  54386. views: EngineView[];
  54387. /**
  54388. * Register a new child canvas
  54389. * @param canvas defines the canvas to register
  54390. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  54391. * @returns the associated view
  54392. */
  54393. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  54394. /**
  54395. * Remove a registered child canvas
  54396. * @param canvas defines the canvas to remove
  54397. * @returns the current engine
  54398. */
  54399. unRegisterView(canvas: HTMLCanvasElement): Engine;
  54400. }
  54401. }
  54402. }
  54403. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  54404. import { Nullable } from "babylonjs/types";
  54405. module "babylonjs/Engines/engine" {
  54406. interface Engine {
  54407. /** @hidden */
  54408. _excludedCompressedTextures: string[];
  54409. /** @hidden */
  54410. _textureFormatInUse: string;
  54411. /**
  54412. * Gets the list of texture formats supported
  54413. */
  54414. readonly texturesSupported: Array<string>;
  54415. /**
  54416. * Gets the texture format in use
  54417. */
  54418. readonly textureFormatInUse: Nullable<string>;
  54419. /**
  54420. * Set the compressed texture extensions or file names to skip.
  54421. *
  54422. * @param skippedFiles defines the list of those texture files you want to skip
  54423. * Example: [".dds", ".env", "myfile.png"]
  54424. */
  54425. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  54426. /**
  54427. * Set the compressed texture format to use, based on the formats you have, and the formats
  54428. * supported by the hardware / browser.
  54429. *
  54430. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  54431. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  54432. * to API arguments needed to compressed textures. This puts the burden on the container
  54433. * generator to house the arcane code for determining these for current & future formats.
  54434. *
  54435. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  54436. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  54437. *
  54438. * Note: The result of this call is not taken into account when a texture is base64.
  54439. *
  54440. * @param formatsAvailable defines the list of those format families you have created
  54441. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  54442. *
  54443. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  54444. * @returns The extension selected.
  54445. */
  54446. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  54447. }
  54448. }
  54449. }
  54450. declare module "babylonjs/Engines/Extensions/index" {
  54451. export * from "babylonjs/Engines/Extensions/engine.alpha";
  54452. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  54453. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  54454. export * from "babylonjs/Engines/Extensions/engine.multiview";
  54455. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  54456. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  54457. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  54458. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  54459. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  54460. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  54461. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54462. export * from "babylonjs/Engines/Extensions/engine.webVR";
  54463. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  54464. export * from "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  54465. export * from "babylonjs/Engines/Extensions/engine.views";
  54466. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  54467. import "babylonjs/Engines/Extensions/engine.textureSelector";
  54468. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  54469. }
  54470. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  54471. import { Nullable } from "babylonjs/types";
  54472. /**
  54473. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  54474. */
  54475. export interface CubeMapInfo {
  54476. /**
  54477. * The pixel array for the front face.
  54478. * This is stored in format, left to right, up to down format.
  54479. */
  54480. front: Nullable<ArrayBufferView>;
  54481. /**
  54482. * The pixel array for the back face.
  54483. * This is stored in format, left to right, up to down format.
  54484. */
  54485. back: Nullable<ArrayBufferView>;
  54486. /**
  54487. * The pixel array for the left face.
  54488. * This is stored in format, left to right, up to down format.
  54489. */
  54490. left: Nullable<ArrayBufferView>;
  54491. /**
  54492. * The pixel array for the right face.
  54493. * This is stored in format, left to right, up to down format.
  54494. */
  54495. right: Nullable<ArrayBufferView>;
  54496. /**
  54497. * The pixel array for the up face.
  54498. * This is stored in format, left to right, up to down format.
  54499. */
  54500. up: Nullable<ArrayBufferView>;
  54501. /**
  54502. * The pixel array for the down face.
  54503. * This is stored in format, left to right, up to down format.
  54504. */
  54505. down: Nullable<ArrayBufferView>;
  54506. /**
  54507. * The size of the cubemap stored.
  54508. *
  54509. * Each faces will be size * size pixels.
  54510. */
  54511. size: number;
  54512. /**
  54513. * The format of the texture.
  54514. *
  54515. * RGBA, RGB.
  54516. */
  54517. format: number;
  54518. /**
  54519. * The type of the texture data.
  54520. *
  54521. * UNSIGNED_INT, FLOAT.
  54522. */
  54523. type: number;
  54524. /**
  54525. * Specifies whether the texture is in gamma space.
  54526. */
  54527. gammaSpace: boolean;
  54528. }
  54529. /**
  54530. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  54531. */
  54532. export class PanoramaToCubeMapTools {
  54533. private static FACE_LEFT;
  54534. private static FACE_RIGHT;
  54535. private static FACE_FRONT;
  54536. private static FACE_BACK;
  54537. private static FACE_DOWN;
  54538. private static FACE_UP;
  54539. /**
  54540. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  54541. *
  54542. * @param float32Array The source data.
  54543. * @param inputWidth The width of the input panorama.
  54544. * @param inputHeight The height of the input panorama.
  54545. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  54546. * @return The cubemap data
  54547. */
  54548. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  54549. private static CreateCubemapTexture;
  54550. private static CalcProjectionSpherical;
  54551. }
  54552. }
  54553. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  54554. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54555. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54556. import { Nullable } from "babylonjs/types";
  54557. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  54558. /**
  54559. * Helper class dealing with the extraction of spherical polynomial dataArray
  54560. * from a cube map.
  54561. */
  54562. export class CubeMapToSphericalPolynomialTools {
  54563. private static FileFaces;
  54564. /**
  54565. * Converts a texture to the according Spherical Polynomial data.
  54566. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54567. *
  54568. * @param texture The texture to extract the information from.
  54569. * @return The Spherical Polynomial data.
  54570. */
  54571. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  54572. /**
  54573. * Converts a cubemap to the according Spherical Polynomial data.
  54574. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54575. *
  54576. * @param cubeInfo The Cube map to extract the information from.
  54577. * @return The Spherical Polynomial data.
  54578. */
  54579. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  54580. }
  54581. }
  54582. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  54583. import { Nullable } from "babylonjs/types";
  54584. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54585. module "babylonjs/Materials/Textures/baseTexture" {
  54586. interface BaseTexture {
  54587. /**
  54588. * Get the polynomial representation of the texture data.
  54589. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  54590. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  54591. */
  54592. sphericalPolynomial: Nullable<SphericalPolynomial>;
  54593. }
  54594. }
  54595. }
  54596. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  54597. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54598. /** @hidden */
  54599. export var rgbdEncodePixelShader: {
  54600. name: string;
  54601. shader: string;
  54602. };
  54603. }
  54604. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  54605. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54606. /** @hidden */
  54607. export var rgbdDecodePixelShader: {
  54608. name: string;
  54609. shader: string;
  54610. };
  54611. }
  54612. declare module "babylonjs/Misc/environmentTextureTools" {
  54613. import { Nullable } from "babylonjs/types";
  54614. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54615. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54616. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54617. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54618. import "babylonjs/Engines/Extensions/engine.readTexture";
  54619. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54620. import "babylonjs/Shaders/rgbdEncode.fragment";
  54621. import "babylonjs/Shaders/rgbdDecode.fragment";
  54622. /**
  54623. * Raw texture data and descriptor sufficient for WebGL texture upload
  54624. */
  54625. export interface EnvironmentTextureInfo {
  54626. /**
  54627. * Version of the environment map
  54628. */
  54629. version: number;
  54630. /**
  54631. * Width of image
  54632. */
  54633. width: number;
  54634. /**
  54635. * Irradiance information stored in the file.
  54636. */
  54637. irradiance: any;
  54638. /**
  54639. * Specular information stored in the file.
  54640. */
  54641. specular: any;
  54642. }
  54643. /**
  54644. * Defines One Image in the file. It requires only the position in the file
  54645. * as well as the length.
  54646. */
  54647. interface BufferImageData {
  54648. /**
  54649. * Length of the image data.
  54650. */
  54651. length: number;
  54652. /**
  54653. * Position of the data from the null terminator delimiting the end of the JSON.
  54654. */
  54655. position: number;
  54656. }
  54657. /**
  54658. * Defines the specular data enclosed in the file.
  54659. * This corresponds to the version 1 of the data.
  54660. */
  54661. export interface EnvironmentTextureSpecularInfoV1 {
  54662. /**
  54663. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54664. */
  54665. specularDataPosition?: number;
  54666. /**
  54667. * This contains all the images data needed to reconstruct the cubemap.
  54668. */
  54669. mipmaps: Array<BufferImageData>;
  54670. /**
  54671. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54672. */
  54673. lodGenerationScale: number;
  54674. }
  54675. /**
  54676. * Sets of helpers addressing the serialization and deserialization of environment texture
  54677. * stored in a BabylonJS env file.
  54678. * Those files are usually stored as .env files.
  54679. */
  54680. export class EnvironmentTextureTools {
  54681. /**
  54682. * Magic number identifying the env file.
  54683. */
  54684. private static _MagicBytes;
  54685. /**
  54686. * Gets the environment info from an env file.
  54687. * @param data The array buffer containing the .env bytes.
  54688. * @returns the environment file info (the json header) if successfully parsed.
  54689. */
  54690. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54691. /**
  54692. * Creates an environment texture from a loaded cube texture.
  54693. * @param texture defines the cube texture to convert in env file
  54694. * @return a promise containing the environment data if succesfull.
  54695. */
  54696. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54697. /**
  54698. * Creates a JSON representation of the spherical data.
  54699. * @param texture defines the texture containing the polynomials
  54700. * @return the JSON representation of the spherical info
  54701. */
  54702. private static _CreateEnvTextureIrradiance;
  54703. /**
  54704. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54705. * @param data the image data
  54706. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54707. * @return the views described by info providing access to the underlying buffer
  54708. */
  54709. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54710. /**
  54711. * Uploads the texture info contained in the env file to the GPU.
  54712. * @param texture defines the internal texture to upload to
  54713. * @param data defines the data to load
  54714. * @param info defines the texture info retrieved through the GetEnvInfo method
  54715. * @returns a promise
  54716. */
  54717. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54718. private static _OnImageReadyAsync;
  54719. /**
  54720. * Uploads the levels of image data to the GPU.
  54721. * @param texture defines the internal texture to upload to
  54722. * @param imageData defines the array buffer views of image data [mipmap][face]
  54723. * @returns a promise
  54724. */
  54725. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54726. /**
  54727. * Uploads spherical polynomials information to the texture.
  54728. * @param texture defines the texture we are trying to upload the information to
  54729. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54730. */
  54731. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54732. /** @hidden */
  54733. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54734. }
  54735. }
  54736. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54737. /**
  54738. * Class used to inline functions in shader code
  54739. */
  54740. export class ShaderCodeInliner {
  54741. private static readonly _RegexpFindFunctionNameAndType;
  54742. private _sourceCode;
  54743. private _functionDescr;
  54744. private _numMaxIterations;
  54745. /** Gets or sets the token used to mark the functions to inline */
  54746. inlineToken: string;
  54747. /** Gets or sets the debug mode */
  54748. debug: boolean;
  54749. /** Gets the code after the inlining process */
  54750. get code(): string;
  54751. /**
  54752. * Initializes the inliner
  54753. * @param sourceCode shader code source to inline
  54754. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  54755. */
  54756. constructor(sourceCode: string, numMaxIterations?: number);
  54757. /**
  54758. * Start the processing of the shader code
  54759. */
  54760. processCode(): void;
  54761. private _collectFunctions;
  54762. private _processInlining;
  54763. private _extractBetweenMarkers;
  54764. private _skipWhitespaces;
  54765. private _removeComments;
  54766. private _replaceFunctionCallsByCode;
  54767. private _findBackward;
  54768. private _escapeRegExp;
  54769. private _replaceNames;
  54770. }
  54771. }
  54772. declare module "babylonjs/Engines/nativeEngine" {
  54773. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  54774. import { Engine } from "babylonjs/Engines/engine";
  54775. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  54776. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54777. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54778. import { Effect } from "babylonjs/Materials/effect";
  54779. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54780. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  54781. import { IColor4Like } from "babylonjs/Maths/math.like";
  54782. import { Scene } from "babylonjs/scene";
  54783. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  54784. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  54785. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  54786. /**
  54787. * Container for accessors for natively-stored mesh data buffers.
  54788. */
  54789. class NativeDataBuffer extends DataBuffer {
  54790. /**
  54791. * Accessor value used to identify/retrieve a natively-stored index buffer.
  54792. */
  54793. nativeIndexBuffer?: any;
  54794. /**
  54795. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  54796. */
  54797. nativeVertexBuffer?: any;
  54798. }
  54799. /** @hidden */
  54800. class NativeTexture extends InternalTexture {
  54801. getInternalTexture(): InternalTexture;
  54802. getViewCount(): number;
  54803. }
  54804. /** @hidden */
  54805. export class NativeEngine extends Engine {
  54806. private readonly _native;
  54807. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  54808. private readonly INVALID_HANDLE;
  54809. private _boundBuffersVertexArray;
  54810. getHardwareScalingLevel(): number;
  54811. constructor();
  54812. dispose(): void;
  54813. /**
  54814. * Can be used to override the current requestAnimationFrame requester.
  54815. * @hidden
  54816. */
  54817. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  54818. /**
  54819. * Override default engine behavior.
  54820. * @param color
  54821. * @param backBuffer
  54822. * @param depth
  54823. * @param stencil
  54824. */
  54825. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  54826. /**
  54827. * Gets host document
  54828. * @returns the host document object
  54829. */
  54830. getHostDocument(): Nullable<Document>;
  54831. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54832. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  54833. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  54834. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  54835. [key: string]: VertexBuffer;
  54836. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54837. bindBuffers(vertexBuffers: {
  54838. [key: string]: VertexBuffer;
  54839. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54840. recordVertexArrayObject(vertexBuffers: {
  54841. [key: string]: VertexBuffer;
  54842. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  54843. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54844. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54845. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54846. /**
  54847. * Draw a list of indexed primitives
  54848. * @param fillMode defines the primitive to use
  54849. * @param indexStart defines the starting index
  54850. * @param indexCount defines the number of index to draw
  54851. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54852. */
  54853. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54854. /**
  54855. * Draw a list of unindexed primitives
  54856. * @param fillMode defines the primitive to use
  54857. * @param verticesStart defines the index of first vertex to draw
  54858. * @param verticesCount defines the count of vertices to draw
  54859. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54860. */
  54861. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54862. createPipelineContext(): IPipelineContext;
  54863. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  54864. /** @hidden */
  54865. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  54866. /** @hidden */
  54867. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  54868. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54869. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54870. protected _setProgram(program: WebGLProgram): void;
  54871. _releaseEffect(effect: Effect): void;
  54872. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  54873. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  54874. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  54875. bindSamplers(effect: Effect): void;
  54876. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  54877. getRenderWidth(useScreen?: boolean): number;
  54878. getRenderHeight(useScreen?: boolean): number;
  54879. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  54880. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54881. /**
  54882. * Set the z offset to apply to current rendering
  54883. * @param value defines the offset to apply
  54884. */
  54885. setZOffset(value: number): void;
  54886. /**
  54887. * Gets the current value of the zOffset
  54888. * @returns the current zOffset state
  54889. */
  54890. getZOffset(): number;
  54891. /**
  54892. * Enable or disable depth buffering
  54893. * @param enable defines the state to set
  54894. */
  54895. setDepthBuffer(enable: boolean): void;
  54896. /**
  54897. * Gets a boolean indicating if depth writing is enabled
  54898. * @returns the current depth writing state
  54899. */
  54900. getDepthWrite(): boolean;
  54901. /**
  54902. * Enable or disable depth writing
  54903. * @param enable defines the state to set
  54904. */
  54905. setDepthWrite(enable: boolean): void;
  54906. /**
  54907. * Enable or disable color writing
  54908. * @param enable defines the state to set
  54909. */
  54910. setColorWrite(enable: boolean): void;
  54911. /**
  54912. * Gets a boolean indicating if color writing is enabled
  54913. * @returns the current color writing state
  54914. */
  54915. getColorWrite(): boolean;
  54916. /**
  54917. * Sets alpha constants used by some alpha blending modes
  54918. * @param r defines the red component
  54919. * @param g defines the green component
  54920. * @param b defines the blue component
  54921. * @param a defines the alpha component
  54922. */
  54923. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  54924. /**
  54925. * Sets the current alpha mode
  54926. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  54927. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54928. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54929. */
  54930. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54931. /**
  54932. * Gets the current alpha mode
  54933. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54934. * @returns the current alpha mode
  54935. */
  54936. getAlphaMode(): number;
  54937. setInt(uniform: WebGLUniformLocation, int: number): void;
  54938. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  54939. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  54940. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  54941. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  54942. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  54943. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  54944. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  54945. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  54946. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  54947. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  54948. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  54949. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  54950. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  54951. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54952. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54953. setFloat(uniform: WebGLUniformLocation, value: number): void;
  54954. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  54955. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  54956. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54957. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  54958. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  54959. wipeCaches(bruteForce?: boolean): void;
  54960. _createTexture(): WebGLTexture;
  54961. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  54962. /**
  54963. * Usually called from Texture.ts.
  54964. * Passed information to create a WebGLTexture
  54965. * @param url defines a value which contains one of the following:
  54966. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54967. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54968. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54969. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54970. * @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)
  54971. * @param scene needed for loading to the correct scene
  54972. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54973. * @param onLoad optional callback to be called upon successful completion
  54974. * @param onError optional callback to be called upon failure
  54975. * @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
  54976. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54977. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54978. * @param forcedExtension defines the extension to use to pick the right loader
  54979. * @param mimeType defines an optional mime type
  54980. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54981. */
  54982. 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;
  54983. /**
  54984. * Creates a cube texture
  54985. * @param rootUrl defines the url where the files to load is located
  54986. * @param scene defines the current scene
  54987. * @param files defines the list of files to load (1 per face)
  54988. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  54989. * @param onLoad defines an optional callback raised when the texture is loaded
  54990. * @param onError defines an optional callback raised if there is an issue to load the texture
  54991. * @param format defines the format of the data
  54992. * @param forcedExtension defines the extension to use to pick the right loader
  54993. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  54994. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  54995. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  54996. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  54997. * @returns the cube texture as an InternalTexture
  54998. */
  54999. 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;
  55000. private _getSamplingFilter;
  55001. private static _GetNativeTextureFormat;
  55002. createRenderTargetTexture(size: number | {
  55003. width: number;
  55004. height: number;
  55005. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  55006. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  55007. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  55008. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  55009. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  55010. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  55011. /**
  55012. * Updates a dynamic vertex buffer.
  55013. * @param vertexBuffer the vertex buffer to update
  55014. * @param data the data used to update the vertex buffer
  55015. * @param byteOffset the byte offset of the data (optional)
  55016. * @param byteLength the byte length of the data (optional)
  55017. */
  55018. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  55019. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  55020. private _updateAnisotropicLevel;
  55021. private _getAddressMode;
  55022. /** @hidden */
  55023. _bindTexture(channel: number, texture: InternalTexture): void;
  55024. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  55025. releaseEffects(): void;
  55026. /** @hidden */
  55027. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55028. /** @hidden */
  55029. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55030. /** @hidden */
  55031. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55032. /** @hidden */
  55033. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  55034. }
  55035. }
  55036. declare module "babylonjs/Engines/index" {
  55037. export * from "babylonjs/Engines/constants";
  55038. export * from "babylonjs/Engines/engineCapabilities";
  55039. export * from "babylonjs/Engines/instancingAttributeInfo";
  55040. export * from "babylonjs/Engines/thinEngine";
  55041. export * from "babylonjs/Engines/engine";
  55042. export * from "babylonjs/Engines/engineStore";
  55043. export * from "babylonjs/Engines/nullEngine";
  55044. export * from "babylonjs/Engines/Extensions/index";
  55045. export * from "babylonjs/Engines/IPipelineContext";
  55046. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  55047. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  55048. export * from "babylonjs/Engines/nativeEngine";
  55049. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  55050. export * from "babylonjs/Engines/performanceConfigurator";
  55051. }
  55052. declare module "babylonjs/Events/clipboardEvents" {
  55053. /**
  55054. * Gather the list of clipboard event types as constants.
  55055. */
  55056. export class ClipboardEventTypes {
  55057. /**
  55058. * The clipboard event is fired when a copy command is active (pressed).
  55059. */
  55060. static readonly COPY: number;
  55061. /**
  55062. * The clipboard event is fired when a cut command is active (pressed).
  55063. */
  55064. static readonly CUT: number;
  55065. /**
  55066. * The clipboard event is fired when a paste command is active (pressed).
  55067. */
  55068. static readonly PASTE: number;
  55069. }
  55070. /**
  55071. * This class is used to store clipboard related info for the onClipboardObservable event.
  55072. */
  55073. export class ClipboardInfo {
  55074. /**
  55075. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55076. */
  55077. type: number;
  55078. /**
  55079. * Defines the related dom event
  55080. */
  55081. event: ClipboardEvent;
  55082. /**
  55083. *Creates an instance of ClipboardInfo.
  55084. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  55085. * @param event Defines the related dom event
  55086. */
  55087. constructor(
  55088. /**
  55089. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55090. */
  55091. type: number,
  55092. /**
  55093. * Defines the related dom event
  55094. */
  55095. event: ClipboardEvent);
  55096. /**
  55097. * Get the clipboard event's type from the keycode.
  55098. * @param keyCode Defines the keyCode for the current keyboard event.
  55099. * @return {number}
  55100. */
  55101. static GetTypeFromCharacter(keyCode: number): number;
  55102. }
  55103. }
  55104. declare module "babylonjs/Events/index" {
  55105. export * from "babylonjs/Events/keyboardEvents";
  55106. export * from "babylonjs/Events/pointerEvents";
  55107. export * from "babylonjs/Events/clipboardEvents";
  55108. }
  55109. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  55110. import { Scene } from "babylonjs/scene";
  55111. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55112. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55113. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55114. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55115. /**
  55116. * Google Daydream controller
  55117. */
  55118. export class DaydreamController extends WebVRController {
  55119. /**
  55120. * Base Url for the controller model.
  55121. */
  55122. static MODEL_BASE_URL: string;
  55123. /**
  55124. * File name for the controller model.
  55125. */
  55126. static MODEL_FILENAME: string;
  55127. /**
  55128. * Gamepad Id prefix used to identify Daydream Controller.
  55129. */
  55130. static readonly GAMEPAD_ID_PREFIX: string;
  55131. /**
  55132. * Creates a new DaydreamController from a gamepad
  55133. * @param vrGamepad the gamepad that the controller should be created from
  55134. */
  55135. constructor(vrGamepad: any);
  55136. /**
  55137. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55138. * @param scene scene in which to add meshes
  55139. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55140. */
  55141. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55142. /**
  55143. * Called once for each button that changed state since the last frame
  55144. * @param buttonIdx Which button index changed
  55145. * @param state New state of the button
  55146. * @param changes Which properties on the state changed since last frame
  55147. */
  55148. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55149. }
  55150. }
  55151. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  55152. import { Scene } from "babylonjs/scene";
  55153. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55154. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55155. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55156. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55157. /**
  55158. * Gear VR Controller
  55159. */
  55160. export class GearVRController extends WebVRController {
  55161. /**
  55162. * Base Url for the controller model.
  55163. */
  55164. static MODEL_BASE_URL: string;
  55165. /**
  55166. * File name for the controller model.
  55167. */
  55168. static MODEL_FILENAME: string;
  55169. /**
  55170. * Gamepad Id prefix used to identify this controller.
  55171. */
  55172. static readonly GAMEPAD_ID_PREFIX: string;
  55173. private readonly _buttonIndexToObservableNameMap;
  55174. /**
  55175. * Creates a new GearVRController from a gamepad
  55176. * @param vrGamepad the gamepad that the controller should be created from
  55177. */
  55178. constructor(vrGamepad: any);
  55179. /**
  55180. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55181. * @param scene scene in which to add meshes
  55182. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55183. */
  55184. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55185. /**
  55186. * Called once for each button that changed state since the last frame
  55187. * @param buttonIdx Which button index changed
  55188. * @param state New state of the button
  55189. * @param changes Which properties on the state changed since last frame
  55190. */
  55191. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55192. }
  55193. }
  55194. declare module "babylonjs/Gamepads/Controllers/genericController" {
  55195. import { Scene } from "babylonjs/scene";
  55196. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55197. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55198. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55199. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55200. /**
  55201. * Generic Controller
  55202. */
  55203. export class GenericController extends WebVRController {
  55204. /**
  55205. * Base Url for the controller model.
  55206. */
  55207. static readonly MODEL_BASE_URL: string;
  55208. /**
  55209. * File name for the controller model.
  55210. */
  55211. static readonly MODEL_FILENAME: string;
  55212. /**
  55213. * Creates a new GenericController from a gamepad
  55214. * @param vrGamepad the gamepad that the controller should be created from
  55215. */
  55216. constructor(vrGamepad: any);
  55217. /**
  55218. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55219. * @param scene scene in which to add meshes
  55220. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55221. */
  55222. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55223. /**
  55224. * Called once for each button that changed state since the last frame
  55225. * @param buttonIdx Which button index changed
  55226. * @param state New state of the button
  55227. * @param changes Which properties on the state changed since last frame
  55228. */
  55229. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55230. }
  55231. }
  55232. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  55233. import { Observable } from "babylonjs/Misc/observable";
  55234. import { Scene } from "babylonjs/scene";
  55235. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55236. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55237. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55238. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55239. /**
  55240. * Oculus Touch Controller
  55241. */
  55242. export class OculusTouchController extends WebVRController {
  55243. /**
  55244. * Base Url for the controller model.
  55245. */
  55246. static MODEL_BASE_URL: string;
  55247. /**
  55248. * File name for the left controller model.
  55249. */
  55250. static MODEL_LEFT_FILENAME: string;
  55251. /**
  55252. * File name for the right controller model.
  55253. */
  55254. static MODEL_RIGHT_FILENAME: string;
  55255. /**
  55256. * Base Url for the Quest controller model.
  55257. */
  55258. static QUEST_MODEL_BASE_URL: string;
  55259. /**
  55260. * @hidden
  55261. * If the controllers are running on a device that needs the updated Quest controller models
  55262. */
  55263. static _IsQuest: boolean;
  55264. /**
  55265. * Fired when the secondary trigger on this controller is modified
  55266. */
  55267. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  55268. /**
  55269. * Fired when the thumb rest on this controller is modified
  55270. */
  55271. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  55272. /**
  55273. * Creates a new OculusTouchController from a gamepad
  55274. * @param vrGamepad the gamepad that the controller should be created from
  55275. */
  55276. constructor(vrGamepad: any);
  55277. /**
  55278. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55279. * @param scene scene in which to add meshes
  55280. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55281. */
  55282. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55283. /**
  55284. * Fired when the A button on this controller is modified
  55285. */
  55286. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55287. /**
  55288. * Fired when the B button on this controller is modified
  55289. */
  55290. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55291. /**
  55292. * Fired when the X button on this controller is modified
  55293. */
  55294. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55295. /**
  55296. * Fired when the Y button on this controller is modified
  55297. */
  55298. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55299. /**
  55300. * Called once for each button that changed state since the last frame
  55301. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  55302. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  55303. * 2) secondary trigger (same)
  55304. * 3) A (right) X (left), touch, pressed = value
  55305. * 4) B / Y
  55306. * 5) thumb rest
  55307. * @param buttonIdx Which button index changed
  55308. * @param state New state of the button
  55309. * @param changes Which properties on the state changed since last frame
  55310. */
  55311. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55312. }
  55313. }
  55314. declare module "babylonjs/Gamepads/Controllers/viveController" {
  55315. import { Scene } from "babylonjs/scene";
  55316. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55317. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55318. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55319. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55320. import { Observable } from "babylonjs/Misc/observable";
  55321. /**
  55322. * Vive Controller
  55323. */
  55324. export class ViveController extends WebVRController {
  55325. /**
  55326. * Base Url for the controller model.
  55327. */
  55328. static MODEL_BASE_URL: string;
  55329. /**
  55330. * File name for the controller model.
  55331. */
  55332. static MODEL_FILENAME: string;
  55333. /**
  55334. * Creates a new ViveController from a gamepad
  55335. * @param vrGamepad the gamepad that the controller should be created from
  55336. */
  55337. constructor(vrGamepad: any);
  55338. /**
  55339. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55340. * @param scene scene in which to add meshes
  55341. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55342. */
  55343. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55344. /**
  55345. * Fired when the left button on this controller is modified
  55346. */
  55347. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55348. /**
  55349. * Fired when the right button on this controller is modified
  55350. */
  55351. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55352. /**
  55353. * Fired when the menu button on this controller is modified
  55354. */
  55355. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55356. /**
  55357. * Called once for each button that changed state since the last frame
  55358. * Vive mapping:
  55359. * 0: touchpad
  55360. * 1: trigger
  55361. * 2: left AND right buttons
  55362. * 3: menu button
  55363. * @param buttonIdx Which button index changed
  55364. * @param state New state of the button
  55365. * @param changes Which properties on the state changed since last frame
  55366. */
  55367. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55368. }
  55369. }
  55370. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  55371. import { Observable } from "babylonjs/Misc/observable";
  55372. import { Scene } from "babylonjs/scene";
  55373. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55374. import { Ray } from "babylonjs/Culling/ray";
  55375. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55376. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55377. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55378. /**
  55379. * Defines the WindowsMotionController object that the state of the windows motion controller
  55380. */
  55381. export class WindowsMotionController extends WebVRController {
  55382. /**
  55383. * The base url used to load the left and right controller models
  55384. */
  55385. static MODEL_BASE_URL: string;
  55386. /**
  55387. * The name of the left controller model file
  55388. */
  55389. static MODEL_LEFT_FILENAME: string;
  55390. /**
  55391. * The name of the right controller model file
  55392. */
  55393. static MODEL_RIGHT_FILENAME: string;
  55394. /**
  55395. * The controller name prefix for this controller type
  55396. */
  55397. static readonly GAMEPAD_ID_PREFIX: string;
  55398. /**
  55399. * The controller id pattern for this controller type
  55400. */
  55401. private static readonly GAMEPAD_ID_PATTERN;
  55402. private _loadedMeshInfo;
  55403. protected readonly _mapping: {
  55404. buttons: string[];
  55405. buttonMeshNames: {
  55406. trigger: string;
  55407. menu: string;
  55408. grip: string;
  55409. thumbstick: string;
  55410. trackpad: string;
  55411. };
  55412. buttonObservableNames: {
  55413. trigger: string;
  55414. menu: string;
  55415. grip: string;
  55416. thumbstick: string;
  55417. trackpad: string;
  55418. };
  55419. axisMeshNames: string[];
  55420. pointingPoseMeshName: string;
  55421. };
  55422. /**
  55423. * Fired when the trackpad on this controller is clicked
  55424. */
  55425. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55426. /**
  55427. * Fired when the trackpad on this controller is modified
  55428. */
  55429. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55430. /**
  55431. * The current x and y values of this controller's trackpad
  55432. */
  55433. trackpad: StickValues;
  55434. /**
  55435. * Creates a new WindowsMotionController from a gamepad
  55436. * @param vrGamepad the gamepad that the controller should be created from
  55437. */
  55438. constructor(vrGamepad: any);
  55439. /**
  55440. * Fired when the trigger on this controller is modified
  55441. */
  55442. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55443. /**
  55444. * Fired when the menu button on this controller is modified
  55445. */
  55446. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55447. /**
  55448. * Fired when the grip button on this controller is modified
  55449. */
  55450. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55451. /**
  55452. * Fired when the thumbstick button on this controller is modified
  55453. */
  55454. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55455. /**
  55456. * Fired when the touchpad button on this controller is modified
  55457. */
  55458. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55459. /**
  55460. * Fired when the touchpad values on this controller are modified
  55461. */
  55462. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  55463. protected _updateTrackpad(): void;
  55464. /**
  55465. * Called once per frame by the engine.
  55466. */
  55467. update(): void;
  55468. /**
  55469. * Called once for each button that changed state since the last frame
  55470. * @param buttonIdx Which button index changed
  55471. * @param state New state of the button
  55472. * @param changes Which properties on the state changed since last frame
  55473. */
  55474. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55475. /**
  55476. * Moves the buttons on the controller mesh based on their current state
  55477. * @param buttonName the name of the button to move
  55478. * @param buttonValue the value of the button which determines the buttons new position
  55479. */
  55480. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  55481. /**
  55482. * Moves the axis on the controller mesh based on its current state
  55483. * @param axis the index of the axis
  55484. * @param axisValue the value of the axis which determines the meshes new position
  55485. * @hidden
  55486. */
  55487. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  55488. /**
  55489. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55490. * @param scene scene in which to add meshes
  55491. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55492. */
  55493. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  55494. /**
  55495. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  55496. * can be transformed by button presses and axes values, based on this._mapping.
  55497. *
  55498. * @param scene scene in which the meshes exist
  55499. * @param meshes list of meshes that make up the controller model to process
  55500. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  55501. */
  55502. private processModel;
  55503. private createMeshInfo;
  55504. /**
  55505. * Gets the ray of the controller in the direction the controller is pointing
  55506. * @param length the length the resulting ray should be
  55507. * @returns a ray in the direction the controller is pointing
  55508. */
  55509. getForwardRay(length?: number): Ray;
  55510. /**
  55511. * Disposes of the controller
  55512. */
  55513. dispose(): void;
  55514. }
  55515. /**
  55516. * This class represents a new windows motion controller in XR.
  55517. */
  55518. export class XRWindowsMotionController extends WindowsMotionController {
  55519. /**
  55520. * Changing the original WIndowsMotionController mapping to fir the new mapping
  55521. */
  55522. protected readonly _mapping: {
  55523. buttons: string[];
  55524. buttonMeshNames: {
  55525. trigger: string;
  55526. menu: string;
  55527. grip: string;
  55528. thumbstick: string;
  55529. trackpad: string;
  55530. };
  55531. buttonObservableNames: {
  55532. trigger: string;
  55533. menu: string;
  55534. grip: string;
  55535. thumbstick: string;
  55536. trackpad: string;
  55537. };
  55538. axisMeshNames: string[];
  55539. pointingPoseMeshName: string;
  55540. };
  55541. /**
  55542. * Construct a new XR-Based windows motion controller
  55543. *
  55544. * @param gamepadInfo the gamepad object from the browser
  55545. */
  55546. constructor(gamepadInfo: any);
  55547. /**
  55548. * holds the thumbstick values (X,Y)
  55549. */
  55550. thumbstickValues: StickValues;
  55551. /**
  55552. * Fired when the thumbstick on this controller is clicked
  55553. */
  55554. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  55555. /**
  55556. * Fired when the thumbstick on this controller is modified
  55557. */
  55558. onThumbstickValuesChangedObservable: Observable<StickValues>;
  55559. /**
  55560. * Fired when the touchpad button on this controller is modified
  55561. */
  55562. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55563. /**
  55564. * Fired when the touchpad values on this controller are modified
  55565. */
  55566. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55567. /**
  55568. * Fired when the thumbstick button on this controller is modified
  55569. * here to prevent breaking changes
  55570. */
  55571. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55572. /**
  55573. * updating the thumbstick(!) and not the trackpad.
  55574. * This is named this way due to the difference between WebVR and XR and to avoid
  55575. * changing the parent class.
  55576. */
  55577. protected _updateTrackpad(): void;
  55578. /**
  55579. * Disposes the class with joy
  55580. */
  55581. dispose(): void;
  55582. }
  55583. }
  55584. declare module "babylonjs/Gamepads/Controllers/index" {
  55585. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  55586. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  55587. export * from "babylonjs/Gamepads/Controllers/genericController";
  55588. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  55589. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55590. export * from "babylonjs/Gamepads/Controllers/viveController";
  55591. export * from "babylonjs/Gamepads/Controllers/webVRController";
  55592. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  55593. }
  55594. declare module "babylonjs/Gamepads/index" {
  55595. export * from "babylonjs/Gamepads/Controllers/index";
  55596. export * from "babylonjs/Gamepads/gamepad";
  55597. export * from "babylonjs/Gamepads/gamepadManager";
  55598. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  55599. export * from "babylonjs/Gamepads/xboxGamepad";
  55600. export * from "babylonjs/Gamepads/dualShockGamepad";
  55601. }
  55602. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  55603. import { Scene } from "babylonjs/scene";
  55604. import { Vector4 } from "babylonjs/Maths/math.vector";
  55605. import { Color4 } from "babylonjs/Maths/math.color";
  55606. import { Mesh } from "babylonjs/Meshes/mesh";
  55607. import { Nullable } from "babylonjs/types";
  55608. /**
  55609. * Class containing static functions to help procedurally build meshes
  55610. */
  55611. export class PolyhedronBuilder {
  55612. /**
  55613. * Creates a polyhedron mesh
  55614. * * 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
  55615. * * The parameter `size` (positive float, default 1) sets the polygon size
  55616. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55617. * * 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`
  55618. * * 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
  55619. * * 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)`)
  55620. * * 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
  55621. * * 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
  55622. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55623. * * 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
  55624. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55625. * @param name defines the name of the mesh
  55626. * @param options defines the options used to create the mesh
  55627. * @param scene defines the hosting scene
  55628. * @returns the polyhedron mesh
  55629. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55630. */
  55631. static CreatePolyhedron(name: string, options: {
  55632. type?: number;
  55633. size?: number;
  55634. sizeX?: number;
  55635. sizeY?: number;
  55636. sizeZ?: number;
  55637. custom?: any;
  55638. faceUV?: Vector4[];
  55639. faceColors?: Color4[];
  55640. flat?: boolean;
  55641. updatable?: boolean;
  55642. sideOrientation?: number;
  55643. frontUVs?: Vector4;
  55644. backUVs?: Vector4;
  55645. }, scene?: Nullable<Scene>): Mesh;
  55646. }
  55647. }
  55648. declare module "babylonjs/Gizmos/scaleGizmo" {
  55649. import { Observable } from "babylonjs/Misc/observable";
  55650. import { Nullable } from "babylonjs/types";
  55651. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55652. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55653. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55654. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55655. import { Node } from "babylonjs/node";
  55656. /**
  55657. * Gizmo that enables scaling a mesh along 3 axis
  55658. */
  55659. export class ScaleGizmo extends Gizmo {
  55660. /**
  55661. * Internal gizmo used for interactions on the x axis
  55662. */
  55663. xGizmo: AxisScaleGizmo;
  55664. /**
  55665. * Internal gizmo used for interactions on the y axis
  55666. */
  55667. yGizmo: AxisScaleGizmo;
  55668. /**
  55669. * Internal gizmo used for interactions on the z axis
  55670. */
  55671. zGizmo: AxisScaleGizmo;
  55672. /**
  55673. * Internal gizmo used to scale all axis equally
  55674. */
  55675. uniformScaleGizmo: AxisScaleGizmo;
  55676. private _meshAttached;
  55677. private _nodeAttached;
  55678. private _snapDistance;
  55679. private _uniformScalingMesh;
  55680. private _octahedron;
  55681. private _sensitivity;
  55682. /** Fires an event when any of it's sub gizmos are dragged */
  55683. onDragStartObservable: Observable<unknown>;
  55684. /** Fires an event when any of it's sub gizmos are released from dragging */
  55685. onDragEndObservable: Observable<unknown>;
  55686. get attachedMesh(): Nullable<AbstractMesh>;
  55687. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55688. get attachedNode(): Nullable<Node>;
  55689. set attachedNode(node: Nullable<Node>);
  55690. /**
  55691. * Creates a ScaleGizmo
  55692. * @param gizmoLayer The utility layer the gizmo will be added to
  55693. * @param thickness display gizmo axis thickness
  55694. */
  55695. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55696. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55697. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55698. /**
  55699. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55700. */
  55701. set snapDistance(value: number);
  55702. get snapDistance(): number;
  55703. /**
  55704. * Ratio for the scale of the gizmo (Default: 1)
  55705. */
  55706. set scaleRatio(value: number);
  55707. get scaleRatio(): number;
  55708. /**
  55709. * Sensitivity factor for dragging (Default: 1)
  55710. */
  55711. set sensitivity(value: number);
  55712. get sensitivity(): number;
  55713. /**
  55714. * Disposes of the gizmo
  55715. */
  55716. dispose(): void;
  55717. }
  55718. }
  55719. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55720. import { Observable } from "babylonjs/Misc/observable";
  55721. import { Nullable } from "babylonjs/types";
  55722. import { Vector3 } from "babylonjs/Maths/math.vector";
  55723. import { Node } from "babylonjs/node";
  55724. import { Mesh } from "babylonjs/Meshes/mesh";
  55725. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55726. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55727. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55728. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55729. import { Color3 } from "babylonjs/Maths/math.color";
  55730. /**
  55731. * Single axis scale gizmo
  55732. */
  55733. export class AxisScaleGizmo extends Gizmo {
  55734. /**
  55735. * Drag behavior responsible for the gizmos dragging interactions
  55736. */
  55737. dragBehavior: PointerDragBehavior;
  55738. private _pointerObserver;
  55739. /**
  55740. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55741. */
  55742. snapDistance: number;
  55743. /**
  55744. * Event that fires each time the gizmo snaps to a new location.
  55745. * * snapDistance is the the change in distance
  55746. */
  55747. onSnapObservable: Observable<{
  55748. snapDistance: number;
  55749. }>;
  55750. /**
  55751. * If the scaling operation should be done on all axis (default: false)
  55752. */
  55753. uniformScaling: boolean;
  55754. /**
  55755. * Custom sensitivity value for the drag strength
  55756. */
  55757. sensitivity: number;
  55758. private _isEnabled;
  55759. private _parent;
  55760. private _arrow;
  55761. private _coloredMaterial;
  55762. private _hoverMaterial;
  55763. /**
  55764. * Creates an AxisScaleGizmo
  55765. * @param gizmoLayer The utility layer the gizmo will be added to
  55766. * @param dragAxis The axis which the gizmo will be able to scale on
  55767. * @param color The color of the gizmo
  55768. * @param thickness display gizmo axis thickness
  55769. */
  55770. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  55771. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55772. /**
  55773. * If the gizmo is enabled
  55774. */
  55775. set isEnabled(value: boolean);
  55776. get isEnabled(): boolean;
  55777. /**
  55778. * Disposes of the gizmo
  55779. */
  55780. dispose(): void;
  55781. /**
  55782. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  55783. * @param mesh The mesh to replace the default mesh of the gizmo
  55784. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  55785. */
  55786. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  55787. }
  55788. }
  55789. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  55790. import { Observable } from "babylonjs/Misc/observable";
  55791. import { Nullable } from "babylonjs/types";
  55792. import { Vector3 } from "babylonjs/Maths/math.vector";
  55793. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55794. import { Mesh } from "babylonjs/Meshes/mesh";
  55795. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55796. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55797. import { Color3 } from "babylonjs/Maths/math.color";
  55798. import "babylonjs/Meshes/Builders/boxBuilder";
  55799. /**
  55800. * Bounding box gizmo
  55801. */
  55802. export class BoundingBoxGizmo extends Gizmo {
  55803. private _lineBoundingBox;
  55804. private _rotateSpheresParent;
  55805. private _scaleBoxesParent;
  55806. private _boundingDimensions;
  55807. private _renderObserver;
  55808. private _pointerObserver;
  55809. private _scaleDragSpeed;
  55810. private _tmpQuaternion;
  55811. private _tmpVector;
  55812. private _tmpRotationMatrix;
  55813. /**
  55814. * 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)
  55815. */
  55816. ignoreChildren: boolean;
  55817. /**
  55818. * 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)
  55819. */
  55820. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  55821. /**
  55822. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  55823. */
  55824. rotationSphereSize: number;
  55825. /**
  55826. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  55827. */
  55828. scaleBoxSize: number;
  55829. /**
  55830. * 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)
  55831. */
  55832. fixedDragMeshScreenSize: boolean;
  55833. /**
  55834. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  55835. */
  55836. fixedDragMeshScreenSizeDistanceFactor: number;
  55837. /**
  55838. * Fired when a rotation sphere or scale box is dragged
  55839. */
  55840. onDragStartObservable: Observable<{}>;
  55841. /**
  55842. * Fired when a scale box is dragged
  55843. */
  55844. onScaleBoxDragObservable: Observable<{}>;
  55845. /**
  55846. * Fired when a scale box drag is ended
  55847. */
  55848. onScaleBoxDragEndObservable: Observable<{}>;
  55849. /**
  55850. * Fired when a rotation sphere is dragged
  55851. */
  55852. onRotationSphereDragObservable: Observable<{}>;
  55853. /**
  55854. * Fired when a rotation sphere drag is ended
  55855. */
  55856. onRotationSphereDragEndObservable: Observable<{}>;
  55857. /**
  55858. * 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)
  55859. */
  55860. scalePivot: Nullable<Vector3>;
  55861. /**
  55862. * Mesh used as a pivot to rotate the attached node
  55863. */
  55864. private _anchorMesh;
  55865. private _existingMeshScale;
  55866. private _dragMesh;
  55867. private pointerDragBehavior;
  55868. private coloredMaterial;
  55869. private hoverColoredMaterial;
  55870. /**
  55871. * Sets the color of the bounding box gizmo
  55872. * @param color the color to set
  55873. */
  55874. setColor(color: Color3): void;
  55875. /**
  55876. * Creates an BoundingBoxGizmo
  55877. * @param gizmoLayer The utility layer the gizmo will be added to
  55878. * @param color The color of the gizmo
  55879. */
  55880. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  55881. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  55882. private _selectNode;
  55883. /**
  55884. * Updates the bounding box information for the Gizmo
  55885. */
  55886. updateBoundingBox(): void;
  55887. private _updateRotationSpheres;
  55888. private _updateScaleBoxes;
  55889. /**
  55890. * Enables rotation on the specified axis and disables rotation on the others
  55891. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  55892. */
  55893. setEnabledRotationAxis(axis: string): void;
  55894. /**
  55895. * Enables/disables scaling
  55896. * @param enable if scaling should be enabled
  55897. * @param homogeneousScaling defines if scaling should only be homogeneous
  55898. */
  55899. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  55900. private _updateDummy;
  55901. /**
  55902. * Enables a pointer drag behavior on the bounding box of the gizmo
  55903. */
  55904. enableDragBehavior(): void;
  55905. /**
  55906. * Disposes of the gizmo
  55907. */
  55908. dispose(): void;
  55909. /**
  55910. * 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)
  55911. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  55912. * @returns the bounding box mesh with the passed in mesh as a child
  55913. */
  55914. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  55915. /**
  55916. * CustomMeshes are not supported by this gizmo
  55917. * @param mesh The mesh to replace the default mesh of the gizmo
  55918. */
  55919. setCustomMesh(mesh: Mesh): void;
  55920. }
  55921. }
  55922. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  55923. import { Observable } from "babylonjs/Misc/observable";
  55924. import { Nullable } from "babylonjs/types";
  55925. import { Vector3 } from "babylonjs/Maths/math.vector";
  55926. import { Color3 } from "babylonjs/Maths/math.color";
  55927. import { Node } from "babylonjs/node";
  55928. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55929. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55930. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55931. import "babylonjs/Meshes/Builders/linesBuilder";
  55932. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  55933. /**
  55934. * Single plane rotation gizmo
  55935. */
  55936. export class PlaneRotationGizmo extends Gizmo {
  55937. /**
  55938. * Drag behavior responsible for the gizmos dragging interactions
  55939. */
  55940. dragBehavior: PointerDragBehavior;
  55941. private _pointerObserver;
  55942. /**
  55943. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  55944. */
  55945. snapDistance: number;
  55946. /**
  55947. * Event that fires each time the gizmo snaps to a new location.
  55948. * * snapDistance is the the change in distance
  55949. */
  55950. onSnapObservable: Observable<{
  55951. snapDistance: number;
  55952. }>;
  55953. private _isEnabled;
  55954. private _parent;
  55955. /**
  55956. * Creates a PlaneRotationGizmo
  55957. * @param gizmoLayer The utility layer the gizmo will be added to
  55958. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  55959. * @param color The color of the gizmo
  55960. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55961. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55962. * @param thickness display gizmo axis thickness
  55963. */
  55964. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  55965. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55966. /**
  55967. * If the gizmo is enabled
  55968. */
  55969. set isEnabled(value: boolean);
  55970. get isEnabled(): boolean;
  55971. /**
  55972. * Disposes of the gizmo
  55973. */
  55974. dispose(): void;
  55975. }
  55976. }
  55977. declare module "babylonjs/Gizmos/rotationGizmo" {
  55978. import { Observable } from "babylonjs/Misc/observable";
  55979. import { Nullable } from "babylonjs/types";
  55980. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55981. import { Mesh } from "babylonjs/Meshes/mesh";
  55982. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55983. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  55984. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55985. import { Node } from "babylonjs/node";
  55986. /**
  55987. * Gizmo that enables rotating a mesh along 3 axis
  55988. */
  55989. export class RotationGizmo extends Gizmo {
  55990. /**
  55991. * Internal gizmo used for interactions on the x axis
  55992. */
  55993. xGizmo: PlaneRotationGizmo;
  55994. /**
  55995. * Internal gizmo used for interactions on the y axis
  55996. */
  55997. yGizmo: PlaneRotationGizmo;
  55998. /**
  55999. * Internal gizmo used for interactions on the z axis
  56000. */
  56001. zGizmo: PlaneRotationGizmo;
  56002. /** Fires an event when any of it's sub gizmos are dragged */
  56003. onDragStartObservable: Observable<unknown>;
  56004. /** Fires an event when any of it's sub gizmos are released from dragging */
  56005. onDragEndObservable: Observable<unknown>;
  56006. private _meshAttached;
  56007. private _nodeAttached;
  56008. get attachedMesh(): Nullable<AbstractMesh>;
  56009. set attachedMesh(mesh: Nullable<AbstractMesh>);
  56010. get attachedNode(): Nullable<Node>;
  56011. set attachedNode(node: Nullable<Node>);
  56012. /**
  56013. * Creates a RotationGizmo
  56014. * @param gizmoLayer The utility layer the gizmo will be added to
  56015. * @param tessellation Amount of tessellation to be used when creating rotation circles
  56016. * @param useEulerRotation Use and update Euler angle instead of quaternion
  56017. * @param thickness display gizmo axis thickness
  56018. */
  56019. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  56020. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  56021. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  56022. /**
  56023. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  56024. */
  56025. set snapDistance(value: number);
  56026. get snapDistance(): number;
  56027. /**
  56028. * Ratio for the scale of the gizmo (Default: 1)
  56029. */
  56030. set scaleRatio(value: number);
  56031. get scaleRatio(): number;
  56032. /**
  56033. * Disposes of the gizmo
  56034. */
  56035. dispose(): void;
  56036. /**
  56037. * CustomMeshes are not supported by this gizmo
  56038. * @param mesh The mesh to replace the default mesh of the gizmo
  56039. */
  56040. setCustomMesh(mesh: Mesh): void;
  56041. }
  56042. }
  56043. declare module "babylonjs/Gizmos/gizmoManager" {
  56044. import { Observable } from "babylonjs/Misc/observable";
  56045. import { Nullable } from "babylonjs/types";
  56046. import { Scene, IDisposable } from "babylonjs/scene";
  56047. import { Node } from "babylonjs/node";
  56048. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56049. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56050. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  56051. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56052. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  56053. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  56054. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  56055. /**
  56056. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  56057. */
  56058. export class GizmoManager implements IDisposable {
  56059. private scene;
  56060. /**
  56061. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  56062. */
  56063. gizmos: {
  56064. positionGizmo: Nullable<PositionGizmo>;
  56065. rotationGizmo: Nullable<RotationGizmo>;
  56066. scaleGizmo: Nullable<ScaleGizmo>;
  56067. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  56068. };
  56069. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  56070. clearGizmoOnEmptyPointerEvent: boolean;
  56071. /** Fires an event when the manager is attached to a mesh */
  56072. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  56073. /** Fires an event when the manager is attached to a node */
  56074. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  56075. private _gizmosEnabled;
  56076. private _pointerObserver;
  56077. private _attachedMesh;
  56078. private _attachedNode;
  56079. private _boundingBoxColor;
  56080. private _defaultUtilityLayer;
  56081. private _defaultKeepDepthUtilityLayer;
  56082. private _thickness;
  56083. /**
  56084. * When bounding box gizmo is enabled, this can be used to track drag/end events
  56085. */
  56086. boundingBoxDragBehavior: SixDofDragBehavior;
  56087. /**
  56088. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  56089. */
  56090. attachableMeshes: Nullable<Array<AbstractMesh>>;
  56091. /**
  56092. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  56093. */
  56094. attachableNodes: Nullable<Array<Node>>;
  56095. /**
  56096. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  56097. */
  56098. usePointerToAttachGizmos: boolean;
  56099. /**
  56100. * Utility layer that the bounding box gizmo belongs to
  56101. */
  56102. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  56103. /**
  56104. * Utility layer that all gizmos besides bounding box belong to
  56105. */
  56106. get utilityLayer(): UtilityLayerRenderer;
  56107. /**
  56108. * Instatiates a gizmo manager
  56109. * @param scene the scene to overlay the gizmos on top of
  56110. * @param thickness display gizmo axis thickness
  56111. */
  56112. constructor(scene: Scene, thickness?: number);
  56113. /**
  56114. * Attaches a set of gizmos to the specified mesh
  56115. * @param mesh The mesh the gizmo's should be attached to
  56116. */
  56117. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  56118. /**
  56119. * Attaches a set of gizmos to the specified node
  56120. * @param node The node the gizmo's should be attached to
  56121. */
  56122. attachToNode(node: Nullable<Node>): void;
  56123. /**
  56124. * If the position gizmo is enabled
  56125. */
  56126. set positionGizmoEnabled(value: boolean);
  56127. get positionGizmoEnabled(): boolean;
  56128. /**
  56129. * If the rotation gizmo is enabled
  56130. */
  56131. set rotationGizmoEnabled(value: boolean);
  56132. get rotationGizmoEnabled(): boolean;
  56133. /**
  56134. * If the scale gizmo is enabled
  56135. */
  56136. set scaleGizmoEnabled(value: boolean);
  56137. get scaleGizmoEnabled(): boolean;
  56138. /**
  56139. * If the boundingBox gizmo is enabled
  56140. */
  56141. set boundingBoxGizmoEnabled(value: boolean);
  56142. get boundingBoxGizmoEnabled(): boolean;
  56143. /**
  56144. * Disposes of the gizmo manager
  56145. */
  56146. dispose(): void;
  56147. }
  56148. }
  56149. declare module "babylonjs/Lights/directionalLight" {
  56150. import { Camera } from "babylonjs/Cameras/camera";
  56151. import { Scene } from "babylonjs/scene";
  56152. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56153. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56154. import { Light } from "babylonjs/Lights/light";
  56155. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56156. import { Effect } from "babylonjs/Materials/effect";
  56157. /**
  56158. * A directional light is defined by a direction (what a surprise!).
  56159. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  56160. * 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.
  56161. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56162. */
  56163. export class DirectionalLight extends ShadowLight {
  56164. private _shadowFrustumSize;
  56165. /**
  56166. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  56167. */
  56168. get shadowFrustumSize(): number;
  56169. /**
  56170. * Specifies a fix frustum size for the shadow generation.
  56171. */
  56172. set shadowFrustumSize(value: number);
  56173. private _shadowOrthoScale;
  56174. /**
  56175. * Gets the shadow projection scale against the optimal computed one.
  56176. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56177. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56178. */
  56179. get shadowOrthoScale(): number;
  56180. /**
  56181. * Sets the shadow projection scale against the optimal computed one.
  56182. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56183. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56184. */
  56185. set shadowOrthoScale(value: number);
  56186. /**
  56187. * Automatically compute the projection matrix to best fit (including all the casters)
  56188. * on each frame.
  56189. */
  56190. autoUpdateExtends: boolean;
  56191. /**
  56192. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  56193. * on each frame. autoUpdateExtends must be set to true for this to work
  56194. */
  56195. autoCalcShadowZBounds: boolean;
  56196. private _orthoLeft;
  56197. private _orthoRight;
  56198. private _orthoTop;
  56199. private _orthoBottom;
  56200. /**
  56201. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  56202. * The directional light is emitted from everywhere in the given direction.
  56203. * It can cast shadows.
  56204. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56205. * @param name The friendly name of the light
  56206. * @param direction The direction of the light
  56207. * @param scene The scene the light belongs to
  56208. */
  56209. constructor(name: string, direction: Vector3, scene: Scene);
  56210. /**
  56211. * Returns the string "DirectionalLight".
  56212. * @return The class name
  56213. */
  56214. getClassName(): string;
  56215. /**
  56216. * Returns the integer 1.
  56217. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56218. */
  56219. getTypeID(): number;
  56220. /**
  56221. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  56222. * Returns the DirectionalLight Shadow projection matrix.
  56223. */
  56224. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56225. /**
  56226. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  56227. * Returns the DirectionalLight Shadow projection matrix.
  56228. */
  56229. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  56230. /**
  56231. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  56232. * Returns the DirectionalLight Shadow projection matrix.
  56233. */
  56234. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56235. protected _buildUniformLayout(): void;
  56236. /**
  56237. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  56238. * @param effect The effect to update
  56239. * @param lightIndex The index of the light in the effect to update
  56240. * @returns The directional light
  56241. */
  56242. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  56243. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  56244. /**
  56245. * Gets the minZ used for shadow according to both the scene and the light.
  56246. *
  56247. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56248. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56249. * @param activeCamera The camera we are returning the min for
  56250. * @returns the depth min z
  56251. */
  56252. getDepthMinZ(activeCamera: Camera): number;
  56253. /**
  56254. * Gets the maxZ used for shadow according to both the scene and the light.
  56255. *
  56256. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56257. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56258. * @param activeCamera The camera we are returning the max for
  56259. * @returns the depth max z
  56260. */
  56261. getDepthMaxZ(activeCamera: Camera): number;
  56262. /**
  56263. * Prepares the list of defines specific to the light type.
  56264. * @param defines the list of defines
  56265. * @param lightIndex defines the index of the light for the effect
  56266. */
  56267. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56268. }
  56269. }
  56270. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  56271. import { Mesh } from "babylonjs/Meshes/mesh";
  56272. /**
  56273. * Class containing static functions to help procedurally build meshes
  56274. */
  56275. export class HemisphereBuilder {
  56276. /**
  56277. * Creates a hemisphere mesh
  56278. * @param name defines the name of the mesh
  56279. * @param options defines the options used to create the mesh
  56280. * @param scene defines the hosting scene
  56281. * @returns the hemisphere mesh
  56282. */
  56283. static CreateHemisphere(name: string, options: {
  56284. segments?: number;
  56285. diameter?: number;
  56286. sideOrientation?: number;
  56287. }, scene: any): Mesh;
  56288. }
  56289. }
  56290. declare module "babylonjs/Lights/spotLight" {
  56291. import { Nullable } from "babylonjs/types";
  56292. import { Scene } from "babylonjs/scene";
  56293. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56294. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56295. import { Effect } from "babylonjs/Materials/effect";
  56296. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56297. import { Light } from "babylonjs/Lights/light";
  56298. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56299. /**
  56300. * A spot light is defined by a position, a direction, an angle, and an exponent.
  56301. * These values define a cone of light starting from the position, emitting toward the direction.
  56302. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  56303. * and the exponent defines the speed of the decay of the light with distance (reach).
  56304. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56305. */
  56306. export class SpotLight extends ShadowLight {
  56307. private _angle;
  56308. private _innerAngle;
  56309. private _cosHalfAngle;
  56310. private _lightAngleScale;
  56311. private _lightAngleOffset;
  56312. /**
  56313. * Gets the cone angle of the spot light in Radians.
  56314. */
  56315. get angle(): number;
  56316. /**
  56317. * Sets the cone angle of the spot light in Radians.
  56318. */
  56319. set angle(value: number);
  56320. /**
  56321. * Only used in gltf falloff mode, this defines the angle where
  56322. * the directional falloff will start before cutting at angle which could be seen
  56323. * as outer angle.
  56324. */
  56325. get innerAngle(): number;
  56326. /**
  56327. * Only used in gltf falloff mode, this defines the angle where
  56328. * the directional falloff will start before cutting at angle which could be seen
  56329. * as outer angle.
  56330. */
  56331. set innerAngle(value: number);
  56332. private _shadowAngleScale;
  56333. /**
  56334. * Allows scaling the angle of the light for shadow generation only.
  56335. */
  56336. get shadowAngleScale(): number;
  56337. /**
  56338. * Allows scaling the angle of the light for shadow generation only.
  56339. */
  56340. set shadowAngleScale(value: number);
  56341. /**
  56342. * The light decay speed with the distance from the emission spot.
  56343. */
  56344. exponent: number;
  56345. private _projectionTextureMatrix;
  56346. /**
  56347. * Allows reading the projecton texture
  56348. */
  56349. get projectionTextureMatrix(): Matrix;
  56350. protected _projectionTextureLightNear: number;
  56351. /**
  56352. * Gets the near clip of the Spotlight for texture projection.
  56353. */
  56354. get projectionTextureLightNear(): number;
  56355. /**
  56356. * Sets the near clip of the Spotlight for texture projection.
  56357. */
  56358. set projectionTextureLightNear(value: number);
  56359. protected _projectionTextureLightFar: number;
  56360. /**
  56361. * Gets the far clip of the Spotlight for texture projection.
  56362. */
  56363. get projectionTextureLightFar(): number;
  56364. /**
  56365. * Sets the far clip of the Spotlight for texture projection.
  56366. */
  56367. set projectionTextureLightFar(value: number);
  56368. protected _projectionTextureUpDirection: Vector3;
  56369. /**
  56370. * Gets the Up vector of the Spotlight for texture projection.
  56371. */
  56372. get projectionTextureUpDirection(): Vector3;
  56373. /**
  56374. * Sets the Up vector of the Spotlight for texture projection.
  56375. */
  56376. set projectionTextureUpDirection(value: Vector3);
  56377. private _projectionTexture;
  56378. /**
  56379. * Gets the projection texture of the light.
  56380. */
  56381. get projectionTexture(): Nullable<BaseTexture>;
  56382. /**
  56383. * Sets the projection texture of the light.
  56384. */
  56385. set projectionTexture(value: Nullable<BaseTexture>);
  56386. private _projectionTextureViewLightDirty;
  56387. private _projectionTextureProjectionLightDirty;
  56388. private _projectionTextureDirty;
  56389. private _projectionTextureViewTargetVector;
  56390. private _projectionTextureViewLightMatrix;
  56391. private _projectionTextureProjectionLightMatrix;
  56392. private _projectionTextureScalingMatrix;
  56393. /**
  56394. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  56395. * It can cast shadows.
  56396. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56397. * @param name The light friendly name
  56398. * @param position The position of the spot light in the scene
  56399. * @param direction The direction of the light in the scene
  56400. * @param angle The cone angle of the light in Radians
  56401. * @param exponent The light decay speed with the distance from the emission spot
  56402. * @param scene The scene the lights belongs to
  56403. */
  56404. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  56405. /**
  56406. * Returns the string "SpotLight".
  56407. * @returns the class name
  56408. */
  56409. getClassName(): string;
  56410. /**
  56411. * Returns the integer 2.
  56412. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56413. */
  56414. getTypeID(): number;
  56415. /**
  56416. * Overrides the direction setter to recompute the projection texture view light Matrix.
  56417. */
  56418. protected _setDirection(value: Vector3): void;
  56419. /**
  56420. * Overrides the position setter to recompute the projection texture view light Matrix.
  56421. */
  56422. protected _setPosition(value: Vector3): void;
  56423. /**
  56424. * 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.
  56425. * Returns the SpotLight.
  56426. */
  56427. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56428. protected _computeProjectionTextureViewLightMatrix(): void;
  56429. protected _computeProjectionTextureProjectionLightMatrix(): void;
  56430. /**
  56431. * Main function for light texture projection matrix computing.
  56432. */
  56433. protected _computeProjectionTextureMatrix(): void;
  56434. protected _buildUniformLayout(): void;
  56435. private _computeAngleValues;
  56436. /**
  56437. * Sets the passed Effect "effect" with the Light textures.
  56438. * @param effect The effect to update
  56439. * @param lightIndex The index of the light in the effect to update
  56440. * @returns The light
  56441. */
  56442. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  56443. /**
  56444. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  56445. * @param effect The effect to update
  56446. * @param lightIndex The index of the light in the effect to update
  56447. * @returns The spot light
  56448. */
  56449. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  56450. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  56451. /**
  56452. * Disposes the light and the associated resources.
  56453. */
  56454. dispose(): void;
  56455. /**
  56456. * Prepares the list of defines specific to the light type.
  56457. * @param defines the list of defines
  56458. * @param lightIndex defines the index of the light for the effect
  56459. */
  56460. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56461. }
  56462. }
  56463. declare module "babylonjs/Gizmos/lightGizmo" {
  56464. import { Nullable } from "babylonjs/types";
  56465. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56466. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56467. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56468. import { Light } from "babylonjs/Lights/light";
  56469. /**
  56470. * Gizmo that enables viewing a light
  56471. */
  56472. export class LightGizmo extends Gizmo {
  56473. private _lightMesh;
  56474. private _material;
  56475. private _cachedPosition;
  56476. private _cachedForward;
  56477. private _attachedMeshParent;
  56478. /**
  56479. * Creates a LightGizmo
  56480. * @param gizmoLayer The utility layer the gizmo will be added to
  56481. */
  56482. constructor(gizmoLayer?: UtilityLayerRenderer);
  56483. private _light;
  56484. /**
  56485. * The light that the gizmo is attached to
  56486. */
  56487. set light(light: Nullable<Light>);
  56488. get light(): Nullable<Light>;
  56489. /**
  56490. * Gets the material used to render the light gizmo
  56491. */
  56492. get material(): StandardMaterial;
  56493. /**
  56494. * @hidden
  56495. * Updates the gizmo to match the attached mesh's position/rotation
  56496. */
  56497. protected _update(): void;
  56498. private static _Scale;
  56499. /**
  56500. * Creates the lines for a light mesh
  56501. */
  56502. private static _CreateLightLines;
  56503. /**
  56504. * Disposes of the light gizmo
  56505. */
  56506. dispose(): void;
  56507. private static _CreateHemisphericLightMesh;
  56508. private static _CreatePointLightMesh;
  56509. private static _CreateSpotLightMesh;
  56510. private static _CreateDirectionalLightMesh;
  56511. }
  56512. }
  56513. declare module "babylonjs/Gizmos/cameraGizmo" {
  56514. import { Nullable } from "babylonjs/types";
  56515. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56516. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56517. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56518. import { Camera } from "babylonjs/Cameras/camera";
  56519. /**
  56520. * Gizmo that enables viewing a camera
  56521. */
  56522. export class CameraGizmo extends Gizmo {
  56523. private _cameraMesh;
  56524. private _cameraLinesMesh;
  56525. private _material;
  56526. /**
  56527. * Creates a CameraGizmo
  56528. * @param gizmoLayer The utility layer the gizmo will be added to
  56529. */
  56530. constructor(gizmoLayer?: UtilityLayerRenderer);
  56531. private _camera;
  56532. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  56533. get displayFrustum(): boolean;
  56534. set displayFrustum(value: boolean);
  56535. /**
  56536. * The camera that the gizmo is attached to
  56537. */
  56538. set camera(camera: Nullable<Camera>);
  56539. get camera(): Nullable<Camera>;
  56540. /**
  56541. * Gets the material used to render the camera gizmo
  56542. */
  56543. get material(): StandardMaterial;
  56544. /**
  56545. * @hidden
  56546. * Updates the gizmo to match the attached mesh's position/rotation
  56547. */
  56548. protected _update(): void;
  56549. private static _Scale;
  56550. private _invProjection;
  56551. /**
  56552. * Disposes of the camera gizmo
  56553. */
  56554. dispose(): void;
  56555. private static _CreateCameraMesh;
  56556. private static _CreateCameraFrustum;
  56557. }
  56558. }
  56559. declare module "babylonjs/Gizmos/index" {
  56560. export * from "babylonjs/Gizmos/axisDragGizmo";
  56561. export * from "babylonjs/Gizmos/axisScaleGizmo";
  56562. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  56563. export * from "babylonjs/Gizmos/gizmo";
  56564. export * from "babylonjs/Gizmos/gizmoManager";
  56565. export * from "babylonjs/Gizmos/planeRotationGizmo";
  56566. export * from "babylonjs/Gizmos/positionGizmo";
  56567. export * from "babylonjs/Gizmos/rotationGizmo";
  56568. export * from "babylonjs/Gizmos/scaleGizmo";
  56569. export * from "babylonjs/Gizmos/lightGizmo";
  56570. export * from "babylonjs/Gizmos/cameraGizmo";
  56571. export * from "babylonjs/Gizmos/planeDragGizmo";
  56572. }
  56573. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  56574. /** @hidden */
  56575. export var backgroundFragmentDeclaration: {
  56576. name: string;
  56577. shader: string;
  56578. };
  56579. }
  56580. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  56581. /** @hidden */
  56582. export var backgroundUboDeclaration: {
  56583. name: string;
  56584. shader: string;
  56585. };
  56586. }
  56587. declare module "babylonjs/Shaders/background.fragment" {
  56588. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  56589. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56590. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56591. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  56592. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56593. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56594. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56595. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  56596. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  56597. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  56598. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  56599. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  56600. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  56601. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  56602. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  56603. /** @hidden */
  56604. export var backgroundPixelShader: {
  56605. name: string;
  56606. shader: string;
  56607. };
  56608. }
  56609. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  56610. /** @hidden */
  56611. export var backgroundVertexDeclaration: {
  56612. name: string;
  56613. shader: string;
  56614. };
  56615. }
  56616. declare module "babylonjs/Shaders/background.vertex" {
  56617. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  56618. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56619. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56620. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56621. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  56622. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  56623. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  56624. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56625. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56626. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  56627. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56628. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  56629. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  56630. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  56631. /** @hidden */
  56632. export var backgroundVertexShader: {
  56633. name: string;
  56634. shader: string;
  56635. };
  56636. }
  56637. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  56638. import { Nullable, int, float } from "babylonjs/types";
  56639. import { Scene } from "babylonjs/scene";
  56640. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56641. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56642. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56643. import { Mesh } from "babylonjs/Meshes/mesh";
  56644. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56645. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  56646. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  56647. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56648. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  56649. import { Color3 } from "babylonjs/Maths/math.color";
  56650. import "babylonjs/Shaders/background.fragment";
  56651. import "babylonjs/Shaders/background.vertex";
  56652. /**
  56653. * Background material used to create an efficient environement around your scene.
  56654. */
  56655. export class BackgroundMaterial extends PushMaterial {
  56656. /**
  56657. * Standard reflectance value at parallel view angle.
  56658. */
  56659. static StandardReflectance0: number;
  56660. /**
  56661. * Standard reflectance value at grazing angle.
  56662. */
  56663. static StandardReflectance90: number;
  56664. protected _primaryColor: Color3;
  56665. /**
  56666. * Key light Color (multiply against the environement texture)
  56667. */
  56668. primaryColor: Color3;
  56669. protected __perceptualColor: Nullable<Color3>;
  56670. /**
  56671. * Experimental Internal Use Only.
  56672. *
  56673. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56674. * This acts as a helper to set the primary color to a more "human friendly" value.
  56675. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56676. * output color as close as possible from the chosen value.
  56677. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56678. * part of lighting setup.)
  56679. */
  56680. get _perceptualColor(): Nullable<Color3>;
  56681. set _perceptualColor(value: Nullable<Color3>);
  56682. protected _primaryColorShadowLevel: float;
  56683. /**
  56684. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56685. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56686. */
  56687. get primaryColorShadowLevel(): float;
  56688. set primaryColorShadowLevel(value: float);
  56689. protected _primaryColorHighlightLevel: float;
  56690. /**
  56691. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56692. * The primary color is used at the level chosen to define what the white area would look.
  56693. */
  56694. get primaryColorHighlightLevel(): float;
  56695. set primaryColorHighlightLevel(value: float);
  56696. protected _reflectionTexture: Nullable<BaseTexture>;
  56697. /**
  56698. * Reflection Texture used in the material.
  56699. * Should be author in a specific way for the best result (refer to the documentation).
  56700. */
  56701. reflectionTexture: Nullable<BaseTexture>;
  56702. protected _reflectionBlur: float;
  56703. /**
  56704. * Reflection Texture level of blur.
  56705. *
  56706. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56707. * texture twice.
  56708. */
  56709. reflectionBlur: float;
  56710. protected _diffuseTexture: Nullable<BaseTexture>;
  56711. /**
  56712. * Diffuse Texture used in the material.
  56713. * Should be author in a specific way for the best result (refer to the documentation).
  56714. */
  56715. diffuseTexture: Nullable<BaseTexture>;
  56716. protected _shadowLights: Nullable<IShadowLight[]>;
  56717. /**
  56718. * Specify the list of lights casting shadow on the material.
  56719. * All scene shadow lights will be included if null.
  56720. */
  56721. shadowLights: Nullable<IShadowLight[]>;
  56722. protected _shadowLevel: float;
  56723. /**
  56724. * Helps adjusting the shadow to a softer level if required.
  56725. * 0 means black shadows and 1 means no shadows.
  56726. */
  56727. shadowLevel: float;
  56728. protected _sceneCenter: Vector3;
  56729. /**
  56730. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  56731. * It is usually zero but might be interesting to modify according to your setup.
  56732. */
  56733. sceneCenter: Vector3;
  56734. protected _opacityFresnel: boolean;
  56735. /**
  56736. * This helps specifying that the material is falling off to the sky box at grazing angle.
  56737. * This helps ensuring a nice transition when the camera goes under the ground.
  56738. */
  56739. opacityFresnel: boolean;
  56740. protected _reflectionFresnel: boolean;
  56741. /**
  56742. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  56743. * This helps adding a mirror texture on the ground.
  56744. */
  56745. reflectionFresnel: boolean;
  56746. protected _reflectionFalloffDistance: number;
  56747. /**
  56748. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  56749. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  56750. */
  56751. reflectionFalloffDistance: number;
  56752. protected _reflectionAmount: number;
  56753. /**
  56754. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  56755. */
  56756. reflectionAmount: number;
  56757. protected _reflectionReflectance0: number;
  56758. /**
  56759. * This specifies the weight of the reflection at grazing angle.
  56760. */
  56761. reflectionReflectance0: number;
  56762. protected _reflectionReflectance90: number;
  56763. /**
  56764. * This specifies the weight of the reflection at a perpendicular point of view.
  56765. */
  56766. reflectionReflectance90: number;
  56767. /**
  56768. * Sets the reflection reflectance fresnel values according to the default standard
  56769. * empirically know to work well :-)
  56770. */
  56771. set reflectionStandardFresnelWeight(value: number);
  56772. protected _useRGBColor: boolean;
  56773. /**
  56774. * Helps to directly use the maps channels instead of their level.
  56775. */
  56776. useRGBColor: boolean;
  56777. protected _enableNoise: boolean;
  56778. /**
  56779. * This helps reducing the banding effect that could occur on the background.
  56780. */
  56781. enableNoise: boolean;
  56782. /**
  56783. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56784. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  56785. * Recommended to be keep at 1.0 except for special cases.
  56786. */
  56787. get fovMultiplier(): number;
  56788. set fovMultiplier(value: number);
  56789. private _fovMultiplier;
  56790. /**
  56791. * Enable the FOV adjustment feature controlled by fovMultiplier.
  56792. */
  56793. useEquirectangularFOV: boolean;
  56794. private _maxSimultaneousLights;
  56795. /**
  56796. * Number of Simultaneous lights allowed on the material.
  56797. */
  56798. maxSimultaneousLights: int;
  56799. private _shadowOnly;
  56800. /**
  56801. * Make the material only render shadows
  56802. */
  56803. shadowOnly: boolean;
  56804. /**
  56805. * Default configuration related to image processing available in the Background Material.
  56806. */
  56807. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56808. /**
  56809. * Keep track of the image processing observer to allow dispose and replace.
  56810. */
  56811. private _imageProcessingObserver;
  56812. /**
  56813. * Attaches a new image processing configuration to the PBR Material.
  56814. * @param configuration (if null the scene configuration will be use)
  56815. */
  56816. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56817. /**
  56818. * Gets the image processing configuration used either in this material.
  56819. */
  56820. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  56821. /**
  56822. * Sets the Default image processing configuration used either in the this material.
  56823. *
  56824. * If sets to null, the scene one is in use.
  56825. */
  56826. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  56827. /**
  56828. * Gets wether the color curves effect is enabled.
  56829. */
  56830. get cameraColorCurvesEnabled(): boolean;
  56831. /**
  56832. * Sets wether the color curves effect is enabled.
  56833. */
  56834. set cameraColorCurvesEnabled(value: boolean);
  56835. /**
  56836. * Gets wether the color grading effect is enabled.
  56837. */
  56838. get cameraColorGradingEnabled(): boolean;
  56839. /**
  56840. * Gets wether the color grading effect is enabled.
  56841. */
  56842. set cameraColorGradingEnabled(value: boolean);
  56843. /**
  56844. * Gets wether tonemapping is enabled or not.
  56845. */
  56846. get cameraToneMappingEnabled(): boolean;
  56847. /**
  56848. * Sets wether tonemapping is enabled or not
  56849. */
  56850. set cameraToneMappingEnabled(value: boolean);
  56851. /**
  56852. * The camera exposure used on this material.
  56853. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56854. * This corresponds to a photographic exposure.
  56855. */
  56856. get cameraExposure(): float;
  56857. /**
  56858. * The camera exposure used on this material.
  56859. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56860. * This corresponds to a photographic exposure.
  56861. */
  56862. set cameraExposure(value: float);
  56863. /**
  56864. * Gets The camera contrast used on this material.
  56865. */
  56866. get cameraContrast(): float;
  56867. /**
  56868. * Sets The camera contrast used on this material.
  56869. */
  56870. set cameraContrast(value: float);
  56871. /**
  56872. * Gets the Color Grading 2D Lookup Texture.
  56873. */
  56874. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  56875. /**
  56876. * Sets the Color Grading 2D Lookup Texture.
  56877. */
  56878. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  56879. /**
  56880. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56881. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56882. * 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;
  56883. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56884. */
  56885. get cameraColorCurves(): Nullable<ColorCurves>;
  56886. /**
  56887. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56888. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56889. * 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;
  56890. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56891. */
  56892. set cameraColorCurves(value: Nullable<ColorCurves>);
  56893. /**
  56894. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  56895. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  56896. */
  56897. switchToBGR: boolean;
  56898. private _renderTargets;
  56899. private _reflectionControls;
  56900. private _white;
  56901. private _primaryShadowColor;
  56902. private _primaryHighlightColor;
  56903. /**
  56904. * Instantiates a Background Material in the given scene
  56905. * @param name The friendly name of the material
  56906. * @param scene The scene to add the material to
  56907. */
  56908. constructor(name: string, scene: Scene);
  56909. /**
  56910. * Gets a boolean indicating that current material needs to register RTT
  56911. */
  56912. get hasRenderTargetTextures(): boolean;
  56913. /**
  56914. * The entire material has been created in order to prevent overdraw.
  56915. * @returns false
  56916. */
  56917. needAlphaTesting(): boolean;
  56918. /**
  56919. * The entire material has been created in order to prevent overdraw.
  56920. * @returns true if blending is enable
  56921. */
  56922. needAlphaBlending(): boolean;
  56923. /**
  56924. * Checks wether the material is ready to be rendered for a given mesh.
  56925. * @param mesh The mesh to render
  56926. * @param subMesh The submesh to check against
  56927. * @param useInstances Specify wether or not the material is used with instances
  56928. * @returns true if all the dependencies are ready (Textures, Effects...)
  56929. */
  56930. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  56931. /**
  56932. * Compute the primary color according to the chosen perceptual color.
  56933. */
  56934. private _computePrimaryColorFromPerceptualColor;
  56935. /**
  56936. * Compute the highlights and shadow colors according to their chosen levels.
  56937. */
  56938. private _computePrimaryColors;
  56939. /**
  56940. * Build the uniform buffer used in the material.
  56941. */
  56942. buildUniformLayout(): void;
  56943. /**
  56944. * Unbind the material.
  56945. */
  56946. unbind(): void;
  56947. /**
  56948. * Bind only the world matrix to the material.
  56949. * @param world The world matrix to bind.
  56950. */
  56951. bindOnlyWorldMatrix(world: Matrix): void;
  56952. /**
  56953. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  56954. * @param world The world matrix to bind.
  56955. * @param subMesh The submesh to bind for.
  56956. */
  56957. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  56958. /**
  56959. * Checks to see if a texture is used in the material.
  56960. * @param texture - Base texture to use.
  56961. * @returns - Boolean specifying if a texture is used in the material.
  56962. */
  56963. hasTexture(texture: BaseTexture): boolean;
  56964. /**
  56965. * Dispose the material.
  56966. * @param forceDisposeEffect Force disposal of the associated effect.
  56967. * @param forceDisposeTextures Force disposal of the associated textures.
  56968. */
  56969. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  56970. /**
  56971. * Clones the material.
  56972. * @param name The cloned name.
  56973. * @returns The cloned material.
  56974. */
  56975. clone(name: string): BackgroundMaterial;
  56976. /**
  56977. * Serializes the current material to its JSON representation.
  56978. * @returns The JSON representation.
  56979. */
  56980. serialize(): any;
  56981. /**
  56982. * Gets the class name of the material
  56983. * @returns "BackgroundMaterial"
  56984. */
  56985. getClassName(): string;
  56986. /**
  56987. * Parse a JSON input to create back a background material.
  56988. * @param source The JSON data to parse
  56989. * @param scene The scene to create the parsed material in
  56990. * @param rootUrl The root url of the assets the material depends upon
  56991. * @returns the instantiated BackgroundMaterial.
  56992. */
  56993. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  56994. }
  56995. }
  56996. declare module "babylonjs/Helpers/environmentHelper" {
  56997. import { Observable } from "babylonjs/Misc/observable";
  56998. import { Nullable } from "babylonjs/types";
  56999. import { Scene } from "babylonjs/scene";
  57000. import { Vector3 } from "babylonjs/Maths/math.vector";
  57001. import { Color3 } from "babylonjs/Maths/math.color";
  57002. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57003. import { Mesh } from "babylonjs/Meshes/mesh";
  57004. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57005. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  57006. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57007. import "babylonjs/Meshes/Builders/planeBuilder";
  57008. import "babylonjs/Meshes/Builders/boxBuilder";
  57009. /**
  57010. * Represents the different options available during the creation of
  57011. * a Environment helper.
  57012. *
  57013. * This can control the default ground, skybox and image processing setup of your scene.
  57014. */
  57015. export interface IEnvironmentHelperOptions {
  57016. /**
  57017. * Specifies whether or not to create a ground.
  57018. * True by default.
  57019. */
  57020. createGround: boolean;
  57021. /**
  57022. * Specifies the ground size.
  57023. * 15 by default.
  57024. */
  57025. groundSize: number;
  57026. /**
  57027. * The texture used on the ground for the main color.
  57028. * Comes from the BabylonJS CDN by default.
  57029. *
  57030. * Remarks: Can be either a texture or a url.
  57031. */
  57032. groundTexture: string | BaseTexture;
  57033. /**
  57034. * The color mixed in the ground texture by default.
  57035. * BabylonJS clearColor by default.
  57036. */
  57037. groundColor: Color3;
  57038. /**
  57039. * Specifies the ground opacity.
  57040. * 1 by default.
  57041. */
  57042. groundOpacity: number;
  57043. /**
  57044. * Enables the ground to receive shadows.
  57045. * True by default.
  57046. */
  57047. enableGroundShadow: boolean;
  57048. /**
  57049. * Helps preventing the shadow to be fully black on the ground.
  57050. * 0.5 by default.
  57051. */
  57052. groundShadowLevel: number;
  57053. /**
  57054. * Creates a mirror texture attach to the ground.
  57055. * false by default.
  57056. */
  57057. enableGroundMirror: boolean;
  57058. /**
  57059. * Specifies the ground mirror size ratio.
  57060. * 0.3 by default as the default kernel is 64.
  57061. */
  57062. groundMirrorSizeRatio: number;
  57063. /**
  57064. * Specifies the ground mirror blur kernel size.
  57065. * 64 by default.
  57066. */
  57067. groundMirrorBlurKernel: number;
  57068. /**
  57069. * Specifies the ground mirror visibility amount.
  57070. * 1 by default
  57071. */
  57072. groundMirrorAmount: number;
  57073. /**
  57074. * Specifies the ground mirror reflectance weight.
  57075. * This uses the standard weight of the background material to setup the fresnel effect
  57076. * of the mirror.
  57077. * 1 by default.
  57078. */
  57079. groundMirrorFresnelWeight: number;
  57080. /**
  57081. * Specifies the ground mirror Falloff distance.
  57082. * This can helps reducing the size of the reflection.
  57083. * 0 by Default.
  57084. */
  57085. groundMirrorFallOffDistance: number;
  57086. /**
  57087. * Specifies the ground mirror texture type.
  57088. * Unsigned Int by Default.
  57089. */
  57090. groundMirrorTextureType: number;
  57091. /**
  57092. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  57093. * the shown objects.
  57094. */
  57095. groundYBias: number;
  57096. /**
  57097. * Specifies whether or not to create a skybox.
  57098. * True by default.
  57099. */
  57100. createSkybox: boolean;
  57101. /**
  57102. * Specifies the skybox size.
  57103. * 20 by default.
  57104. */
  57105. skyboxSize: number;
  57106. /**
  57107. * The texture used on the skybox for the main color.
  57108. * Comes from the BabylonJS CDN by default.
  57109. *
  57110. * Remarks: Can be either a texture or a url.
  57111. */
  57112. skyboxTexture: string | BaseTexture;
  57113. /**
  57114. * The color mixed in the skybox texture by default.
  57115. * BabylonJS clearColor by default.
  57116. */
  57117. skyboxColor: Color3;
  57118. /**
  57119. * The background rotation around the Y axis of the scene.
  57120. * This helps aligning the key lights of your scene with the background.
  57121. * 0 by default.
  57122. */
  57123. backgroundYRotation: number;
  57124. /**
  57125. * Compute automatically the size of the elements to best fit with the scene.
  57126. */
  57127. sizeAuto: boolean;
  57128. /**
  57129. * Default position of the rootMesh if autoSize is not true.
  57130. */
  57131. rootPosition: Vector3;
  57132. /**
  57133. * Sets up the image processing in the scene.
  57134. * true by default.
  57135. */
  57136. setupImageProcessing: boolean;
  57137. /**
  57138. * The texture used as your environment texture in the scene.
  57139. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  57140. *
  57141. * Remarks: Can be either a texture or a url.
  57142. */
  57143. environmentTexture: string | BaseTexture;
  57144. /**
  57145. * The value of the exposure to apply to the scene.
  57146. * 0.6 by default if setupImageProcessing is true.
  57147. */
  57148. cameraExposure: number;
  57149. /**
  57150. * The value of the contrast to apply to the scene.
  57151. * 1.6 by default if setupImageProcessing is true.
  57152. */
  57153. cameraContrast: number;
  57154. /**
  57155. * Specifies whether or not tonemapping should be enabled in the scene.
  57156. * true by default if setupImageProcessing is true.
  57157. */
  57158. toneMappingEnabled: boolean;
  57159. }
  57160. /**
  57161. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  57162. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  57163. * It also helps with the default setup of your imageProcessing configuration.
  57164. */
  57165. export class EnvironmentHelper {
  57166. /**
  57167. * Default ground texture URL.
  57168. */
  57169. private static _groundTextureCDNUrl;
  57170. /**
  57171. * Default skybox texture URL.
  57172. */
  57173. private static _skyboxTextureCDNUrl;
  57174. /**
  57175. * Default environment texture URL.
  57176. */
  57177. private static _environmentTextureCDNUrl;
  57178. /**
  57179. * Creates the default options for the helper.
  57180. */
  57181. private static _getDefaultOptions;
  57182. private _rootMesh;
  57183. /**
  57184. * Gets the root mesh created by the helper.
  57185. */
  57186. get rootMesh(): Mesh;
  57187. private _skybox;
  57188. /**
  57189. * Gets the skybox created by the helper.
  57190. */
  57191. get skybox(): Nullable<Mesh>;
  57192. private _skyboxTexture;
  57193. /**
  57194. * Gets the skybox texture created by the helper.
  57195. */
  57196. get skyboxTexture(): Nullable<BaseTexture>;
  57197. private _skyboxMaterial;
  57198. /**
  57199. * Gets the skybox material created by the helper.
  57200. */
  57201. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  57202. private _ground;
  57203. /**
  57204. * Gets the ground mesh created by the helper.
  57205. */
  57206. get ground(): Nullable<Mesh>;
  57207. private _groundTexture;
  57208. /**
  57209. * Gets the ground texture created by the helper.
  57210. */
  57211. get groundTexture(): Nullable<BaseTexture>;
  57212. private _groundMirror;
  57213. /**
  57214. * Gets the ground mirror created by the helper.
  57215. */
  57216. get groundMirror(): Nullable<MirrorTexture>;
  57217. /**
  57218. * Gets the ground mirror render list to helps pushing the meshes
  57219. * you wish in the ground reflection.
  57220. */
  57221. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  57222. private _groundMaterial;
  57223. /**
  57224. * Gets the ground material created by the helper.
  57225. */
  57226. get groundMaterial(): Nullable<BackgroundMaterial>;
  57227. /**
  57228. * Stores the creation options.
  57229. */
  57230. private readonly _scene;
  57231. private _options;
  57232. /**
  57233. * This observable will be notified with any error during the creation of the environment,
  57234. * mainly texture creation errors.
  57235. */
  57236. onErrorObservable: Observable<{
  57237. message?: string;
  57238. exception?: any;
  57239. }>;
  57240. /**
  57241. * constructor
  57242. * @param options Defines the options we want to customize the helper
  57243. * @param scene The scene to add the material to
  57244. */
  57245. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  57246. /**
  57247. * Updates the background according to the new options
  57248. * @param options
  57249. */
  57250. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  57251. /**
  57252. * Sets the primary color of all the available elements.
  57253. * @param color the main color to affect to the ground and the background
  57254. */
  57255. setMainColor(color: Color3): void;
  57256. /**
  57257. * Setup the image processing according to the specified options.
  57258. */
  57259. private _setupImageProcessing;
  57260. /**
  57261. * Setup the environment texture according to the specified options.
  57262. */
  57263. private _setupEnvironmentTexture;
  57264. /**
  57265. * Setup the background according to the specified options.
  57266. */
  57267. private _setupBackground;
  57268. /**
  57269. * Get the scene sizes according to the setup.
  57270. */
  57271. private _getSceneSize;
  57272. /**
  57273. * Setup the ground according to the specified options.
  57274. */
  57275. private _setupGround;
  57276. /**
  57277. * Setup the ground material according to the specified options.
  57278. */
  57279. private _setupGroundMaterial;
  57280. /**
  57281. * Setup the ground diffuse texture according to the specified options.
  57282. */
  57283. private _setupGroundDiffuseTexture;
  57284. /**
  57285. * Setup the ground mirror texture according to the specified options.
  57286. */
  57287. private _setupGroundMirrorTexture;
  57288. /**
  57289. * Setup the ground to receive the mirror texture.
  57290. */
  57291. private _setupMirrorInGroundMaterial;
  57292. /**
  57293. * Setup the skybox according to the specified options.
  57294. */
  57295. private _setupSkybox;
  57296. /**
  57297. * Setup the skybox material according to the specified options.
  57298. */
  57299. private _setupSkyboxMaterial;
  57300. /**
  57301. * Setup the skybox reflection texture according to the specified options.
  57302. */
  57303. private _setupSkyboxReflectionTexture;
  57304. private _errorHandler;
  57305. /**
  57306. * Dispose all the elements created by the Helper.
  57307. */
  57308. dispose(): void;
  57309. }
  57310. }
  57311. declare module "babylonjs/Helpers/textureDome" {
  57312. import { Scene } from "babylonjs/scene";
  57313. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57314. import { Mesh } from "babylonjs/Meshes/mesh";
  57315. import { Texture } from "babylonjs/Materials/Textures/texture";
  57316. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57317. import "babylonjs/Meshes/Builders/sphereBuilder";
  57318. import { Nullable } from "babylonjs/types";
  57319. import { Observable } from "babylonjs/Misc/observable";
  57320. /**
  57321. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  57322. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  57323. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57324. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57325. */
  57326. export abstract class TextureDome<T extends Texture> extends TransformNode {
  57327. protected onError: Nullable<(message?: string, exception?: any) => void>;
  57328. /**
  57329. * Define the source as a Monoscopic panoramic 360/180.
  57330. */
  57331. static readonly MODE_MONOSCOPIC: number;
  57332. /**
  57333. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  57334. */
  57335. static readonly MODE_TOPBOTTOM: number;
  57336. /**
  57337. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  57338. */
  57339. static readonly MODE_SIDEBYSIDE: number;
  57340. private _halfDome;
  57341. protected _useDirectMapping: boolean;
  57342. /**
  57343. * The texture being displayed on the sphere
  57344. */
  57345. protected _texture: T;
  57346. /**
  57347. * Gets the texture being displayed on the sphere
  57348. */
  57349. get texture(): T;
  57350. /**
  57351. * Sets the texture being displayed on the sphere
  57352. */
  57353. set texture(newTexture: T);
  57354. /**
  57355. * The skybox material
  57356. */
  57357. protected _material: BackgroundMaterial;
  57358. /**
  57359. * The surface used for the dome
  57360. */
  57361. protected _mesh: Mesh;
  57362. /**
  57363. * Gets the mesh used for the dome.
  57364. */
  57365. get mesh(): Mesh;
  57366. /**
  57367. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  57368. */
  57369. private _halfDomeMask;
  57370. /**
  57371. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57372. * Also see the options.resolution property.
  57373. */
  57374. get fovMultiplier(): number;
  57375. set fovMultiplier(value: number);
  57376. protected _textureMode: number;
  57377. /**
  57378. * Gets or set the current texture mode for the texture. It can be:
  57379. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57380. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57381. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57382. */
  57383. get textureMode(): number;
  57384. /**
  57385. * Sets the current texture mode for the texture. It can be:
  57386. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57387. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57388. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57389. */
  57390. set textureMode(value: number);
  57391. /**
  57392. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  57393. */
  57394. get halfDome(): boolean;
  57395. /**
  57396. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  57397. */
  57398. set halfDome(enabled: boolean);
  57399. /**
  57400. * Oberserver used in Stereoscopic VR Mode.
  57401. */
  57402. private _onBeforeCameraRenderObserver;
  57403. /**
  57404. * Observable raised when an error occured while loading the 360 image
  57405. */
  57406. onLoadErrorObservable: Observable<string>;
  57407. /**
  57408. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  57409. * @param name Element's name, child elements will append suffixes for their own names.
  57410. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  57411. * @param options An object containing optional or exposed sub element properties
  57412. */
  57413. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  57414. resolution?: number;
  57415. clickToPlay?: boolean;
  57416. autoPlay?: boolean;
  57417. loop?: boolean;
  57418. size?: number;
  57419. poster?: string;
  57420. faceForward?: boolean;
  57421. useDirectMapping?: boolean;
  57422. halfDomeMode?: boolean;
  57423. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  57424. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  57425. protected _changeTextureMode(value: number): void;
  57426. /**
  57427. * Releases resources associated with this node.
  57428. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  57429. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  57430. */
  57431. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  57432. }
  57433. }
  57434. declare module "babylonjs/Helpers/photoDome" {
  57435. import { Scene } from "babylonjs/scene";
  57436. import { Texture } from "babylonjs/Materials/Textures/texture";
  57437. import { TextureDome } from "babylonjs/Helpers/textureDome";
  57438. /**
  57439. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  57440. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  57441. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57442. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57443. */
  57444. export class PhotoDome extends TextureDome<Texture> {
  57445. /**
  57446. * Define the image as a Monoscopic panoramic 360 image.
  57447. */
  57448. static readonly MODE_MONOSCOPIC: number;
  57449. /**
  57450. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57451. */
  57452. static readonly MODE_TOPBOTTOM: number;
  57453. /**
  57454. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57455. */
  57456. static readonly MODE_SIDEBYSIDE: number;
  57457. /**
  57458. * Gets or sets the texture being displayed on the sphere
  57459. */
  57460. get photoTexture(): Texture;
  57461. /**
  57462. * sets the texture being displayed on the sphere
  57463. */
  57464. set photoTexture(value: Texture);
  57465. /**
  57466. * Gets the current video mode for the video. It can be:
  57467. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57468. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57469. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57470. */
  57471. get imageMode(): number;
  57472. /**
  57473. * Sets the current video mode for the video. It can be:
  57474. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57475. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57476. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57477. */
  57478. set imageMode(value: number);
  57479. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  57480. }
  57481. }
  57482. declare module "babylonjs/Misc/rgbdTextureTools" {
  57483. import "babylonjs/Shaders/rgbdDecode.fragment";
  57484. import "babylonjs/Engines/Extensions/engine.renderTarget";
  57485. import { Texture } from "babylonjs/Materials/Textures/texture";
  57486. /**
  57487. * Class used to host RGBD texture specific utilities
  57488. */
  57489. export class RGBDTextureTools {
  57490. /**
  57491. * Expand the RGBD Texture from RGBD to Half Float if possible.
  57492. * @param texture the texture to expand.
  57493. */
  57494. static ExpandRGBDTexture(texture: Texture): void;
  57495. }
  57496. }
  57497. declare module "babylonjs/Misc/brdfTextureTools" {
  57498. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57499. import { Scene } from "babylonjs/scene";
  57500. /**
  57501. * Class used to host texture specific utilities
  57502. */
  57503. export class BRDFTextureTools {
  57504. /**
  57505. * Prevents texture cache collision
  57506. */
  57507. private static _instanceNumber;
  57508. /**
  57509. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  57510. * @param scene defines the hosting scene
  57511. * @returns the environment BRDF texture
  57512. */
  57513. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  57514. private static _environmentBRDFBase64Texture;
  57515. }
  57516. }
  57517. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  57518. import { Nullable } from "babylonjs/types";
  57519. import { Color3 } from "babylonjs/Maths/math.color";
  57520. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57521. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57522. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57523. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57524. import { Engine } from "babylonjs/Engines/engine";
  57525. import { Scene } from "babylonjs/scene";
  57526. /**
  57527. * @hidden
  57528. */
  57529. export interface IMaterialClearCoatDefines {
  57530. CLEARCOAT: boolean;
  57531. CLEARCOAT_DEFAULTIOR: boolean;
  57532. CLEARCOAT_TEXTURE: boolean;
  57533. CLEARCOAT_TEXTUREDIRECTUV: number;
  57534. CLEARCOAT_BUMP: boolean;
  57535. CLEARCOAT_BUMPDIRECTUV: number;
  57536. CLEARCOAT_TINT: boolean;
  57537. CLEARCOAT_TINT_TEXTURE: boolean;
  57538. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  57539. /** @hidden */
  57540. _areTexturesDirty: boolean;
  57541. }
  57542. /**
  57543. * Define the code related to the clear coat parameters of the pbr material.
  57544. */
  57545. export class PBRClearCoatConfiguration {
  57546. /**
  57547. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57548. * The default fits with a polyurethane material.
  57549. */
  57550. private static readonly _DefaultIndexOfRefraction;
  57551. private _isEnabled;
  57552. /**
  57553. * Defines if the clear coat is enabled in the material.
  57554. */
  57555. isEnabled: boolean;
  57556. /**
  57557. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  57558. */
  57559. intensity: number;
  57560. /**
  57561. * Defines the clear coat layer roughness.
  57562. */
  57563. roughness: number;
  57564. private _indexOfRefraction;
  57565. /**
  57566. * Defines the index of refraction of the clear coat.
  57567. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57568. * The default fits with a polyurethane material.
  57569. * Changing the default value is more performance intensive.
  57570. */
  57571. indexOfRefraction: number;
  57572. private _texture;
  57573. /**
  57574. * Stores the clear coat values in a texture.
  57575. */
  57576. texture: Nullable<BaseTexture>;
  57577. private _bumpTexture;
  57578. /**
  57579. * Define the clear coat specific bump texture.
  57580. */
  57581. bumpTexture: Nullable<BaseTexture>;
  57582. private _isTintEnabled;
  57583. /**
  57584. * Defines if the clear coat tint is enabled in the material.
  57585. */
  57586. isTintEnabled: boolean;
  57587. /**
  57588. * Defines the clear coat tint of the material.
  57589. * This is only use if tint is enabled
  57590. */
  57591. tintColor: Color3;
  57592. /**
  57593. * Defines the distance at which the tint color should be found in the
  57594. * clear coat media.
  57595. * This is only use if tint is enabled
  57596. */
  57597. tintColorAtDistance: number;
  57598. /**
  57599. * Defines the clear coat layer thickness.
  57600. * This is only use if tint is enabled
  57601. */
  57602. tintThickness: number;
  57603. private _tintTexture;
  57604. /**
  57605. * Stores the clear tint values in a texture.
  57606. * rgb is tint
  57607. * a is a thickness factor
  57608. */
  57609. tintTexture: Nullable<BaseTexture>;
  57610. /** @hidden */
  57611. private _internalMarkAllSubMeshesAsTexturesDirty;
  57612. /** @hidden */
  57613. _markAllSubMeshesAsTexturesDirty(): void;
  57614. /**
  57615. * Instantiate a new istance of clear coat configuration.
  57616. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57617. */
  57618. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57619. /**
  57620. * Gets wehter the submesh is ready to be used or not.
  57621. * @param defines the list of "defines" to update.
  57622. * @param scene defines the scene the material belongs to.
  57623. * @param engine defines the engine the material belongs to.
  57624. * @param disableBumpMap defines wether the material disables bump or not.
  57625. * @returns - boolean indicating that the submesh is ready or not.
  57626. */
  57627. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  57628. /**
  57629. * Checks to see if a texture is used in the material.
  57630. * @param defines the list of "defines" to update.
  57631. * @param scene defines the scene to the material belongs to.
  57632. */
  57633. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  57634. /**
  57635. * Binds the material data.
  57636. * @param uniformBuffer defines the Uniform buffer to fill in.
  57637. * @param scene defines the scene the material belongs to.
  57638. * @param engine defines the engine the material belongs to.
  57639. * @param disableBumpMap defines wether the material disables bump or not.
  57640. * @param isFrozen defines wether the material is frozen or not.
  57641. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57642. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57643. */
  57644. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  57645. /**
  57646. * Checks to see if a texture is used in the material.
  57647. * @param texture - Base texture to use.
  57648. * @returns - Boolean specifying if a texture is used in the material.
  57649. */
  57650. hasTexture(texture: BaseTexture): boolean;
  57651. /**
  57652. * Returns an array of the actively used textures.
  57653. * @param activeTextures Array of BaseTextures
  57654. */
  57655. getActiveTextures(activeTextures: BaseTexture[]): void;
  57656. /**
  57657. * Returns the animatable textures.
  57658. * @param animatables Array of animatable textures.
  57659. */
  57660. getAnimatables(animatables: IAnimatable[]): void;
  57661. /**
  57662. * Disposes the resources of the material.
  57663. * @param forceDisposeTextures - Forces the disposal of all textures.
  57664. */
  57665. dispose(forceDisposeTextures?: boolean): void;
  57666. /**
  57667. * Get the current class name of the texture useful for serialization or dynamic coding.
  57668. * @returns "PBRClearCoatConfiguration"
  57669. */
  57670. getClassName(): string;
  57671. /**
  57672. * Add fallbacks to the effect fallbacks list.
  57673. * @param defines defines the Base texture to use.
  57674. * @param fallbacks defines the current fallback list.
  57675. * @param currentRank defines the current fallback rank.
  57676. * @returns the new fallback rank.
  57677. */
  57678. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57679. /**
  57680. * Add the required uniforms to the current list.
  57681. * @param uniforms defines the current uniform list.
  57682. */
  57683. static AddUniforms(uniforms: string[]): void;
  57684. /**
  57685. * Add the required samplers to the current list.
  57686. * @param samplers defines the current sampler list.
  57687. */
  57688. static AddSamplers(samplers: string[]): void;
  57689. /**
  57690. * Add the required uniforms to the current buffer.
  57691. * @param uniformBuffer defines the current uniform buffer.
  57692. */
  57693. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57694. /**
  57695. * Makes a duplicate of the current configuration into another one.
  57696. * @param clearCoatConfiguration define the config where to copy the info
  57697. */
  57698. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  57699. /**
  57700. * Serializes this clear coat configuration.
  57701. * @returns - An object with the serialized config.
  57702. */
  57703. serialize(): any;
  57704. /**
  57705. * Parses a anisotropy Configuration from a serialized object.
  57706. * @param source - Serialized object.
  57707. * @param scene Defines the scene we are parsing for
  57708. * @param rootUrl Defines the rootUrl to load from
  57709. */
  57710. parse(source: any, scene: Scene, rootUrl: string): void;
  57711. }
  57712. }
  57713. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  57714. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57715. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57716. import { Vector2 } from "babylonjs/Maths/math.vector";
  57717. import { Scene } from "babylonjs/scene";
  57718. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57719. import { Nullable } from "babylonjs/types";
  57720. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57721. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57722. /**
  57723. * @hidden
  57724. */
  57725. export interface IMaterialAnisotropicDefines {
  57726. ANISOTROPIC: boolean;
  57727. ANISOTROPIC_TEXTURE: boolean;
  57728. ANISOTROPIC_TEXTUREDIRECTUV: number;
  57729. MAINUV1: boolean;
  57730. _areTexturesDirty: boolean;
  57731. _needUVs: boolean;
  57732. }
  57733. /**
  57734. * Define the code related to the anisotropic parameters of the pbr material.
  57735. */
  57736. export class PBRAnisotropicConfiguration {
  57737. private _isEnabled;
  57738. /**
  57739. * Defines if the anisotropy is enabled in the material.
  57740. */
  57741. isEnabled: boolean;
  57742. /**
  57743. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  57744. */
  57745. intensity: number;
  57746. /**
  57747. * Defines if the effect is along the tangents, bitangents or in between.
  57748. * By default, the effect is "strectching" the highlights along the tangents.
  57749. */
  57750. direction: Vector2;
  57751. private _texture;
  57752. /**
  57753. * Stores the anisotropy values in a texture.
  57754. * rg is direction (like normal from -1 to 1)
  57755. * b is a intensity
  57756. */
  57757. texture: Nullable<BaseTexture>;
  57758. /** @hidden */
  57759. private _internalMarkAllSubMeshesAsTexturesDirty;
  57760. /** @hidden */
  57761. _markAllSubMeshesAsTexturesDirty(): void;
  57762. /**
  57763. * Instantiate a new istance of anisotropy configuration.
  57764. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57765. */
  57766. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57767. /**
  57768. * Specifies that the submesh is ready to be used.
  57769. * @param defines the list of "defines" to update.
  57770. * @param scene defines the scene the material belongs to.
  57771. * @returns - boolean indicating that the submesh is ready or not.
  57772. */
  57773. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  57774. /**
  57775. * Checks to see if a texture is used in the material.
  57776. * @param defines the list of "defines" to update.
  57777. * @param mesh the mesh we are preparing the defines for.
  57778. * @param scene defines the scene the material belongs to.
  57779. */
  57780. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  57781. /**
  57782. * Binds the material data.
  57783. * @param uniformBuffer defines the Uniform buffer to fill in.
  57784. * @param scene defines the scene the material belongs to.
  57785. * @param isFrozen defines wether the material is frozen or not.
  57786. */
  57787. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57788. /**
  57789. * Checks to see if a texture is used in the material.
  57790. * @param texture - Base texture to use.
  57791. * @returns - Boolean specifying if a texture is used in the material.
  57792. */
  57793. hasTexture(texture: BaseTexture): boolean;
  57794. /**
  57795. * Returns an array of the actively used textures.
  57796. * @param activeTextures Array of BaseTextures
  57797. */
  57798. getActiveTextures(activeTextures: BaseTexture[]): void;
  57799. /**
  57800. * Returns the animatable textures.
  57801. * @param animatables Array of animatable textures.
  57802. */
  57803. getAnimatables(animatables: IAnimatable[]): void;
  57804. /**
  57805. * Disposes the resources of the material.
  57806. * @param forceDisposeTextures - Forces the disposal of all textures.
  57807. */
  57808. dispose(forceDisposeTextures?: boolean): void;
  57809. /**
  57810. * Get the current class name of the texture useful for serialization or dynamic coding.
  57811. * @returns "PBRAnisotropicConfiguration"
  57812. */
  57813. getClassName(): string;
  57814. /**
  57815. * Add fallbacks to the effect fallbacks list.
  57816. * @param defines defines the Base texture to use.
  57817. * @param fallbacks defines the current fallback list.
  57818. * @param currentRank defines the current fallback rank.
  57819. * @returns the new fallback rank.
  57820. */
  57821. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57822. /**
  57823. * Add the required uniforms to the current list.
  57824. * @param uniforms defines the current uniform list.
  57825. */
  57826. static AddUniforms(uniforms: string[]): void;
  57827. /**
  57828. * Add the required uniforms to the current buffer.
  57829. * @param uniformBuffer defines the current uniform buffer.
  57830. */
  57831. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57832. /**
  57833. * Add the required samplers to the current list.
  57834. * @param samplers defines the current sampler list.
  57835. */
  57836. static AddSamplers(samplers: string[]): void;
  57837. /**
  57838. * Makes a duplicate of the current configuration into another one.
  57839. * @param anisotropicConfiguration define the config where to copy the info
  57840. */
  57841. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  57842. /**
  57843. * Serializes this anisotropy configuration.
  57844. * @returns - An object with the serialized config.
  57845. */
  57846. serialize(): any;
  57847. /**
  57848. * Parses a anisotropy Configuration from a serialized object.
  57849. * @param source - Serialized object.
  57850. * @param scene Defines the scene we are parsing for
  57851. * @param rootUrl Defines the rootUrl to load from
  57852. */
  57853. parse(source: any, scene: Scene, rootUrl: string): void;
  57854. }
  57855. }
  57856. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  57857. import { Scene } from "babylonjs/scene";
  57858. /**
  57859. * @hidden
  57860. */
  57861. export interface IMaterialBRDFDefines {
  57862. BRDF_V_HEIGHT_CORRELATED: boolean;
  57863. MS_BRDF_ENERGY_CONSERVATION: boolean;
  57864. SPHERICAL_HARMONICS: boolean;
  57865. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  57866. /** @hidden */
  57867. _areMiscDirty: boolean;
  57868. }
  57869. /**
  57870. * Define the code related to the BRDF parameters of the pbr material.
  57871. */
  57872. export class PBRBRDFConfiguration {
  57873. /**
  57874. * Default value used for the energy conservation.
  57875. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57876. */
  57877. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  57878. /**
  57879. * Default value used for the Smith Visibility Height Correlated mode.
  57880. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57881. */
  57882. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  57883. /**
  57884. * Default value used for the IBL diffuse part.
  57885. * This can help switching back to the polynomials mode globally which is a tiny bit
  57886. * less GPU intensive at the drawback of a lower quality.
  57887. */
  57888. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  57889. /**
  57890. * Default value used for activating energy conservation for the specular workflow.
  57891. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57892. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57893. */
  57894. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  57895. private _useEnergyConservation;
  57896. /**
  57897. * Defines if the material uses energy conservation.
  57898. */
  57899. useEnergyConservation: boolean;
  57900. private _useSmithVisibilityHeightCorrelated;
  57901. /**
  57902. * LEGACY Mode set to false
  57903. * Defines if the material uses height smith correlated visibility term.
  57904. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  57905. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  57906. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  57907. * Not relying on height correlated will also disable energy conservation.
  57908. */
  57909. useSmithVisibilityHeightCorrelated: boolean;
  57910. private _useSphericalHarmonics;
  57911. /**
  57912. * LEGACY Mode set to false
  57913. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  57914. * diffuse part of the IBL.
  57915. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  57916. * to the ground truth.
  57917. */
  57918. useSphericalHarmonics: boolean;
  57919. private _useSpecularGlossinessInputEnergyConservation;
  57920. /**
  57921. * Defines if the material uses energy conservation, when the specular workflow is active.
  57922. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57923. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57924. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  57925. */
  57926. useSpecularGlossinessInputEnergyConservation: boolean;
  57927. /** @hidden */
  57928. private _internalMarkAllSubMeshesAsMiscDirty;
  57929. /** @hidden */
  57930. _markAllSubMeshesAsMiscDirty(): void;
  57931. /**
  57932. * Instantiate a new istance of clear coat configuration.
  57933. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  57934. */
  57935. constructor(markAllSubMeshesAsMiscDirty: () => void);
  57936. /**
  57937. * Checks to see if a texture is used in the material.
  57938. * @param defines the list of "defines" to update.
  57939. */
  57940. prepareDefines(defines: IMaterialBRDFDefines): void;
  57941. /**
  57942. * Get the current class name of the texture useful for serialization or dynamic coding.
  57943. * @returns "PBRClearCoatConfiguration"
  57944. */
  57945. getClassName(): string;
  57946. /**
  57947. * Makes a duplicate of the current configuration into another one.
  57948. * @param brdfConfiguration define the config where to copy the info
  57949. */
  57950. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  57951. /**
  57952. * Serializes this BRDF configuration.
  57953. * @returns - An object with the serialized config.
  57954. */
  57955. serialize(): any;
  57956. /**
  57957. * Parses a anisotropy Configuration from a serialized object.
  57958. * @param source - Serialized object.
  57959. * @param scene Defines the scene we are parsing for
  57960. * @param rootUrl Defines the rootUrl to load from
  57961. */
  57962. parse(source: any, scene: Scene, rootUrl: string): void;
  57963. }
  57964. }
  57965. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  57966. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57967. import { Color3 } from "babylonjs/Maths/math.color";
  57968. import { Scene } from "babylonjs/scene";
  57969. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57970. import { Nullable } from "babylonjs/types";
  57971. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57972. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57973. /**
  57974. * @hidden
  57975. */
  57976. export interface IMaterialSheenDefines {
  57977. SHEEN: boolean;
  57978. SHEEN_TEXTURE: boolean;
  57979. SHEEN_TEXTUREDIRECTUV: number;
  57980. SHEEN_LINKWITHALBEDO: boolean;
  57981. SHEEN_ROUGHNESS: boolean;
  57982. SHEEN_ALBEDOSCALING: boolean;
  57983. /** @hidden */
  57984. _areTexturesDirty: boolean;
  57985. }
  57986. /**
  57987. * Define the code related to the Sheen parameters of the pbr material.
  57988. */
  57989. export class PBRSheenConfiguration {
  57990. private _isEnabled;
  57991. /**
  57992. * Defines if the material uses sheen.
  57993. */
  57994. isEnabled: boolean;
  57995. private _linkSheenWithAlbedo;
  57996. /**
  57997. * Defines if the sheen is linked to the sheen color.
  57998. */
  57999. linkSheenWithAlbedo: boolean;
  58000. /**
  58001. * Defines the sheen intensity.
  58002. */
  58003. intensity: number;
  58004. /**
  58005. * Defines the sheen color.
  58006. */
  58007. color: Color3;
  58008. private _texture;
  58009. /**
  58010. * Stores the sheen tint values in a texture.
  58011. * rgb is tint
  58012. * a is a intensity or roughness if roughness has been defined
  58013. */
  58014. texture: Nullable<BaseTexture>;
  58015. private _roughness;
  58016. /**
  58017. * Defines the sheen roughness.
  58018. * It is not taken into account if linkSheenWithAlbedo is true.
  58019. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  58020. */
  58021. roughness: Nullable<number>;
  58022. private _albedoScaling;
  58023. /**
  58024. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  58025. * It allows the strength of the sheen effect to not depend on the base color of the material,
  58026. * making it easier to setup and tweak the effect
  58027. */
  58028. albedoScaling: boolean;
  58029. /** @hidden */
  58030. private _internalMarkAllSubMeshesAsTexturesDirty;
  58031. /** @hidden */
  58032. _markAllSubMeshesAsTexturesDirty(): void;
  58033. /**
  58034. * Instantiate a new istance of clear coat configuration.
  58035. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58036. */
  58037. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  58038. /**
  58039. * Specifies that the submesh is ready to be used.
  58040. * @param defines the list of "defines" to update.
  58041. * @param scene defines the scene the material belongs to.
  58042. * @returns - boolean indicating that the submesh is ready or not.
  58043. */
  58044. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  58045. /**
  58046. * Checks to see if a texture is used in the material.
  58047. * @param defines the list of "defines" to update.
  58048. * @param scene defines the scene the material belongs to.
  58049. */
  58050. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  58051. /**
  58052. * Binds the material data.
  58053. * @param uniformBuffer defines the Uniform buffer to fill in.
  58054. * @param scene defines the scene the material belongs to.
  58055. * @param isFrozen defines wether the material is frozen or not.
  58056. */
  58057. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  58058. /**
  58059. * Checks to see if a texture is used in the material.
  58060. * @param texture - Base texture to use.
  58061. * @returns - Boolean specifying if a texture is used in the material.
  58062. */
  58063. hasTexture(texture: BaseTexture): boolean;
  58064. /**
  58065. * Returns an array of the actively used textures.
  58066. * @param activeTextures Array of BaseTextures
  58067. */
  58068. getActiveTextures(activeTextures: BaseTexture[]): void;
  58069. /**
  58070. * Returns the animatable textures.
  58071. * @param animatables Array of animatable textures.
  58072. */
  58073. getAnimatables(animatables: IAnimatable[]): void;
  58074. /**
  58075. * Disposes the resources of the material.
  58076. * @param forceDisposeTextures - Forces the disposal of all textures.
  58077. */
  58078. dispose(forceDisposeTextures?: boolean): void;
  58079. /**
  58080. * Get the current class name of the texture useful for serialization or dynamic coding.
  58081. * @returns "PBRSheenConfiguration"
  58082. */
  58083. getClassName(): string;
  58084. /**
  58085. * Add fallbacks to the effect fallbacks list.
  58086. * @param defines defines the Base texture to use.
  58087. * @param fallbacks defines the current fallback list.
  58088. * @param currentRank defines the current fallback rank.
  58089. * @returns the new fallback rank.
  58090. */
  58091. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58092. /**
  58093. * Add the required uniforms to the current list.
  58094. * @param uniforms defines the current uniform list.
  58095. */
  58096. static AddUniforms(uniforms: string[]): void;
  58097. /**
  58098. * Add the required uniforms to the current buffer.
  58099. * @param uniformBuffer defines the current uniform buffer.
  58100. */
  58101. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58102. /**
  58103. * Add the required samplers to the current list.
  58104. * @param samplers defines the current sampler list.
  58105. */
  58106. static AddSamplers(samplers: string[]): void;
  58107. /**
  58108. * Makes a duplicate of the current configuration into another one.
  58109. * @param sheenConfiguration define the config where to copy the info
  58110. */
  58111. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  58112. /**
  58113. * Serializes this BRDF configuration.
  58114. * @returns - An object with the serialized config.
  58115. */
  58116. serialize(): any;
  58117. /**
  58118. * Parses a anisotropy Configuration from a serialized object.
  58119. * @param source - Serialized object.
  58120. * @param scene Defines the scene we are parsing for
  58121. * @param rootUrl Defines the rootUrl to load from
  58122. */
  58123. parse(source: any, scene: Scene, rootUrl: string): void;
  58124. }
  58125. }
  58126. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  58127. import { Nullable } from "babylonjs/types";
  58128. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58129. import { Color3 } from "babylonjs/Maths/math.color";
  58130. import { SmartArray } from "babylonjs/Misc/smartArray";
  58131. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58132. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  58133. import { Effect } from "babylonjs/Materials/effect";
  58134. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58135. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58136. import { Engine } from "babylonjs/Engines/engine";
  58137. import { Scene } from "babylonjs/scene";
  58138. /**
  58139. * @hidden
  58140. */
  58141. export interface IMaterialSubSurfaceDefines {
  58142. SUBSURFACE: boolean;
  58143. SS_REFRACTION: boolean;
  58144. SS_TRANSLUCENCY: boolean;
  58145. SS_SCATTERING: boolean;
  58146. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58147. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58148. SS_REFRACTIONMAP_3D: boolean;
  58149. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58150. SS_LODINREFRACTIONALPHA: boolean;
  58151. SS_GAMMAREFRACTION: boolean;
  58152. SS_RGBDREFRACTION: boolean;
  58153. SS_LINEARSPECULARREFRACTION: boolean;
  58154. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58155. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58156. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58157. /** @hidden */
  58158. _areTexturesDirty: boolean;
  58159. }
  58160. /**
  58161. * Define the code related to the sub surface parameters of the pbr material.
  58162. */
  58163. export class PBRSubSurfaceConfiguration {
  58164. private _isRefractionEnabled;
  58165. /**
  58166. * Defines if the refraction is enabled in the material.
  58167. */
  58168. isRefractionEnabled: boolean;
  58169. private _isTranslucencyEnabled;
  58170. /**
  58171. * Defines if the translucency is enabled in the material.
  58172. */
  58173. isTranslucencyEnabled: boolean;
  58174. private _isScatteringEnabled;
  58175. /**
  58176. * Defines if the sub surface scattering is enabled in the material.
  58177. */
  58178. isScatteringEnabled: boolean;
  58179. private _scatteringDiffusionProfileIndex;
  58180. /**
  58181. * Diffusion profile for subsurface scattering.
  58182. * Useful for better scattering in the skins or foliages.
  58183. */
  58184. get scatteringDiffusionProfile(): Nullable<Color3>;
  58185. set scatteringDiffusionProfile(c: Nullable<Color3>);
  58186. /**
  58187. * Defines the refraction intensity of the material.
  58188. * The refraction when enabled replaces the Diffuse part of the material.
  58189. * The intensity helps transitionning between diffuse and refraction.
  58190. */
  58191. refractionIntensity: number;
  58192. /**
  58193. * Defines the translucency intensity of the material.
  58194. * When translucency has been enabled, this defines how much of the "translucency"
  58195. * is addded to the diffuse part of the material.
  58196. */
  58197. translucencyIntensity: number;
  58198. /**
  58199. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  58200. */
  58201. useAlbedoToTintRefraction: boolean;
  58202. private _thicknessTexture;
  58203. /**
  58204. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  58205. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  58206. * 0 would mean minimumThickness
  58207. * 1 would mean maximumThickness
  58208. * The other channels might be use as a mask to vary the different effects intensity.
  58209. */
  58210. thicknessTexture: Nullable<BaseTexture>;
  58211. private _refractionTexture;
  58212. /**
  58213. * Defines the texture to use for refraction.
  58214. */
  58215. refractionTexture: Nullable<BaseTexture>;
  58216. private _indexOfRefraction;
  58217. /**
  58218. * Index of refraction of the material base layer.
  58219. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58220. *
  58221. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58222. *
  58223. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58224. */
  58225. indexOfRefraction: number;
  58226. private _volumeIndexOfRefraction;
  58227. /**
  58228. * Index of refraction of the material's volume.
  58229. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58230. *
  58231. * This ONLY impacts refraction. If not provided or given a non-valid value,
  58232. * the volume will use the same IOR as the surface.
  58233. */
  58234. get volumeIndexOfRefraction(): number;
  58235. set volumeIndexOfRefraction(value: number);
  58236. private _invertRefractionY;
  58237. /**
  58238. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58239. */
  58240. invertRefractionY: boolean;
  58241. private _linkRefractionWithTransparency;
  58242. /**
  58243. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58244. * Materials half opaque for instance using refraction could benefit from this control.
  58245. */
  58246. linkRefractionWithTransparency: boolean;
  58247. /**
  58248. * Defines the minimum thickness stored in the thickness map.
  58249. * If no thickness map is defined, this value will be used to simulate thickness.
  58250. */
  58251. minimumThickness: number;
  58252. /**
  58253. * Defines the maximum thickness stored in the thickness map.
  58254. */
  58255. maximumThickness: number;
  58256. /**
  58257. * Defines the volume tint of the material.
  58258. * This is used for both translucency and scattering.
  58259. */
  58260. tintColor: Color3;
  58261. /**
  58262. * Defines the distance at which the tint color should be found in the media.
  58263. * This is used for refraction only.
  58264. */
  58265. tintColorAtDistance: number;
  58266. /**
  58267. * Defines how far each channel transmit through the media.
  58268. * It is defined as a color to simplify it selection.
  58269. */
  58270. diffusionDistance: Color3;
  58271. private _useMaskFromThicknessTexture;
  58272. /**
  58273. * Stores the intensity of the different subsurface effects in the thickness texture.
  58274. * * the green channel is the translucency intensity.
  58275. * * the blue channel is the scattering intensity.
  58276. * * the alpha channel is the refraction intensity.
  58277. */
  58278. useMaskFromThicknessTexture: boolean;
  58279. private _scene;
  58280. /** @hidden */
  58281. private _internalMarkAllSubMeshesAsTexturesDirty;
  58282. private _internalMarkScenePrePassDirty;
  58283. /** @hidden */
  58284. _markAllSubMeshesAsTexturesDirty(): void;
  58285. /** @hidden */
  58286. _markScenePrePassDirty(): void;
  58287. /**
  58288. * Instantiate a new istance of sub surface configuration.
  58289. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58290. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  58291. * @param scene The scene
  58292. */
  58293. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  58294. /**
  58295. * Gets wehter the submesh is ready to be used or not.
  58296. * @param defines the list of "defines" to update.
  58297. * @param scene defines the scene the material belongs to.
  58298. * @returns - boolean indicating that the submesh is ready or not.
  58299. */
  58300. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  58301. /**
  58302. * Checks to see if a texture is used in the material.
  58303. * @param defines the list of "defines" to update.
  58304. * @param scene defines the scene to the material belongs to.
  58305. */
  58306. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  58307. /**
  58308. * Binds the material data.
  58309. * @param uniformBuffer defines the Uniform buffer to fill in.
  58310. * @param scene defines the scene the material belongs to.
  58311. * @param engine defines the engine the material belongs to.
  58312. * @param isFrozen defines whether the material is frozen or not.
  58313. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  58314. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  58315. */
  58316. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  58317. /**
  58318. * Unbinds the material from the mesh.
  58319. * @param activeEffect defines the effect that should be unbound from.
  58320. * @returns true if unbound, otherwise false
  58321. */
  58322. unbind(activeEffect: Effect): boolean;
  58323. /**
  58324. * Returns the texture used for refraction or null if none is used.
  58325. * @param scene defines the scene the material belongs to.
  58326. * @returns - Refraction texture if present. If no refraction texture and refraction
  58327. * is linked with transparency, returns environment texture. Otherwise, returns null.
  58328. */
  58329. private _getRefractionTexture;
  58330. /**
  58331. * Returns true if alpha blending should be disabled.
  58332. */
  58333. get disableAlphaBlending(): boolean;
  58334. /**
  58335. * Fills the list of render target textures.
  58336. * @param renderTargets the list of render targets to update
  58337. */
  58338. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  58339. /**
  58340. * Checks to see if a texture is used in the material.
  58341. * @param texture - Base texture to use.
  58342. * @returns - Boolean specifying if a texture is used in the material.
  58343. */
  58344. hasTexture(texture: BaseTexture): boolean;
  58345. /**
  58346. * Gets a boolean indicating that current material needs to register RTT
  58347. * @returns true if this uses a render target otherwise false.
  58348. */
  58349. hasRenderTargetTextures(): boolean;
  58350. /**
  58351. * Returns an array of the actively used textures.
  58352. * @param activeTextures Array of BaseTextures
  58353. */
  58354. getActiveTextures(activeTextures: BaseTexture[]): void;
  58355. /**
  58356. * Returns the animatable textures.
  58357. * @param animatables Array of animatable textures.
  58358. */
  58359. getAnimatables(animatables: IAnimatable[]): void;
  58360. /**
  58361. * Disposes the resources of the material.
  58362. * @param forceDisposeTextures - Forces the disposal of all textures.
  58363. */
  58364. dispose(forceDisposeTextures?: boolean): void;
  58365. /**
  58366. * Get the current class name of the texture useful for serialization or dynamic coding.
  58367. * @returns "PBRSubSurfaceConfiguration"
  58368. */
  58369. getClassName(): string;
  58370. /**
  58371. * Add fallbacks to the effect fallbacks list.
  58372. * @param defines defines the Base texture to use.
  58373. * @param fallbacks defines the current fallback list.
  58374. * @param currentRank defines the current fallback rank.
  58375. * @returns the new fallback rank.
  58376. */
  58377. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58378. /**
  58379. * Add the required uniforms to the current list.
  58380. * @param uniforms defines the current uniform list.
  58381. */
  58382. static AddUniforms(uniforms: string[]): void;
  58383. /**
  58384. * Add the required samplers to the current list.
  58385. * @param samplers defines the current sampler list.
  58386. */
  58387. static AddSamplers(samplers: string[]): void;
  58388. /**
  58389. * Add the required uniforms to the current buffer.
  58390. * @param uniformBuffer defines the current uniform buffer.
  58391. */
  58392. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58393. /**
  58394. * Makes a duplicate of the current configuration into another one.
  58395. * @param configuration define the config where to copy the info
  58396. */
  58397. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  58398. /**
  58399. * Serializes this Sub Surface configuration.
  58400. * @returns - An object with the serialized config.
  58401. */
  58402. serialize(): any;
  58403. /**
  58404. * Parses a anisotropy Configuration from a serialized object.
  58405. * @param source - Serialized object.
  58406. * @param scene Defines the scene we are parsing for
  58407. * @param rootUrl Defines the rootUrl to load from
  58408. */
  58409. parse(source: any, scene: Scene, rootUrl: string): void;
  58410. }
  58411. }
  58412. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  58413. /** @hidden */
  58414. export var pbrFragmentDeclaration: {
  58415. name: string;
  58416. shader: string;
  58417. };
  58418. }
  58419. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  58420. /** @hidden */
  58421. export var pbrUboDeclaration: {
  58422. name: string;
  58423. shader: string;
  58424. };
  58425. }
  58426. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  58427. /** @hidden */
  58428. export var pbrFragmentExtraDeclaration: {
  58429. name: string;
  58430. shader: string;
  58431. };
  58432. }
  58433. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  58434. /** @hidden */
  58435. export var pbrFragmentSamplersDeclaration: {
  58436. name: string;
  58437. shader: string;
  58438. };
  58439. }
  58440. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  58441. /** @hidden */
  58442. export var importanceSampling: {
  58443. name: string;
  58444. shader: string;
  58445. };
  58446. }
  58447. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  58448. /** @hidden */
  58449. export var pbrHelperFunctions: {
  58450. name: string;
  58451. shader: string;
  58452. };
  58453. }
  58454. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  58455. /** @hidden */
  58456. export var harmonicsFunctions: {
  58457. name: string;
  58458. shader: string;
  58459. };
  58460. }
  58461. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  58462. /** @hidden */
  58463. export var pbrDirectLightingSetupFunctions: {
  58464. name: string;
  58465. shader: string;
  58466. };
  58467. }
  58468. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  58469. /** @hidden */
  58470. export var pbrDirectLightingFalloffFunctions: {
  58471. name: string;
  58472. shader: string;
  58473. };
  58474. }
  58475. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  58476. /** @hidden */
  58477. export var pbrBRDFFunctions: {
  58478. name: string;
  58479. shader: string;
  58480. };
  58481. }
  58482. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  58483. /** @hidden */
  58484. export var hdrFilteringFunctions: {
  58485. name: string;
  58486. shader: string;
  58487. };
  58488. }
  58489. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  58490. /** @hidden */
  58491. export var pbrDirectLightingFunctions: {
  58492. name: string;
  58493. shader: string;
  58494. };
  58495. }
  58496. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  58497. /** @hidden */
  58498. export var pbrIBLFunctions: {
  58499. name: string;
  58500. shader: string;
  58501. };
  58502. }
  58503. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  58504. /** @hidden */
  58505. export var pbrBlockAlbedoOpacity: {
  58506. name: string;
  58507. shader: string;
  58508. };
  58509. }
  58510. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  58511. /** @hidden */
  58512. export var pbrBlockReflectivity: {
  58513. name: string;
  58514. shader: string;
  58515. };
  58516. }
  58517. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  58518. /** @hidden */
  58519. export var pbrBlockAmbientOcclusion: {
  58520. name: string;
  58521. shader: string;
  58522. };
  58523. }
  58524. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  58525. /** @hidden */
  58526. export var pbrBlockAlphaFresnel: {
  58527. name: string;
  58528. shader: string;
  58529. };
  58530. }
  58531. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  58532. /** @hidden */
  58533. export var pbrBlockAnisotropic: {
  58534. name: string;
  58535. shader: string;
  58536. };
  58537. }
  58538. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  58539. /** @hidden */
  58540. export var pbrBlockReflection: {
  58541. name: string;
  58542. shader: string;
  58543. };
  58544. }
  58545. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  58546. /** @hidden */
  58547. export var pbrBlockSheen: {
  58548. name: string;
  58549. shader: string;
  58550. };
  58551. }
  58552. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  58553. /** @hidden */
  58554. export var pbrBlockClearcoat: {
  58555. name: string;
  58556. shader: string;
  58557. };
  58558. }
  58559. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  58560. /** @hidden */
  58561. export var pbrBlockSubSurface: {
  58562. name: string;
  58563. shader: string;
  58564. };
  58565. }
  58566. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  58567. /** @hidden */
  58568. export var pbrBlockNormalGeometric: {
  58569. name: string;
  58570. shader: string;
  58571. };
  58572. }
  58573. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  58574. /** @hidden */
  58575. export var pbrBlockNormalFinal: {
  58576. name: string;
  58577. shader: string;
  58578. };
  58579. }
  58580. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  58581. /** @hidden */
  58582. export var pbrBlockLightmapInit: {
  58583. name: string;
  58584. shader: string;
  58585. };
  58586. }
  58587. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  58588. /** @hidden */
  58589. export var pbrBlockGeometryInfo: {
  58590. name: string;
  58591. shader: string;
  58592. };
  58593. }
  58594. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  58595. /** @hidden */
  58596. export var pbrBlockReflectance0: {
  58597. name: string;
  58598. shader: string;
  58599. };
  58600. }
  58601. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  58602. /** @hidden */
  58603. export var pbrBlockReflectance: {
  58604. name: string;
  58605. shader: string;
  58606. };
  58607. }
  58608. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  58609. /** @hidden */
  58610. export var pbrBlockDirectLighting: {
  58611. name: string;
  58612. shader: string;
  58613. };
  58614. }
  58615. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  58616. /** @hidden */
  58617. export var pbrBlockFinalLitComponents: {
  58618. name: string;
  58619. shader: string;
  58620. };
  58621. }
  58622. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  58623. /** @hidden */
  58624. export var pbrBlockFinalUnlitComponents: {
  58625. name: string;
  58626. shader: string;
  58627. };
  58628. }
  58629. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  58630. /** @hidden */
  58631. export var pbrBlockFinalColorComposition: {
  58632. name: string;
  58633. shader: string;
  58634. };
  58635. }
  58636. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  58637. /** @hidden */
  58638. export var pbrBlockImageProcessing: {
  58639. name: string;
  58640. shader: string;
  58641. };
  58642. }
  58643. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  58644. /** @hidden */
  58645. export var pbrDebug: {
  58646. name: string;
  58647. shader: string;
  58648. };
  58649. }
  58650. declare module "babylonjs/Shaders/pbr.fragment" {
  58651. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  58652. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  58653. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58654. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  58655. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58656. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58657. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  58658. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58659. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  58660. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58661. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  58662. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58663. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  58664. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  58665. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  58666. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58667. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  58668. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58669. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  58670. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  58671. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  58672. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  58673. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  58674. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  58675. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  58676. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  58677. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  58678. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  58679. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  58680. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  58681. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  58682. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  58683. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  58684. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  58685. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  58686. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  58687. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58688. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  58689. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  58690. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  58691. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  58692. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  58693. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  58694. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  58695. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  58696. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  58697. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  58698. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  58699. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  58700. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  58701. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  58702. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  58703. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  58704. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  58705. /** @hidden */
  58706. export var pbrPixelShader: {
  58707. name: string;
  58708. shader: string;
  58709. };
  58710. }
  58711. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  58712. /** @hidden */
  58713. export var pbrVertexDeclaration: {
  58714. name: string;
  58715. shader: string;
  58716. };
  58717. }
  58718. declare module "babylonjs/Shaders/pbr.vertex" {
  58719. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  58720. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58721. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58722. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  58723. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  58724. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58725. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  58726. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  58727. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  58728. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58729. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58730. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  58731. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  58732. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58733. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  58734. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  58735. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  58736. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  58737. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  58738. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  58739. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  58740. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  58741. /** @hidden */
  58742. export var pbrVertexShader: {
  58743. name: string;
  58744. shader: string;
  58745. };
  58746. }
  58747. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  58748. import { Nullable } from "babylonjs/types";
  58749. import { Scene } from "babylonjs/scene";
  58750. import { Matrix } from "babylonjs/Maths/math.vector";
  58751. import { SubMesh } from "babylonjs/Meshes/subMesh";
  58752. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58753. import { Mesh } from "babylonjs/Meshes/mesh";
  58754. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  58755. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  58756. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  58757. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  58758. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  58759. import { Color3 } from "babylonjs/Maths/math.color";
  58760. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  58761. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  58762. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  58763. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  58764. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58765. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58766. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  58767. import "babylonjs/Shaders/pbr.fragment";
  58768. import "babylonjs/Shaders/pbr.vertex";
  58769. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  58770. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  58771. /**
  58772. * Manages the defines for the PBR Material.
  58773. * @hidden
  58774. */
  58775. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  58776. PBR: boolean;
  58777. NUM_SAMPLES: string;
  58778. REALTIME_FILTERING: boolean;
  58779. MAINUV1: boolean;
  58780. MAINUV2: boolean;
  58781. UV1: boolean;
  58782. UV2: boolean;
  58783. ALBEDO: boolean;
  58784. GAMMAALBEDO: boolean;
  58785. ALBEDODIRECTUV: number;
  58786. VERTEXCOLOR: boolean;
  58787. DETAIL: boolean;
  58788. DETAILDIRECTUV: number;
  58789. DETAIL_NORMALBLENDMETHOD: number;
  58790. AMBIENT: boolean;
  58791. AMBIENTDIRECTUV: number;
  58792. AMBIENTINGRAYSCALE: boolean;
  58793. OPACITY: boolean;
  58794. VERTEXALPHA: boolean;
  58795. OPACITYDIRECTUV: number;
  58796. OPACITYRGB: boolean;
  58797. ALPHATEST: boolean;
  58798. DEPTHPREPASS: boolean;
  58799. ALPHABLEND: boolean;
  58800. ALPHAFROMALBEDO: boolean;
  58801. ALPHATESTVALUE: string;
  58802. SPECULAROVERALPHA: boolean;
  58803. RADIANCEOVERALPHA: boolean;
  58804. ALPHAFRESNEL: boolean;
  58805. LINEARALPHAFRESNEL: boolean;
  58806. PREMULTIPLYALPHA: boolean;
  58807. EMISSIVE: boolean;
  58808. EMISSIVEDIRECTUV: number;
  58809. REFLECTIVITY: boolean;
  58810. REFLECTIVITYDIRECTUV: number;
  58811. SPECULARTERM: boolean;
  58812. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  58813. MICROSURFACEAUTOMATIC: boolean;
  58814. LODBASEDMICROSFURACE: boolean;
  58815. MICROSURFACEMAP: boolean;
  58816. MICROSURFACEMAPDIRECTUV: number;
  58817. METALLICWORKFLOW: boolean;
  58818. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  58819. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  58820. METALLNESSSTOREINMETALMAPBLUE: boolean;
  58821. AOSTOREINMETALMAPRED: boolean;
  58822. METALLIC_REFLECTANCE: boolean;
  58823. METALLIC_REFLECTANCEDIRECTUV: number;
  58824. ENVIRONMENTBRDF: boolean;
  58825. ENVIRONMENTBRDF_RGBD: boolean;
  58826. NORMAL: boolean;
  58827. TANGENT: boolean;
  58828. BUMP: boolean;
  58829. BUMPDIRECTUV: number;
  58830. OBJECTSPACE_NORMALMAP: boolean;
  58831. PARALLAX: boolean;
  58832. PARALLAXOCCLUSION: boolean;
  58833. NORMALXYSCALE: boolean;
  58834. LIGHTMAP: boolean;
  58835. LIGHTMAPDIRECTUV: number;
  58836. USELIGHTMAPASSHADOWMAP: boolean;
  58837. GAMMALIGHTMAP: boolean;
  58838. RGBDLIGHTMAP: boolean;
  58839. REFLECTION: boolean;
  58840. REFLECTIONMAP_3D: boolean;
  58841. REFLECTIONMAP_SPHERICAL: boolean;
  58842. REFLECTIONMAP_PLANAR: boolean;
  58843. REFLECTIONMAP_CUBIC: boolean;
  58844. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  58845. REFLECTIONMAP_PROJECTION: boolean;
  58846. REFLECTIONMAP_SKYBOX: boolean;
  58847. REFLECTIONMAP_EXPLICIT: boolean;
  58848. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  58849. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  58850. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  58851. INVERTCUBICMAP: boolean;
  58852. USESPHERICALFROMREFLECTIONMAP: boolean;
  58853. USEIRRADIANCEMAP: boolean;
  58854. SPHERICAL_HARMONICS: boolean;
  58855. USESPHERICALINVERTEX: boolean;
  58856. REFLECTIONMAP_OPPOSITEZ: boolean;
  58857. LODINREFLECTIONALPHA: boolean;
  58858. GAMMAREFLECTION: boolean;
  58859. RGBDREFLECTION: boolean;
  58860. LINEARSPECULARREFLECTION: boolean;
  58861. RADIANCEOCCLUSION: boolean;
  58862. HORIZONOCCLUSION: boolean;
  58863. INSTANCES: boolean;
  58864. THIN_INSTANCES: boolean;
  58865. PREPASS: boolean;
  58866. SCENE_MRT_COUNT: number;
  58867. NUM_BONE_INFLUENCERS: number;
  58868. BonesPerMesh: number;
  58869. BONETEXTURE: boolean;
  58870. NONUNIFORMSCALING: boolean;
  58871. MORPHTARGETS: boolean;
  58872. MORPHTARGETS_NORMAL: boolean;
  58873. MORPHTARGETS_TANGENT: boolean;
  58874. MORPHTARGETS_UV: boolean;
  58875. NUM_MORPH_INFLUENCERS: number;
  58876. IMAGEPROCESSING: boolean;
  58877. VIGNETTE: boolean;
  58878. VIGNETTEBLENDMODEMULTIPLY: boolean;
  58879. VIGNETTEBLENDMODEOPAQUE: boolean;
  58880. TONEMAPPING: boolean;
  58881. TONEMAPPING_ACES: boolean;
  58882. CONTRAST: boolean;
  58883. COLORCURVES: boolean;
  58884. COLORGRADING: boolean;
  58885. COLORGRADING3D: boolean;
  58886. SAMPLER3DGREENDEPTH: boolean;
  58887. SAMPLER3DBGRMAP: boolean;
  58888. IMAGEPROCESSINGPOSTPROCESS: boolean;
  58889. EXPOSURE: boolean;
  58890. MULTIVIEW: boolean;
  58891. USEPHYSICALLIGHTFALLOFF: boolean;
  58892. USEGLTFLIGHTFALLOFF: boolean;
  58893. TWOSIDEDLIGHTING: boolean;
  58894. SHADOWFLOAT: boolean;
  58895. CLIPPLANE: boolean;
  58896. CLIPPLANE2: boolean;
  58897. CLIPPLANE3: boolean;
  58898. CLIPPLANE4: boolean;
  58899. CLIPPLANE5: boolean;
  58900. CLIPPLANE6: boolean;
  58901. POINTSIZE: boolean;
  58902. FOG: boolean;
  58903. LOGARITHMICDEPTH: boolean;
  58904. FORCENORMALFORWARD: boolean;
  58905. SPECULARAA: boolean;
  58906. CLEARCOAT: boolean;
  58907. CLEARCOAT_DEFAULTIOR: boolean;
  58908. CLEARCOAT_TEXTURE: boolean;
  58909. CLEARCOAT_TEXTUREDIRECTUV: number;
  58910. CLEARCOAT_BUMP: boolean;
  58911. CLEARCOAT_BUMPDIRECTUV: number;
  58912. CLEARCOAT_TINT: boolean;
  58913. CLEARCOAT_TINT_TEXTURE: boolean;
  58914. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  58915. ANISOTROPIC: boolean;
  58916. ANISOTROPIC_TEXTURE: boolean;
  58917. ANISOTROPIC_TEXTUREDIRECTUV: number;
  58918. BRDF_V_HEIGHT_CORRELATED: boolean;
  58919. MS_BRDF_ENERGY_CONSERVATION: boolean;
  58920. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  58921. SHEEN: boolean;
  58922. SHEEN_TEXTURE: boolean;
  58923. SHEEN_TEXTUREDIRECTUV: number;
  58924. SHEEN_LINKWITHALBEDO: boolean;
  58925. SHEEN_ROUGHNESS: boolean;
  58926. SHEEN_ALBEDOSCALING: boolean;
  58927. SUBSURFACE: boolean;
  58928. SS_REFRACTION: boolean;
  58929. SS_TRANSLUCENCY: boolean;
  58930. SS_SCATTERING: boolean;
  58931. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58932. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58933. SS_REFRACTIONMAP_3D: boolean;
  58934. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58935. SS_LODINREFRACTIONALPHA: boolean;
  58936. SS_GAMMAREFRACTION: boolean;
  58937. SS_RGBDREFRACTION: boolean;
  58938. SS_LINEARSPECULARREFRACTION: boolean;
  58939. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58940. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58941. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58942. UNLIT: boolean;
  58943. DEBUGMODE: number;
  58944. /**
  58945. * Initializes the PBR Material defines.
  58946. */
  58947. constructor();
  58948. /**
  58949. * Resets the PBR Material defines.
  58950. */
  58951. reset(): void;
  58952. }
  58953. /**
  58954. * The Physically based material base class of BJS.
  58955. *
  58956. * This offers the main features of a standard PBR material.
  58957. * For more information, please refer to the documentation :
  58958. * https://doc.babylonjs.com/how_to/physically_based_rendering
  58959. */
  58960. export abstract class PBRBaseMaterial extends PushMaterial {
  58961. /**
  58962. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  58963. */
  58964. static readonly PBRMATERIAL_OPAQUE: number;
  58965. /**
  58966. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  58967. */
  58968. static readonly PBRMATERIAL_ALPHATEST: number;
  58969. /**
  58970. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58971. */
  58972. static readonly PBRMATERIAL_ALPHABLEND: number;
  58973. /**
  58974. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58975. * They are also discarded below the alpha cutoff threshold to improve performances.
  58976. */
  58977. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  58978. /**
  58979. * Defines the default value of how much AO map is occluding the analytical lights
  58980. * (point spot...).
  58981. */
  58982. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  58983. /**
  58984. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  58985. */
  58986. static readonly LIGHTFALLOFF_PHYSICAL: number;
  58987. /**
  58988. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  58989. * to enhance interoperability with other engines.
  58990. */
  58991. static readonly LIGHTFALLOFF_GLTF: number;
  58992. /**
  58993. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  58994. * to enhance interoperability with other materials.
  58995. */
  58996. static readonly LIGHTFALLOFF_STANDARD: number;
  58997. /**
  58998. * Intensity of the direct lights e.g. the four lights available in your scene.
  58999. * This impacts both the direct diffuse and specular highlights.
  59000. */
  59001. protected _directIntensity: number;
  59002. /**
  59003. * Intensity of the emissive part of the material.
  59004. * This helps controlling the emissive effect without modifying the emissive color.
  59005. */
  59006. protected _emissiveIntensity: number;
  59007. /**
  59008. * Intensity of the environment e.g. how much the environment will light the object
  59009. * either through harmonics for rough material or through the refelction for shiny ones.
  59010. */
  59011. protected _environmentIntensity: number;
  59012. /**
  59013. * This is a special control allowing the reduction of the specular highlights coming from the
  59014. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59015. */
  59016. protected _specularIntensity: number;
  59017. /**
  59018. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  59019. */
  59020. private _lightingInfos;
  59021. /**
  59022. * Debug Control allowing disabling the bump map on this material.
  59023. */
  59024. protected _disableBumpMap: boolean;
  59025. /**
  59026. * AKA Diffuse Texture in standard nomenclature.
  59027. */
  59028. protected _albedoTexture: Nullable<BaseTexture>;
  59029. /**
  59030. * AKA Occlusion Texture in other nomenclature.
  59031. */
  59032. protected _ambientTexture: Nullable<BaseTexture>;
  59033. /**
  59034. * AKA Occlusion Texture Intensity in other nomenclature.
  59035. */
  59036. protected _ambientTextureStrength: number;
  59037. /**
  59038. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59039. * 1 means it completely occludes it
  59040. * 0 mean it has no impact
  59041. */
  59042. protected _ambientTextureImpactOnAnalyticalLights: number;
  59043. /**
  59044. * Stores the alpha values in a texture.
  59045. */
  59046. protected _opacityTexture: Nullable<BaseTexture>;
  59047. /**
  59048. * Stores the reflection values in a texture.
  59049. */
  59050. protected _reflectionTexture: Nullable<BaseTexture>;
  59051. /**
  59052. * Stores the emissive values in a texture.
  59053. */
  59054. protected _emissiveTexture: Nullable<BaseTexture>;
  59055. /**
  59056. * AKA Specular texture in other nomenclature.
  59057. */
  59058. protected _reflectivityTexture: Nullable<BaseTexture>;
  59059. /**
  59060. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59061. */
  59062. protected _metallicTexture: Nullable<BaseTexture>;
  59063. /**
  59064. * Specifies the metallic scalar of the metallic/roughness workflow.
  59065. * Can also be used to scale the metalness values of the metallic texture.
  59066. */
  59067. protected _metallic: Nullable<number>;
  59068. /**
  59069. * Specifies the roughness scalar of the metallic/roughness workflow.
  59070. * Can also be used to scale the roughness values of the metallic texture.
  59071. */
  59072. protected _roughness: Nullable<number>;
  59073. /**
  59074. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59075. * By default the indexOfrefraction is used to compute F0;
  59076. *
  59077. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59078. *
  59079. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59080. * F90 = metallicReflectanceColor;
  59081. */
  59082. protected _metallicF0Factor: number;
  59083. /**
  59084. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59085. * By default the F90 is always 1;
  59086. *
  59087. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59088. *
  59089. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59090. * F90 = metallicReflectanceColor;
  59091. */
  59092. protected _metallicReflectanceColor: Color3;
  59093. /**
  59094. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59095. * This is multiply against the scalar values defined in the material.
  59096. */
  59097. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  59098. /**
  59099. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59100. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59101. */
  59102. protected _microSurfaceTexture: Nullable<BaseTexture>;
  59103. /**
  59104. * Stores surface normal data used to displace a mesh in a texture.
  59105. */
  59106. protected _bumpTexture: Nullable<BaseTexture>;
  59107. /**
  59108. * Stores the pre-calculated light information of a mesh in a texture.
  59109. */
  59110. protected _lightmapTexture: Nullable<BaseTexture>;
  59111. /**
  59112. * The color of a material in ambient lighting.
  59113. */
  59114. protected _ambientColor: Color3;
  59115. /**
  59116. * AKA Diffuse Color in other nomenclature.
  59117. */
  59118. protected _albedoColor: Color3;
  59119. /**
  59120. * AKA Specular Color in other nomenclature.
  59121. */
  59122. protected _reflectivityColor: Color3;
  59123. /**
  59124. * The color applied when light is reflected from a material.
  59125. */
  59126. protected _reflectionColor: Color3;
  59127. /**
  59128. * The color applied when light is emitted from a material.
  59129. */
  59130. protected _emissiveColor: Color3;
  59131. /**
  59132. * AKA Glossiness in other nomenclature.
  59133. */
  59134. protected _microSurface: number;
  59135. /**
  59136. * Specifies that the material will use the light map as a show map.
  59137. */
  59138. protected _useLightmapAsShadowmap: boolean;
  59139. /**
  59140. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59141. * makes the reflect vector face the model (under horizon).
  59142. */
  59143. protected _useHorizonOcclusion: boolean;
  59144. /**
  59145. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59146. * too much the area relying on ambient texture to define their ambient occlusion.
  59147. */
  59148. protected _useRadianceOcclusion: boolean;
  59149. /**
  59150. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59151. */
  59152. protected _useAlphaFromAlbedoTexture: boolean;
  59153. /**
  59154. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  59155. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59156. */
  59157. protected _useSpecularOverAlpha: boolean;
  59158. /**
  59159. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59160. */
  59161. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59162. /**
  59163. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59164. */
  59165. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  59166. /**
  59167. * Specifies if the metallic texture contains the roughness information in its green channel.
  59168. */
  59169. protected _useRoughnessFromMetallicTextureGreen: boolean;
  59170. /**
  59171. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59172. */
  59173. protected _useMetallnessFromMetallicTextureBlue: boolean;
  59174. /**
  59175. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59176. */
  59177. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  59178. /**
  59179. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59180. */
  59181. protected _useAmbientInGrayScale: boolean;
  59182. /**
  59183. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59184. * The material will try to infer what glossiness each pixel should be.
  59185. */
  59186. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  59187. /**
  59188. * Defines the falloff type used in this material.
  59189. * It by default is Physical.
  59190. */
  59191. protected _lightFalloff: number;
  59192. /**
  59193. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59194. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59195. */
  59196. protected _useRadianceOverAlpha: boolean;
  59197. /**
  59198. * Allows using an object space normal map (instead of tangent space).
  59199. */
  59200. protected _useObjectSpaceNormalMap: boolean;
  59201. /**
  59202. * Allows using the bump map in parallax mode.
  59203. */
  59204. protected _useParallax: boolean;
  59205. /**
  59206. * Allows using the bump map in parallax occlusion mode.
  59207. */
  59208. protected _useParallaxOcclusion: boolean;
  59209. /**
  59210. * Controls the scale bias of the parallax mode.
  59211. */
  59212. protected _parallaxScaleBias: number;
  59213. /**
  59214. * If sets to true, disables all the lights affecting the material.
  59215. */
  59216. protected _disableLighting: boolean;
  59217. /**
  59218. * Number of Simultaneous lights allowed on the material.
  59219. */
  59220. protected _maxSimultaneousLights: number;
  59221. /**
  59222. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  59223. */
  59224. protected _invertNormalMapX: boolean;
  59225. /**
  59226. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  59227. */
  59228. protected _invertNormalMapY: boolean;
  59229. /**
  59230. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59231. */
  59232. protected _twoSidedLighting: boolean;
  59233. /**
  59234. * Defines the alpha limits in alpha test mode.
  59235. */
  59236. protected _alphaCutOff: number;
  59237. /**
  59238. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59239. */
  59240. protected _forceAlphaTest: boolean;
  59241. /**
  59242. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59243. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59244. */
  59245. protected _useAlphaFresnel: boolean;
  59246. /**
  59247. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59248. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59249. */
  59250. protected _useLinearAlphaFresnel: boolean;
  59251. /**
  59252. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  59253. * from cos thetav and roughness:
  59254. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  59255. */
  59256. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  59257. /**
  59258. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59259. */
  59260. protected _forceIrradianceInFragment: boolean;
  59261. private _realTimeFiltering;
  59262. /**
  59263. * Enables realtime filtering on the texture.
  59264. */
  59265. get realTimeFiltering(): boolean;
  59266. set realTimeFiltering(b: boolean);
  59267. private _realTimeFilteringQuality;
  59268. /**
  59269. * Quality switch for realtime filtering
  59270. */
  59271. get realTimeFilteringQuality(): number;
  59272. set realTimeFilteringQuality(n: number);
  59273. /**
  59274. * Can this material render to several textures at once
  59275. */
  59276. get canRenderToMRT(): boolean;
  59277. /**
  59278. * Force normal to face away from face.
  59279. */
  59280. protected _forceNormalForward: boolean;
  59281. /**
  59282. * Enables specular anti aliasing in the PBR shader.
  59283. * It will both interacts on the Geometry for analytical and IBL lighting.
  59284. * It also prefilter the roughness map based on the bump values.
  59285. */
  59286. protected _enableSpecularAntiAliasing: boolean;
  59287. /**
  59288. * Default configuration related to image processing available in the PBR Material.
  59289. */
  59290. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  59291. /**
  59292. * Keep track of the image processing observer to allow dispose and replace.
  59293. */
  59294. private _imageProcessingObserver;
  59295. /**
  59296. * Attaches a new image processing configuration to the PBR Material.
  59297. * @param configuration
  59298. */
  59299. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  59300. /**
  59301. * Stores the available render targets.
  59302. */
  59303. private _renderTargets;
  59304. /**
  59305. * Sets the global ambient color for the material used in lighting calculations.
  59306. */
  59307. private _globalAmbientColor;
  59308. /**
  59309. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  59310. */
  59311. private _useLogarithmicDepth;
  59312. /**
  59313. * If set to true, no lighting calculations will be applied.
  59314. */
  59315. private _unlit;
  59316. private _debugMode;
  59317. /**
  59318. * @hidden
  59319. * This is reserved for the inspector.
  59320. * Defines the material debug mode.
  59321. * It helps seeing only some components of the material while troubleshooting.
  59322. */
  59323. debugMode: number;
  59324. /**
  59325. * @hidden
  59326. * This is reserved for the inspector.
  59327. * Specify from where on screen the debug mode should start.
  59328. * The value goes from -1 (full screen) to 1 (not visible)
  59329. * It helps with side by side comparison against the final render
  59330. * This defaults to -1
  59331. */
  59332. private debugLimit;
  59333. /**
  59334. * @hidden
  59335. * This is reserved for the inspector.
  59336. * As the default viewing range might not be enough (if the ambient is really small for instance)
  59337. * You can use the factor to better multiply the final value.
  59338. */
  59339. private debugFactor;
  59340. /**
  59341. * Defines the clear coat layer parameters for the material.
  59342. */
  59343. readonly clearCoat: PBRClearCoatConfiguration;
  59344. /**
  59345. * Defines the anisotropic parameters for the material.
  59346. */
  59347. readonly anisotropy: PBRAnisotropicConfiguration;
  59348. /**
  59349. * Defines the BRDF parameters for the material.
  59350. */
  59351. readonly brdf: PBRBRDFConfiguration;
  59352. /**
  59353. * Defines the Sheen parameters for the material.
  59354. */
  59355. readonly sheen: PBRSheenConfiguration;
  59356. /**
  59357. * Defines the SubSurface parameters for the material.
  59358. */
  59359. readonly subSurface: PBRSubSurfaceConfiguration;
  59360. /**
  59361. * Defines the detail map parameters for the material.
  59362. */
  59363. readonly detailMap: DetailMapConfiguration;
  59364. protected _rebuildInParallel: boolean;
  59365. /**
  59366. * Instantiates a new PBRMaterial instance.
  59367. *
  59368. * @param name The material name
  59369. * @param scene The scene the material will be use in.
  59370. */
  59371. constructor(name: string, scene: Scene);
  59372. /**
  59373. * Gets a boolean indicating that current material needs to register RTT
  59374. */
  59375. get hasRenderTargetTextures(): boolean;
  59376. /**
  59377. * Gets the name of the material class.
  59378. */
  59379. getClassName(): string;
  59380. /**
  59381. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59382. */
  59383. get useLogarithmicDepth(): boolean;
  59384. /**
  59385. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59386. */
  59387. set useLogarithmicDepth(value: boolean);
  59388. /**
  59389. * Returns true if alpha blending should be disabled.
  59390. */
  59391. protected get _disableAlphaBlending(): boolean;
  59392. /**
  59393. * Specifies whether or not this material should be rendered in alpha blend mode.
  59394. */
  59395. needAlphaBlending(): boolean;
  59396. /**
  59397. * Specifies whether or not this material should be rendered in alpha test mode.
  59398. */
  59399. needAlphaTesting(): boolean;
  59400. /**
  59401. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  59402. */
  59403. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  59404. /**
  59405. * Gets the texture used for the alpha test.
  59406. */
  59407. getAlphaTestTexture(): Nullable<BaseTexture>;
  59408. /**
  59409. * Specifies that the submesh is ready to be used.
  59410. * @param mesh - BJS mesh.
  59411. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  59412. * @param useInstances - Specifies that instances should be used.
  59413. * @returns - boolean indicating that the submesh is ready or not.
  59414. */
  59415. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  59416. /**
  59417. * Specifies if the material uses metallic roughness workflow.
  59418. * @returns boolean specifiying if the material uses metallic roughness workflow.
  59419. */
  59420. isMetallicWorkflow(): boolean;
  59421. private _prepareEffect;
  59422. private _prepareDefines;
  59423. /**
  59424. * Force shader compilation
  59425. */
  59426. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  59427. /**
  59428. * Initializes the uniform buffer layout for the shader.
  59429. */
  59430. buildUniformLayout(): void;
  59431. /**
  59432. * Unbinds the material from the mesh
  59433. */
  59434. unbind(): void;
  59435. /**
  59436. * Binds the submesh data.
  59437. * @param world - The world matrix.
  59438. * @param mesh - The BJS mesh.
  59439. * @param subMesh - A submesh of the BJS mesh.
  59440. */
  59441. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  59442. /**
  59443. * Returns the animatable textures.
  59444. * @returns - Array of animatable textures.
  59445. */
  59446. getAnimatables(): IAnimatable[];
  59447. /**
  59448. * Returns the texture used for reflections.
  59449. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  59450. */
  59451. private _getReflectionTexture;
  59452. /**
  59453. * Returns an array of the actively used textures.
  59454. * @returns - Array of BaseTextures
  59455. */
  59456. getActiveTextures(): BaseTexture[];
  59457. /**
  59458. * Checks to see if a texture is used in the material.
  59459. * @param texture - Base texture to use.
  59460. * @returns - Boolean specifying if a texture is used in the material.
  59461. */
  59462. hasTexture(texture: BaseTexture): boolean;
  59463. /**
  59464. * Sets the required values to the prepass renderer.
  59465. * @param prePassRenderer defines the prepass renderer to setup
  59466. */
  59467. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  59468. /**
  59469. * Disposes the resources of the material.
  59470. * @param forceDisposeEffect - Forces the disposal of effects.
  59471. * @param forceDisposeTextures - Forces the disposal of all textures.
  59472. */
  59473. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  59474. }
  59475. }
  59476. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  59477. import { Nullable } from "babylonjs/types";
  59478. import { Scene } from "babylonjs/scene";
  59479. import { Color3 } from "babylonjs/Maths/math.color";
  59480. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  59481. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  59482. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59483. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  59484. /**
  59485. * The Physically based material of BJS.
  59486. *
  59487. * This offers the main features of a standard PBR material.
  59488. * For more information, please refer to the documentation :
  59489. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59490. */
  59491. export class PBRMaterial extends PBRBaseMaterial {
  59492. /**
  59493. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59494. */
  59495. static readonly PBRMATERIAL_OPAQUE: number;
  59496. /**
  59497. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59498. */
  59499. static readonly PBRMATERIAL_ALPHATEST: number;
  59500. /**
  59501. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59502. */
  59503. static readonly PBRMATERIAL_ALPHABLEND: number;
  59504. /**
  59505. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59506. * They are also discarded below the alpha cutoff threshold to improve performances.
  59507. */
  59508. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59509. /**
  59510. * Defines the default value of how much AO map is occluding the analytical lights
  59511. * (point spot...).
  59512. */
  59513. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59514. /**
  59515. * Intensity of the direct lights e.g. the four lights available in your scene.
  59516. * This impacts both the direct diffuse and specular highlights.
  59517. */
  59518. directIntensity: number;
  59519. /**
  59520. * Intensity of the emissive part of the material.
  59521. * This helps controlling the emissive effect without modifying the emissive color.
  59522. */
  59523. emissiveIntensity: number;
  59524. /**
  59525. * Intensity of the environment e.g. how much the environment will light the object
  59526. * either through harmonics for rough material or through the refelction for shiny ones.
  59527. */
  59528. environmentIntensity: number;
  59529. /**
  59530. * This is a special control allowing the reduction of the specular highlights coming from the
  59531. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59532. */
  59533. specularIntensity: number;
  59534. /**
  59535. * Debug Control allowing disabling the bump map on this material.
  59536. */
  59537. disableBumpMap: boolean;
  59538. /**
  59539. * AKA Diffuse Texture in standard nomenclature.
  59540. */
  59541. albedoTexture: BaseTexture;
  59542. /**
  59543. * AKA Occlusion Texture in other nomenclature.
  59544. */
  59545. ambientTexture: BaseTexture;
  59546. /**
  59547. * AKA Occlusion Texture Intensity in other nomenclature.
  59548. */
  59549. ambientTextureStrength: number;
  59550. /**
  59551. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59552. * 1 means it completely occludes it
  59553. * 0 mean it has no impact
  59554. */
  59555. ambientTextureImpactOnAnalyticalLights: number;
  59556. /**
  59557. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  59558. */
  59559. opacityTexture: BaseTexture;
  59560. /**
  59561. * Stores the reflection values in a texture.
  59562. */
  59563. reflectionTexture: Nullable<BaseTexture>;
  59564. /**
  59565. * Stores the emissive values in a texture.
  59566. */
  59567. emissiveTexture: BaseTexture;
  59568. /**
  59569. * AKA Specular texture in other nomenclature.
  59570. */
  59571. reflectivityTexture: BaseTexture;
  59572. /**
  59573. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59574. */
  59575. metallicTexture: BaseTexture;
  59576. /**
  59577. * Specifies the metallic scalar of the metallic/roughness workflow.
  59578. * Can also be used to scale the metalness values of the metallic texture.
  59579. */
  59580. metallic: Nullable<number>;
  59581. /**
  59582. * Specifies the roughness scalar of the metallic/roughness workflow.
  59583. * Can also be used to scale the roughness values of the metallic texture.
  59584. */
  59585. roughness: Nullable<number>;
  59586. /**
  59587. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59588. * By default the indexOfrefraction is used to compute F0;
  59589. *
  59590. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59591. *
  59592. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59593. * F90 = metallicReflectanceColor;
  59594. */
  59595. metallicF0Factor: number;
  59596. /**
  59597. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59598. * By default the F90 is always 1;
  59599. *
  59600. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59601. *
  59602. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59603. * F90 = metallicReflectanceColor;
  59604. */
  59605. metallicReflectanceColor: Color3;
  59606. /**
  59607. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59608. * This is multiply against the scalar values defined in the material.
  59609. */
  59610. metallicReflectanceTexture: Nullable<BaseTexture>;
  59611. /**
  59612. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59613. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59614. */
  59615. microSurfaceTexture: BaseTexture;
  59616. /**
  59617. * Stores surface normal data used to displace a mesh in a texture.
  59618. */
  59619. bumpTexture: BaseTexture;
  59620. /**
  59621. * Stores the pre-calculated light information of a mesh in a texture.
  59622. */
  59623. lightmapTexture: BaseTexture;
  59624. /**
  59625. * Stores the refracted light information in a texture.
  59626. */
  59627. get refractionTexture(): Nullable<BaseTexture>;
  59628. set refractionTexture(value: Nullable<BaseTexture>);
  59629. /**
  59630. * The color of a material in ambient lighting.
  59631. */
  59632. ambientColor: Color3;
  59633. /**
  59634. * AKA Diffuse Color in other nomenclature.
  59635. */
  59636. albedoColor: Color3;
  59637. /**
  59638. * AKA Specular Color in other nomenclature.
  59639. */
  59640. reflectivityColor: Color3;
  59641. /**
  59642. * The color reflected from the material.
  59643. */
  59644. reflectionColor: Color3;
  59645. /**
  59646. * The color emitted from the material.
  59647. */
  59648. emissiveColor: Color3;
  59649. /**
  59650. * AKA Glossiness in other nomenclature.
  59651. */
  59652. microSurface: number;
  59653. /**
  59654. * Index of refraction of the material base layer.
  59655. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  59656. *
  59657. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  59658. *
  59659. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  59660. */
  59661. get indexOfRefraction(): number;
  59662. set indexOfRefraction(value: number);
  59663. /**
  59664. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  59665. */
  59666. get invertRefractionY(): boolean;
  59667. set invertRefractionY(value: boolean);
  59668. /**
  59669. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  59670. * Materials half opaque for instance using refraction could benefit from this control.
  59671. */
  59672. get linkRefractionWithTransparency(): boolean;
  59673. set linkRefractionWithTransparency(value: boolean);
  59674. /**
  59675. * If true, the light map contains occlusion information instead of lighting info.
  59676. */
  59677. useLightmapAsShadowmap: boolean;
  59678. /**
  59679. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59680. */
  59681. useAlphaFromAlbedoTexture: boolean;
  59682. /**
  59683. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59684. */
  59685. forceAlphaTest: boolean;
  59686. /**
  59687. * Defines the alpha limits in alpha test mode.
  59688. */
  59689. alphaCutOff: number;
  59690. /**
  59691. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  59692. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59693. */
  59694. useSpecularOverAlpha: boolean;
  59695. /**
  59696. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59697. */
  59698. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59699. /**
  59700. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59701. */
  59702. useRoughnessFromMetallicTextureAlpha: boolean;
  59703. /**
  59704. * Specifies if the metallic texture contains the roughness information in its green channel.
  59705. */
  59706. useRoughnessFromMetallicTextureGreen: boolean;
  59707. /**
  59708. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59709. */
  59710. useMetallnessFromMetallicTextureBlue: boolean;
  59711. /**
  59712. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59713. */
  59714. useAmbientOcclusionFromMetallicTextureRed: boolean;
  59715. /**
  59716. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59717. */
  59718. useAmbientInGrayScale: boolean;
  59719. /**
  59720. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59721. * The material will try to infer what glossiness each pixel should be.
  59722. */
  59723. useAutoMicroSurfaceFromReflectivityMap: boolean;
  59724. /**
  59725. * BJS is using an harcoded light falloff based on a manually sets up range.
  59726. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59727. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59728. */
  59729. get usePhysicalLightFalloff(): boolean;
  59730. /**
  59731. * BJS is using an harcoded light falloff based on a manually sets up range.
  59732. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59733. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59734. */
  59735. set usePhysicalLightFalloff(value: boolean);
  59736. /**
  59737. * In order to support the falloff compatibility with gltf, a special mode has been added
  59738. * to reproduce the gltf light falloff.
  59739. */
  59740. get useGLTFLightFalloff(): boolean;
  59741. /**
  59742. * In order to support the falloff compatibility with gltf, a special mode has been added
  59743. * to reproduce the gltf light falloff.
  59744. */
  59745. set useGLTFLightFalloff(value: boolean);
  59746. /**
  59747. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59748. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59749. */
  59750. useRadianceOverAlpha: boolean;
  59751. /**
  59752. * Allows using an object space normal map (instead of tangent space).
  59753. */
  59754. useObjectSpaceNormalMap: boolean;
  59755. /**
  59756. * Allows using the bump map in parallax mode.
  59757. */
  59758. useParallax: boolean;
  59759. /**
  59760. * Allows using the bump map in parallax occlusion mode.
  59761. */
  59762. useParallaxOcclusion: boolean;
  59763. /**
  59764. * Controls the scale bias of the parallax mode.
  59765. */
  59766. parallaxScaleBias: number;
  59767. /**
  59768. * If sets to true, disables all the lights affecting the material.
  59769. */
  59770. disableLighting: boolean;
  59771. /**
  59772. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59773. */
  59774. forceIrradianceInFragment: boolean;
  59775. /**
  59776. * Number of Simultaneous lights allowed on the material.
  59777. */
  59778. maxSimultaneousLights: number;
  59779. /**
  59780. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  59781. */
  59782. invertNormalMapX: boolean;
  59783. /**
  59784. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  59785. */
  59786. invertNormalMapY: boolean;
  59787. /**
  59788. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59789. */
  59790. twoSidedLighting: boolean;
  59791. /**
  59792. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59793. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59794. */
  59795. useAlphaFresnel: boolean;
  59796. /**
  59797. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59798. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59799. */
  59800. useLinearAlphaFresnel: boolean;
  59801. /**
  59802. * Let user defines the brdf lookup texture used for IBL.
  59803. * A default 8bit version is embedded but you could point at :
  59804. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  59805. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  59806. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  59807. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  59808. */
  59809. environmentBRDFTexture: Nullable<BaseTexture>;
  59810. /**
  59811. * Force normal to face away from face.
  59812. */
  59813. forceNormalForward: boolean;
  59814. /**
  59815. * Enables specular anti aliasing in the PBR shader.
  59816. * It will both interacts on the Geometry for analytical and IBL lighting.
  59817. * It also prefilter the roughness map based on the bump values.
  59818. */
  59819. enableSpecularAntiAliasing: boolean;
  59820. /**
  59821. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59822. * makes the reflect vector face the model (under horizon).
  59823. */
  59824. useHorizonOcclusion: boolean;
  59825. /**
  59826. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59827. * too much the area relying on ambient texture to define their ambient occlusion.
  59828. */
  59829. useRadianceOcclusion: boolean;
  59830. /**
  59831. * If set to true, no lighting calculations will be applied.
  59832. */
  59833. unlit: boolean;
  59834. /**
  59835. * Gets the image processing configuration used either in this material.
  59836. */
  59837. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  59838. /**
  59839. * Sets the Default image processing configuration used either in the this material.
  59840. *
  59841. * If sets to null, the scene one is in use.
  59842. */
  59843. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  59844. /**
  59845. * Gets wether the color curves effect is enabled.
  59846. */
  59847. get cameraColorCurvesEnabled(): boolean;
  59848. /**
  59849. * Sets wether the color curves effect is enabled.
  59850. */
  59851. set cameraColorCurvesEnabled(value: boolean);
  59852. /**
  59853. * Gets wether the color grading effect is enabled.
  59854. */
  59855. get cameraColorGradingEnabled(): boolean;
  59856. /**
  59857. * Gets wether the color grading effect is enabled.
  59858. */
  59859. set cameraColorGradingEnabled(value: boolean);
  59860. /**
  59861. * Gets wether tonemapping is enabled or not.
  59862. */
  59863. get cameraToneMappingEnabled(): boolean;
  59864. /**
  59865. * Sets wether tonemapping is enabled or not
  59866. */
  59867. set cameraToneMappingEnabled(value: boolean);
  59868. /**
  59869. * The camera exposure used on this material.
  59870. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59871. * This corresponds to a photographic exposure.
  59872. */
  59873. get cameraExposure(): number;
  59874. /**
  59875. * The camera exposure used on this material.
  59876. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59877. * This corresponds to a photographic exposure.
  59878. */
  59879. set cameraExposure(value: number);
  59880. /**
  59881. * Gets The camera contrast used on this material.
  59882. */
  59883. get cameraContrast(): number;
  59884. /**
  59885. * Sets The camera contrast used on this material.
  59886. */
  59887. set cameraContrast(value: number);
  59888. /**
  59889. * Gets the Color Grading 2D Lookup Texture.
  59890. */
  59891. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  59892. /**
  59893. * Sets the Color Grading 2D Lookup Texture.
  59894. */
  59895. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  59896. /**
  59897. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59898. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59899. * 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;
  59900. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59901. */
  59902. get cameraColorCurves(): Nullable<ColorCurves>;
  59903. /**
  59904. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59905. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59906. * 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;
  59907. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59908. */
  59909. set cameraColorCurves(value: Nullable<ColorCurves>);
  59910. /**
  59911. * Instantiates a new PBRMaterial instance.
  59912. *
  59913. * @param name The material name
  59914. * @param scene The scene the material will be use in.
  59915. */
  59916. constructor(name: string, scene: Scene);
  59917. /**
  59918. * Returns the name of this material class.
  59919. */
  59920. getClassName(): string;
  59921. /**
  59922. * Makes a duplicate of the current material.
  59923. * @param name - name to use for the new material.
  59924. */
  59925. clone(name: string): PBRMaterial;
  59926. /**
  59927. * Serializes this PBR Material.
  59928. * @returns - An object with the serialized material.
  59929. */
  59930. serialize(): any;
  59931. /**
  59932. * Parses a PBR Material from a serialized object.
  59933. * @param source - Serialized object.
  59934. * @param scene - BJS scene instance.
  59935. * @param rootUrl - url for the scene object
  59936. * @returns - PBRMaterial
  59937. */
  59938. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  59939. }
  59940. }
  59941. declare module "babylonjs/Misc/dds" {
  59942. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  59943. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59944. import { Nullable } from "babylonjs/types";
  59945. import { Scene } from "babylonjs/scene";
  59946. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  59947. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59948. /**
  59949. * Direct draw surface info
  59950. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  59951. */
  59952. export interface DDSInfo {
  59953. /**
  59954. * Width of the texture
  59955. */
  59956. width: number;
  59957. /**
  59958. * Width of the texture
  59959. */
  59960. height: number;
  59961. /**
  59962. * Number of Mipmaps for the texture
  59963. * @see https://en.wikipedia.org/wiki/Mipmap
  59964. */
  59965. mipmapCount: number;
  59966. /**
  59967. * If the textures format is a known fourCC format
  59968. * @see https://www.fourcc.org/
  59969. */
  59970. isFourCC: boolean;
  59971. /**
  59972. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  59973. */
  59974. isRGB: boolean;
  59975. /**
  59976. * If the texture is a lumincance format
  59977. */
  59978. isLuminance: boolean;
  59979. /**
  59980. * If this is a cube texture
  59981. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  59982. */
  59983. isCube: boolean;
  59984. /**
  59985. * If the texture is a compressed format eg. FOURCC_DXT1
  59986. */
  59987. isCompressed: boolean;
  59988. /**
  59989. * The dxgiFormat of the texture
  59990. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  59991. */
  59992. dxgiFormat: number;
  59993. /**
  59994. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  59995. */
  59996. textureType: number;
  59997. /**
  59998. * Sphericle polynomial created for the dds texture
  59999. */
  60000. sphericalPolynomial?: SphericalPolynomial;
  60001. }
  60002. /**
  60003. * Class used to provide DDS decompression tools
  60004. */
  60005. export class DDSTools {
  60006. /**
  60007. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  60008. */
  60009. static StoreLODInAlphaChannel: boolean;
  60010. /**
  60011. * Gets DDS information from an array buffer
  60012. * @param data defines the array buffer view to read data from
  60013. * @returns the DDS information
  60014. */
  60015. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  60016. private static _FloatView;
  60017. private static _Int32View;
  60018. private static _ToHalfFloat;
  60019. private static _FromHalfFloat;
  60020. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  60021. private static _GetHalfFloatRGBAArrayBuffer;
  60022. private static _GetFloatRGBAArrayBuffer;
  60023. private static _GetFloatAsUIntRGBAArrayBuffer;
  60024. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  60025. private static _GetRGBAArrayBuffer;
  60026. private static _ExtractLongWordOrder;
  60027. private static _GetRGBArrayBuffer;
  60028. private static _GetLuminanceArrayBuffer;
  60029. /**
  60030. * Uploads DDS Levels to a Babylon Texture
  60031. * @hidden
  60032. */
  60033. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  60034. }
  60035. module "babylonjs/Engines/thinEngine" {
  60036. interface ThinEngine {
  60037. /**
  60038. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  60039. * @param rootUrl defines the url where the file to load is located
  60040. * @param scene defines the current scene
  60041. * @param lodScale defines scale to apply to the mip map selection
  60042. * @param lodOffset defines offset to apply to the mip map selection
  60043. * @param onLoad defines an optional callback raised when the texture is loaded
  60044. * @param onError defines an optional callback raised if there is an issue to load the texture
  60045. * @param format defines the format of the data
  60046. * @param forcedExtension defines the extension to use to pick the right loader
  60047. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  60048. * @returns the cube texture as an InternalTexture
  60049. */
  60050. 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;
  60051. }
  60052. }
  60053. }
  60054. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  60055. import { Nullable } from "babylonjs/types";
  60056. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60057. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60058. /**
  60059. * Implementation of the DDS Texture Loader.
  60060. * @hidden
  60061. */
  60062. export class _DDSTextureLoader implements IInternalTextureLoader {
  60063. /**
  60064. * Defines wether the loader supports cascade loading the different faces.
  60065. */
  60066. readonly supportCascades: boolean;
  60067. /**
  60068. * This returns if the loader support the current file information.
  60069. * @param extension defines the file extension of the file being loaded
  60070. * @returns true if the loader can load the specified file
  60071. */
  60072. canLoad(extension: string): boolean;
  60073. /**
  60074. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60075. * @param data contains the texture data
  60076. * @param texture defines the BabylonJS internal texture
  60077. * @param createPolynomials will be true if polynomials have been requested
  60078. * @param onLoad defines the callback to trigger once the texture is ready
  60079. * @param onError defines the callback to trigger in case of error
  60080. */
  60081. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60082. /**
  60083. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60084. * @param data contains the texture data
  60085. * @param texture defines the BabylonJS internal texture
  60086. * @param callback defines the method to call once ready to upload
  60087. */
  60088. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60089. }
  60090. }
  60091. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  60092. import { Nullable } from "babylonjs/types";
  60093. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60094. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60095. /**
  60096. * Implementation of the ENV Texture Loader.
  60097. * @hidden
  60098. */
  60099. export class _ENVTextureLoader implements IInternalTextureLoader {
  60100. /**
  60101. * Defines wether the loader supports cascade loading the different faces.
  60102. */
  60103. readonly supportCascades: boolean;
  60104. /**
  60105. * This returns if the loader support the current file information.
  60106. * @param extension defines the file extension of the file being loaded
  60107. * @returns true if the loader can load the specified file
  60108. */
  60109. canLoad(extension: string): boolean;
  60110. /**
  60111. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60112. * @param data contains the texture data
  60113. * @param texture defines the BabylonJS internal texture
  60114. * @param createPolynomials will be true if polynomials have been requested
  60115. * @param onLoad defines the callback to trigger once the texture is ready
  60116. * @param onError defines the callback to trigger in case of error
  60117. */
  60118. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60119. /**
  60120. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60121. * @param data contains the texture data
  60122. * @param texture defines the BabylonJS internal texture
  60123. * @param callback defines the method to call once ready to upload
  60124. */
  60125. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60126. }
  60127. }
  60128. declare module "babylonjs/Misc/khronosTextureContainer" {
  60129. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60130. /**
  60131. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  60132. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  60133. */
  60134. export class KhronosTextureContainer {
  60135. /** contents of the KTX container file */
  60136. data: ArrayBufferView;
  60137. private static HEADER_LEN;
  60138. private static COMPRESSED_2D;
  60139. private static COMPRESSED_3D;
  60140. private static TEX_2D;
  60141. private static TEX_3D;
  60142. /**
  60143. * Gets the openGL type
  60144. */
  60145. glType: number;
  60146. /**
  60147. * Gets the openGL type size
  60148. */
  60149. glTypeSize: number;
  60150. /**
  60151. * Gets the openGL format
  60152. */
  60153. glFormat: number;
  60154. /**
  60155. * Gets the openGL internal format
  60156. */
  60157. glInternalFormat: number;
  60158. /**
  60159. * Gets the base internal format
  60160. */
  60161. glBaseInternalFormat: number;
  60162. /**
  60163. * Gets image width in pixel
  60164. */
  60165. pixelWidth: number;
  60166. /**
  60167. * Gets image height in pixel
  60168. */
  60169. pixelHeight: number;
  60170. /**
  60171. * Gets image depth in pixels
  60172. */
  60173. pixelDepth: number;
  60174. /**
  60175. * Gets the number of array elements
  60176. */
  60177. numberOfArrayElements: number;
  60178. /**
  60179. * Gets the number of faces
  60180. */
  60181. numberOfFaces: number;
  60182. /**
  60183. * Gets the number of mipmap levels
  60184. */
  60185. numberOfMipmapLevels: number;
  60186. /**
  60187. * Gets the bytes of key value data
  60188. */
  60189. bytesOfKeyValueData: number;
  60190. /**
  60191. * Gets the load type
  60192. */
  60193. loadType: number;
  60194. /**
  60195. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  60196. */
  60197. isInvalid: boolean;
  60198. /**
  60199. * Creates a new KhronosTextureContainer
  60200. * @param data contents of the KTX container file
  60201. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  60202. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  60203. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  60204. */
  60205. constructor(
  60206. /** contents of the KTX container file */
  60207. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  60208. /**
  60209. * Uploads KTX content to a Babylon Texture.
  60210. * It is assumed that the texture has already been created & is currently bound
  60211. * @hidden
  60212. */
  60213. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  60214. private _upload2DCompressedLevels;
  60215. /**
  60216. * Checks if the given data starts with a KTX file identifier.
  60217. * @param data the data to check
  60218. * @returns true if the data is a KTX file or false otherwise
  60219. */
  60220. static IsValid(data: ArrayBufferView): boolean;
  60221. }
  60222. }
  60223. declare module "babylonjs/Misc/khronosTextureContainer2" {
  60224. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60225. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60226. /**
  60227. * Class for loading KTX2 files
  60228. * !!! Experimental Extension Subject to Changes !!!
  60229. * @hidden
  60230. */
  60231. export class KhronosTextureContainer2 {
  60232. private static _ModulePromise;
  60233. private static _TranscodeFormat;
  60234. constructor(engine: ThinEngine);
  60235. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  60236. private _determineTranscodeFormat;
  60237. /**
  60238. * Checks if the given data starts with a KTX2 file identifier.
  60239. * @param data the data to check
  60240. * @returns true if the data is a KTX2 file or false otherwise
  60241. */
  60242. static IsValid(data: ArrayBufferView): boolean;
  60243. }
  60244. }
  60245. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  60246. import { Nullable } from "babylonjs/types";
  60247. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60248. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60249. /**
  60250. * Implementation of the KTX Texture Loader.
  60251. * @hidden
  60252. */
  60253. export class _KTXTextureLoader implements IInternalTextureLoader {
  60254. /**
  60255. * Defines wether the loader supports cascade loading the different faces.
  60256. */
  60257. readonly supportCascades: boolean;
  60258. /**
  60259. * This returns if the loader support the current file information.
  60260. * @param extension defines the file extension of the file being loaded
  60261. * @param mimeType defines the optional mime type of the file being loaded
  60262. * @returns true if the loader can load the specified file
  60263. */
  60264. canLoad(extension: string, mimeType?: string): boolean;
  60265. /**
  60266. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60267. * @param data contains the texture data
  60268. * @param texture defines the BabylonJS internal texture
  60269. * @param createPolynomials will be true if polynomials have been requested
  60270. * @param onLoad defines the callback to trigger once the texture is ready
  60271. * @param onError defines the callback to trigger in case of error
  60272. */
  60273. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60274. /**
  60275. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60276. * @param data contains the texture data
  60277. * @param texture defines the BabylonJS internal texture
  60278. * @param callback defines the method to call once ready to upload
  60279. */
  60280. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  60281. }
  60282. }
  60283. declare module "babylonjs/Helpers/sceneHelpers" {
  60284. import { Nullable } from "babylonjs/types";
  60285. import { Mesh } from "babylonjs/Meshes/mesh";
  60286. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60287. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  60288. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  60289. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  60290. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  60291. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  60292. import "babylonjs/Meshes/Builders/boxBuilder";
  60293. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  60294. /** @hidden */
  60295. export var _forceSceneHelpersToBundle: boolean;
  60296. module "babylonjs/scene" {
  60297. interface Scene {
  60298. /**
  60299. * Creates a default light for the scene.
  60300. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  60301. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  60302. */
  60303. createDefaultLight(replace?: boolean): void;
  60304. /**
  60305. * Creates a default camera for the scene.
  60306. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  60307. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60308. * @param replace has default false, when true replaces the active camera in the scene
  60309. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  60310. */
  60311. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60312. /**
  60313. * Creates a default camera and a default light.
  60314. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  60315. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60316. * @param replace has the default false, when true replaces the active camera/light in the scene
  60317. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  60318. */
  60319. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60320. /**
  60321. * Creates a new sky box
  60322. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  60323. * @param environmentTexture defines the texture to use as environment texture
  60324. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  60325. * @param scale defines the overall scale of the skybox
  60326. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  60327. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  60328. * @returns a new mesh holding the sky box
  60329. */
  60330. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  60331. /**
  60332. * Creates a new environment
  60333. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  60334. * @param options defines the options you can use to configure the environment
  60335. * @returns the new EnvironmentHelper
  60336. */
  60337. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  60338. /**
  60339. * Creates a new VREXperienceHelper
  60340. * @see https://doc.babylonjs.com/how_to/webvr_helper
  60341. * @param webVROptions defines the options used to create the new VREXperienceHelper
  60342. * @returns a new VREXperienceHelper
  60343. */
  60344. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  60345. /**
  60346. * Creates a new WebXRDefaultExperience
  60347. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  60348. * @param options experience options
  60349. * @returns a promise for a new WebXRDefaultExperience
  60350. */
  60351. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  60352. }
  60353. }
  60354. }
  60355. declare module "babylonjs/Helpers/videoDome" {
  60356. import { Scene } from "babylonjs/scene";
  60357. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  60358. import { TextureDome } from "babylonjs/Helpers/textureDome";
  60359. /**
  60360. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  60361. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  60362. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  60363. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60364. */
  60365. export class VideoDome extends TextureDome<VideoTexture> {
  60366. /**
  60367. * Define the video source as a Monoscopic panoramic 360 video.
  60368. */
  60369. static readonly MODE_MONOSCOPIC: number;
  60370. /**
  60371. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60372. */
  60373. static readonly MODE_TOPBOTTOM: number;
  60374. /**
  60375. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60376. */
  60377. static readonly MODE_SIDEBYSIDE: number;
  60378. /**
  60379. * Get the video texture associated with this video dome
  60380. */
  60381. get videoTexture(): VideoTexture;
  60382. /**
  60383. * Get the video mode of this dome
  60384. */
  60385. get videoMode(): number;
  60386. /**
  60387. * Set the video mode of this dome.
  60388. * @see textureMode
  60389. */
  60390. set videoMode(value: number);
  60391. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  60392. }
  60393. }
  60394. declare module "babylonjs/Helpers/index" {
  60395. export * from "babylonjs/Helpers/environmentHelper";
  60396. export * from "babylonjs/Helpers/photoDome";
  60397. export * from "babylonjs/Helpers/sceneHelpers";
  60398. export * from "babylonjs/Helpers/videoDome";
  60399. }
  60400. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  60401. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60402. import { IDisposable } from "babylonjs/scene";
  60403. import { Engine } from "babylonjs/Engines/engine";
  60404. /**
  60405. * This class can be used to get instrumentation data from a Babylon engine
  60406. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60407. */
  60408. export class EngineInstrumentation implements IDisposable {
  60409. /**
  60410. * Define the instrumented engine.
  60411. */
  60412. engine: Engine;
  60413. private _captureGPUFrameTime;
  60414. private _gpuFrameTimeToken;
  60415. private _gpuFrameTime;
  60416. private _captureShaderCompilationTime;
  60417. private _shaderCompilationTime;
  60418. private _onBeginFrameObserver;
  60419. private _onEndFrameObserver;
  60420. private _onBeforeShaderCompilationObserver;
  60421. private _onAfterShaderCompilationObserver;
  60422. /**
  60423. * Gets the perf counter used for GPU frame time
  60424. */
  60425. get gpuFrameTimeCounter(): PerfCounter;
  60426. /**
  60427. * Gets the GPU frame time capture status
  60428. */
  60429. get captureGPUFrameTime(): boolean;
  60430. /**
  60431. * Enable or disable the GPU frame time capture
  60432. */
  60433. set captureGPUFrameTime(value: boolean);
  60434. /**
  60435. * Gets the perf counter used for shader compilation time
  60436. */
  60437. get shaderCompilationTimeCounter(): PerfCounter;
  60438. /**
  60439. * Gets the shader compilation time capture status
  60440. */
  60441. get captureShaderCompilationTime(): boolean;
  60442. /**
  60443. * Enable or disable the shader compilation time capture
  60444. */
  60445. set captureShaderCompilationTime(value: boolean);
  60446. /**
  60447. * Instantiates a new engine instrumentation.
  60448. * This class can be used to get instrumentation data from a Babylon engine
  60449. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60450. * @param engine Defines the engine to instrument
  60451. */
  60452. constructor(
  60453. /**
  60454. * Define the instrumented engine.
  60455. */
  60456. engine: Engine);
  60457. /**
  60458. * Dispose and release associated resources.
  60459. */
  60460. dispose(): void;
  60461. }
  60462. }
  60463. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  60464. import { Scene, IDisposable } from "babylonjs/scene";
  60465. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60466. /**
  60467. * This class can be used to get instrumentation data from a Babylon engine
  60468. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60469. */
  60470. export class SceneInstrumentation implements IDisposable {
  60471. /**
  60472. * Defines the scene to instrument
  60473. */
  60474. scene: Scene;
  60475. private _captureActiveMeshesEvaluationTime;
  60476. private _activeMeshesEvaluationTime;
  60477. private _captureRenderTargetsRenderTime;
  60478. private _renderTargetsRenderTime;
  60479. private _captureFrameTime;
  60480. private _frameTime;
  60481. private _captureRenderTime;
  60482. private _renderTime;
  60483. private _captureInterFrameTime;
  60484. private _interFrameTime;
  60485. private _captureParticlesRenderTime;
  60486. private _particlesRenderTime;
  60487. private _captureSpritesRenderTime;
  60488. private _spritesRenderTime;
  60489. private _capturePhysicsTime;
  60490. private _physicsTime;
  60491. private _captureAnimationsTime;
  60492. private _animationsTime;
  60493. private _captureCameraRenderTime;
  60494. private _cameraRenderTime;
  60495. private _onBeforeActiveMeshesEvaluationObserver;
  60496. private _onAfterActiveMeshesEvaluationObserver;
  60497. private _onBeforeRenderTargetsRenderObserver;
  60498. private _onAfterRenderTargetsRenderObserver;
  60499. private _onAfterRenderObserver;
  60500. private _onBeforeDrawPhaseObserver;
  60501. private _onAfterDrawPhaseObserver;
  60502. private _onBeforeAnimationsObserver;
  60503. private _onBeforeParticlesRenderingObserver;
  60504. private _onAfterParticlesRenderingObserver;
  60505. private _onBeforeSpritesRenderingObserver;
  60506. private _onAfterSpritesRenderingObserver;
  60507. private _onBeforePhysicsObserver;
  60508. private _onAfterPhysicsObserver;
  60509. private _onAfterAnimationsObserver;
  60510. private _onBeforeCameraRenderObserver;
  60511. private _onAfterCameraRenderObserver;
  60512. /**
  60513. * Gets the perf counter used for active meshes evaluation time
  60514. */
  60515. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  60516. /**
  60517. * Gets the active meshes evaluation time capture status
  60518. */
  60519. get captureActiveMeshesEvaluationTime(): boolean;
  60520. /**
  60521. * Enable or disable the active meshes evaluation time capture
  60522. */
  60523. set captureActiveMeshesEvaluationTime(value: boolean);
  60524. /**
  60525. * Gets the perf counter used for render targets render time
  60526. */
  60527. get renderTargetsRenderTimeCounter(): PerfCounter;
  60528. /**
  60529. * Gets the render targets render time capture status
  60530. */
  60531. get captureRenderTargetsRenderTime(): boolean;
  60532. /**
  60533. * Enable or disable the render targets render time capture
  60534. */
  60535. set captureRenderTargetsRenderTime(value: boolean);
  60536. /**
  60537. * Gets the perf counter used for particles render time
  60538. */
  60539. get particlesRenderTimeCounter(): PerfCounter;
  60540. /**
  60541. * Gets the particles render time capture status
  60542. */
  60543. get captureParticlesRenderTime(): boolean;
  60544. /**
  60545. * Enable or disable the particles render time capture
  60546. */
  60547. set captureParticlesRenderTime(value: boolean);
  60548. /**
  60549. * Gets the perf counter used for sprites render time
  60550. */
  60551. get spritesRenderTimeCounter(): PerfCounter;
  60552. /**
  60553. * Gets the sprites render time capture status
  60554. */
  60555. get captureSpritesRenderTime(): boolean;
  60556. /**
  60557. * Enable or disable the sprites render time capture
  60558. */
  60559. set captureSpritesRenderTime(value: boolean);
  60560. /**
  60561. * Gets the perf counter used for physics time
  60562. */
  60563. get physicsTimeCounter(): PerfCounter;
  60564. /**
  60565. * Gets the physics time capture status
  60566. */
  60567. get capturePhysicsTime(): boolean;
  60568. /**
  60569. * Enable or disable the physics time capture
  60570. */
  60571. set capturePhysicsTime(value: boolean);
  60572. /**
  60573. * Gets the perf counter used for animations time
  60574. */
  60575. get animationsTimeCounter(): PerfCounter;
  60576. /**
  60577. * Gets the animations time capture status
  60578. */
  60579. get captureAnimationsTime(): boolean;
  60580. /**
  60581. * Enable or disable the animations time capture
  60582. */
  60583. set captureAnimationsTime(value: boolean);
  60584. /**
  60585. * Gets the perf counter used for frame time capture
  60586. */
  60587. get frameTimeCounter(): PerfCounter;
  60588. /**
  60589. * Gets the frame time capture status
  60590. */
  60591. get captureFrameTime(): boolean;
  60592. /**
  60593. * Enable or disable the frame time capture
  60594. */
  60595. set captureFrameTime(value: boolean);
  60596. /**
  60597. * Gets the perf counter used for inter-frames time capture
  60598. */
  60599. get interFrameTimeCounter(): PerfCounter;
  60600. /**
  60601. * Gets the inter-frames time capture status
  60602. */
  60603. get captureInterFrameTime(): boolean;
  60604. /**
  60605. * Enable or disable the inter-frames time capture
  60606. */
  60607. set captureInterFrameTime(value: boolean);
  60608. /**
  60609. * Gets the perf counter used for render time capture
  60610. */
  60611. get renderTimeCounter(): PerfCounter;
  60612. /**
  60613. * Gets the render time capture status
  60614. */
  60615. get captureRenderTime(): boolean;
  60616. /**
  60617. * Enable or disable the render time capture
  60618. */
  60619. set captureRenderTime(value: boolean);
  60620. /**
  60621. * Gets the perf counter used for camera render time capture
  60622. */
  60623. get cameraRenderTimeCounter(): PerfCounter;
  60624. /**
  60625. * Gets the camera render time capture status
  60626. */
  60627. get captureCameraRenderTime(): boolean;
  60628. /**
  60629. * Enable or disable the camera render time capture
  60630. */
  60631. set captureCameraRenderTime(value: boolean);
  60632. /**
  60633. * Gets the perf counter used for draw calls
  60634. */
  60635. get drawCallsCounter(): PerfCounter;
  60636. /**
  60637. * Instantiates a new scene instrumentation.
  60638. * This class can be used to get instrumentation data from a Babylon engine
  60639. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60640. * @param scene Defines the scene to instrument
  60641. */
  60642. constructor(
  60643. /**
  60644. * Defines the scene to instrument
  60645. */
  60646. scene: Scene);
  60647. /**
  60648. * Dispose and release associated resources.
  60649. */
  60650. dispose(): void;
  60651. }
  60652. }
  60653. declare module "babylonjs/Instrumentation/index" {
  60654. export * from "babylonjs/Instrumentation/engineInstrumentation";
  60655. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  60656. export * from "babylonjs/Instrumentation/timeToken";
  60657. }
  60658. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  60659. /** @hidden */
  60660. export var glowMapGenerationPixelShader: {
  60661. name: string;
  60662. shader: string;
  60663. };
  60664. }
  60665. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  60666. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60667. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60668. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60669. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60670. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60671. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60672. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60673. /** @hidden */
  60674. export var glowMapGenerationVertexShader: {
  60675. name: string;
  60676. shader: string;
  60677. };
  60678. }
  60679. declare module "babylonjs/Layers/effectLayer" {
  60680. import { Observable } from "babylonjs/Misc/observable";
  60681. import { Nullable } from "babylonjs/types";
  60682. import { Camera } from "babylonjs/Cameras/camera";
  60683. import { Scene } from "babylonjs/scene";
  60684. import { ISize } from "babylonjs/Maths/math.size";
  60685. import { Color4 } from "babylonjs/Maths/math.color";
  60686. import { Engine } from "babylonjs/Engines/engine";
  60687. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60688. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60689. import { Mesh } from "babylonjs/Meshes/mesh";
  60690. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60691. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60692. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60693. import { Effect } from "babylonjs/Materials/effect";
  60694. import { Material } from "babylonjs/Materials/material";
  60695. import "babylonjs/Shaders/glowMapGeneration.fragment";
  60696. import "babylonjs/Shaders/glowMapGeneration.vertex";
  60697. /**
  60698. * Effect layer options. This helps customizing the behaviour
  60699. * of the effect layer.
  60700. */
  60701. export interface IEffectLayerOptions {
  60702. /**
  60703. * Multiplication factor apply to the canvas size to compute the render target size
  60704. * used to generated the objects (the smaller the faster).
  60705. */
  60706. mainTextureRatio: number;
  60707. /**
  60708. * Enforces a fixed size texture to ensure effect stability across devices.
  60709. */
  60710. mainTextureFixedSize?: number;
  60711. /**
  60712. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  60713. */
  60714. alphaBlendingMode: number;
  60715. /**
  60716. * The camera attached to the layer.
  60717. */
  60718. camera: Nullable<Camera>;
  60719. /**
  60720. * The rendering group to draw the layer in.
  60721. */
  60722. renderingGroupId: number;
  60723. }
  60724. /**
  60725. * The effect layer Helps adding post process effect blended with the main pass.
  60726. *
  60727. * This can be for instance use to generate glow or higlight effects on the scene.
  60728. *
  60729. * The effect layer class can not be used directly and is intented to inherited from to be
  60730. * customized per effects.
  60731. */
  60732. export abstract class EffectLayer {
  60733. private _vertexBuffers;
  60734. private _indexBuffer;
  60735. private _cachedDefines;
  60736. private _effectLayerMapGenerationEffect;
  60737. private _effectLayerOptions;
  60738. private _mergeEffect;
  60739. protected _scene: Scene;
  60740. protected _engine: Engine;
  60741. protected _maxSize: number;
  60742. protected _mainTextureDesiredSize: ISize;
  60743. protected _mainTexture: RenderTargetTexture;
  60744. protected _shouldRender: boolean;
  60745. protected _postProcesses: PostProcess[];
  60746. protected _textures: BaseTexture[];
  60747. protected _emissiveTextureAndColor: {
  60748. texture: Nullable<BaseTexture>;
  60749. color: Color4;
  60750. };
  60751. /**
  60752. * The name of the layer
  60753. */
  60754. name: string;
  60755. /**
  60756. * The clear color of the texture used to generate the glow map.
  60757. */
  60758. neutralColor: Color4;
  60759. /**
  60760. * Specifies whether the highlight layer is enabled or not.
  60761. */
  60762. isEnabled: boolean;
  60763. /**
  60764. * Gets the camera attached to the layer.
  60765. */
  60766. get camera(): Nullable<Camera>;
  60767. /**
  60768. * Gets the rendering group id the layer should render in.
  60769. */
  60770. get renderingGroupId(): number;
  60771. set renderingGroupId(renderingGroupId: number);
  60772. /**
  60773. * An event triggered when the effect layer has been disposed.
  60774. */
  60775. onDisposeObservable: Observable<EffectLayer>;
  60776. /**
  60777. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  60778. */
  60779. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  60780. /**
  60781. * An event triggered when the generated texture is being merged in the scene.
  60782. */
  60783. onBeforeComposeObservable: Observable<EffectLayer>;
  60784. /**
  60785. * An event triggered when the mesh is rendered into the effect render target.
  60786. */
  60787. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  60788. /**
  60789. * An event triggered after the mesh has been rendered into the effect render target.
  60790. */
  60791. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  60792. /**
  60793. * An event triggered when the generated texture has been merged in the scene.
  60794. */
  60795. onAfterComposeObservable: Observable<EffectLayer>;
  60796. /**
  60797. * An event triggered when the efffect layer changes its size.
  60798. */
  60799. onSizeChangedObservable: Observable<EffectLayer>;
  60800. /** @hidden */
  60801. static _SceneComponentInitialization: (scene: Scene) => void;
  60802. /**
  60803. * Instantiates a new effect Layer and references it in the scene.
  60804. * @param name The name of the layer
  60805. * @param scene The scene to use the layer in
  60806. */
  60807. constructor(
  60808. /** The Friendly of the effect in the scene */
  60809. name: string, scene: Scene);
  60810. /**
  60811. * Get the effect name of the layer.
  60812. * @return The effect name
  60813. */
  60814. abstract getEffectName(): string;
  60815. /**
  60816. * Checks for the readiness of the element composing the layer.
  60817. * @param subMesh the mesh to check for
  60818. * @param useInstances specify whether or not to use instances to render the mesh
  60819. * @return true if ready otherwise, false
  60820. */
  60821. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60822. /**
  60823. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60824. * @returns true if the effect requires stencil during the main canvas render pass.
  60825. */
  60826. abstract needStencil(): boolean;
  60827. /**
  60828. * Create the merge effect. This is the shader use to blit the information back
  60829. * to the main canvas at the end of the scene rendering.
  60830. * @returns The effect containing the shader used to merge the effect on the main canvas
  60831. */
  60832. protected abstract _createMergeEffect(): Effect;
  60833. /**
  60834. * Creates the render target textures and post processes used in the effect layer.
  60835. */
  60836. protected abstract _createTextureAndPostProcesses(): void;
  60837. /**
  60838. * Implementation specific of rendering the generating effect on the main canvas.
  60839. * @param effect The effect used to render through
  60840. */
  60841. protected abstract _internalRender(effect: Effect): void;
  60842. /**
  60843. * Sets the required values for both the emissive texture and and the main color.
  60844. */
  60845. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60846. /**
  60847. * Free any resources and references associated to a mesh.
  60848. * Internal use
  60849. * @param mesh The mesh to free.
  60850. */
  60851. abstract _disposeMesh(mesh: Mesh): void;
  60852. /**
  60853. * Serializes this layer (Glow or Highlight for example)
  60854. * @returns a serialized layer object
  60855. */
  60856. abstract serialize?(): any;
  60857. /**
  60858. * Initializes the effect layer with the required options.
  60859. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  60860. */
  60861. protected _init(options: Partial<IEffectLayerOptions>): void;
  60862. /**
  60863. * Generates the index buffer of the full screen quad blending to the main canvas.
  60864. */
  60865. private _generateIndexBuffer;
  60866. /**
  60867. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  60868. */
  60869. private _generateVertexBuffer;
  60870. /**
  60871. * Sets the main texture desired size which is the closest power of two
  60872. * of the engine canvas size.
  60873. */
  60874. private _setMainTextureSize;
  60875. /**
  60876. * Creates the main texture for the effect layer.
  60877. */
  60878. protected _createMainTexture(): void;
  60879. /**
  60880. * Adds specific effects defines.
  60881. * @param defines The defines to add specifics to.
  60882. */
  60883. protected _addCustomEffectDefines(defines: string[]): void;
  60884. /**
  60885. * Checks for the readiness of the element composing the layer.
  60886. * @param subMesh the mesh to check for
  60887. * @param useInstances specify whether or not to use instances to render the mesh
  60888. * @param emissiveTexture the associated emissive texture used to generate the glow
  60889. * @return true if ready otherwise, false
  60890. */
  60891. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  60892. /**
  60893. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  60894. */
  60895. render(): void;
  60896. /**
  60897. * Determine if a given mesh will be used in the current effect.
  60898. * @param mesh mesh to test
  60899. * @returns true if the mesh will be used
  60900. */
  60901. hasMesh(mesh: AbstractMesh): boolean;
  60902. /**
  60903. * Returns true if the layer contains information to display, otherwise false.
  60904. * @returns true if the glow layer should be rendered
  60905. */
  60906. shouldRender(): boolean;
  60907. /**
  60908. * Returns true if the mesh should render, otherwise false.
  60909. * @param mesh The mesh to render
  60910. * @returns true if it should render otherwise false
  60911. */
  60912. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  60913. /**
  60914. * Returns true if the mesh can be rendered, otherwise false.
  60915. * @param mesh The mesh to render
  60916. * @param material The material used on the mesh
  60917. * @returns true if it can be rendered otherwise false
  60918. */
  60919. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60920. /**
  60921. * Returns true if the mesh should render, otherwise false.
  60922. * @param mesh The mesh to render
  60923. * @returns true if it should render otherwise false
  60924. */
  60925. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  60926. /**
  60927. * Renders the submesh passed in parameter to the generation map.
  60928. */
  60929. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  60930. /**
  60931. * Defines whether the current material of the mesh should be use to render the effect.
  60932. * @param mesh defines the current mesh to render
  60933. */
  60934. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60935. /**
  60936. * Rebuild the required buffers.
  60937. * @hidden Internal use only.
  60938. */
  60939. _rebuild(): void;
  60940. /**
  60941. * Dispose only the render target textures and post process.
  60942. */
  60943. private _disposeTextureAndPostProcesses;
  60944. /**
  60945. * Dispose the highlight layer and free resources.
  60946. */
  60947. dispose(): void;
  60948. /**
  60949. * Gets the class name of the effect layer
  60950. * @returns the string with the class name of the effect layer
  60951. */
  60952. getClassName(): string;
  60953. /**
  60954. * Creates an effect layer from parsed effect layer data
  60955. * @param parsedEffectLayer defines effect layer data
  60956. * @param scene defines the current scene
  60957. * @param rootUrl defines the root URL containing the effect layer information
  60958. * @returns a parsed effect Layer
  60959. */
  60960. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  60961. }
  60962. }
  60963. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  60964. import { Scene } from "babylonjs/scene";
  60965. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  60966. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60967. import { AbstractScene } from "babylonjs/abstractScene";
  60968. module "babylonjs/abstractScene" {
  60969. interface AbstractScene {
  60970. /**
  60971. * The list of effect layers (highlights/glow) added to the scene
  60972. * @see https://doc.babylonjs.com/how_to/highlight_layer
  60973. * @see https://doc.babylonjs.com/how_to/glow_layer
  60974. */
  60975. effectLayers: Array<EffectLayer>;
  60976. /**
  60977. * Removes the given effect layer from this scene.
  60978. * @param toRemove defines the effect layer to remove
  60979. * @returns the index of the removed effect layer
  60980. */
  60981. removeEffectLayer(toRemove: EffectLayer): number;
  60982. /**
  60983. * Adds the given effect layer to this scene
  60984. * @param newEffectLayer defines the effect layer to add
  60985. */
  60986. addEffectLayer(newEffectLayer: EffectLayer): void;
  60987. }
  60988. }
  60989. /**
  60990. * Defines the layer scene component responsible to manage any effect layers
  60991. * in a given scene.
  60992. */
  60993. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  60994. /**
  60995. * The component name helpfull to identify the component in the list of scene components.
  60996. */
  60997. readonly name: string;
  60998. /**
  60999. * The scene the component belongs to.
  61000. */
  61001. scene: Scene;
  61002. private _engine;
  61003. private _renderEffects;
  61004. private _needStencil;
  61005. private _previousStencilState;
  61006. /**
  61007. * Creates a new instance of the component for the given scene
  61008. * @param scene Defines the scene to register the component in
  61009. */
  61010. constructor(scene: Scene);
  61011. /**
  61012. * Registers the component in a given scene
  61013. */
  61014. register(): void;
  61015. /**
  61016. * Rebuilds the elements related to this component in case of
  61017. * context lost for instance.
  61018. */
  61019. rebuild(): void;
  61020. /**
  61021. * Serializes the component data to the specified json object
  61022. * @param serializationObject The object to serialize to
  61023. */
  61024. serialize(serializationObject: any): void;
  61025. /**
  61026. * Adds all the elements from the container to the scene
  61027. * @param container the container holding the elements
  61028. */
  61029. addFromContainer(container: AbstractScene): void;
  61030. /**
  61031. * Removes all the elements in the container from the scene
  61032. * @param container contains the elements to remove
  61033. * @param dispose if the removed element should be disposed (default: false)
  61034. */
  61035. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61036. /**
  61037. * Disposes the component and the associated ressources.
  61038. */
  61039. dispose(): void;
  61040. private _isReadyForMesh;
  61041. private _renderMainTexture;
  61042. private _setStencil;
  61043. private _setStencilBack;
  61044. private _draw;
  61045. private _drawCamera;
  61046. private _drawRenderingGroup;
  61047. }
  61048. }
  61049. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  61050. /** @hidden */
  61051. export var glowMapMergePixelShader: {
  61052. name: string;
  61053. shader: string;
  61054. };
  61055. }
  61056. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  61057. /** @hidden */
  61058. export var glowMapMergeVertexShader: {
  61059. name: string;
  61060. shader: string;
  61061. };
  61062. }
  61063. declare module "babylonjs/Layers/glowLayer" {
  61064. import { Nullable } from "babylonjs/types";
  61065. import { Camera } from "babylonjs/Cameras/camera";
  61066. import { Scene } from "babylonjs/scene";
  61067. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61068. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61069. import { Mesh } from "babylonjs/Meshes/mesh";
  61070. import { Texture } from "babylonjs/Materials/Textures/texture";
  61071. import { Effect } from "babylonjs/Materials/effect";
  61072. import { Material } from "babylonjs/Materials/material";
  61073. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61074. import { Color4 } from "babylonjs/Maths/math.color";
  61075. import "babylonjs/Shaders/glowMapMerge.fragment";
  61076. import "babylonjs/Shaders/glowMapMerge.vertex";
  61077. import "babylonjs/Layers/effectLayerSceneComponent";
  61078. module "babylonjs/abstractScene" {
  61079. interface AbstractScene {
  61080. /**
  61081. * Return a the first highlight layer of the scene with a given name.
  61082. * @param name The name of the highlight layer to look for.
  61083. * @return The highlight layer if found otherwise null.
  61084. */
  61085. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  61086. }
  61087. }
  61088. /**
  61089. * Glow layer options. This helps customizing the behaviour
  61090. * of the glow layer.
  61091. */
  61092. export interface IGlowLayerOptions {
  61093. /**
  61094. * Multiplication factor apply to the canvas size to compute the render target size
  61095. * used to generated the glowing objects (the smaller the faster).
  61096. */
  61097. mainTextureRatio: number;
  61098. /**
  61099. * Enforces a fixed size texture to ensure resize independant blur.
  61100. */
  61101. mainTextureFixedSize?: number;
  61102. /**
  61103. * How big is the kernel of the blur texture.
  61104. */
  61105. blurKernelSize: number;
  61106. /**
  61107. * The camera attached to the layer.
  61108. */
  61109. camera: Nullable<Camera>;
  61110. /**
  61111. * Enable MSAA by chosing the number of samples.
  61112. */
  61113. mainTextureSamples?: number;
  61114. /**
  61115. * The rendering group to draw the layer in.
  61116. */
  61117. renderingGroupId: number;
  61118. }
  61119. /**
  61120. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  61121. *
  61122. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  61123. *
  61124. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  61125. */
  61126. export class GlowLayer extends EffectLayer {
  61127. /**
  61128. * Effect Name of the layer.
  61129. */
  61130. static readonly EffectName: string;
  61131. /**
  61132. * The default blur kernel size used for the glow.
  61133. */
  61134. static DefaultBlurKernelSize: number;
  61135. /**
  61136. * The default texture size ratio used for the glow.
  61137. */
  61138. static DefaultTextureRatio: number;
  61139. /**
  61140. * Sets the kernel size of the blur.
  61141. */
  61142. set blurKernelSize(value: number);
  61143. /**
  61144. * Gets the kernel size of the blur.
  61145. */
  61146. get blurKernelSize(): number;
  61147. /**
  61148. * Sets the glow intensity.
  61149. */
  61150. set intensity(value: number);
  61151. /**
  61152. * Gets the glow intensity.
  61153. */
  61154. get intensity(): number;
  61155. private _options;
  61156. private _intensity;
  61157. private _horizontalBlurPostprocess1;
  61158. private _verticalBlurPostprocess1;
  61159. private _horizontalBlurPostprocess2;
  61160. private _verticalBlurPostprocess2;
  61161. private _blurTexture1;
  61162. private _blurTexture2;
  61163. private _postProcesses1;
  61164. private _postProcesses2;
  61165. private _includedOnlyMeshes;
  61166. private _excludedMeshes;
  61167. private _meshesUsingTheirOwnMaterials;
  61168. /**
  61169. * Callback used to let the user override the color selection on a per mesh basis
  61170. */
  61171. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  61172. /**
  61173. * Callback used to let the user override the texture selection on a per mesh basis
  61174. */
  61175. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  61176. /**
  61177. * Instantiates a new glow Layer and references it to the scene.
  61178. * @param name The name of the layer
  61179. * @param scene The scene to use the layer in
  61180. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  61181. */
  61182. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  61183. /**
  61184. * Get the effect name of the layer.
  61185. * @return The effect name
  61186. */
  61187. getEffectName(): string;
  61188. /**
  61189. * Create the merge effect. This is the shader use to blit the information back
  61190. * to the main canvas at the end of the scene rendering.
  61191. */
  61192. protected _createMergeEffect(): Effect;
  61193. /**
  61194. * Creates the render target textures and post processes used in the glow layer.
  61195. */
  61196. protected _createTextureAndPostProcesses(): void;
  61197. /**
  61198. * Checks for the readiness of the element composing the layer.
  61199. * @param subMesh the mesh to check for
  61200. * @param useInstances specify wether or not to use instances to render the mesh
  61201. * @param emissiveTexture the associated emissive texture used to generate the glow
  61202. * @return true if ready otherwise, false
  61203. */
  61204. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61205. /**
  61206. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61207. */
  61208. needStencil(): boolean;
  61209. /**
  61210. * Returns true if the mesh can be rendered, otherwise false.
  61211. * @param mesh The mesh to render
  61212. * @param material The material used on the mesh
  61213. * @returns true if it can be rendered otherwise false
  61214. */
  61215. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61216. /**
  61217. * Implementation specific of rendering the generating effect on the main canvas.
  61218. * @param effect The effect used to render through
  61219. */
  61220. protected _internalRender(effect: Effect): void;
  61221. /**
  61222. * Sets the required values for both the emissive texture and and the main color.
  61223. */
  61224. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61225. /**
  61226. * Returns true if the mesh should render, otherwise false.
  61227. * @param mesh The mesh to render
  61228. * @returns true if it should render otherwise false
  61229. */
  61230. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61231. /**
  61232. * Adds specific effects defines.
  61233. * @param defines The defines to add specifics to.
  61234. */
  61235. protected _addCustomEffectDefines(defines: string[]): void;
  61236. /**
  61237. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  61238. * @param mesh The mesh to exclude from the glow layer
  61239. */
  61240. addExcludedMesh(mesh: Mesh): void;
  61241. /**
  61242. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  61243. * @param mesh The mesh to remove
  61244. */
  61245. removeExcludedMesh(mesh: Mesh): void;
  61246. /**
  61247. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  61248. * @param mesh The mesh to include in the glow layer
  61249. */
  61250. addIncludedOnlyMesh(mesh: Mesh): void;
  61251. /**
  61252. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  61253. * @param mesh The mesh to remove
  61254. */
  61255. removeIncludedOnlyMesh(mesh: Mesh): void;
  61256. /**
  61257. * Determine if a given mesh will be used in the glow layer
  61258. * @param mesh The mesh to test
  61259. * @returns true if the mesh will be highlighted by the current glow layer
  61260. */
  61261. hasMesh(mesh: AbstractMesh): boolean;
  61262. /**
  61263. * Defines whether the current material of the mesh should be use to render the effect.
  61264. * @param mesh defines the current mesh to render
  61265. */
  61266. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61267. /**
  61268. * Add a mesh to be rendered through its own material and not with emissive only.
  61269. * @param mesh The mesh for which we need to use its material
  61270. */
  61271. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  61272. /**
  61273. * Remove a mesh from being rendered through its own material and not with emissive only.
  61274. * @param mesh The mesh for which we need to not use its material
  61275. */
  61276. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  61277. /**
  61278. * Free any resources and references associated to a mesh.
  61279. * Internal use
  61280. * @param mesh The mesh to free.
  61281. * @hidden
  61282. */
  61283. _disposeMesh(mesh: Mesh): void;
  61284. /**
  61285. * Gets the class name of the effect layer
  61286. * @returns the string with the class name of the effect layer
  61287. */
  61288. getClassName(): string;
  61289. /**
  61290. * Serializes this glow layer
  61291. * @returns a serialized glow layer object
  61292. */
  61293. serialize(): any;
  61294. /**
  61295. * Creates a Glow Layer from parsed glow layer data
  61296. * @param parsedGlowLayer defines glow layer data
  61297. * @param scene defines the current scene
  61298. * @param rootUrl defines the root URL containing the glow layer information
  61299. * @returns a parsed Glow Layer
  61300. */
  61301. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  61302. }
  61303. }
  61304. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  61305. /** @hidden */
  61306. export var glowBlurPostProcessPixelShader: {
  61307. name: string;
  61308. shader: string;
  61309. };
  61310. }
  61311. declare module "babylonjs/Layers/highlightLayer" {
  61312. import { Observable } from "babylonjs/Misc/observable";
  61313. import { Nullable } from "babylonjs/types";
  61314. import { Camera } from "babylonjs/Cameras/camera";
  61315. import { Scene } from "babylonjs/scene";
  61316. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61317. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61318. import { Mesh } from "babylonjs/Meshes/mesh";
  61319. import { Effect } from "babylonjs/Materials/effect";
  61320. import { Material } from "babylonjs/Materials/material";
  61321. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61322. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61323. import "babylonjs/Shaders/glowMapMerge.fragment";
  61324. import "babylonjs/Shaders/glowMapMerge.vertex";
  61325. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  61326. module "babylonjs/abstractScene" {
  61327. interface AbstractScene {
  61328. /**
  61329. * Return a the first highlight layer of the scene with a given name.
  61330. * @param name The name of the highlight layer to look for.
  61331. * @return The highlight layer if found otherwise null.
  61332. */
  61333. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  61334. }
  61335. }
  61336. /**
  61337. * Highlight layer options. This helps customizing the behaviour
  61338. * of the highlight layer.
  61339. */
  61340. export interface IHighlightLayerOptions {
  61341. /**
  61342. * Multiplication factor apply to the canvas size to compute the render target size
  61343. * used to generated the glowing objects (the smaller the faster).
  61344. */
  61345. mainTextureRatio: number;
  61346. /**
  61347. * Enforces a fixed size texture to ensure resize independant blur.
  61348. */
  61349. mainTextureFixedSize?: number;
  61350. /**
  61351. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  61352. * of the picture to blur (the smaller the faster).
  61353. */
  61354. blurTextureSizeRatio: number;
  61355. /**
  61356. * How big in texel of the blur texture is the vertical blur.
  61357. */
  61358. blurVerticalSize: number;
  61359. /**
  61360. * How big in texel of the blur texture is the horizontal blur.
  61361. */
  61362. blurHorizontalSize: number;
  61363. /**
  61364. * Alpha blending mode used to apply the blur. Default is combine.
  61365. */
  61366. alphaBlendingMode: number;
  61367. /**
  61368. * The camera attached to the layer.
  61369. */
  61370. camera: Nullable<Camera>;
  61371. /**
  61372. * Should we display highlight as a solid stroke?
  61373. */
  61374. isStroke?: boolean;
  61375. /**
  61376. * The rendering group to draw the layer in.
  61377. */
  61378. renderingGroupId: number;
  61379. }
  61380. /**
  61381. * The highlight layer Helps adding a glow effect around a mesh.
  61382. *
  61383. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  61384. * glowy meshes to your scene.
  61385. *
  61386. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  61387. */
  61388. export class HighlightLayer extends EffectLayer {
  61389. name: string;
  61390. /**
  61391. * Effect Name of the highlight layer.
  61392. */
  61393. static readonly EffectName: string;
  61394. /**
  61395. * The neutral color used during the preparation of the glow effect.
  61396. * This is black by default as the blend operation is a blend operation.
  61397. */
  61398. static NeutralColor: Color4;
  61399. /**
  61400. * Stencil value used for glowing meshes.
  61401. */
  61402. static GlowingMeshStencilReference: number;
  61403. /**
  61404. * Stencil value used for the other meshes in the scene.
  61405. */
  61406. static NormalMeshStencilReference: number;
  61407. /**
  61408. * Specifies whether or not the inner glow is ACTIVE in the layer.
  61409. */
  61410. innerGlow: boolean;
  61411. /**
  61412. * Specifies whether or not the outer glow is ACTIVE in the layer.
  61413. */
  61414. outerGlow: boolean;
  61415. /**
  61416. * Specifies the horizontal size of the blur.
  61417. */
  61418. set blurHorizontalSize(value: number);
  61419. /**
  61420. * Specifies the vertical size of the blur.
  61421. */
  61422. set blurVerticalSize(value: number);
  61423. /**
  61424. * Gets the horizontal size of the blur.
  61425. */
  61426. get blurHorizontalSize(): number;
  61427. /**
  61428. * Gets the vertical size of the blur.
  61429. */
  61430. get blurVerticalSize(): number;
  61431. /**
  61432. * An event triggered when the highlight layer is being blurred.
  61433. */
  61434. onBeforeBlurObservable: Observable<HighlightLayer>;
  61435. /**
  61436. * An event triggered when the highlight layer has been blurred.
  61437. */
  61438. onAfterBlurObservable: Observable<HighlightLayer>;
  61439. private _instanceGlowingMeshStencilReference;
  61440. private _options;
  61441. private _downSamplePostprocess;
  61442. private _horizontalBlurPostprocess;
  61443. private _verticalBlurPostprocess;
  61444. private _blurTexture;
  61445. private _meshes;
  61446. private _excludedMeshes;
  61447. /**
  61448. * Instantiates a new highlight Layer and references it to the scene..
  61449. * @param name The name of the layer
  61450. * @param scene The scene to use the layer in
  61451. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  61452. */
  61453. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  61454. /**
  61455. * Get the effect name of the layer.
  61456. * @return The effect name
  61457. */
  61458. getEffectName(): string;
  61459. /**
  61460. * Create the merge effect. This is the shader use to blit the information back
  61461. * to the main canvas at the end of the scene rendering.
  61462. */
  61463. protected _createMergeEffect(): Effect;
  61464. /**
  61465. * Creates the render target textures and post processes used in the highlight layer.
  61466. */
  61467. protected _createTextureAndPostProcesses(): void;
  61468. /**
  61469. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  61470. */
  61471. needStencil(): boolean;
  61472. /**
  61473. * Checks for the readiness of the element composing the layer.
  61474. * @param subMesh the mesh to check for
  61475. * @param useInstances specify wether or not to use instances to render the mesh
  61476. * @param emissiveTexture the associated emissive texture used to generate the glow
  61477. * @return true if ready otherwise, false
  61478. */
  61479. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61480. /**
  61481. * Implementation specific of rendering the generating effect on the main canvas.
  61482. * @param effect The effect used to render through
  61483. */
  61484. protected _internalRender(effect: Effect): void;
  61485. /**
  61486. * Returns true if the layer contains information to display, otherwise false.
  61487. */
  61488. shouldRender(): boolean;
  61489. /**
  61490. * Returns true if the mesh should render, otherwise false.
  61491. * @param mesh The mesh to render
  61492. * @returns true if it should render otherwise false
  61493. */
  61494. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61495. /**
  61496. * Returns true if the mesh can be rendered, otherwise false.
  61497. * @param mesh The mesh to render
  61498. * @param material The material used on the mesh
  61499. * @returns true if it can be rendered otherwise false
  61500. */
  61501. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61502. /**
  61503. * Adds specific effects defines.
  61504. * @param defines The defines to add specifics to.
  61505. */
  61506. protected _addCustomEffectDefines(defines: string[]): void;
  61507. /**
  61508. * Sets the required values for both the emissive texture and and the main color.
  61509. */
  61510. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61511. /**
  61512. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  61513. * @param mesh The mesh to exclude from the highlight layer
  61514. */
  61515. addExcludedMesh(mesh: Mesh): void;
  61516. /**
  61517. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  61518. * @param mesh The mesh to highlight
  61519. */
  61520. removeExcludedMesh(mesh: Mesh): void;
  61521. /**
  61522. * Determine if a given mesh will be highlighted by the current HighlightLayer
  61523. * @param mesh mesh to test
  61524. * @returns true if the mesh will be highlighted by the current HighlightLayer
  61525. */
  61526. hasMesh(mesh: AbstractMesh): boolean;
  61527. /**
  61528. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  61529. * @param mesh The mesh to highlight
  61530. * @param color The color of the highlight
  61531. * @param glowEmissiveOnly Extract the glow from the emissive texture
  61532. */
  61533. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  61534. /**
  61535. * Remove a mesh from the highlight layer in order to make it stop glowing.
  61536. * @param mesh The mesh to highlight
  61537. */
  61538. removeMesh(mesh: Mesh): void;
  61539. /**
  61540. * Remove all the meshes currently referenced in the highlight layer
  61541. */
  61542. removeAllMeshes(): void;
  61543. /**
  61544. * Force the stencil to the normal expected value for none glowing parts
  61545. */
  61546. private _defaultStencilReference;
  61547. /**
  61548. * Free any resources and references associated to a mesh.
  61549. * Internal use
  61550. * @param mesh The mesh to free.
  61551. * @hidden
  61552. */
  61553. _disposeMesh(mesh: Mesh): void;
  61554. /**
  61555. * Dispose the highlight layer and free resources.
  61556. */
  61557. dispose(): void;
  61558. /**
  61559. * Gets the class name of the effect layer
  61560. * @returns the string with the class name of the effect layer
  61561. */
  61562. getClassName(): string;
  61563. /**
  61564. * Serializes this Highlight layer
  61565. * @returns a serialized Highlight layer object
  61566. */
  61567. serialize(): any;
  61568. /**
  61569. * Creates a Highlight layer from parsed Highlight layer data
  61570. * @param parsedHightlightLayer defines the Highlight layer data
  61571. * @param scene defines the current scene
  61572. * @param rootUrl defines the root URL containing the Highlight layer information
  61573. * @returns a parsed Highlight layer
  61574. */
  61575. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  61576. }
  61577. }
  61578. declare module "babylonjs/Layers/layerSceneComponent" {
  61579. import { Scene } from "babylonjs/scene";
  61580. import { ISceneComponent } from "babylonjs/sceneComponent";
  61581. import { Layer } from "babylonjs/Layers/layer";
  61582. import { AbstractScene } from "babylonjs/abstractScene";
  61583. module "babylonjs/abstractScene" {
  61584. interface AbstractScene {
  61585. /**
  61586. * The list of layers (background and foreground) of the scene
  61587. */
  61588. layers: Array<Layer>;
  61589. }
  61590. }
  61591. /**
  61592. * Defines the layer scene component responsible to manage any layers
  61593. * in a given scene.
  61594. */
  61595. export class LayerSceneComponent implements ISceneComponent {
  61596. /**
  61597. * The component name helpfull to identify the component in the list of scene components.
  61598. */
  61599. readonly name: string;
  61600. /**
  61601. * The scene the component belongs to.
  61602. */
  61603. scene: Scene;
  61604. private _engine;
  61605. /**
  61606. * Creates a new instance of the component for the given scene
  61607. * @param scene Defines the scene to register the component in
  61608. */
  61609. constructor(scene: Scene);
  61610. /**
  61611. * Registers the component in a given scene
  61612. */
  61613. register(): void;
  61614. /**
  61615. * Rebuilds the elements related to this component in case of
  61616. * context lost for instance.
  61617. */
  61618. rebuild(): void;
  61619. /**
  61620. * Disposes the component and the associated ressources.
  61621. */
  61622. dispose(): void;
  61623. private _draw;
  61624. private _drawCameraPredicate;
  61625. private _drawCameraBackground;
  61626. private _drawCameraForeground;
  61627. private _drawRenderTargetPredicate;
  61628. private _drawRenderTargetBackground;
  61629. private _drawRenderTargetForeground;
  61630. /**
  61631. * Adds all the elements from the container to the scene
  61632. * @param container the container holding the elements
  61633. */
  61634. addFromContainer(container: AbstractScene): void;
  61635. /**
  61636. * Removes all the elements in the container from the scene
  61637. * @param container contains the elements to remove
  61638. * @param dispose if the removed element should be disposed (default: false)
  61639. */
  61640. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61641. }
  61642. }
  61643. declare module "babylonjs/Shaders/layer.fragment" {
  61644. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61645. /** @hidden */
  61646. export var layerPixelShader: {
  61647. name: string;
  61648. shader: string;
  61649. };
  61650. }
  61651. declare module "babylonjs/Shaders/layer.vertex" {
  61652. /** @hidden */
  61653. export var layerVertexShader: {
  61654. name: string;
  61655. shader: string;
  61656. };
  61657. }
  61658. declare module "babylonjs/Layers/layer" {
  61659. import { Observable } from "babylonjs/Misc/observable";
  61660. import { Nullable } from "babylonjs/types";
  61661. import { Scene } from "babylonjs/scene";
  61662. import { Vector2 } from "babylonjs/Maths/math.vector";
  61663. import { Color4 } from "babylonjs/Maths/math.color";
  61664. import { Texture } from "babylonjs/Materials/Textures/texture";
  61665. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61666. import "babylonjs/Shaders/layer.fragment";
  61667. import "babylonjs/Shaders/layer.vertex";
  61668. /**
  61669. * This represents a full screen 2d layer.
  61670. * This can be useful to display a picture in the background of your scene for instance.
  61671. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61672. */
  61673. export class Layer {
  61674. /**
  61675. * Define the name of the layer.
  61676. */
  61677. name: string;
  61678. /**
  61679. * Define the texture the layer should display.
  61680. */
  61681. texture: Nullable<Texture>;
  61682. /**
  61683. * Is the layer in background or foreground.
  61684. */
  61685. isBackground: boolean;
  61686. /**
  61687. * Define the color of the layer (instead of texture).
  61688. */
  61689. color: Color4;
  61690. /**
  61691. * Define the scale of the layer in order to zoom in out of the texture.
  61692. */
  61693. scale: Vector2;
  61694. /**
  61695. * Define an offset for the layer in order to shift the texture.
  61696. */
  61697. offset: Vector2;
  61698. /**
  61699. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  61700. */
  61701. alphaBlendingMode: number;
  61702. /**
  61703. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  61704. * Alpha test will not mix with the background color in case of transparency.
  61705. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  61706. */
  61707. alphaTest: boolean;
  61708. /**
  61709. * Define a mask to restrict the layer to only some of the scene cameras.
  61710. */
  61711. layerMask: number;
  61712. /**
  61713. * Define the list of render target the layer is visible into.
  61714. */
  61715. renderTargetTextures: RenderTargetTexture[];
  61716. /**
  61717. * Define if the layer is only used in renderTarget or if it also
  61718. * renders in the main frame buffer of the canvas.
  61719. */
  61720. renderOnlyInRenderTargetTextures: boolean;
  61721. private _scene;
  61722. private _vertexBuffers;
  61723. private _indexBuffer;
  61724. private _effect;
  61725. private _previousDefines;
  61726. /**
  61727. * An event triggered when the layer is disposed.
  61728. */
  61729. onDisposeObservable: Observable<Layer>;
  61730. private _onDisposeObserver;
  61731. /**
  61732. * Back compatibility with callback before the onDisposeObservable existed.
  61733. * The set callback will be triggered when the layer has been disposed.
  61734. */
  61735. set onDispose(callback: () => void);
  61736. /**
  61737. * An event triggered before rendering the scene
  61738. */
  61739. onBeforeRenderObservable: Observable<Layer>;
  61740. private _onBeforeRenderObserver;
  61741. /**
  61742. * Back compatibility with callback before the onBeforeRenderObservable existed.
  61743. * The set callback will be triggered just before rendering the layer.
  61744. */
  61745. set onBeforeRender(callback: () => void);
  61746. /**
  61747. * An event triggered after rendering the scene
  61748. */
  61749. onAfterRenderObservable: Observable<Layer>;
  61750. private _onAfterRenderObserver;
  61751. /**
  61752. * Back compatibility with callback before the onAfterRenderObservable existed.
  61753. * The set callback will be triggered just after rendering the layer.
  61754. */
  61755. set onAfterRender(callback: () => void);
  61756. /**
  61757. * Instantiates a new layer.
  61758. * This represents a full screen 2d layer.
  61759. * This can be useful to display a picture in the background of your scene for instance.
  61760. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61761. * @param name Define the name of the layer in the scene
  61762. * @param imgUrl Define the url of the texture to display in the layer
  61763. * @param scene Define the scene the layer belongs to
  61764. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  61765. * @param color Defines a color for the layer
  61766. */
  61767. constructor(
  61768. /**
  61769. * Define the name of the layer.
  61770. */
  61771. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  61772. private _createIndexBuffer;
  61773. /** @hidden */
  61774. _rebuild(): void;
  61775. /**
  61776. * Renders the layer in the scene.
  61777. */
  61778. render(): void;
  61779. /**
  61780. * Disposes and releases the associated ressources.
  61781. */
  61782. dispose(): void;
  61783. }
  61784. }
  61785. declare module "babylonjs/Layers/index" {
  61786. export * from "babylonjs/Layers/effectLayer";
  61787. export * from "babylonjs/Layers/effectLayerSceneComponent";
  61788. export * from "babylonjs/Layers/glowLayer";
  61789. export * from "babylonjs/Layers/highlightLayer";
  61790. export * from "babylonjs/Layers/layer";
  61791. export * from "babylonjs/Layers/layerSceneComponent";
  61792. }
  61793. declare module "babylonjs/Shaders/lensFlare.fragment" {
  61794. /** @hidden */
  61795. export var lensFlarePixelShader: {
  61796. name: string;
  61797. shader: string;
  61798. };
  61799. }
  61800. declare module "babylonjs/Shaders/lensFlare.vertex" {
  61801. /** @hidden */
  61802. export var lensFlareVertexShader: {
  61803. name: string;
  61804. shader: string;
  61805. };
  61806. }
  61807. declare module "babylonjs/LensFlares/lensFlareSystem" {
  61808. import { Scene } from "babylonjs/scene";
  61809. import { Vector3 } from "babylonjs/Maths/math.vector";
  61810. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61811. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  61812. import "babylonjs/Shaders/lensFlare.fragment";
  61813. import "babylonjs/Shaders/lensFlare.vertex";
  61814. import { Viewport } from "babylonjs/Maths/math.viewport";
  61815. /**
  61816. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61817. * It is usually composed of several `lensFlare`.
  61818. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61819. */
  61820. export class LensFlareSystem {
  61821. /**
  61822. * Define the name of the lens flare system
  61823. */
  61824. name: string;
  61825. /**
  61826. * List of lens flares used in this system.
  61827. */
  61828. lensFlares: LensFlare[];
  61829. /**
  61830. * Define a limit from the border the lens flare can be visible.
  61831. */
  61832. borderLimit: number;
  61833. /**
  61834. * Define a viewport border we do not want to see the lens flare in.
  61835. */
  61836. viewportBorder: number;
  61837. /**
  61838. * Define a predicate which could limit the list of meshes able to occlude the effect.
  61839. */
  61840. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  61841. /**
  61842. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  61843. */
  61844. layerMask: number;
  61845. /**
  61846. * Define the id of the lens flare system in the scene.
  61847. * (equal to name by default)
  61848. */
  61849. id: string;
  61850. private _scene;
  61851. private _emitter;
  61852. private _vertexBuffers;
  61853. private _indexBuffer;
  61854. private _effect;
  61855. private _positionX;
  61856. private _positionY;
  61857. private _isEnabled;
  61858. /** @hidden */
  61859. static _SceneComponentInitialization: (scene: Scene) => void;
  61860. /**
  61861. * Instantiates a lens flare system.
  61862. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61863. * It is usually composed of several `lensFlare`.
  61864. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61865. * @param name Define the name of the lens flare system in the scene
  61866. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  61867. * @param scene Define the scene the lens flare system belongs to
  61868. */
  61869. constructor(
  61870. /**
  61871. * Define the name of the lens flare system
  61872. */
  61873. name: string, emitter: any, scene: Scene);
  61874. /**
  61875. * Define if the lens flare system is enabled.
  61876. */
  61877. get isEnabled(): boolean;
  61878. set isEnabled(value: boolean);
  61879. /**
  61880. * Get the scene the effects belongs to.
  61881. * @returns the scene holding the lens flare system
  61882. */
  61883. getScene(): Scene;
  61884. /**
  61885. * Get the emitter of the lens flare system.
  61886. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61887. * @returns the emitter of the lens flare system
  61888. */
  61889. getEmitter(): any;
  61890. /**
  61891. * Set the emitter of the lens flare system.
  61892. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61893. * @param newEmitter Define the new emitter of the system
  61894. */
  61895. setEmitter(newEmitter: any): void;
  61896. /**
  61897. * Get the lens flare system emitter position.
  61898. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  61899. * @returns the position
  61900. */
  61901. getEmitterPosition(): Vector3;
  61902. /**
  61903. * @hidden
  61904. */
  61905. computeEffectivePosition(globalViewport: Viewport): boolean;
  61906. /** @hidden */
  61907. _isVisible(): boolean;
  61908. /**
  61909. * @hidden
  61910. */
  61911. render(): boolean;
  61912. /**
  61913. * Dispose and release the lens flare with its associated resources.
  61914. */
  61915. dispose(): void;
  61916. /**
  61917. * Parse a lens flare system from a JSON repressentation
  61918. * @param parsedLensFlareSystem Define the JSON to parse
  61919. * @param scene Define the scene the parsed system should be instantiated in
  61920. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  61921. * @returns the parsed system
  61922. */
  61923. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  61924. /**
  61925. * Serialize the current Lens Flare System into a JSON representation.
  61926. * @returns the serialized JSON
  61927. */
  61928. serialize(): any;
  61929. }
  61930. }
  61931. declare module "babylonjs/LensFlares/lensFlare" {
  61932. import { Nullable } from "babylonjs/types";
  61933. import { Color3 } from "babylonjs/Maths/math.color";
  61934. import { Texture } from "babylonjs/Materials/Textures/texture";
  61935. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61936. /**
  61937. * This represents one of the lens effect in a `lensFlareSystem`.
  61938. * It controls one of the indiviual texture used in the effect.
  61939. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61940. */
  61941. export class LensFlare {
  61942. /**
  61943. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61944. */
  61945. size: number;
  61946. /**
  61947. * 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.
  61948. */
  61949. position: number;
  61950. /**
  61951. * Define the lens color.
  61952. */
  61953. color: Color3;
  61954. /**
  61955. * Define the lens texture.
  61956. */
  61957. texture: Nullable<Texture>;
  61958. /**
  61959. * Define the alpha mode to render this particular lens.
  61960. */
  61961. alphaMode: number;
  61962. private _system;
  61963. /**
  61964. * Creates a new Lens Flare.
  61965. * This represents one of the lens effect in a `lensFlareSystem`.
  61966. * It controls one of the indiviual texture used in the effect.
  61967. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61968. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  61969. * @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.
  61970. * @param color Define the lens color
  61971. * @param imgUrl Define the lens texture url
  61972. * @param system Define the `lensFlareSystem` this flare is part of
  61973. * @returns The newly created Lens Flare
  61974. */
  61975. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  61976. /**
  61977. * Instantiates a new Lens Flare.
  61978. * This represents one of the lens effect in a `lensFlareSystem`.
  61979. * It controls one of the indiviual texture used in the effect.
  61980. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61981. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  61982. * @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.
  61983. * @param color Define the lens color
  61984. * @param imgUrl Define the lens texture url
  61985. * @param system Define the `lensFlareSystem` this flare is part of
  61986. */
  61987. constructor(
  61988. /**
  61989. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61990. */
  61991. size: number,
  61992. /**
  61993. * 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.
  61994. */
  61995. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  61996. /**
  61997. * Dispose and release the lens flare with its associated resources.
  61998. */
  61999. dispose(): void;
  62000. }
  62001. }
  62002. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  62003. import { Nullable } from "babylonjs/types";
  62004. import { Scene } from "babylonjs/scene";
  62005. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62006. import { AbstractScene } from "babylonjs/abstractScene";
  62007. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  62008. module "babylonjs/abstractScene" {
  62009. interface AbstractScene {
  62010. /**
  62011. * The list of lens flare system added to the scene
  62012. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62013. */
  62014. lensFlareSystems: Array<LensFlareSystem>;
  62015. /**
  62016. * Removes the given lens flare system from this scene.
  62017. * @param toRemove The lens flare system to remove
  62018. * @returns The index of the removed lens flare system
  62019. */
  62020. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  62021. /**
  62022. * Adds the given lens flare system to this scene
  62023. * @param newLensFlareSystem The lens flare system to add
  62024. */
  62025. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  62026. /**
  62027. * Gets a lens flare system using its name
  62028. * @param name defines the name to look for
  62029. * @returns the lens flare system or null if not found
  62030. */
  62031. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  62032. /**
  62033. * Gets a lens flare system using its id
  62034. * @param id defines the id to look for
  62035. * @returns the lens flare system or null if not found
  62036. */
  62037. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  62038. }
  62039. }
  62040. /**
  62041. * Defines the lens flare scene component responsible to manage any lens flares
  62042. * in a given scene.
  62043. */
  62044. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  62045. /**
  62046. * The component name helpfull to identify the component in the list of scene components.
  62047. */
  62048. readonly name: string;
  62049. /**
  62050. * The scene the component belongs to.
  62051. */
  62052. scene: Scene;
  62053. /**
  62054. * Creates a new instance of the component for the given scene
  62055. * @param scene Defines the scene to register the component in
  62056. */
  62057. constructor(scene: Scene);
  62058. /**
  62059. * Registers the component in a given scene
  62060. */
  62061. register(): void;
  62062. /**
  62063. * Rebuilds the elements related to this component in case of
  62064. * context lost for instance.
  62065. */
  62066. rebuild(): void;
  62067. /**
  62068. * Adds all the elements from the container to the scene
  62069. * @param container the container holding the elements
  62070. */
  62071. addFromContainer(container: AbstractScene): void;
  62072. /**
  62073. * Removes all the elements in the container from the scene
  62074. * @param container contains the elements to remove
  62075. * @param dispose if the removed element should be disposed (default: false)
  62076. */
  62077. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62078. /**
  62079. * Serializes the component data to the specified json object
  62080. * @param serializationObject The object to serialize to
  62081. */
  62082. serialize(serializationObject: any): void;
  62083. /**
  62084. * Disposes the component and the associated ressources.
  62085. */
  62086. dispose(): void;
  62087. private _draw;
  62088. }
  62089. }
  62090. declare module "babylonjs/LensFlares/index" {
  62091. export * from "babylonjs/LensFlares/lensFlare";
  62092. export * from "babylonjs/LensFlares/lensFlareSystem";
  62093. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  62094. }
  62095. declare module "babylonjs/Shaders/depth.fragment" {
  62096. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62097. /** @hidden */
  62098. export var depthPixelShader: {
  62099. name: string;
  62100. shader: string;
  62101. };
  62102. }
  62103. declare module "babylonjs/Shaders/depth.vertex" {
  62104. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  62105. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  62106. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  62107. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  62108. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  62109. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  62110. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  62111. /** @hidden */
  62112. export var depthVertexShader: {
  62113. name: string;
  62114. shader: string;
  62115. };
  62116. }
  62117. declare module "babylonjs/Rendering/depthRenderer" {
  62118. import { Nullable } from "babylonjs/types";
  62119. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62120. import { Scene } from "babylonjs/scene";
  62121. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62122. import { Camera } from "babylonjs/Cameras/camera";
  62123. import "babylonjs/Shaders/depth.fragment";
  62124. import "babylonjs/Shaders/depth.vertex";
  62125. /**
  62126. * This represents a depth renderer in Babylon.
  62127. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  62128. */
  62129. export class DepthRenderer {
  62130. private _scene;
  62131. private _depthMap;
  62132. private _effect;
  62133. private readonly _storeNonLinearDepth;
  62134. private readonly _clearColor;
  62135. /** Get if the depth renderer is using packed depth or not */
  62136. readonly isPacked: boolean;
  62137. private _cachedDefines;
  62138. private _camera;
  62139. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  62140. enabled: boolean;
  62141. /**
  62142. * Specifiess that the depth renderer will only be used within
  62143. * the camera it is created for.
  62144. * This can help forcing its rendering during the camera processing.
  62145. */
  62146. useOnlyInActiveCamera: boolean;
  62147. /** @hidden */
  62148. static _SceneComponentInitialization: (scene: Scene) => void;
  62149. /**
  62150. * Instantiates a depth renderer
  62151. * @param scene The scene the renderer belongs to
  62152. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  62153. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  62154. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62155. */
  62156. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  62157. /**
  62158. * Creates the depth rendering effect and checks if the effect is ready.
  62159. * @param subMesh The submesh to be used to render the depth map of
  62160. * @param useInstances If multiple world instances should be used
  62161. * @returns if the depth renderer is ready to render the depth map
  62162. */
  62163. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62164. /**
  62165. * Gets the texture which the depth map will be written to.
  62166. * @returns The depth map texture
  62167. */
  62168. getDepthMap(): RenderTargetTexture;
  62169. /**
  62170. * Disposes of the depth renderer.
  62171. */
  62172. dispose(): void;
  62173. }
  62174. }
  62175. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  62176. /** @hidden */
  62177. export var minmaxReduxPixelShader: {
  62178. name: string;
  62179. shader: string;
  62180. };
  62181. }
  62182. declare module "babylonjs/Misc/minMaxReducer" {
  62183. import { Nullable } from "babylonjs/types";
  62184. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62185. import { Camera } from "babylonjs/Cameras/camera";
  62186. import { Observer } from "babylonjs/Misc/observable";
  62187. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62188. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  62189. import { Observable } from "babylonjs/Misc/observable";
  62190. import "babylonjs/Shaders/minmaxRedux.fragment";
  62191. /**
  62192. * This class computes a min/max reduction from a texture: it means it computes the minimum
  62193. * and maximum values from all values of the texture.
  62194. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  62195. * The source values are read from the red channel of the texture.
  62196. */
  62197. export class MinMaxReducer {
  62198. /**
  62199. * Observable triggered when the computation has been performed
  62200. */
  62201. onAfterReductionPerformed: Observable<{
  62202. min: number;
  62203. max: number;
  62204. }>;
  62205. protected _camera: Camera;
  62206. protected _sourceTexture: Nullable<RenderTargetTexture>;
  62207. protected _reductionSteps: Nullable<Array<PostProcess>>;
  62208. protected _postProcessManager: PostProcessManager;
  62209. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  62210. protected _forceFullscreenViewport: boolean;
  62211. /**
  62212. * Creates a min/max reducer
  62213. * @param camera The camera to use for the post processes
  62214. */
  62215. constructor(camera: Camera);
  62216. /**
  62217. * Gets the texture used to read the values from.
  62218. */
  62219. get sourceTexture(): Nullable<RenderTargetTexture>;
  62220. /**
  62221. * Sets the source texture to read the values from.
  62222. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  62223. * because in such textures '1' value must not be taken into account to compute the maximum
  62224. * as this value is used to clear the texture.
  62225. * Note that the computation is not activated by calling this function, you must call activate() for that!
  62226. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  62227. * @param depthRedux Indicates if the texture is a depth texture or not
  62228. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  62229. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62230. */
  62231. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62232. /**
  62233. * Defines the refresh rate of the computation.
  62234. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62235. */
  62236. get refreshRate(): number;
  62237. set refreshRate(value: number);
  62238. protected _activated: boolean;
  62239. /**
  62240. * Gets the activation status of the reducer
  62241. */
  62242. get activated(): boolean;
  62243. /**
  62244. * Activates the reduction computation.
  62245. * When activated, the observers registered in onAfterReductionPerformed are
  62246. * called after the compuation is performed
  62247. */
  62248. activate(): void;
  62249. /**
  62250. * Deactivates the reduction computation.
  62251. */
  62252. deactivate(): void;
  62253. /**
  62254. * Disposes the min/max reducer
  62255. * @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.
  62256. */
  62257. dispose(disposeAll?: boolean): void;
  62258. }
  62259. }
  62260. declare module "babylonjs/Misc/depthReducer" {
  62261. import { Nullable } from "babylonjs/types";
  62262. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62263. import { Camera } from "babylonjs/Cameras/camera";
  62264. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62265. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  62266. /**
  62267. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  62268. */
  62269. export class DepthReducer extends MinMaxReducer {
  62270. private _depthRenderer;
  62271. private _depthRendererId;
  62272. /**
  62273. * Gets the depth renderer used for the computation.
  62274. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  62275. */
  62276. get depthRenderer(): Nullable<DepthRenderer>;
  62277. /**
  62278. * Creates a depth reducer
  62279. * @param camera The camera used to render the depth texture
  62280. */
  62281. constructor(camera: Camera);
  62282. /**
  62283. * Sets the depth renderer to use to generate the depth map
  62284. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  62285. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  62286. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62287. */
  62288. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  62289. /** @hidden */
  62290. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62291. /**
  62292. * Activates the reduction computation.
  62293. * When activated, the observers registered in onAfterReductionPerformed are
  62294. * called after the compuation is performed
  62295. */
  62296. activate(): void;
  62297. /**
  62298. * Deactivates the reduction computation.
  62299. */
  62300. deactivate(): void;
  62301. /**
  62302. * Disposes the depth reducer
  62303. * @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.
  62304. */
  62305. dispose(disposeAll?: boolean): void;
  62306. }
  62307. }
  62308. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  62309. import { Nullable } from "babylonjs/types";
  62310. import { Scene } from "babylonjs/scene";
  62311. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62312. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62313. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62314. import { Effect } from "babylonjs/Materials/effect";
  62315. import "babylonjs/Shaders/shadowMap.fragment";
  62316. import "babylonjs/Shaders/shadowMap.vertex";
  62317. import "babylonjs/Shaders/depthBoxBlur.fragment";
  62318. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  62319. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  62320. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62321. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62322. /**
  62323. * A CSM implementation allowing casting shadows on large scenes.
  62324. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62325. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  62326. */
  62327. export class CascadedShadowGenerator extends ShadowGenerator {
  62328. private static readonly frustumCornersNDCSpace;
  62329. /**
  62330. * Name of the CSM class
  62331. */
  62332. static CLASSNAME: string;
  62333. /**
  62334. * Defines the default number of cascades used by the CSM.
  62335. */
  62336. static readonly DEFAULT_CASCADES_COUNT: number;
  62337. /**
  62338. * Defines the minimum number of cascades used by the CSM.
  62339. */
  62340. static readonly MIN_CASCADES_COUNT: number;
  62341. /**
  62342. * Defines the maximum number of cascades used by the CSM.
  62343. */
  62344. static readonly MAX_CASCADES_COUNT: number;
  62345. protected _validateFilter(filter: number): number;
  62346. /**
  62347. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  62348. */
  62349. penumbraDarkness: number;
  62350. private _numCascades;
  62351. /**
  62352. * Gets or set the number of cascades used by the CSM.
  62353. */
  62354. get numCascades(): number;
  62355. set numCascades(value: number);
  62356. /**
  62357. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  62358. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  62359. */
  62360. stabilizeCascades: boolean;
  62361. private _freezeShadowCastersBoundingInfo;
  62362. private _freezeShadowCastersBoundingInfoObservable;
  62363. /**
  62364. * Enables or disables the shadow casters bounding info computation.
  62365. * If your shadow casters don't move, you can disable this feature.
  62366. * If it is enabled, the bounding box computation is done every frame.
  62367. */
  62368. get freezeShadowCastersBoundingInfo(): boolean;
  62369. set freezeShadowCastersBoundingInfo(freeze: boolean);
  62370. private _scbiMin;
  62371. private _scbiMax;
  62372. protected _computeShadowCastersBoundingInfo(): void;
  62373. protected _shadowCastersBoundingInfo: BoundingInfo;
  62374. /**
  62375. * Gets or sets the shadow casters bounding info.
  62376. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  62377. * so that the system won't overwrite the bounds you provide
  62378. */
  62379. get shadowCastersBoundingInfo(): BoundingInfo;
  62380. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  62381. protected _breaksAreDirty: boolean;
  62382. protected _minDistance: number;
  62383. protected _maxDistance: number;
  62384. /**
  62385. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  62386. *
  62387. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  62388. * If you don't know these values, simply leave them to their defaults and don't call this function.
  62389. * @param min minimal distance for the breaks (default to 0.)
  62390. * @param max maximal distance for the breaks (default to 1.)
  62391. */
  62392. setMinMaxDistance(min: number, max: number): void;
  62393. /** Gets the minimal distance used in the cascade break computation */
  62394. get minDistance(): number;
  62395. /** Gets the maximal distance used in the cascade break computation */
  62396. get maxDistance(): number;
  62397. /**
  62398. * Gets the class name of that object
  62399. * @returns "CascadedShadowGenerator"
  62400. */
  62401. getClassName(): string;
  62402. private _cascadeMinExtents;
  62403. private _cascadeMaxExtents;
  62404. /**
  62405. * Gets a cascade minimum extents
  62406. * @param cascadeIndex index of the cascade
  62407. * @returns the minimum cascade extents
  62408. */
  62409. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  62410. /**
  62411. * Gets a cascade maximum extents
  62412. * @param cascadeIndex index of the cascade
  62413. * @returns the maximum cascade extents
  62414. */
  62415. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  62416. private _cascades;
  62417. private _currentLayer;
  62418. private _viewSpaceFrustumsZ;
  62419. private _viewMatrices;
  62420. private _projectionMatrices;
  62421. private _transformMatrices;
  62422. private _transformMatricesAsArray;
  62423. private _frustumLengths;
  62424. private _lightSizeUVCorrection;
  62425. private _depthCorrection;
  62426. private _frustumCornersWorldSpace;
  62427. private _frustumCenter;
  62428. private _shadowCameraPos;
  62429. private _shadowMaxZ;
  62430. /**
  62431. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  62432. * It defaults to camera.maxZ
  62433. */
  62434. get shadowMaxZ(): number;
  62435. /**
  62436. * Sets the shadow max z distance.
  62437. */
  62438. set shadowMaxZ(value: number);
  62439. protected _debug: boolean;
  62440. /**
  62441. * Gets or sets the debug flag.
  62442. * When enabled, the cascades are materialized by different colors on the screen.
  62443. */
  62444. get debug(): boolean;
  62445. set debug(dbg: boolean);
  62446. private _depthClamp;
  62447. /**
  62448. * Gets or sets the depth clamping value.
  62449. *
  62450. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  62451. * to account for the shadow casters far away.
  62452. *
  62453. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  62454. */
  62455. get depthClamp(): boolean;
  62456. set depthClamp(value: boolean);
  62457. private _cascadeBlendPercentage;
  62458. /**
  62459. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  62460. * It defaults to 0.1 (10% blending).
  62461. */
  62462. get cascadeBlendPercentage(): number;
  62463. set cascadeBlendPercentage(value: number);
  62464. private _lambda;
  62465. /**
  62466. * Gets or set the lambda parameter.
  62467. * This parameter is used to split the camera frustum and create the cascades.
  62468. * 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.
  62469. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  62470. */
  62471. get lambda(): number;
  62472. set lambda(value: number);
  62473. /**
  62474. * Gets the view matrix corresponding to a given cascade
  62475. * @param cascadeNum cascade to retrieve the view matrix from
  62476. * @returns the cascade view matrix
  62477. */
  62478. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  62479. /**
  62480. * Gets the projection matrix corresponding to a given cascade
  62481. * @param cascadeNum cascade to retrieve the projection matrix from
  62482. * @returns the cascade projection matrix
  62483. */
  62484. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  62485. /**
  62486. * Gets the transformation matrix corresponding to a given cascade
  62487. * @param cascadeNum cascade to retrieve the transformation matrix from
  62488. * @returns the cascade transformation matrix
  62489. */
  62490. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  62491. private _depthRenderer;
  62492. /**
  62493. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  62494. *
  62495. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  62496. *
  62497. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  62498. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  62499. * @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
  62500. */
  62501. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  62502. private _depthReducer;
  62503. private _autoCalcDepthBounds;
  62504. /**
  62505. * Gets or sets the autoCalcDepthBounds property.
  62506. *
  62507. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  62508. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  62509. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  62510. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  62511. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  62512. */
  62513. get autoCalcDepthBounds(): boolean;
  62514. set autoCalcDepthBounds(value: boolean);
  62515. /**
  62516. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  62517. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62518. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  62519. * for setting the refresh rate on the renderer yourself!
  62520. */
  62521. get autoCalcDepthBoundsRefreshRate(): number;
  62522. set autoCalcDepthBoundsRefreshRate(value: number);
  62523. /**
  62524. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  62525. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  62526. * you change the camera near/far planes!
  62527. */
  62528. splitFrustum(): void;
  62529. private _splitFrustum;
  62530. private _computeMatrices;
  62531. private _computeFrustumInWorldSpace;
  62532. private _computeCascadeFrustum;
  62533. /**
  62534. * Support test.
  62535. */
  62536. static get IsSupported(): boolean;
  62537. /** @hidden */
  62538. static _SceneComponentInitialization: (scene: Scene) => void;
  62539. /**
  62540. * Creates a Cascaded Shadow Generator object.
  62541. * A ShadowGenerator is the required tool to use the shadows.
  62542. * Each directional light casting shadows needs to use its own ShadowGenerator.
  62543. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62544. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  62545. * @param light The directional light object generating the shadows.
  62546. * @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.
  62547. */
  62548. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  62549. protected _initializeGenerator(): void;
  62550. protected _createTargetRenderTexture(): void;
  62551. protected _initializeShadowMap(): void;
  62552. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  62553. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  62554. /**
  62555. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  62556. * @param defines Defines of the material we want to update
  62557. * @param lightIndex Index of the light in the enabled light list of the material
  62558. */
  62559. prepareDefines(defines: any, lightIndex: number): void;
  62560. /**
  62561. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  62562. * defined in the generator but impacting the effect).
  62563. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  62564. * @param effect The effect we are binfing the information for
  62565. */
  62566. bindShadowLight(lightIndex: string, effect: Effect): void;
  62567. /**
  62568. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  62569. * (eq to view projection * shadow projection matrices)
  62570. * @returns The transform matrix used to create the shadow map
  62571. */
  62572. getTransformMatrix(): Matrix;
  62573. /**
  62574. * Disposes the ShadowGenerator.
  62575. * Returns nothing.
  62576. */
  62577. dispose(): void;
  62578. /**
  62579. * Serializes the shadow generator setup to a json object.
  62580. * @returns The serialized JSON object
  62581. */
  62582. serialize(): any;
  62583. /**
  62584. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  62585. * @param parsedShadowGenerator The JSON object to parse
  62586. * @param scene The scene to create the shadow map for
  62587. * @returns The parsed shadow generator
  62588. */
  62589. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  62590. }
  62591. }
  62592. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  62593. import { Scene } from "babylonjs/scene";
  62594. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62595. import { AbstractScene } from "babylonjs/abstractScene";
  62596. /**
  62597. * Defines the shadow generator component responsible to manage any shadow generators
  62598. * in a given scene.
  62599. */
  62600. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  62601. /**
  62602. * The component name helpfull to identify the component in the list of scene components.
  62603. */
  62604. readonly name: string;
  62605. /**
  62606. * The scene the component belongs to.
  62607. */
  62608. scene: Scene;
  62609. /**
  62610. * Creates a new instance of the component for the given scene
  62611. * @param scene Defines the scene to register the component in
  62612. */
  62613. constructor(scene: Scene);
  62614. /**
  62615. * Registers the component in a given scene
  62616. */
  62617. register(): void;
  62618. /**
  62619. * Rebuilds the elements related to this component in case of
  62620. * context lost for instance.
  62621. */
  62622. rebuild(): void;
  62623. /**
  62624. * Serializes the component data to the specified json object
  62625. * @param serializationObject The object to serialize to
  62626. */
  62627. serialize(serializationObject: any): void;
  62628. /**
  62629. * Adds all the elements from the container to the scene
  62630. * @param container the container holding the elements
  62631. */
  62632. addFromContainer(container: AbstractScene): void;
  62633. /**
  62634. * Removes all the elements in the container from the scene
  62635. * @param container contains the elements to remove
  62636. * @param dispose if the removed element should be disposed (default: false)
  62637. */
  62638. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62639. /**
  62640. * Rebuilds the elements related to this component in case of
  62641. * context lost for instance.
  62642. */
  62643. dispose(): void;
  62644. private _gatherRenderTargets;
  62645. }
  62646. }
  62647. declare module "babylonjs/Lights/Shadows/index" {
  62648. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  62649. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  62650. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  62651. }
  62652. declare module "babylonjs/Lights/pointLight" {
  62653. import { Scene } from "babylonjs/scene";
  62654. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62655. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62656. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  62657. import { Effect } from "babylonjs/Materials/effect";
  62658. /**
  62659. * A point light is a light defined by an unique point in world space.
  62660. * The light is emitted in every direction from this point.
  62661. * A good example of a point light is a standard light bulb.
  62662. * Documentation: https://doc.babylonjs.com/babylon101/lights
  62663. */
  62664. export class PointLight extends ShadowLight {
  62665. private _shadowAngle;
  62666. /**
  62667. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62668. * This specifies what angle the shadow will use to be created.
  62669. *
  62670. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62671. */
  62672. get shadowAngle(): number;
  62673. /**
  62674. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62675. * This specifies what angle the shadow will use to be created.
  62676. *
  62677. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62678. */
  62679. set shadowAngle(value: number);
  62680. /**
  62681. * Gets the direction if it has been set.
  62682. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62683. */
  62684. get direction(): Vector3;
  62685. /**
  62686. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62687. */
  62688. set direction(value: Vector3);
  62689. /**
  62690. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  62691. * A PointLight emits the light in every direction.
  62692. * It can cast shadows.
  62693. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  62694. * ```javascript
  62695. * var pointLight = new PointLight("pl", camera.position, scene);
  62696. * ```
  62697. * Documentation : https://doc.babylonjs.com/babylon101/lights
  62698. * @param name The light friendly name
  62699. * @param position The position of the point light in the scene
  62700. * @param scene The scene the lights belongs to
  62701. */
  62702. constructor(name: string, position: Vector3, scene: Scene);
  62703. /**
  62704. * Returns the string "PointLight"
  62705. * @returns the class name
  62706. */
  62707. getClassName(): string;
  62708. /**
  62709. * Returns the integer 0.
  62710. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  62711. */
  62712. getTypeID(): number;
  62713. /**
  62714. * Specifies wether or not the shadowmap should be a cube texture.
  62715. * @returns true if the shadowmap needs to be a cube texture.
  62716. */
  62717. needCube(): boolean;
  62718. /**
  62719. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  62720. * @param faceIndex The index of the face we are computed the direction to generate shadow
  62721. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  62722. */
  62723. getShadowDirection(faceIndex?: number): Vector3;
  62724. /**
  62725. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  62726. * - fov = PI / 2
  62727. * - aspect ratio : 1.0
  62728. * - z-near and far equal to the active camera minZ and maxZ.
  62729. * Returns the PointLight.
  62730. */
  62731. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  62732. protected _buildUniformLayout(): void;
  62733. /**
  62734. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  62735. * @param effect The effect to update
  62736. * @param lightIndex The index of the light in the effect to update
  62737. * @returns The point light
  62738. */
  62739. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  62740. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  62741. /**
  62742. * Prepares the list of defines specific to the light type.
  62743. * @param defines the list of defines
  62744. * @param lightIndex defines the index of the light for the effect
  62745. */
  62746. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  62747. }
  62748. }
  62749. declare module "babylonjs/Lights/index" {
  62750. export * from "babylonjs/Lights/light";
  62751. export * from "babylonjs/Lights/shadowLight";
  62752. export * from "babylonjs/Lights/Shadows/index";
  62753. export * from "babylonjs/Lights/directionalLight";
  62754. export * from "babylonjs/Lights/hemisphericLight";
  62755. export * from "babylonjs/Lights/pointLight";
  62756. export * from "babylonjs/Lights/spotLight";
  62757. }
  62758. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  62759. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  62760. /**
  62761. * Header information of HDR texture files.
  62762. */
  62763. export interface HDRInfo {
  62764. /**
  62765. * The height of the texture in pixels.
  62766. */
  62767. height: number;
  62768. /**
  62769. * The width of the texture in pixels.
  62770. */
  62771. width: number;
  62772. /**
  62773. * The index of the beginning of the data in the binary file.
  62774. */
  62775. dataPosition: number;
  62776. }
  62777. /**
  62778. * This groups tools to convert HDR texture to native colors array.
  62779. */
  62780. export class HDRTools {
  62781. private static Ldexp;
  62782. private static Rgbe2float;
  62783. private static readStringLine;
  62784. /**
  62785. * Reads header information from an RGBE texture stored in a native array.
  62786. * More information on this format are available here:
  62787. * https://en.wikipedia.org/wiki/RGBE_image_format
  62788. *
  62789. * @param uint8array The binary file stored in native array.
  62790. * @return The header information.
  62791. */
  62792. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  62793. /**
  62794. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  62795. * This RGBE texture needs to store the information as a panorama.
  62796. *
  62797. * More information on this format are available here:
  62798. * https://en.wikipedia.org/wiki/RGBE_image_format
  62799. *
  62800. * @param buffer The binary file stored in an array buffer.
  62801. * @param size The expected size of the extracted cubemap.
  62802. * @return The Cube Map information.
  62803. */
  62804. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  62805. /**
  62806. * Returns the pixels data extracted from an RGBE texture.
  62807. * This pixels will be stored left to right up to down in the R G B order in one array.
  62808. *
  62809. * More information on this format are available here:
  62810. * https://en.wikipedia.org/wiki/RGBE_image_format
  62811. *
  62812. * @param uint8array The binary file stored in an array buffer.
  62813. * @param hdrInfo The header information of the file.
  62814. * @return The pixels data in RGB right to left up to down order.
  62815. */
  62816. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  62817. private static RGBE_ReadPixels_RLE;
  62818. private static RGBE_ReadPixels_NOT_RLE;
  62819. }
  62820. }
  62821. declare module "babylonjs/Materials/effectRenderer" {
  62822. import { Nullable } from "babylonjs/types";
  62823. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  62824. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62825. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62826. import { Viewport } from "babylonjs/Maths/math.viewport";
  62827. import { Observable } from "babylonjs/Misc/observable";
  62828. import { Effect } from "babylonjs/Materials/effect";
  62829. import "babylonjs/Shaders/postprocess.vertex";
  62830. /**
  62831. * Effect Render Options
  62832. */
  62833. export interface IEffectRendererOptions {
  62834. /**
  62835. * Defines the vertices positions.
  62836. */
  62837. positions?: number[];
  62838. /**
  62839. * Defines the indices.
  62840. */
  62841. indices?: number[];
  62842. }
  62843. /**
  62844. * Helper class to render one or more effects.
  62845. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  62846. */
  62847. export class EffectRenderer {
  62848. private engine;
  62849. private static _DefaultOptions;
  62850. private _vertexBuffers;
  62851. private _indexBuffer;
  62852. private _fullscreenViewport;
  62853. /**
  62854. * Creates an effect renderer
  62855. * @param engine the engine to use for rendering
  62856. * @param options defines the options of the effect renderer
  62857. */
  62858. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  62859. /**
  62860. * Sets the current viewport in normalized coordinates 0-1
  62861. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  62862. */
  62863. setViewport(viewport?: Viewport): void;
  62864. /**
  62865. * Binds the embedded attributes buffer to the effect.
  62866. * @param effect Defines the effect to bind the attributes for
  62867. */
  62868. bindBuffers(effect: Effect): void;
  62869. /**
  62870. * Sets the current effect wrapper to use during draw.
  62871. * The effect needs to be ready before calling this api.
  62872. * This also sets the default full screen position attribute.
  62873. * @param effectWrapper Defines the effect to draw with
  62874. */
  62875. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  62876. /**
  62877. * Restores engine states
  62878. */
  62879. restoreStates(): void;
  62880. /**
  62881. * Draws a full screen quad.
  62882. */
  62883. draw(): void;
  62884. private isRenderTargetTexture;
  62885. /**
  62886. * renders one or more effects to a specified texture
  62887. * @param effectWrapper the effect to renderer
  62888. * @param outputTexture texture to draw to, if null it will render to the screen.
  62889. */
  62890. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  62891. /**
  62892. * Disposes of the effect renderer
  62893. */
  62894. dispose(): void;
  62895. }
  62896. /**
  62897. * Options to create an EffectWrapper
  62898. */
  62899. interface EffectWrapperCreationOptions {
  62900. /**
  62901. * Engine to use to create the effect
  62902. */
  62903. engine: ThinEngine;
  62904. /**
  62905. * Fragment shader for the effect
  62906. */
  62907. fragmentShader: string;
  62908. /**
  62909. * Use the shader store instead of direct source code
  62910. */
  62911. useShaderStore?: boolean;
  62912. /**
  62913. * Vertex shader for the effect
  62914. */
  62915. vertexShader?: string;
  62916. /**
  62917. * Attributes to use in the shader
  62918. */
  62919. attributeNames?: Array<string>;
  62920. /**
  62921. * Uniforms to use in the shader
  62922. */
  62923. uniformNames?: Array<string>;
  62924. /**
  62925. * Texture sampler names to use in the shader
  62926. */
  62927. samplerNames?: Array<string>;
  62928. /**
  62929. * Defines to use in the shader
  62930. */
  62931. defines?: Array<string>;
  62932. /**
  62933. * Callback when effect is compiled
  62934. */
  62935. onCompiled?: Nullable<(effect: Effect) => void>;
  62936. /**
  62937. * The friendly name of the effect displayed in Spector.
  62938. */
  62939. name?: string;
  62940. }
  62941. /**
  62942. * Wraps an effect to be used for rendering
  62943. */
  62944. export class EffectWrapper {
  62945. /**
  62946. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  62947. */
  62948. onApplyObservable: Observable<{}>;
  62949. /**
  62950. * The underlying effect
  62951. */
  62952. effect: Effect;
  62953. /**
  62954. * Creates an effect to be renderer
  62955. * @param creationOptions options to create the effect
  62956. */
  62957. constructor(creationOptions: EffectWrapperCreationOptions);
  62958. /**
  62959. * Disposes of the effect wrapper
  62960. */
  62961. dispose(): void;
  62962. }
  62963. }
  62964. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  62965. /** @hidden */
  62966. export var hdrFilteringVertexShader: {
  62967. name: string;
  62968. shader: string;
  62969. };
  62970. }
  62971. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  62972. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  62973. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  62974. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  62975. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  62976. /** @hidden */
  62977. export var hdrFilteringPixelShader: {
  62978. name: string;
  62979. shader: string;
  62980. };
  62981. }
  62982. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  62983. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62984. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62985. import { Nullable } from "babylonjs/types";
  62986. import "babylonjs/Shaders/hdrFiltering.vertex";
  62987. import "babylonjs/Shaders/hdrFiltering.fragment";
  62988. /**
  62989. * Options for texture filtering
  62990. */
  62991. interface IHDRFilteringOptions {
  62992. /**
  62993. * Scales pixel intensity for the input HDR map.
  62994. */
  62995. hdrScale?: number;
  62996. /**
  62997. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  62998. */
  62999. quality?: number;
  63000. }
  63001. /**
  63002. * Filters HDR maps to get correct renderings of PBR reflections
  63003. */
  63004. export class HDRFiltering {
  63005. private _engine;
  63006. private _effectRenderer;
  63007. private _effectWrapper;
  63008. private _lodGenerationOffset;
  63009. private _lodGenerationScale;
  63010. /**
  63011. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  63012. * you care about baking speed.
  63013. */
  63014. quality: number;
  63015. /**
  63016. * Scales pixel intensity for the input HDR map.
  63017. */
  63018. hdrScale: number;
  63019. /**
  63020. * Instantiates HDR filter for reflection maps
  63021. *
  63022. * @param engine Thin engine
  63023. * @param options Options
  63024. */
  63025. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  63026. private _createRenderTarget;
  63027. private _prefilterInternal;
  63028. private _createEffect;
  63029. /**
  63030. * Get a value indicating if the filter is ready to be used
  63031. * @param texture Texture to filter
  63032. * @returns true if the filter is ready
  63033. */
  63034. isReady(texture: BaseTexture): boolean;
  63035. /**
  63036. * Prefilters a cube texture to have mipmap levels representing roughness values.
  63037. * Prefiltering will be invoked at the end of next rendering pass.
  63038. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  63039. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  63040. * @param texture Texture to filter
  63041. * @param onFinished Callback when filtering is done
  63042. * @return Promise called when prefiltering is done
  63043. */
  63044. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  63045. }
  63046. }
  63047. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  63048. import { Nullable } from "babylonjs/types";
  63049. import { Scene } from "babylonjs/scene";
  63050. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  63051. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63052. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63053. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63054. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  63055. /**
  63056. * This represents a texture coming from an HDR input.
  63057. *
  63058. * The only supported format is currently panorama picture stored in RGBE format.
  63059. * Example of such files can be found on HDRLib: http://hdrlib.com/
  63060. */
  63061. export class HDRCubeTexture extends BaseTexture {
  63062. private static _facesMapping;
  63063. private _generateHarmonics;
  63064. private _noMipmap;
  63065. private _prefilterOnLoad;
  63066. private _textureMatrix;
  63067. private _size;
  63068. private _onLoad;
  63069. private _onError;
  63070. /**
  63071. * The texture URL.
  63072. */
  63073. url: string;
  63074. protected _isBlocking: boolean;
  63075. /**
  63076. * Sets wether or not the texture is blocking during loading.
  63077. */
  63078. set isBlocking(value: boolean);
  63079. /**
  63080. * Gets wether or not the texture is blocking during loading.
  63081. */
  63082. get isBlocking(): boolean;
  63083. protected _rotationY: number;
  63084. /**
  63085. * Sets texture matrix rotation angle around Y axis in radians.
  63086. */
  63087. set rotationY(value: number);
  63088. /**
  63089. * Gets texture matrix rotation angle around Y axis radians.
  63090. */
  63091. get rotationY(): number;
  63092. /**
  63093. * Gets or sets the center of the bounding box associated with the cube texture
  63094. * It must define where the camera used to render the texture was set
  63095. */
  63096. boundingBoxPosition: Vector3;
  63097. private _boundingBoxSize;
  63098. /**
  63099. * Gets or sets the size of the bounding box associated with the cube texture
  63100. * When defined, the cubemap will switch to local mode
  63101. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  63102. * @example https://www.babylonjs-playground.com/#RNASML
  63103. */
  63104. set boundingBoxSize(value: Vector3);
  63105. get boundingBoxSize(): Vector3;
  63106. /**
  63107. * Instantiates an HDRTexture from the following parameters.
  63108. *
  63109. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  63110. * @param sceneOrEngine The scene or engine the texture will be used in
  63111. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63112. * @param noMipmap Forces to not generate the mipmap if true
  63113. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  63114. * @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)
  63115. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  63116. */
  63117. 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>);
  63118. /**
  63119. * Get the current class name of the texture useful for serialization or dynamic coding.
  63120. * @returns "HDRCubeTexture"
  63121. */
  63122. getClassName(): string;
  63123. /**
  63124. * Occurs when the file is raw .hdr file.
  63125. */
  63126. private loadTexture;
  63127. clone(): HDRCubeTexture;
  63128. delayLoad(): void;
  63129. /**
  63130. * Get the texture reflection matrix used to rotate/transform the reflection.
  63131. * @returns the reflection matrix
  63132. */
  63133. getReflectionTextureMatrix(): Matrix;
  63134. /**
  63135. * Set the texture reflection matrix used to rotate/transform the reflection.
  63136. * @param value Define the reflection matrix to set
  63137. */
  63138. setReflectionTextureMatrix(value: Matrix): void;
  63139. /**
  63140. * Parses a JSON representation of an HDR Texture in order to create the texture
  63141. * @param parsedTexture Define the JSON representation
  63142. * @param scene Define the scene the texture should be created in
  63143. * @param rootUrl Define the root url in case we need to load relative dependencies
  63144. * @returns the newly created texture after parsing
  63145. */
  63146. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  63147. serialize(): any;
  63148. }
  63149. }
  63150. declare module "babylonjs/Physics/physicsEngine" {
  63151. import { Nullable } from "babylonjs/types";
  63152. import { Vector3 } from "babylonjs/Maths/math.vector";
  63153. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  63154. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  63155. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  63156. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63157. /**
  63158. * Class used to control physics engine
  63159. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63160. */
  63161. export class PhysicsEngine implements IPhysicsEngine {
  63162. private _physicsPlugin;
  63163. /**
  63164. * Global value used to control the smallest number supported by the simulation
  63165. */
  63166. static Epsilon: number;
  63167. private _impostors;
  63168. private _joints;
  63169. private _subTimeStep;
  63170. /**
  63171. * Gets the gravity vector used by the simulation
  63172. */
  63173. gravity: Vector3;
  63174. /**
  63175. * Factory used to create the default physics plugin.
  63176. * @returns The default physics plugin
  63177. */
  63178. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  63179. /**
  63180. * Creates a new Physics Engine
  63181. * @param gravity defines the gravity vector used by the simulation
  63182. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  63183. */
  63184. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  63185. /**
  63186. * Sets the gravity vector used by the simulation
  63187. * @param gravity defines the gravity vector to use
  63188. */
  63189. setGravity(gravity: Vector3): void;
  63190. /**
  63191. * Set the time step of the physics engine.
  63192. * Default is 1/60.
  63193. * To slow it down, enter 1/600 for example.
  63194. * To speed it up, 1/30
  63195. * @param newTimeStep defines the new timestep to apply to this world.
  63196. */
  63197. setTimeStep(newTimeStep?: number): void;
  63198. /**
  63199. * Get the time step of the physics engine.
  63200. * @returns the current time step
  63201. */
  63202. getTimeStep(): number;
  63203. /**
  63204. * Set the sub time step of the physics engine.
  63205. * Default is 0 meaning there is no sub steps
  63206. * To increase physics resolution precision, set a small value (like 1 ms)
  63207. * @param subTimeStep defines the new sub timestep used for physics resolution.
  63208. */
  63209. setSubTimeStep(subTimeStep?: number): void;
  63210. /**
  63211. * Get the sub time step of the physics engine.
  63212. * @returns the current sub time step
  63213. */
  63214. getSubTimeStep(): number;
  63215. /**
  63216. * Release all resources
  63217. */
  63218. dispose(): void;
  63219. /**
  63220. * Gets the name of the current physics plugin
  63221. * @returns the name of the plugin
  63222. */
  63223. getPhysicsPluginName(): string;
  63224. /**
  63225. * Adding a new impostor for the impostor tracking.
  63226. * This will be done by the impostor itself.
  63227. * @param impostor the impostor to add
  63228. */
  63229. addImpostor(impostor: PhysicsImpostor): void;
  63230. /**
  63231. * Remove an impostor from the engine.
  63232. * This impostor and its mesh will not longer be updated by the physics engine.
  63233. * @param impostor the impostor to remove
  63234. */
  63235. removeImpostor(impostor: PhysicsImpostor): void;
  63236. /**
  63237. * Add a joint to the physics engine
  63238. * @param mainImpostor defines the main impostor to which the joint is added.
  63239. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  63240. * @param joint defines the joint that will connect both impostors.
  63241. */
  63242. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63243. /**
  63244. * Removes a joint from the simulation
  63245. * @param mainImpostor defines the impostor used with the joint
  63246. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  63247. * @param joint defines the joint to remove
  63248. */
  63249. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63250. /**
  63251. * Called by the scene. No need to call it.
  63252. * @param delta defines the timespam between frames
  63253. */
  63254. _step(delta: number): void;
  63255. /**
  63256. * Gets the current plugin used to run the simulation
  63257. * @returns current plugin
  63258. */
  63259. getPhysicsPlugin(): IPhysicsEnginePlugin;
  63260. /**
  63261. * Gets the list of physic impostors
  63262. * @returns an array of PhysicsImpostor
  63263. */
  63264. getImpostors(): Array<PhysicsImpostor>;
  63265. /**
  63266. * Gets the impostor for a physics enabled object
  63267. * @param object defines the object impersonated by the impostor
  63268. * @returns the PhysicsImpostor or null if not found
  63269. */
  63270. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  63271. /**
  63272. * Gets the impostor for a physics body object
  63273. * @param body defines physics body used by the impostor
  63274. * @returns the PhysicsImpostor or null if not found
  63275. */
  63276. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  63277. /**
  63278. * Does a raycast in the physics world
  63279. * @param from when should the ray start?
  63280. * @param to when should the ray end?
  63281. * @returns PhysicsRaycastResult
  63282. */
  63283. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63284. }
  63285. }
  63286. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  63287. import { Nullable } from "babylonjs/types";
  63288. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63289. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63290. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63291. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63292. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63293. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63294. /** @hidden */
  63295. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  63296. private _useDeltaForWorldStep;
  63297. world: any;
  63298. name: string;
  63299. private _physicsMaterials;
  63300. private _fixedTimeStep;
  63301. private _cannonRaycastResult;
  63302. private _raycastResult;
  63303. private _physicsBodysToRemoveAfterStep;
  63304. private _firstFrame;
  63305. BJSCANNON: any;
  63306. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  63307. setGravity(gravity: Vector3): void;
  63308. setTimeStep(timeStep: number): void;
  63309. getTimeStep(): number;
  63310. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63311. private _removeMarkedPhysicsBodiesFromWorld;
  63312. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63313. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63314. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63315. private _processChildMeshes;
  63316. removePhysicsBody(impostor: PhysicsImpostor): void;
  63317. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63318. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63319. private _addMaterial;
  63320. private _checkWithEpsilon;
  63321. private _createShape;
  63322. private _createHeightmap;
  63323. private _minus90X;
  63324. private _plus90X;
  63325. private _tmpPosition;
  63326. private _tmpDeltaPosition;
  63327. private _tmpUnityRotation;
  63328. private _updatePhysicsBodyTransformation;
  63329. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63330. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63331. isSupported(): boolean;
  63332. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63333. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63334. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63335. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63336. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63337. getBodyMass(impostor: PhysicsImpostor): number;
  63338. getBodyFriction(impostor: PhysicsImpostor): number;
  63339. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63340. getBodyRestitution(impostor: PhysicsImpostor): number;
  63341. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63342. sleepBody(impostor: PhysicsImpostor): void;
  63343. wakeUpBody(impostor: PhysicsImpostor): void;
  63344. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  63345. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63346. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63347. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63348. getRadius(impostor: PhysicsImpostor): number;
  63349. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63350. dispose(): void;
  63351. private _extendNamespace;
  63352. /**
  63353. * Does a raycast in the physics world
  63354. * @param from when should the ray start?
  63355. * @param to when should the ray end?
  63356. * @returns PhysicsRaycastResult
  63357. */
  63358. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63359. }
  63360. }
  63361. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  63362. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63363. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63364. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63365. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63366. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63367. import { Nullable } from "babylonjs/types";
  63368. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63369. /** @hidden */
  63370. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  63371. private _useDeltaForWorldStep;
  63372. world: any;
  63373. name: string;
  63374. BJSOIMO: any;
  63375. private _raycastResult;
  63376. private _fixedTimeStep;
  63377. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  63378. setGravity(gravity: Vector3): void;
  63379. setTimeStep(timeStep: number): void;
  63380. getTimeStep(): number;
  63381. private _tmpImpostorsArray;
  63382. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63383. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63384. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63385. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63386. private _tmpPositionVector;
  63387. removePhysicsBody(impostor: PhysicsImpostor): void;
  63388. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63389. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63390. isSupported(): boolean;
  63391. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63392. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63393. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63394. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63395. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63396. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63397. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63398. getBodyMass(impostor: PhysicsImpostor): number;
  63399. getBodyFriction(impostor: PhysicsImpostor): number;
  63400. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63401. getBodyRestitution(impostor: PhysicsImpostor): number;
  63402. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63403. sleepBody(impostor: PhysicsImpostor): void;
  63404. wakeUpBody(impostor: PhysicsImpostor): void;
  63405. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63406. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  63407. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  63408. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63409. getRadius(impostor: PhysicsImpostor): number;
  63410. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63411. dispose(): void;
  63412. /**
  63413. * Does a raycast in the physics world
  63414. * @param from when should the ray start?
  63415. * @param to when should the ray end?
  63416. * @returns PhysicsRaycastResult
  63417. */
  63418. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63419. }
  63420. }
  63421. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  63422. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  63423. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63424. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63425. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63426. import { Nullable } from "babylonjs/types";
  63427. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63428. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63429. /**
  63430. * AmmoJS Physics plugin
  63431. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63432. * @see https://github.com/kripken/ammo.js/
  63433. */
  63434. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  63435. private _useDeltaForWorldStep;
  63436. /**
  63437. * Reference to the Ammo library
  63438. */
  63439. bjsAMMO: any;
  63440. /**
  63441. * Created ammoJS world which physics bodies are added to
  63442. */
  63443. world: any;
  63444. /**
  63445. * Name of the plugin
  63446. */
  63447. name: string;
  63448. private _timeStep;
  63449. private _fixedTimeStep;
  63450. private _maxSteps;
  63451. private _tmpQuaternion;
  63452. private _tmpAmmoTransform;
  63453. private _tmpAmmoQuaternion;
  63454. private _tmpAmmoConcreteContactResultCallback;
  63455. private _collisionConfiguration;
  63456. private _dispatcher;
  63457. private _overlappingPairCache;
  63458. private _solver;
  63459. private _softBodySolver;
  63460. private _tmpAmmoVectorA;
  63461. private _tmpAmmoVectorB;
  63462. private _tmpAmmoVectorC;
  63463. private _tmpAmmoVectorD;
  63464. private _tmpContactCallbackResult;
  63465. private _tmpAmmoVectorRCA;
  63466. private _tmpAmmoVectorRCB;
  63467. private _raycastResult;
  63468. private static readonly DISABLE_COLLISION_FLAG;
  63469. private static readonly KINEMATIC_FLAG;
  63470. private static readonly DISABLE_DEACTIVATION_FLAG;
  63471. /**
  63472. * Initializes the ammoJS plugin
  63473. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  63474. * @param ammoInjection can be used to inject your own ammo reference
  63475. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  63476. */
  63477. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  63478. /**
  63479. * Sets the gravity of the physics world (m/(s^2))
  63480. * @param gravity Gravity to set
  63481. */
  63482. setGravity(gravity: Vector3): void;
  63483. /**
  63484. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  63485. * @param timeStep timestep to use in seconds
  63486. */
  63487. setTimeStep(timeStep: number): void;
  63488. /**
  63489. * 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)
  63490. * @param fixedTimeStep fixedTimeStep to use in seconds
  63491. */
  63492. setFixedTimeStep(fixedTimeStep: number): void;
  63493. /**
  63494. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  63495. * @param maxSteps the maximum number of steps by the physics engine per frame
  63496. */
  63497. setMaxSteps(maxSteps: number): void;
  63498. /**
  63499. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  63500. * @returns the current timestep in seconds
  63501. */
  63502. getTimeStep(): number;
  63503. /**
  63504. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  63505. */
  63506. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  63507. private _isImpostorInContact;
  63508. private _isImpostorPairInContact;
  63509. private _stepSimulation;
  63510. /**
  63511. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  63512. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  63513. * After the step the babylon meshes are set to the position of the physics imposters
  63514. * @param delta amount of time to step forward
  63515. * @param impostors array of imposters to update before/after the step
  63516. */
  63517. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63518. /**
  63519. * Update babylon mesh to match physics world object
  63520. * @param impostor imposter to match
  63521. */
  63522. private _afterSoftStep;
  63523. /**
  63524. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63525. * @param impostor imposter to match
  63526. */
  63527. private _ropeStep;
  63528. /**
  63529. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63530. * @param impostor imposter to match
  63531. */
  63532. private _softbodyOrClothStep;
  63533. private _tmpMatrix;
  63534. /**
  63535. * Applies an impulse on the imposter
  63536. * @param impostor imposter to apply impulse to
  63537. * @param force amount of force to be applied to the imposter
  63538. * @param contactPoint the location to apply the impulse on the imposter
  63539. */
  63540. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63541. /**
  63542. * Applies a force on the imposter
  63543. * @param impostor imposter to apply force
  63544. * @param force amount of force to be applied to the imposter
  63545. * @param contactPoint the location to apply the force on the imposter
  63546. */
  63547. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63548. /**
  63549. * Creates a physics body using the plugin
  63550. * @param impostor the imposter to create the physics body on
  63551. */
  63552. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63553. /**
  63554. * Removes the physics body from the imposter and disposes of the body's memory
  63555. * @param impostor imposter to remove the physics body from
  63556. */
  63557. removePhysicsBody(impostor: PhysicsImpostor): void;
  63558. /**
  63559. * Generates a joint
  63560. * @param impostorJoint the imposter joint to create the joint with
  63561. */
  63562. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63563. /**
  63564. * Removes a joint
  63565. * @param impostorJoint the imposter joint to remove the joint from
  63566. */
  63567. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63568. private _addMeshVerts;
  63569. /**
  63570. * Initialise the soft body vertices to match its object's (mesh) vertices
  63571. * Softbody vertices (nodes) are in world space and to match this
  63572. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63573. * @param impostor to create the softbody for
  63574. */
  63575. private _softVertexData;
  63576. /**
  63577. * Create an impostor's soft body
  63578. * @param impostor to create the softbody for
  63579. */
  63580. private _createSoftbody;
  63581. /**
  63582. * Create cloth for an impostor
  63583. * @param impostor to create the softbody for
  63584. */
  63585. private _createCloth;
  63586. /**
  63587. * Create rope for an impostor
  63588. * @param impostor to create the softbody for
  63589. */
  63590. private _createRope;
  63591. /**
  63592. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63593. * @param impostor to create the custom physics shape for
  63594. */
  63595. private _createCustom;
  63596. private _addHullVerts;
  63597. private _createShape;
  63598. /**
  63599. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63600. * @param impostor imposter containing the physics body and babylon object
  63601. */
  63602. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63603. /**
  63604. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63605. * @param impostor imposter containing the physics body and babylon object
  63606. * @param newPosition new position
  63607. * @param newRotation new rotation
  63608. */
  63609. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63610. /**
  63611. * If this plugin is supported
  63612. * @returns true if its supported
  63613. */
  63614. isSupported(): boolean;
  63615. /**
  63616. * Sets the linear velocity of the physics body
  63617. * @param impostor imposter to set the velocity on
  63618. * @param velocity velocity to set
  63619. */
  63620. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63621. /**
  63622. * Sets the angular velocity of the physics body
  63623. * @param impostor imposter to set the velocity on
  63624. * @param velocity velocity to set
  63625. */
  63626. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63627. /**
  63628. * gets the linear velocity
  63629. * @param impostor imposter to get linear velocity from
  63630. * @returns linear velocity
  63631. */
  63632. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63633. /**
  63634. * gets the angular velocity
  63635. * @param impostor imposter to get angular velocity from
  63636. * @returns angular velocity
  63637. */
  63638. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63639. /**
  63640. * Sets the mass of physics body
  63641. * @param impostor imposter to set the mass on
  63642. * @param mass mass to set
  63643. */
  63644. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63645. /**
  63646. * Gets the mass of the physics body
  63647. * @param impostor imposter to get the mass from
  63648. * @returns mass
  63649. */
  63650. getBodyMass(impostor: PhysicsImpostor): number;
  63651. /**
  63652. * Gets friction of the impostor
  63653. * @param impostor impostor to get friction from
  63654. * @returns friction value
  63655. */
  63656. getBodyFriction(impostor: PhysicsImpostor): number;
  63657. /**
  63658. * Sets friction of the impostor
  63659. * @param impostor impostor to set friction on
  63660. * @param friction friction value
  63661. */
  63662. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63663. /**
  63664. * Gets restitution of the impostor
  63665. * @param impostor impostor to get restitution from
  63666. * @returns restitution value
  63667. */
  63668. getBodyRestitution(impostor: PhysicsImpostor): number;
  63669. /**
  63670. * Sets resitution of the impostor
  63671. * @param impostor impostor to set resitution on
  63672. * @param restitution resitution value
  63673. */
  63674. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63675. /**
  63676. * Gets pressure inside the impostor
  63677. * @param impostor impostor to get pressure from
  63678. * @returns pressure value
  63679. */
  63680. getBodyPressure(impostor: PhysicsImpostor): number;
  63681. /**
  63682. * Sets pressure inside a soft body impostor
  63683. * Cloth and rope must remain 0 pressure
  63684. * @param impostor impostor to set pressure on
  63685. * @param pressure pressure value
  63686. */
  63687. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  63688. /**
  63689. * Gets stiffness of the impostor
  63690. * @param impostor impostor to get stiffness from
  63691. * @returns pressure value
  63692. */
  63693. getBodyStiffness(impostor: PhysicsImpostor): number;
  63694. /**
  63695. * Sets stiffness of the impostor
  63696. * @param impostor impostor to set stiffness on
  63697. * @param stiffness stiffness value from 0 to 1
  63698. */
  63699. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  63700. /**
  63701. * Gets velocityIterations of the impostor
  63702. * @param impostor impostor to get velocity iterations from
  63703. * @returns velocityIterations value
  63704. */
  63705. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  63706. /**
  63707. * Sets velocityIterations of the impostor
  63708. * @param impostor impostor to set velocity iterations on
  63709. * @param velocityIterations velocityIterations value
  63710. */
  63711. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  63712. /**
  63713. * Gets positionIterations of the impostor
  63714. * @param impostor impostor to get position iterations from
  63715. * @returns positionIterations value
  63716. */
  63717. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  63718. /**
  63719. * Sets positionIterations of the impostor
  63720. * @param impostor impostor to set position on
  63721. * @param positionIterations positionIterations value
  63722. */
  63723. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  63724. /**
  63725. * Append an anchor to a cloth object
  63726. * @param impostor is the cloth impostor to add anchor to
  63727. * @param otherImpostor is the rigid impostor to anchor to
  63728. * @param width ratio across width from 0 to 1
  63729. * @param height ratio up height from 0 to 1
  63730. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  63731. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63732. */
  63733. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63734. /**
  63735. * Append an hook to a rope object
  63736. * @param impostor is the rope impostor to add hook to
  63737. * @param otherImpostor is the rigid impostor to hook to
  63738. * @param length ratio along the rope from 0 to 1
  63739. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  63740. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63741. */
  63742. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63743. /**
  63744. * Sleeps the physics body and stops it from being active
  63745. * @param impostor impostor to sleep
  63746. */
  63747. sleepBody(impostor: PhysicsImpostor): void;
  63748. /**
  63749. * Activates the physics body
  63750. * @param impostor impostor to activate
  63751. */
  63752. wakeUpBody(impostor: PhysicsImpostor): void;
  63753. /**
  63754. * Updates the distance parameters of the joint
  63755. * @param joint joint to update
  63756. * @param maxDistance maximum distance of the joint
  63757. * @param minDistance minimum distance of the joint
  63758. */
  63759. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63760. /**
  63761. * Sets a motor on the joint
  63762. * @param joint joint to set motor on
  63763. * @param speed speed of the motor
  63764. * @param maxForce maximum force of the motor
  63765. * @param motorIndex index of the motor
  63766. */
  63767. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63768. /**
  63769. * Sets the motors limit
  63770. * @param joint joint to set limit on
  63771. * @param upperLimit upper limit
  63772. * @param lowerLimit lower limit
  63773. */
  63774. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63775. /**
  63776. * Syncs the position and rotation of a mesh with the impostor
  63777. * @param mesh mesh to sync
  63778. * @param impostor impostor to update the mesh with
  63779. */
  63780. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63781. /**
  63782. * Gets the radius of the impostor
  63783. * @param impostor impostor to get radius from
  63784. * @returns the radius
  63785. */
  63786. getRadius(impostor: PhysicsImpostor): number;
  63787. /**
  63788. * Gets the box size of the impostor
  63789. * @param impostor impostor to get box size from
  63790. * @param result the resulting box size
  63791. */
  63792. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63793. /**
  63794. * Disposes of the impostor
  63795. */
  63796. dispose(): void;
  63797. /**
  63798. * Does a raycast in the physics world
  63799. * @param from when should the ray start?
  63800. * @param to when should the ray end?
  63801. * @returns PhysicsRaycastResult
  63802. */
  63803. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63804. }
  63805. }
  63806. declare module "babylonjs/Probes/reflectionProbe" {
  63807. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63808. import { Vector3 } from "babylonjs/Maths/math.vector";
  63809. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63810. import { Nullable } from "babylonjs/types";
  63811. import { Scene } from "babylonjs/scene";
  63812. module "babylonjs/abstractScene" {
  63813. interface AbstractScene {
  63814. /**
  63815. * The list of reflection probes added to the scene
  63816. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63817. */
  63818. reflectionProbes: Array<ReflectionProbe>;
  63819. /**
  63820. * Removes the given reflection probe from this scene.
  63821. * @param toRemove The reflection probe to remove
  63822. * @returns The index of the removed reflection probe
  63823. */
  63824. removeReflectionProbe(toRemove: ReflectionProbe): number;
  63825. /**
  63826. * Adds the given reflection probe to this scene.
  63827. * @param newReflectionProbe The reflection probe to add
  63828. */
  63829. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  63830. }
  63831. }
  63832. /**
  63833. * Class used to generate realtime reflection / refraction cube textures
  63834. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63835. */
  63836. export class ReflectionProbe {
  63837. /** defines the name of the probe */
  63838. name: string;
  63839. private _scene;
  63840. private _renderTargetTexture;
  63841. private _projectionMatrix;
  63842. private _viewMatrix;
  63843. private _target;
  63844. private _add;
  63845. private _attachedMesh;
  63846. private _invertYAxis;
  63847. /** Gets or sets probe position (center of the cube map) */
  63848. position: Vector3;
  63849. /**
  63850. * Creates a new reflection probe
  63851. * @param name defines the name of the probe
  63852. * @param size defines the texture resolution (for each face)
  63853. * @param scene defines the hosting scene
  63854. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  63855. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  63856. */
  63857. constructor(
  63858. /** defines the name of the probe */
  63859. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  63860. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  63861. get samples(): number;
  63862. set samples(value: number);
  63863. /** Gets or sets the refresh rate to use (on every frame by default) */
  63864. get refreshRate(): number;
  63865. set refreshRate(value: number);
  63866. /**
  63867. * Gets the hosting scene
  63868. * @returns a Scene
  63869. */
  63870. getScene(): Scene;
  63871. /** Gets the internal CubeTexture used to render to */
  63872. get cubeTexture(): RenderTargetTexture;
  63873. /** Gets the list of meshes to render */
  63874. get renderList(): Nullable<AbstractMesh[]>;
  63875. /**
  63876. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  63877. * @param mesh defines the mesh to attach to
  63878. */
  63879. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  63880. /**
  63881. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  63882. * @param renderingGroupId The rendering group id corresponding to its index
  63883. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  63884. */
  63885. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  63886. /**
  63887. * Clean all associated resources
  63888. */
  63889. dispose(): void;
  63890. /**
  63891. * Converts the reflection probe information to a readable string for debug purpose.
  63892. * @param fullDetails Supports for multiple levels of logging within scene loading
  63893. * @returns the human readable reflection probe info
  63894. */
  63895. toString(fullDetails?: boolean): string;
  63896. /**
  63897. * Get the class name of the relfection probe.
  63898. * @returns "ReflectionProbe"
  63899. */
  63900. getClassName(): string;
  63901. /**
  63902. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  63903. * @returns The JSON representation of the texture
  63904. */
  63905. serialize(): any;
  63906. /**
  63907. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  63908. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  63909. * @param scene Define the scene the parsed reflection probe should be instantiated in
  63910. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  63911. * @returns The parsed reflection probe if successful
  63912. */
  63913. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  63914. }
  63915. }
  63916. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  63917. /** @hidden */
  63918. export var _BabylonLoaderRegistered: boolean;
  63919. /**
  63920. * Helps setting up some configuration for the babylon file loader.
  63921. */
  63922. export class BabylonFileLoaderConfiguration {
  63923. /**
  63924. * The loader does not allow injecting custom physix engine into the plugins.
  63925. * Unfortunately in ES6, we need to manually inject them into the plugin.
  63926. * So you could set this variable to your engine import to make it work.
  63927. */
  63928. static LoaderInjectedPhysicsEngine: any;
  63929. }
  63930. }
  63931. declare module "babylonjs/Loading/Plugins/index" {
  63932. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  63933. }
  63934. declare module "babylonjs/Loading/index" {
  63935. export * from "babylonjs/Loading/loadingScreen";
  63936. export * from "babylonjs/Loading/Plugins/index";
  63937. export * from "babylonjs/Loading/sceneLoader";
  63938. export * from "babylonjs/Loading/sceneLoaderFlags";
  63939. }
  63940. declare module "babylonjs/Materials/Background/index" {
  63941. export * from "babylonjs/Materials/Background/backgroundMaterial";
  63942. }
  63943. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  63944. import { Scene } from "babylonjs/scene";
  63945. import { Color3 } from "babylonjs/Maths/math.color";
  63946. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  63947. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63948. /**
  63949. * The Physically based simple base material of BJS.
  63950. *
  63951. * This enables better naming and convention enforcements on top of the pbrMaterial.
  63952. * It is used as the base class for both the specGloss and metalRough conventions.
  63953. */
  63954. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  63955. /**
  63956. * Number of Simultaneous lights allowed on the material.
  63957. */
  63958. maxSimultaneousLights: number;
  63959. /**
  63960. * If sets to true, disables all the lights affecting the material.
  63961. */
  63962. disableLighting: boolean;
  63963. /**
  63964. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  63965. */
  63966. environmentTexture: BaseTexture;
  63967. /**
  63968. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  63969. */
  63970. invertNormalMapX: boolean;
  63971. /**
  63972. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  63973. */
  63974. invertNormalMapY: boolean;
  63975. /**
  63976. * Normal map used in the model.
  63977. */
  63978. normalTexture: BaseTexture;
  63979. /**
  63980. * Emissivie color used to self-illuminate the model.
  63981. */
  63982. emissiveColor: Color3;
  63983. /**
  63984. * Emissivie texture used to self-illuminate the model.
  63985. */
  63986. emissiveTexture: BaseTexture;
  63987. /**
  63988. * Occlusion Channel Strenght.
  63989. */
  63990. occlusionStrength: number;
  63991. /**
  63992. * Occlusion Texture of the material (adding extra occlusion effects).
  63993. */
  63994. occlusionTexture: BaseTexture;
  63995. /**
  63996. * Defines the alpha limits in alpha test mode.
  63997. */
  63998. alphaCutOff: number;
  63999. /**
  64000. * Gets the current double sided mode.
  64001. */
  64002. get doubleSided(): boolean;
  64003. /**
  64004. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  64005. */
  64006. set doubleSided(value: boolean);
  64007. /**
  64008. * Stores the pre-calculated light information of a mesh in a texture.
  64009. */
  64010. lightmapTexture: BaseTexture;
  64011. /**
  64012. * If true, the light map contains occlusion information instead of lighting info.
  64013. */
  64014. useLightmapAsShadowmap: boolean;
  64015. /**
  64016. * Instantiates a new PBRMaterial instance.
  64017. *
  64018. * @param name The material name
  64019. * @param scene The scene the material will be use in.
  64020. */
  64021. constructor(name: string, scene: Scene);
  64022. getClassName(): string;
  64023. }
  64024. }
  64025. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  64026. import { Scene } from "babylonjs/scene";
  64027. import { Color3 } from "babylonjs/Maths/math.color";
  64028. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64029. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64030. /**
  64031. * The PBR material of BJS following the metal roughness convention.
  64032. *
  64033. * This fits to the PBR convention in the GLTF definition:
  64034. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  64035. */
  64036. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  64037. /**
  64038. * The base color has two different interpretations depending on the value of metalness.
  64039. * When the material is a metal, the base color is the specific measured reflectance value
  64040. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  64041. * of the material.
  64042. */
  64043. baseColor: Color3;
  64044. /**
  64045. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  64046. * well as opacity information in the alpha channel.
  64047. */
  64048. baseTexture: BaseTexture;
  64049. /**
  64050. * Specifies the metallic scalar value of the material.
  64051. * Can also be used to scale the metalness values of the metallic texture.
  64052. */
  64053. metallic: number;
  64054. /**
  64055. * Specifies the roughness scalar value of the material.
  64056. * Can also be used to scale the roughness values of the metallic texture.
  64057. */
  64058. roughness: number;
  64059. /**
  64060. * Texture containing both the metallic value in the B channel and the
  64061. * roughness value in the G channel to keep better precision.
  64062. */
  64063. metallicRoughnessTexture: BaseTexture;
  64064. /**
  64065. * Instantiates a new PBRMetalRoughnessMaterial instance.
  64066. *
  64067. * @param name The material name
  64068. * @param scene The scene the material will be use in.
  64069. */
  64070. constructor(name: string, scene: Scene);
  64071. /**
  64072. * Return the currrent class name of the material.
  64073. */
  64074. getClassName(): string;
  64075. /**
  64076. * Makes a duplicate of the current material.
  64077. * @param name - name to use for the new material.
  64078. */
  64079. clone(name: string): PBRMetallicRoughnessMaterial;
  64080. /**
  64081. * Serialize the material to a parsable JSON object.
  64082. */
  64083. serialize(): any;
  64084. /**
  64085. * Parses a JSON object correponding to the serialize function.
  64086. */
  64087. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  64088. }
  64089. }
  64090. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  64091. import { Scene } from "babylonjs/scene";
  64092. import { Color3 } from "babylonjs/Maths/math.color";
  64093. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64094. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64095. /**
  64096. * The PBR material of BJS following the specular glossiness convention.
  64097. *
  64098. * This fits to the PBR convention in the GLTF definition:
  64099. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  64100. */
  64101. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  64102. /**
  64103. * Specifies the diffuse color of the material.
  64104. */
  64105. diffuseColor: Color3;
  64106. /**
  64107. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  64108. * channel.
  64109. */
  64110. diffuseTexture: BaseTexture;
  64111. /**
  64112. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  64113. */
  64114. specularColor: Color3;
  64115. /**
  64116. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  64117. */
  64118. glossiness: number;
  64119. /**
  64120. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  64121. */
  64122. specularGlossinessTexture: BaseTexture;
  64123. /**
  64124. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  64125. *
  64126. * @param name The material name
  64127. * @param scene The scene the material will be use in.
  64128. */
  64129. constructor(name: string, scene: Scene);
  64130. /**
  64131. * Return the currrent class name of the material.
  64132. */
  64133. getClassName(): string;
  64134. /**
  64135. * Makes a duplicate of the current material.
  64136. * @param name - name to use for the new material.
  64137. */
  64138. clone(name: string): PBRSpecularGlossinessMaterial;
  64139. /**
  64140. * Serialize the material to a parsable JSON object.
  64141. */
  64142. serialize(): any;
  64143. /**
  64144. * Parses a JSON object correponding to the serialize function.
  64145. */
  64146. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  64147. }
  64148. }
  64149. declare module "babylonjs/Materials/PBR/index" {
  64150. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64151. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64152. export * from "babylonjs/Materials/PBR/pbrMaterial";
  64153. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  64154. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  64155. }
  64156. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  64157. import { Nullable } from "babylonjs/types";
  64158. import { Scene } from "babylonjs/scene";
  64159. import { Matrix } from "babylonjs/Maths/math.vector";
  64160. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64161. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64162. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64163. /**
  64164. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  64165. * It can help converting any input color in a desired output one. This can then be used to create effects
  64166. * from sepia, black and white to sixties or futuristic rendering...
  64167. *
  64168. * The only supported format is currently 3dl.
  64169. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  64170. */
  64171. export class ColorGradingTexture extends BaseTexture {
  64172. /**
  64173. * The texture URL.
  64174. */
  64175. url: string;
  64176. /**
  64177. * Empty line regex stored for GC.
  64178. */
  64179. private static _noneEmptyLineRegex;
  64180. private _textureMatrix;
  64181. private _onLoad;
  64182. /**
  64183. * Instantiates a ColorGradingTexture from the following parameters.
  64184. *
  64185. * @param url The location of the color gradind data (currently only supporting 3dl)
  64186. * @param sceneOrEngine The scene or engine the texture will be used in
  64187. * @param onLoad defines a callback triggered when the texture has been loaded
  64188. */
  64189. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  64190. /**
  64191. * Fires the onload event from the constructor if requested.
  64192. */
  64193. private _triggerOnLoad;
  64194. /**
  64195. * Returns the texture matrix used in most of the material.
  64196. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  64197. */
  64198. getTextureMatrix(): Matrix;
  64199. /**
  64200. * Occurs when the file being loaded is a .3dl LUT file.
  64201. */
  64202. private load3dlTexture;
  64203. /**
  64204. * Starts the loading process of the texture.
  64205. */
  64206. private loadTexture;
  64207. /**
  64208. * Clones the color gradind texture.
  64209. */
  64210. clone(): ColorGradingTexture;
  64211. /**
  64212. * Called during delayed load for textures.
  64213. */
  64214. delayLoad(): void;
  64215. /**
  64216. * Parses a color grading texture serialized by Babylon.
  64217. * @param parsedTexture The texture information being parsedTexture
  64218. * @param scene The scene to load the texture in
  64219. * @param rootUrl The root url of the data assets to load
  64220. * @return A color gradind texture
  64221. */
  64222. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  64223. /**
  64224. * Serializes the LUT texture to json format.
  64225. */
  64226. serialize(): any;
  64227. }
  64228. }
  64229. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  64230. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64231. import { Scene } from "babylonjs/scene";
  64232. import { Nullable } from "babylonjs/types";
  64233. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64234. /**
  64235. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  64236. */
  64237. export class EquiRectangularCubeTexture extends BaseTexture {
  64238. /** The six faces of the cube. */
  64239. private static _FacesMapping;
  64240. private _noMipmap;
  64241. private _onLoad;
  64242. private _onError;
  64243. /** The size of the cubemap. */
  64244. private _size;
  64245. /** The buffer of the image. */
  64246. private _buffer;
  64247. /** The width of the input image. */
  64248. private _width;
  64249. /** The height of the input image. */
  64250. private _height;
  64251. /** The URL to the image. */
  64252. url: string;
  64253. /**
  64254. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  64255. * @param url The location of the image
  64256. * @param scene The scene the texture will be used in
  64257. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  64258. * @param noMipmap Forces to not generate the mipmap if true
  64259. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  64260. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  64261. * @param onLoad — defines a callback called when texture is loaded
  64262. * @param onError — defines a callback called if there is an error
  64263. */
  64264. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  64265. /**
  64266. * Load the image data, by putting the image on a canvas and extracting its buffer.
  64267. */
  64268. private loadImage;
  64269. /**
  64270. * Convert the image buffer into a cubemap and create a CubeTexture.
  64271. */
  64272. private loadTexture;
  64273. /**
  64274. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  64275. * @param buffer The ArrayBuffer that should be converted.
  64276. * @returns The buffer as Float32Array.
  64277. */
  64278. private getFloat32ArrayFromArrayBuffer;
  64279. /**
  64280. * Get the current class name of the texture useful for serialization or dynamic coding.
  64281. * @returns "EquiRectangularCubeTexture"
  64282. */
  64283. getClassName(): string;
  64284. /**
  64285. * Create a clone of the current EquiRectangularCubeTexture and return it.
  64286. * @returns A clone of the current EquiRectangularCubeTexture.
  64287. */
  64288. clone(): EquiRectangularCubeTexture;
  64289. }
  64290. }
  64291. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  64292. import { Nullable } from "babylonjs/types";
  64293. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64294. import { Matrix } from "babylonjs/Maths/math.vector";
  64295. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  64296. import "babylonjs/Engines/Extensions/engine.videoTexture";
  64297. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64298. import { Scene } from "babylonjs/scene";
  64299. /**
  64300. * Defines the options related to the creation of an HtmlElementTexture
  64301. */
  64302. export interface IHtmlElementTextureOptions {
  64303. /**
  64304. * Defines wether mip maps should be created or not.
  64305. */
  64306. generateMipMaps?: boolean;
  64307. /**
  64308. * Defines the sampling mode of the texture.
  64309. */
  64310. samplingMode?: number;
  64311. /**
  64312. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  64313. */
  64314. engine: Nullable<ThinEngine>;
  64315. /**
  64316. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  64317. */
  64318. scene: Nullable<Scene>;
  64319. }
  64320. /**
  64321. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  64322. * To be as efficient as possible depending on your constraints nothing aside the first upload
  64323. * is automatically managed.
  64324. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  64325. * in your application.
  64326. *
  64327. * As the update is not automatic, you need to call them manually.
  64328. */
  64329. export class HtmlElementTexture extends BaseTexture {
  64330. /**
  64331. * The texture URL.
  64332. */
  64333. element: HTMLVideoElement | HTMLCanvasElement;
  64334. private static readonly DefaultOptions;
  64335. private _textureMatrix;
  64336. private _isVideo;
  64337. private _generateMipMaps;
  64338. private _samplingMode;
  64339. /**
  64340. * Instantiates a HtmlElementTexture from the following parameters.
  64341. *
  64342. * @param name Defines the name of the texture
  64343. * @param element Defines the video or canvas the texture is filled with
  64344. * @param options Defines the other none mandatory texture creation options
  64345. */
  64346. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  64347. private _createInternalTexture;
  64348. /**
  64349. * Returns the texture matrix used in most of the material.
  64350. */
  64351. getTextureMatrix(): Matrix;
  64352. /**
  64353. * Updates the content of the texture.
  64354. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  64355. */
  64356. update(invertY?: Nullable<boolean>): void;
  64357. }
  64358. }
  64359. declare module "babylonjs/Misc/tga" {
  64360. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64361. /**
  64362. * Based on jsTGALoader - Javascript loader for TGA file
  64363. * By Vincent Thibault
  64364. * @see http://blog.robrowser.com/javascript-tga-loader.html
  64365. */
  64366. export class TGATools {
  64367. private static _TYPE_INDEXED;
  64368. private static _TYPE_RGB;
  64369. private static _TYPE_GREY;
  64370. private static _TYPE_RLE_INDEXED;
  64371. private static _TYPE_RLE_RGB;
  64372. private static _TYPE_RLE_GREY;
  64373. private static _ORIGIN_MASK;
  64374. private static _ORIGIN_SHIFT;
  64375. private static _ORIGIN_BL;
  64376. private static _ORIGIN_BR;
  64377. private static _ORIGIN_UL;
  64378. private static _ORIGIN_UR;
  64379. /**
  64380. * Gets the header of a TGA file
  64381. * @param data defines the TGA data
  64382. * @returns the header
  64383. */
  64384. static GetTGAHeader(data: Uint8Array): any;
  64385. /**
  64386. * Uploads TGA content to a Babylon Texture
  64387. * @hidden
  64388. */
  64389. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  64390. /** @hidden */
  64391. 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;
  64392. /** @hidden */
  64393. 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;
  64394. /** @hidden */
  64395. 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;
  64396. /** @hidden */
  64397. 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;
  64398. /** @hidden */
  64399. 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;
  64400. /** @hidden */
  64401. 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;
  64402. }
  64403. }
  64404. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  64405. import { Nullable } from "babylonjs/types";
  64406. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64407. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64408. /**
  64409. * Implementation of the TGA Texture Loader.
  64410. * @hidden
  64411. */
  64412. export class _TGATextureLoader implements IInternalTextureLoader {
  64413. /**
  64414. * Defines wether the loader supports cascade loading the different faces.
  64415. */
  64416. readonly supportCascades: boolean;
  64417. /**
  64418. * This returns if the loader support the current file information.
  64419. * @param extension defines the file extension of the file being loaded
  64420. * @returns true if the loader can load the specified file
  64421. */
  64422. canLoad(extension: string): boolean;
  64423. /**
  64424. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64425. * @param data contains the texture data
  64426. * @param texture defines the BabylonJS internal texture
  64427. * @param createPolynomials will be true if polynomials have been requested
  64428. * @param onLoad defines the callback to trigger once the texture is ready
  64429. * @param onError defines the callback to trigger in case of error
  64430. */
  64431. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64432. /**
  64433. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64434. * @param data contains the texture data
  64435. * @param texture defines the BabylonJS internal texture
  64436. * @param callback defines the method to call once ready to upload
  64437. */
  64438. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64439. }
  64440. }
  64441. declare module "babylonjs/Misc/basis" {
  64442. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64443. /**
  64444. * Info about the .basis files
  64445. */
  64446. class BasisFileInfo {
  64447. /**
  64448. * If the file has alpha
  64449. */
  64450. hasAlpha: boolean;
  64451. /**
  64452. * Info about each image of the basis file
  64453. */
  64454. images: Array<{
  64455. levels: Array<{
  64456. width: number;
  64457. height: number;
  64458. transcodedPixels: ArrayBufferView;
  64459. }>;
  64460. }>;
  64461. }
  64462. /**
  64463. * Result of transcoding a basis file
  64464. */
  64465. class TranscodeResult {
  64466. /**
  64467. * Info about the .basis file
  64468. */
  64469. fileInfo: BasisFileInfo;
  64470. /**
  64471. * Format to use when loading the file
  64472. */
  64473. format: number;
  64474. }
  64475. /**
  64476. * Configuration options for the Basis transcoder
  64477. */
  64478. export class BasisTranscodeConfiguration {
  64479. /**
  64480. * Supported compression formats used to determine the supported output format of the transcoder
  64481. */
  64482. supportedCompressionFormats?: {
  64483. /**
  64484. * etc1 compression format
  64485. */
  64486. etc1?: boolean;
  64487. /**
  64488. * s3tc compression format
  64489. */
  64490. s3tc?: boolean;
  64491. /**
  64492. * pvrtc compression format
  64493. */
  64494. pvrtc?: boolean;
  64495. /**
  64496. * etc2 compression format
  64497. */
  64498. etc2?: boolean;
  64499. };
  64500. /**
  64501. * If mipmap levels should be loaded for transcoded images (Default: true)
  64502. */
  64503. loadMipmapLevels?: boolean;
  64504. /**
  64505. * Index of a single image to load (Default: all images)
  64506. */
  64507. loadSingleImage?: number;
  64508. }
  64509. /**
  64510. * Used to load .Basis files
  64511. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  64512. */
  64513. export class BasisTools {
  64514. private static _IgnoreSupportedFormats;
  64515. /**
  64516. * URL to use when loading the basis transcoder
  64517. */
  64518. static JSModuleURL: string;
  64519. /**
  64520. * URL to use when loading the wasm module for the transcoder
  64521. */
  64522. static WasmModuleURL: string;
  64523. /**
  64524. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  64525. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  64526. * @returns internal format corresponding to the Basis format
  64527. */
  64528. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  64529. private static _WorkerPromise;
  64530. private static _Worker;
  64531. private static _actionId;
  64532. private static _CreateWorkerAsync;
  64533. /**
  64534. * Transcodes a loaded image file to compressed pixel data
  64535. * @param data image data to transcode
  64536. * @param config configuration options for the transcoding
  64537. * @returns a promise resulting in the transcoded image
  64538. */
  64539. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  64540. /**
  64541. * Loads a texture from the transcode result
  64542. * @param texture texture load to
  64543. * @param transcodeResult the result of transcoding the basis file to load from
  64544. */
  64545. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64546. }
  64547. }
  64548. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64549. import { Nullable } from "babylonjs/types";
  64550. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64551. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64552. /**
  64553. * Loader for .basis file format
  64554. */
  64555. export class _BasisTextureLoader implements IInternalTextureLoader {
  64556. /**
  64557. * Defines whether the loader supports cascade loading the different faces.
  64558. */
  64559. readonly supportCascades: boolean;
  64560. /**
  64561. * This returns if the loader support the current file information.
  64562. * @param extension defines the file extension of the file being loaded
  64563. * @returns true if the loader can load the specified file
  64564. */
  64565. canLoad(extension: string): boolean;
  64566. /**
  64567. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64568. * @param data contains the texture data
  64569. * @param texture defines the BabylonJS internal texture
  64570. * @param createPolynomials will be true if polynomials have been requested
  64571. * @param onLoad defines the callback to trigger once the texture is ready
  64572. * @param onError defines the callback to trigger in case of error
  64573. */
  64574. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64575. /**
  64576. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64577. * @param data contains the texture data
  64578. * @param texture defines the BabylonJS internal texture
  64579. * @param callback defines the method to call once ready to upload
  64580. */
  64581. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64582. }
  64583. }
  64584. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64585. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64586. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64587. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64588. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64589. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64590. }
  64591. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64592. import { Vector2 } from "babylonjs/Maths/math.vector";
  64593. /**
  64594. * Defines the basic options interface of a TexturePacker Frame
  64595. */
  64596. export interface ITexturePackerFrame {
  64597. /**
  64598. * The frame ID
  64599. */
  64600. id: number;
  64601. /**
  64602. * The frames Scale
  64603. */
  64604. scale: Vector2;
  64605. /**
  64606. * The Frames offset
  64607. */
  64608. offset: Vector2;
  64609. }
  64610. /**
  64611. * This is a support class for frame Data on texture packer sets.
  64612. */
  64613. export class TexturePackerFrame implements ITexturePackerFrame {
  64614. /**
  64615. * The frame ID
  64616. */
  64617. id: number;
  64618. /**
  64619. * The frames Scale
  64620. */
  64621. scale: Vector2;
  64622. /**
  64623. * The Frames offset
  64624. */
  64625. offset: Vector2;
  64626. /**
  64627. * Initializes a texture package frame.
  64628. * @param id The numerical frame identifier
  64629. * @param scale Scalar Vector2 for UV frame
  64630. * @param offset Vector2 for the frame position in UV units.
  64631. * @returns TexturePackerFrame
  64632. */
  64633. constructor(id: number, scale: Vector2, offset: Vector2);
  64634. }
  64635. }
  64636. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64637. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64638. import { Scene } from "babylonjs/scene";
  64639. import { Nullable } from "babylonjs/types";
  64640. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64641. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64642. /**
  64643. * Defines the basic options interface of a TexturePacker
  64644. */
  64645. export interface ITexturePackerOptions {
  64646. /**
  64647. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64648. */
  64649. map?: string[];
  64650. /**
  64651. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64652. */
  64653. uvsIn?: string;
  64654. /**
  64655. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64656. */
  64657. uvsOut?: string;
  64658. /**
  64659. * number representing the layout style. Defaults to LAYOUT_STRIP
  64660. */
  64661. layout?: number;
  64662. /**
  64663. * number of columns if using custom column count layout(2). This defaults to 4.
  64664. */
  64665. colnum?: number;
  64666. /**
  64667. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  64668. */
  64669. updateInputMeshes?: boolean;
  64670. /**
  64671. * boolean flag to dispose all the source textures. Defaults to true.
  64672. */
  64673. disposeSources?: boolean;
  64674. /**
  64675. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  64676. */
  64677. fillBlanks?: boolean;
  64678. /**
  64679. * string value representing the context fill style color. Defaults to 'black'.
  64680. */
  64681. customFillColor?: string;
  64682. /**
  64683. * Width and Height Value of each Frame in the TexturePacker Sets
  64684. */
  64685. frameSize?: number;
  64686. /**
  64687. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  64688. */
  64689. paddingRatio?: number;
  64690. /**
  64691. * Number that declares the fill method for the padding gutter.
  64692. */
  64693. paddingMode?: number;
  64694. /**
  64695. * If in SUBUV_COLOR padding mode what color to use.
  64696. */
  64697. paddingColor?: Color3 | Color4;
  64698. }
  64699. /**
  64700. * Defines the basic interface of a TexturePacker JSON File
  64701. */
  64702. export interface ITexturePackerJSON {
  64703. /**
  64704. * The frame ID
  64705. */
  64706. name: string;
  64707. /**
  64708. * The base64 channel data
  64709. */
  64710. sets: any;
  64711. /**
  64712. * The options of the Packer
  64713. */
  64714. options: ITexturePackerOptions;
  64715. /**
  64716. * The frame data of the Packer
  64717. */
  64718. frames: Array<number>;
  64719. }
  64720. /**
  64721. * This is a support class that generates a series of packed texture sets.
  64722. * @see https://doc.babylonjs.com/babylon101/materials
  64723. */
  64724. export class TexturePacker {
  64725. /** Packer Layout Constant 0 */
  64726. static readonly LAYOUT_STRIP: number;
  64727. /** Packer Layout Constant 1 */
  64728. static readonly LAYOUT_POWER2: number;
  64729. /** Packer Layout Constant 2 */
  64730. static readonly LAYOUT_COLNUM: number;
  64731. /** Packer Layout Constant 0 */
  64732. static readonly SUBUV_WRAP: number;
  64733. /** Packer Layout Constant 1 */
  64734. static readonly SUBUV_EXTEND: number;
  64735. /** Packer Layout Constant 2 */
  64736. static readonly SUBUV_COLOR: number;
  64737. /** The Name of the Texture Package */
  64738. name: string;
  64739. /** The scene scope of the TexturePacker */
  64740. scene: Scene;
  64741. /** The Meshes to target */
  64742. meshes: AbstractMesh[];
  64743. /** Arguments passed with the Constructor */
  64744. options: ITexturePackerOptions;
  64745. /** The promise that is started upon initialization */
  64746. promise: Nullable<Promise<TexturePacker | string>>;
  64747. /** The Container object for the channel sets that are generated */
  64748. sets: object;
  64749. /** The Container array for the frames that are generated */
  64750. frames: TexturePackerFrame[];
  64751. /** The expected number of textures the system is parsing. */
  64752. private _expecting;
  64753. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  64754. private _paddingValue;
  64755. /**
  64756. * Initializes a texture package series from an array of meshes or a single mesh.
  64757. * @param name The name of the package
  64758. * @param meshes The target meshes to compose the package from
  64759. * @param options The arguments that texture packer should follow while building.
  64760. * @param scene The scene which the textures are scoped to.
  64761. * @returns TexturePacker
  64762. */
  64763. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  64764. /**
  64765. * Starts the package process
  64766. * @param resolve The promises resolution function
  64767. * @returns TexturePacker
  64768. */
  64769. private _createFrames;
  64770. /**
  64771. * Calculates the Size of the Channel Sets
  64772. * @returns Vector2
  64773. */
  64774. private _calculateSize;
  64775. /**
  64776. * Calculates the UV data for the frames.
  64777. * @param baseSize the base frameSize
  64778. * @param padding the base frame padding
  64779. * @param dtSize size of the Dynamic Texture for that channel
  64780. * @param dtUnits is 1/dtSize
  64781. * @param update flag to update the input meshes
  64782. */
  64783. private _calculateMeshUVFrames;
  64784. /**
  64785. * Calculates the frames Offset.
  64786. * @param index of the frame
  64787. * @returns Vector2
  64788. */
  64789. private _getFrameOffset;
  64790. /**
  64791. * Updates a Mesh to the frame data
  64792. * @param mesh that is the target
  64793. * @param frameID or the frame index
  64794. */
  64795. private _updateMeshUV;
  64796. /**
  64797. * Updates a Meshes materials to use the texture packer channels
  64798. * @param m is the mesh to target
  64799. * @param force all channels on the packer to be set.
  64800. */
  64801. private _updateTextureReferences;
  64802. /**
  64803. * Public method to set a Mesh to a frame
  64804. * @param m that is the target
  64805. * @param frameID or the frame index
  64806. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  64807. */
  64808. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  64809. /**
  64810. * Starts the async promise to compile the texture packer.
  64811. * @returns Promise<void>
  64812. */
  64813. processAsync(): Promise<void>;
  64814. /**
  64815. * Disposes all textures associated with this packer
  64816. */
  64817. dispose(): void;
  64818. /**
  64819. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  64820. * @param imageType is the image type to use.
  64821. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  64822. */
  64823. download(imageType?: string, quality?: number): void;
  64824. /**
  64825. * Public method to load a texturePacker JSON file.
  64826. * @param data of the JSON file in string format.
  64827. */
  64828. updateFromJSON(data: string): void;
  64829. }
  64830. }
  64831. declare module "babylonjs/Materials/Textures/Packer/index" {
  64832. export * from "babylonjs/Materials/Textures/Packer/packer";
  64833. export * from "babylonjs/Materials/Textures/Packer/frame";
  64834. }
  64835. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  64836. import { Scene } from "babylonjs/scene";
  64837. import { Texture } from "babylonjs/Materials/Textures/texture";
  64838. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64839. /**
  64840. * 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.
  64841. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64842. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64843. */
  64844. export class CustomProceduralTexture extends ProceduralTexture {
  64845. private _animate;
  64846. private _time;
  64847. private _config;
  64848. private _texturePath;
  64849. /**
  64850. * Instantiates a new Custom Procedural Texture.
  64851. * 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.
  64852. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64853. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64854. * @param name Define the name of the texture
  64855. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  64856. * @param size Define the size of the texture to create
  64857. * @param scene Define the scene the texture belongs to
  64858. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  64859. * @param generateMipMaps Define if the texture should creates mip maps or not
  64860. */
  64861. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64862. private _loadJson;
  64863. /**
  64864. * Is the texture ready to be used ? (rendered at least once)
  64865. * @returns true if ready, otherwise, false.
  64866. */
  64867. isReady(): boolean;
  64868. /**
  64869. * Render the texture to its associated render target.
  64870. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  64871. */
  64872. render(useCameraPostProcess?: boolean): void;
  64873. /**
  64874. * Update the list of dependant textures samplers in the shader.
  64875. */
  64876. updateTextures(): void;
  64877. /**
  64878. * Update the uniform values of the procedural texture in the shader.
  64879. */
  64880. updateShaderUniforms(): void;
  64881. /**
  64882. * Define if the texture animates or not.
  64883. */
  64884. get animate(): boolean;
  64885. set animate(value: boolean);
  64886. }
  64887. }
  64888. declare module "babylonjs/Shaders/noise.fragment" {
  64889. /** @hidden */
  64890. export var noisePixelShader: {
  64891. name: string;
  64892. shader: string;
  64893. };
  64894. }
  64895. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  64896. import { Nullable } from "babylonjs/types";
  64897. import { Scene } from "babylonjs/scene";
  64898. import { Texture } from "babylonjs/Materials/Textures/texture";
  64899. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64900. import "babylonjs/Shaders/noise.fragment";
  64901. /**
  64902. * Class used to generate noise procedural textures
  64903. */
  64904. export class NoiseProceduralTexture extends ProceduralTexture {
  64905. /** Gets or sets the start time (default is 0) */
  64906. time: number;
  64907. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  64908. brightness: number;
  64909. /** Defines the number of octaves to process */
  64910. octaves: number;
  64911. /** Defines the level of persistence (0.8 by default) */
  64912. persistence: number;
  64913. /** Gets or sets animation speed factor (default is 1) */
  64914. animationSpeedFactor: number;
  64915. /**
  64916. * Creates a new NoiseProceduralTexture
  64917. * @param name defines the name fo the texture
  64918. * @param size defines the size of the texture (default is 256)
  64919. * @param scene defines the hosting scene
  64920. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  64921. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  64922. */
  64923. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64924. private _updateShaderUniforms;
  64925. protected _getDefines(): string;
  64926. /** Generate the current state of the procedural texture */
  64927. render(useCameraPostProcess?: boolean): void;
  64928. /**
  64929. * Serializes this noise procedural texture
  64930. * @returns a serialized noise procedural texture object
  64931. */
  64932. serialize(): any;
  64933. /**
  64934. * Clone the texture.
  64935. * @returns the cloned texture
  64936. */
  64937. clone(): NoiseProceduralTexture;
  64938. /**
  64939. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  64940. * @param parsedTexture defines parsed texture data
  64941. * @param scene defines the current scene
  64942. * @param rootUrl defines the root URL containing noise procedural texture information
  64943. * @returns a parsed NoiseProceduralTexture
  64944. */
  64945. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  64946. }
  64947. }
  64948. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  64949. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  64950. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  64951. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64952. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  64953. }
  64954. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  64955. import { Nullable } from "babylonjs/types";
  64956. import { Scene } from "babylonjs/scene";
  64957. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  64958. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64959. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  64960. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64961. /**
  64962. * Raw cube texture where the raw buffers are passed in
  64963. */
  64964. export class RawCubeTexture extends CubeTexture {
  64965. /**
  64966. * Creates a cube texture where the raw buffers are passed in.
  64967. * @param scene defines the scene the texture is attached to
  64968. * @param data defines the array of data to use to create each face
  64969. * @param size defines the size of the textures
  64970. * @param format defines the format of the data
  64971. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  64972. * @param generateMipMaps defines if the engine should generate the mip levels
  64973. * @param invertY defines if data must be stored with Y axis inverted
  64974. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  64975. * @param compression defines the compression used (null by default)
  64976. */
  64977. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  64978. /**
  64979. * Updates the raw cube texture.
  64980. * @param data defines the data to store
  64981. * @param format defines the data format
  64982. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  64983. * @param invertY defines if data must be stored with Y axis inverted
  64984. * @param compression defines the compression used (null by default)
  64985. * @param level defines which level of the texture to update
  64986. */
  64987. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  64988. /**
  64989. * Updates a raw cube texture with RGBD encoded data.
  64990. * @param data defines the array of data [mipmap][face] to use to create each face
  64991. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  64992. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  64993. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  64994. * @returns a promsie that resolves when the operation is complete
  64995. */
  64996. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  64997. /**
  64998. * Clones the raw cube texture.
  64999. * @return a new cube texture
  65000. */
  65001. clone(): CubeTexture;
  65002. /** @hidden */
  65003. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  65004. }
  65005. }
  65006. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  65007. import { Scene } from "babylonjs/scene";
  65008. import { Texture } from "babylonjs/Materials/Textures/texture";
  65009. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65010. /**
  65011. * Class used to store 2D array textures containing user data
  65012. */
  65013. export class RawTexture2DArray extends Texture {
  65014. /** Gets or sets the texture format to use */
  65015. format: number;
  65016. /**
  65017. * Create a new RawTexture2DArray
  65018. * @param data defines the data of the texture
  65019. * @param width defines the width of the texture
  65020. * @param height defines the height of the texture
  65021. * @param depth defines the number of layers of the texture
  65022. * @param format defines the texture format to use
  65023. * @param scene defines the hosting scene
  65024. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65025. * @param invertY defines if texture must be stored with Y axis inverted
  65026. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65027. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65028. */
  65029. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65030. /** Gets or sets the texture format to use */
  65031. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65032. /**
  65033. * Update the texture with new data
  65034. * @param data defines the data to store in the texture
  65035. */
  65036. update(data: ArrayBufferView): void;
  65037. }
  65038. }
  65039. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  65040. import { Scene } from "babylonjs/scene";
  65041. import { Texture } from "babylonjs/Materials/Textures/texture";
  65042. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65043. /**
  65044. * Class used to store 3D textures containing user data
  65045. */
  65046. export class RawTexture3D extends Texture {
  65047. /** Gets or sets the texture format to use */
  65048. format: number;
  65049. /**
  65050. * Create a new RawTexture3D
  65051. * @param data defines the data of the texture
  65052. * @param width defines the width of the texture
  65053. * @param height defines the height of the texture
  65054. * @param depth defines the depth of the texture
  65055. * @param format defines the texture format to use
  65056. * @param scene defines the hosting scene
  65057. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65058. * @param invertY defines if texture must be stored with Y axis inverted
  65059. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65060. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65061. */
  65062. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65063. /** Gets or sets the texture format to use */
  65064. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65065. /**
  65066. * Update the texture with new data
  65067. * @param data defines the data to store in the texture
  65068. */
  65069. update(data: ArrayBufferView): void;
  65070. }
  65071. }
  65072. declare module "babylonjs/Materials/Textures/refractionTexture" {
  65073. import { Scene } from "babylonjs/scene";
  65074. import { Plane } from "babylonjs/Maths/math.plane";
  65075. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65076. /**
  65077. * Creates a refraction texture used by refraction channel of the standard material.
  65078. * It is like a mirror but to see through a material.
  65079. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65080. */
  65081. export class RefractionTexture extends RenderTargetTexture {
  65082. /**
  65083. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  65084. * 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.
  65085. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65086. */
  65087. refractionPlane: Plane;
  65088. /**
  65089. * Define how deep under the surface we should see.
  65090. */
  65091. depth: number;
  65092. /**
  65093. * Creates a refraction texture used by refraction channel of the standard material.
  65094. * It is like a mirror but to see through a material.
  65095. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65096. * @param name Define the texture name
  65097. * @param size Define the size of the underlying texture
  65098. * @param scene Define the scene the refraction belongs to
  65099. * @param generateMipMaps Define if we need to generate mips level for the refraction
  65100. */
  65101. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  65102. /**
  65103. * Clone the refraction texture.
  65104. * @returns the cloned texture
  65105. */
  65106. clone(): RefractionTexture;
  65107. /**
  65108. * Serialize the texture to a JSON representation you could use in Parse later on
  65109. * @returns the serialized JSON representation
  65110. */
  65111. serialize(): any;
  65112. }
  65113. }
  65114. declare module "babylonjs/Materials/Textures/index" {
  65115. export * from "babylonjs/Materials/Textures/baseTexture";
  65116. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  65117. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  65118. export * from "babylonjs/Materials/Textures/cubeTexture";
  65119. export * from "babylonjs/Materials/Textures/dynamicTexture";
  65120. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65121. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  65122. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  65123. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  65124. export * from "babylonjs/Materials/Textures/internalTexture";
  65125. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  65126. export * from "babylonjs/Materials/Textures/Loaders/index";
  65127. export * from "babylonjs/Materials/Textures/mirrorTexture";
  65128. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  65129. export * from "babylonjs/Materials/Textures/Packer/index";
  65130. export * from "babylonjs/Materials/Textures/Procedurals/index";
  65131. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  65132. export * from "babylonjs/Materials/Textures/rawTexture";
  65133. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  65134. export * from "babylonjs/Materials/Textures/rawTexture3D";
  65135. export * from "babylonjs/Materials/Textures/refractionTexture";
  65136. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  65137. export * from "babylonjs/Materials/Textures/texture";
  65138. export * from "babylonjs/Materials/Textures/videoTexture";
  65139. }
  65140. declare module "babylonjs/Materials/Node/Enums/index" {
  65141. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  65142. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  65143. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  65144. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  65145. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  65146. }
  65147. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  65148. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65149. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65150. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65151. import { Mesh } from "babylonjs/Meshes/mesh";
  65152. import { Effect } from "babylonjs/Materials/effect";
  65153. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65154. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65155. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65156. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65157. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  65158. /**
  65159. * Block used to add support for vertex skinning (bones)
  65160. */
  65161. export class BonesBlock extends NodeMaterialBlock {
  65162. /**
  65163. * Creates a new BonesBlock
  65164. * @param name defines the block name
  65165. */
  65166. constructor(name: string);
  65167. /**
  65168. * Initialize the block and prepare the context for build
  65169. * @param state defines the state that will be used for the build
  65170. */
  65171. initialize(state: NodeMaterialBuildState): void;
  65172. /**
  65173. * Gets the current class name
  65174. * @returns the class name
  65175. */
  65176. getClassName(): string;
  65177. /**
  65178. * Gets the matrix indices input component
  65179. */
  65180. get matricesIndices(): NodeMaterialConnectionPoint;
  65181. /**
  65182. * Gets the matrix weights input component
  65183. */
  65184. get matricesWeights(): NodeMaterialConnectionPoint;
  65185. /**
  65186. * Gets the extra matrix indices input component
  65187. */
  65188. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  65189. /**
  65190. * Gets the extra matrix weights input component
  65191. */
  65192. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  65193. /**
  65194. * Gets the world input component
  65195. */
  65196. get world(): NodeMaterialConnectionPoint;
  65197. /**
  65198. * Gets the output component
  65199. */
  65200. get output(): NodeMaterialConnectionPoint;
  65201. autoConfigure(material: NodeMaterial): void;
  65202. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  65203. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65204. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65205. protected _buildBlock(state: NodeMaterialBuildState): this;
  65206. }
  65207. }
  65208. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  65209. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65210. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65211. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65212. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65213. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65214. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65215. /**
  65216. * Block used to add support for instances
  65217. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  65218. */
  65219. export class InstancesBlock extends NodeMaterialBlock {
  65220. /**
  65221. * Creates a new InstancesBlock
  65222. * @param name defines the block name
  65223. */
  65224. constructor(name: string);
  65225. /**
  65226. * Gets the current class name
  65227. * @returns the class name
  65228. */
  65229. getClassName(): string;
  65230. /**
  65231. * Gets the first world row input component
  65232. */
  65233. get world0(): NodeMaterialConnectionPoint;
  65234. /**
  65235. * Gets the second world row input component
  65236. */
  65237. get world1(): NodeMaterialConnectionPoint;
  65238. /**
  65239. * Gets the third world row input component
  65240. */
  65241. get world2(): NodeMaterialConnectionPoint;
  65242. /**
  65243. * Gets the forth world row input component
  65244. */
  65245. get world3(): NodeMaterialConnectionPoint;
  65246. /**
  65247. * Gets the world input component
  65248. */
  65249. get world(): NodeMaterialConnectionPoint;
  65250. /**
  65251. * Gets the output component
  65252. */
  65253. get output(): NodeMaterialConnectionPoint;
  65254. /**
  65255. * Gets the isntanceID component
  65256. */
  65257. get instanceID(): NodeMaterialConnectionPoint;
  65258. autoConfigure(material: NodeMaterial): void;
  65259. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  65260. protected _buildBlock(state: NodeMaterialBuildState): this;
  65261. }
  65262. }
  65263. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  65264. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65265. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65266. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65267. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65268. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65269. import { Effect } from "babylonjs/Materials/effect";
  65270. import { Mesh } from "babylonjs/Meshes/mesh";
  65271. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65272. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65273. /**
  65274. * Block used to add morph targets support to vertex shader
  65275. */
  65276. export class MorphTargetsBlock extends NodeMaterialBlock {
  65277. private _repeatableContentAnchor;
  65278. /**
  65279. * Create a new MorphTargetsBlock
  65280. * @param name defines the block name
  65281. */
  65282. constructor(name: string);
  65283. /**
  65284. * Gets the current class name
  65285. * @returns the class name
  65286. */
  65287. getClassName(): string;
  65288. /**
  65289. * Gets the position input component
  65290. */
  65291. get position(): NodeMaterialConnectionPoint;
  65292. /**
  65293. * Gets the normal input component
  65294. */
  65295. get normal(): NodeMaterialConnectionPoint;
  65296. /**
  65297. * Gets the tangent input component
  65298. */
  65299. get tangent(): NodeMaterialConnectionPoint;
  65300. /**
  65301. * Gets the tangent input component
  65302. */
  65303. get uv(): NodeMaterialConnectionPoint;
  65304. /**
  65305. * Gets the position output component
  65306. */
  65307. get positionOutput(): NodeMaterialConnectionPoint;
  65308. /**
  65309. * Gets the normal output component
  65310. */
  65311. get normalOutput(): NodeMaterialConnectionPoint;
  65312. /**
  65313. * Gets the tangent output component
  65314. */
  65315. get tangentOutput(): NodeMaterialConnectionPoint;
  65316. /**
  65317. * Gets the tangent output component
  65318. */
  65319. get uvOutput(): NodeMaterialConnectionPoint;
  65320. initialize(state: NodeMaterialBuildState): void;
  65321. autoConfigure(material: NodeMaterial): void;
  65322. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65323. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65324. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  65325. protected _buildBlock(state: NodeMaterialBuildState): this;
  65326. }
  65327. }
  65328. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  65329. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65330. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65331. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65332. import { Nullable } from "babylonjs/types";
  65333. import { Scene } from "babylonjs/scene";
  65334. import { Effect } from "babylonjs/Materials/effect";
  65335. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65336. import { Mesh } from "babylonjs/Meshes/mesh";
  65337. import { Light } from "babylonjs/Lights/light";
  65338. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65339. /**
  65340. * Block used to get data information from a light
  65341. */
  65342. export class LightInformationBlock extends NodeMaterialBlock {
  65343. private _lightDataUniformName;
  65344. private _lightColorUniformName;
  65345. private _lightTypeDefineName;
  65346. /**
  65347. * Gets or sets the light associated with this block
  65348. */
  65349. light: Nullable<Light>;
  65350. /**
  65351. * Creates a new LightInformationBlock
  65352. * @param name defines the block name
  65353. */
  65354. constructor(name: string);
  65355. /**
  65356. * Gets the current class name
  65357. * @returns the class name
  65358. */
  65359. getClassName(): string;
  65360. /**
  65361. * Gets the world position input component
  65362. */
  65363. get worldPosition(): NodeMaterialConnectionPoint;
  65364. /**
  65365. * Gets the direction output component
  65366. */
  65367. get direction(): NodeMaterialConnectionPoint;
  65368. /**
  65369. * Gets the direction output component
  65370. */
  65371. get color(): NodeMaterialConnectionPoint;
  65372. /**
  65373. * Gets the direction output component
  65374. */
  65375. get intensity(): NodeMaterialConnectionPoint;
  65376. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65377. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65378. protected _buildBlock(state: NodeMaterialBuildState): this;
  65379. serialize(): any;
  65380. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65381. }
  65382. }
  65383. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  65384. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  65385. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  65386. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  65387. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  65388. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  65389. }
  65390. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  65391. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65392. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65393. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65394. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65395. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65396. import { Effect } from "babylonjs/Materials/effect";
  65397. import { Mesh } from "babylonjs/Meshes/mesh";
  65398. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65399. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  65400. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  65401. /**
  65402. * Block used to add image processing support to fragment shader
  65403. */
  65404. export class ImageProcessingBlock extends NodeMaterialBlock {
  65405. /**
  65406. * Create a new ImageProcessingBlock
  65407. * @param name defines the block name
  65408. */
  65409. constructor(name: string);
  65410. /**
  65411. * Gets the current class name
  65412. * @returns the class name
  65413. */
  65414. getClassName(): string;
  65415. /**
  65416. * Gets the color input component
  65417. */
  65418. get color(): NodeMaterialConnectionPoint;
  65419. /**
  65420. * Gets the output component
  65421. */
  65422. get output(): NodeMaterialConnectionPoint;
  65423. /**
  65424. * Initialize the block and prepare the context for build
  65425. * @param state defines the state that will be used for the build
  65426. */
  65427. initialize(state: NodeMaterialBuildState): void;
  65428. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65429. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65430. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65431. protected _buildBlock(state: NodeMaterialBuildState): this;
  65432. }
  65433. }
  65434. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65435. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65436. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65437. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65438. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65439. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65440. import { Effect } from "babylonjs/Materials/effect";
  65441. import { Mesh } from "babylonjs/Meshes/mesh";
  65442. import { Scene } from "babylonjs/scene";
  65443. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65444. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65445. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65446. /**
  65447. * Block used to pertub normals based on a normal map
  65448. */
  65449. export class PerturbNormalBlock extends NodeMaterialBlock {
  65450. private _tangentSpaceParameterName;
  65451. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65452. invertX: boolean;
  65453. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65454. invertY: boolean;
  65455. /**
  65456. * Create a new PerturbNormalBlock
  65457. * @param name defines the block name
  65458. */
  65459. constructor(name: string);
  65460. /**
  65461. * Gets the current class name
  65462. * @returns the class name
  65463. */
  65464. getClassName(): string;
  65465. /**
  65466. * Gets the world position input component
  65467. */
  65468. get worldPosition(): NodeMaterialConnectionPoint;
  65469. /**
  65470. * Gets the world normal input component
  65471. */
  65472. get worldNormal(): NodeMaterialConnectionPoint;
  65473. /**
  65474. * Gets the world tangent input component
  65475. */
  65476. get worldTangent(): NodeMaterialConnectionPoint;
  65477. /**
  65478. * Gets the uv input component
  65479. */
  65480. get uv(): NodeMaterialConnectionPoint;
  65481. /**
  65482. * Gets the normal map color input component
  65483. */
  65484. get normalMapColor(): NodeMaterialConnectionPoint;
  65485. /**
  65486. * Gets the strength input component
  65487. */
  65488. get strength(): NodeMaterialConnectionPoint;
  65489. /**
  65490. * Gets the output component
  65491. */
  65492. get output(): NodeMaterialConnectionPoint;
  65493. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65494. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65495. autoConfigure(material: NodeMaterial): void;
  65496. protected _buildBlock(state: NodeMaterialBuildState): this;
  65497. protected _dumpPropertiesCode(): string;
  65498. serialize(): any;
  65499. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65500. }
  65501. }
  65502. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65503. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65504. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65505. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65506. /**
  65507. * Block used to discard a pixel if a value is smaller than a cutoff
  65508. */
  65509. export class DiscardBlock extends NodeMaterialBlock {
  65510. /**
  65511. * Create a new DiscardBlock
  65512. * @param name defines the block name
  65513. */
  65514. constructor(name: string);
  65515. /**
  65516. * Gets the current class name
  65517. * @returns the class name
  65518. */
  65519. getClassName(): string;
  65520. /**
  65521. * Gets the color input component
  65522. */
  65523. get value(): NodeMaterialConnectionPoint;
  65524. /**
  65525. * Gets the cutoff input component
  65526. */
  65527. get cutoff(): NodeMaterialConnectionPoint;
  65528. protected _buildBlock(state: NodeMaterialBuildState): this;
  65529. }
  65530. }
  65531. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65532. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65533. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65534. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65535. /**
  65536. * Block used to test if the fragment shader is front facing
  65537. */
  65538. export class FrontFacingBlock extends NodeMaterialBlock {
  65539. /**
  65540. * Creates a new FrontFacingBlock
  65541. * @param name defines the block name
  65542. */
  65543. constructor(name: string);
  65544. /**
  65545. * Gets the current class name
  65546. * @returns the class name
  65547. */
  65548. getClassName(): string;
  65549. /**
  65550. * Gets the output component
  65551. */
  65552. get output(): NodeMaterialConnectionPoint;
  65553. protected _buildBlock(state: NodeMaterialBuildState): this;
  65554. }
  65555. }
  65556. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65557. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65558. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65559. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65560. /**
  65561. * Block used to get the derivative value on x and y of a given input
  65562. */
  65563. export class DerivativeBlock extends NodeMaterialBlock {
  65564. /**
  65565. * Create a new DerivativeBlock
  65566. * @param name defines the block name
  65567. */
  65568. constructor(name: string);
  65569. /**
  65570. * Gets the current class name
  65571. * @returns the class name
  65572. */
  65573. getClassName(): string;
  65574. /**
  65575. * Gets the input component
  65576. */
  65577. get input(): NodeMaterialConnectionPoint;
  65578. /**
  65579. * Gets the derivative output on x
  65580. */
  65581. get dx(): NodeMaterialConnectionPoint;
  65582. /**
  65583. * Gets the derivative output on y
  65584. */
  65585. get dy(): NodeMaterialConnectionPoint;
  65586. protected _buildBlock(state: NodeMaterialBuildState): this;
  65587. }
  65588. }
  65589. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  65590. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65591. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65592. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65593. /**
  65594. * Block used to make gl_FragCoord available
  65595. */
  65596. export class FragCoordBlock extends NodeMaterialBlock {
  65597. /**
  65598. * Creates a new FragCoordBlock
  65599. * @param name defines the block name
  65600. */
  65601. constructor(name: string);
  65602. /**
  65603. * Gets the current class name
  65604. * @returns the class name
  65605. */
  65606. getClassName(): string;
  65607. /**
  65608. * Gets the xy component
  65609. */
  65610. get xy(): NodeMaterialConnectionPoint;
  65611. /**
  65612. * Gets the xyz component
  65613. */
  65614. get xyz(): NodeMaterialConnectionPoint;
  65615. /**
  65616. * Gets the xyzw component
  65617. */
  65618. get xyzw(): NodeMaterialConnectionPoint;
  65619. /**
  65620. * Gets the x component
  65621. */
  65622. get x(): NodeMaterialConnectionPoint;
  65623. /**
  65624. * Gets the y component
  65625. */
  65626. get y(): NodeMaterialConnectionPoint;
  65627. /**
  65628. * Gets the z component
  65629. */
  65630. get z(): NodeMaterialConnectionPoint;
  65631. /**
  65632. * Gets the w component
  65633. */
  65634. get output(): NodeMaterialConnectionPoint;
  65635. protected writeOutputs(state: NodeMaterialBuildState): string;
  65636. protected _buildBlock(state: NodeMaterialBuildState): this;
  65637. }
  65638. }
  65639. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65640. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65641. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65642. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65643. import { Effect } from "babylonjs/Materials/effect";
  65644. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65645. import { Mesh } from "babylonjs/Meshes/mesh";
  65646. /**
  65647. * Block used to get the screen sizes
  65648. */
  65649. export class ScreenSizeBlock extends NodeMaterialBlock {
  65650. private _varName;
  65651. private _scene;
  65652. /**
  65653. * Creates a new ScreenSizeBlock
  65654. * @param name defines the block name
  65655. */
  65656. constructor(name: string);
  65657. /**
  65658. * Gets the current class name
  65659. * @returns the class name
  65660. */
  65661. getClassName(): string;
  65662. /**
  65663. * Gets the xy component
  65664. */
  65665. get xy(): NodeMaterialConnectionPoint;
  65666. /**
  65667. * Gets the x component
  65668. */
  65669. get x(): NodeMaterialConnectionPoint;
  65670. /**
  65671. * Gets the y component
  65672. */
  65673. get y(): NodeMaterialConnectionPoint;
  65674. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65675. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  65676. protected _buildBlock(state: NodeMaterialBuildState): this;
  65677. }
  65678. }
  65679. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  65680. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  65681. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  65682. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  65683. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  65684. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  65685. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  65686. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  65687. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  65688. }
  65689. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  65690. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65691. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65692. import { Mesh } from "babylonjs/Meshes/mesh";
  65693. import { Effect } from "babylonjs/Materials/effect";
  65694. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65695. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65696. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65697. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  65698. /**
  65699. * Block used to add support for scene fog
  65700. */
  65701. export class FogBlock extends NodeMaterialBlock {
  65702. private _fogDistanceName;
  65703. private _fogParameters;
  65704. /**
  65705. * Create a new FogBlock
  65706. * @param name defines the block name
  65707. */
  65708. constructor(name: string);
  65709. /**
  65710. * Gets the current class name
  65711. * @returns the class name
  65712. */
  65713. getClassName(): string;
  65714. /**
  65715. * Gets the world position input component
  65716. */
  65717. get worldPosition(): NodeMaterialConnectionPoint;
  65718. /**
  65719. * Gets the view input component
  65720. */
  65721. get view(): NodeMaterialConnectionPoint;
  65722. /**
  65723. * Gets the color input component
  65724. */
  65725. get input(): NodeMaterialConnectionPoint;
  65726. /**
  65727. * Gets the fog color input component
  65728. */
  65729. get fogColor(): NodeMaterialConnectionPoint;
  65730. /**
  65731. * Gets the output component
  65732. */
  65733. get output(): NodeMaterialConnectionPoint;
  65734. autoConfigure(material: NodeMaterial): void;
  65735. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65736. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65737. protected _buildBlock(state: NodeMaterialBuildState): this;
  65738. }
  65739. }
  65740. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  65741. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65742. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65743. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65744. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65745. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65746. import { Effect } from "babylonjs/Materials/effect";
  65747. import { Mesh } from "babylonjs/Meshes/mesh";
  65748. import { Light } from "babylonjs/Lights/light";
  65749. import { Nullable } from "babylonjs/types";
  65750. import { Scene } from "babylonjs/scene";
  65751. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  65752. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  65753. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  65754. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65755. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  65756. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  65757. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  65758. /**
  65759. * Block used to add light in the fragment shader
  65760. */
  65761. export class LightBlock extends NodeMaterialBlock {
  65762. private _lightId;
  65763. /**
  65764. * Gets or sets the light associated with this block
  65765. */
  65766. light: Nullable<Light>;
  65767. /**
  65768. * Create a new LightBlock
  65769. * @param name defines the block name
  65770. */
  65771. constructor(name: string);
  65772. /**
  65773. * Gets the current class name
  65774. * @returns the class name
  65775. */
  65776. getClassName(): string;
  65777. /**
  65778. * Gets the world position input component
  65779. */
  65780. get worldPosition(): NodeMaterialConnectionPoint;
  65781. /**
  65782. * Gets the world normal input component
  65783. */
  65784. get worldNormal(): NodeMaterialConnectionPoint;
  65785. /**
  65786. * Gets the camera (or eye) position component
  65787. */
  65788. get cameraPosition(): NodeMaterialConnectionPoint;
  65789. /**
  65790. * Gets the glossiness component
  65791. */
  65792. get glossiness(): NodeMaterialConnectionPoint;
  65793. /**
  65794. * Gets the glossinness power component
  65795. */
  65796. get glossPower(): NodeMaterialConnectionPoint;
  65797. /**
  65798. * Gets the diffuse color component
  65799. */
  65800. get diffuseColor(): NodeMaterialConnectionPoint;
  65801. /**
  65802. * Gets the specular color component
  65803. */
  65804. get specularColor(): NodeMaterialConnectionPoint;
  65805. /**
  65806. * Gets the diffuse output component
  65807. */
  65808. get diffuseOutput(): NodeMaterialConnectionPoint;
  65809. /**
  65810. * Gets the specular output component
  65811. */
  65812. get specularOutput(): NodeMaterialConnectionPoint;
  65813. /**
  65814. * Gets the shadow output component
  65815. */
  65816. get shadow(): NodeMaterialConnectionPoint;
  65817. autoConfigure(material: NodeMaterial): void;
  65818. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65819. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  65820. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65821. private _injectVertexCode;
  65822. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65823. serialize(): any;
  65824. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65825. }
  65826. }
  65827. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  65828. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65829. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65830. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65831. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  65832. /**
  65833. * Block used to read a reflection texture from a sampler
  65834. */
  65835. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  65836. /**
  65837. * Create a new ReflectionTextureBlock
  65838. * @param name defines the block name
  65839. */
  65840. constructor(name: string);
  65841. /**
  65842. * Gets the current class name
  65843. * @returns the class name
  65844. */
  65845. getClassName(): string;
  65846. /**
  65847. * Gets the world position input component
  65848. */
  65849. get position(): NodeMaterialConnectionPoint;
  65850. /**
  65851. * Gets the world position input component
  65852. */
  65853. get worldPosition(): NodeMaterialConnectionPoint;
  65854. /**
  65855. * Gets the world normal input component
  65856. */
  65857. get worldNormal(): NodeMaterialConnectionPoint;
  65858. /**
  65859. * Gets the world input component
  65860. */
  65861. get world(): NodeMaterialConnectionPoint;
  65862. /**
  65863. * Gets the camera (or eye) position component
  65864. */
  65865. get cameraPosition(): NodeMaterialConnectionPoint;
  65866. /**
  65867. * Gets the view input component
  65868. */
  65869. get view(): NodeMaterialConnectionPoint;
  65870. /**
  65871. * Gets the rgb output component
  65872. */
  65873. get rgb(): NodeMaterialConnectionPoint;
  65874. /**
  65875. * Gets the rgba output component
  65876. */
  65877. get rgba(): NodeMaterialConnectionPoint;
  65878. /**
  65879. * Gets the r output component
  65880. */
  65881. get r(): NodeMaterialConnectionPoint;
  65882. /**
  65883. * Gets the g output component
  65884. */
  65885. get g(): NodeMaterialConnectionPoint;
  65886. /**
  65887. * Gets the b output component
  65888. */
  65889. get b(): NodeMaterialConnectionPoint;
  65890. /**
  65891. * Gets the a output component
  65892. */
  65893. get a(): NodeMaterialConnectionPoint;
  65894. autoConfigure(material: NodeMaterial): void;
  65895. protected _buildBlock(state: NodeMaterialBuildState): this;
  65896. }
  65897. }
  65898. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  65899. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  65900. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  65901. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  65902. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  65903. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  65904. }
  65905. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  65906. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  65907. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  65908. }
  65909. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  65910. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65911. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65912. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65913. /**
  65914. * Block used to add 2 vectors
  65915. */
  65916. export class AddBlock extends NodeMaterialBlock {
  65917. /**
  65918. * Creates a new AddBlock
  65919. * @param name defines the block name
  65920. */
  65921. constructor(name: string);
  65922. /**
  65923. * Gets the current class name
  65924. * @returns the class name
  65925. */
  65926. getClassName(): string;
  65927. /**
  65928. * Gets the left operand input component
  65929. */
  65930. get left(): NodeMaterialConnectionPoint;
  65931. /**
  65932. * Gets the right operand input component
  65933. */
  65934. get right(): NodeMaterialConnectionPoint;
  65935. /**
  65936. * Gets the output component
  65937. */
  65938. get output(): NodeMaterialConnectionPoint;
  65939. protected _buildBlock(state: NodeMaterialBuildState): this;
  65940. }
  65941. }
  65942. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  65943. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65944. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65945. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65946. /**
  65947. * Block used to scale a vector by a float
  65948. */
  65949. export class ScaleBlock extends NodeMaterialBlock {
  65950. /**
  65951. * Creates a new ScaleBlock
  65952. * @param name defines the block name
  65953. */
  65954. constructor(name: string);
  65955. /**
  65956. * Gets the current class name
  65957. * @returns the class name
  65958. */
  65959. getClassName(): string;
  65960. /**
  65961. * Gets the input component
  65962. */
  65963. get input(): NodeMaterialConnectionPoint;
  65964. /**
  65965. * Gets the factor input component
  65966. */
  65967. get factor(): NodeMaterialConnectionPoint;
  65968. /**
  65969. * Gets the output component
  65970. */
  65971. get output(): NodeMaterialConnectionPoint;
  65972. protected _buildBlock(state: NodeMaterialBuildState): this;
  65973. }
  65974. }
  65975. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  65976. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65977. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65978. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65979. import { Scene } from "babylonjs/scene";
  65980. /**
  65981. * Block used to clamp a float
  65982. */
  65983. export class ClampBlock extends NodeMaterialBlock {
  65984. /** Gets or sets the minimum range */
  65985. minimum: number;
  65986. /** Gets or sets the maximum range */
  65987. maximum: number;
  65988. /**
  65989. * Creates a new ClampBlock
  65990. * @param name defines the block name
  65991. */
  65992. constructor(name: string);
  65993. /**
  65994. * Gets the current class name
  65995. * @returns the class name
  65996. */
  65997. getClassName(): string;
  65998. /**
  65999. * Gets the value input component
  66000. */
  66001. get value(): NodeMaterialConnectionPoint;
  66002. /**
  66003. * Gets the output component
  66004. */
  66005. get output(): NodeMaterialConnectionPoint;
  66006. protected _buildBlock(state: NodeMaterialBuildState): this;
  66007. protected _dumpPropertiesCode(): string;
  66008. serialize(): any;
  66009. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66010. }
  66011. }
  66012. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  66013. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66014. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66015. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66016. /**
  66017. * Block used to apply a cross product between 2 vectors
  66018. */
  66019. export class CrossBlock extends NodeMaterialBlock {
  66020. /**
  66021. * Creates a new CrossBlock
  66022. * @param name defines the block name
  66023. */
  66024. constructor(name: string);
  66025. /**
  66026. * Gets the current class name
  66027. * @returns the class name
  66028. */
  66029. getClassName(): string;
  66030. /**
  66031. * Gets the left operand input component
  66032. */
  66033. get left(): NodeMaterialConnectionPoint;
  66034. /**
  66035. * Gets the right operand input component
  66036. */
  66037. get right(): NodeMaterialConnectionPoint;
  66038. /**
  66039. * Gets the output component
  66040. */
  66041. get output(): NodeMaterialConnectionPoint;
  66042. protected _buildBlock(state: NodeMaterialBuildState): this;
  66043. }
  66044. }
  66045. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  66046. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66047. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66048. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66049. /**
  66050. * Block used to apply a dot product between 2 vectors
  66051. */
  66052. export class DotBlock extends NodeMaterialBlock {
  66053. /**
  66054. * Creates a new DotBlock
  66055. * @param name defines the block name
  66056. */
  66057. constructor(name: string);
  66058. /**
  66059. * Gets the current class name
  66060. * @returns the class name
  66061. */
  66062. getClassName(): string;
  66063. /**
  66064. * Gets the left operand input component
  66065. */
  66066. get left(): NodeMaterialConnectionPoint;
  66067. /**
  66068. * Gets the right operand input component
  66069. */
  66070. get right(): NodeMaterialConnectionPoint;
  66071. /**
  66072. * Gets the output component
  66073. */
  66074. get output(): NodeMaterialConnectionPoint;
  66075. protected _buildBlock(state: NodeMaterialBuildState): this;
  66076. }
  66077. }
  66078. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  66079. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66080. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66081. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66082. /**
  66083. * Block used to normalize a vector
  66084. */
  66085. export class NormalizeBlock extends NodeMaterialBlock {
  66086. /**
  66087. * Creates a new NormalizeBlock
  66088. * @param name defines the block name
  66089. */
  66090. constructor(name: string);
  66091. /**
  66092. * Gets the current class name
  66093. * @returns the class name
  66094. */
  66095. getClassName(): string;
  66096. /**
  66097. * Gets the input component
  66098. */
  66099. get input(): NodeMaterialConnectionPoint;
  66100. /**
  66101. * Gets the output component
  66102. */
  66103. get output(): NodeMaterialConnectionPoint;
  66104. protected _buildBlock(state: NodeMaterialBuildState): this;
  66105. }
  66106. }
  66107. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  66108. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66109. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66110. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66111. import { Scene } from "babylonjs/scene";
  66112. /**
  66113. * Operations supported by the Trigonometry block
  66114. */
  66115. export enum TrigonometryBlockOperations {
  66116. /** Cos */
  66117. Cos = 0,
  66118. /** Sin */
  66119. Sin = 1,
  66120. /** Abs */
  66121. Abs = 2,
  66122. /** Exp */
  66123. Exp = 3,
  66124. /** Exp2 */
  66125. Exp2 = 4,
  66126. /** Round */
  66127. Round = 5,
  66128. /** Floor */
  66129. Floor = 6,
  66130. /** Ceiling */
  66131. Ceiling = 7,
  66132. /** Square root */
  66133. Sqrt = 8,
  66134. /** Log */
  66135. Log = 9,
  66136. /** Tangent */
  66137. Tan = 10,
  66138. /** Arc tangent */
  66139. ArcTan = 11,
  66140. /** Arc cosinus */
  66141. ArcCos = 12,
  66142. /** Arc sinus */
  66143. ArcSin = 13,
  66144. /** Fraction */
  66145. Fract = 14,
  66146. /** Sign */
  66147. Sign = 15,
  66148. /** To radians (from degrees) */
  66149. Radians = 16,
  66150. /** To degrees (from radians) */
  66151. Degrees = 17
  66152. }
  66153. /**
  66154. * Block used to apply trigonometry operation to floats
  66155. */
  66156. export class TrigonometryBlock extends NodeMaterialBlock {
  66157. /**
  66158. * Gets or sets the operation applied by the block
  66159. */
  66160. operation: TrigonometryBlockOperations;
  66161. /**
  66162. * Creates a new TrigonometryBlock
  66163. * @param name defines the block name
  66164. */
  66165. constructor(name: string);
  66166. /**
  66167. * Gets the current class name
  66168. * @returns the class name
  66169. */
  66170. getClassName(): string;
  66171. /**
  66172. * Gets the input component
  66173. */
  66174. get input(): NodeMaterialConnectionPoint;
  66175. /**
  66176. * Gets the output component
  66177. */
  66178. get output(): NodeMaterialConnectionPoint;
  66179. protected _buildBlock(state: NodeMaterialBuildState): this;
  66180. serialize(): any;
  66181. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66182. protected _dumpPropertiesCode(): string;
  66183. }
  66184. }
  66185. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  66186. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66187. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66188. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66189. /**
  66190. * Block used to create a Color3/4 out of individual inputs (one for each component)
  66191. */
  66192. export class ColorMergerBlock extends NodeMaterialBlock {
  66193. /**
  66194. * Create a new ColorMergerBlock
  66195. * @param name defines the block name
  66196. */
  66197. constructor(name: string);
  66198. /**
  66199. * Gets the current class name
  66200. * @returns the class name
  66201. */
  66202. getClassName(): string;
  66203. /**
  66204. * Gets the rgb component (input)
  66205. */
  66206. get rgbIn(): NodeMaterialConnectionPoint;
  66207. /**
  66208. * Gets the r component (input)
  66209. */
  66210. get r(): NodeMaterialConnectionPoint;
  66211. /**
  66212. * Gets the g component (input)
  66213. */
  66214. get g(): NodeMaterialConnectionPoint;
  66215. /**
  66216. * Gets the b component (input)
  66217. */
  66218. get b(): NodeMaterialConnectionPoint;
  66219. /**
  66220. * Gets the a component (input)
  66221. */
  66222. get a(): NodeMaterialConnectionPoint;
  66223. /**
  66224. * Gets the rgba component (output)
  66225. */
  66226. get rgba(): NodeMaterialConnectionPoint;
  66227. /**
  66228. * Gets the rgb component (output)
  66229. */
  66230. get rgbOut(): NodeMaterialConnectionPoint;
  66231. /**
  66232. * Gets the rgb component (output)
  66233. * @deprecated Please use rgbOut instead.
  66234. */
  66235. get rgb(): NodeMaterialConnectionPoint;
  66236. protected _buildBlock(state: NodeMaterialBuildState): this;
  66237. }
  66238. }
  66239. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  66240. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66241. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66242. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66243. /**
  66244. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  66245. */
  66246. export class VectorSplitterBlock extends NodeMaterialBlock {
  66247. /**
  66248. * Create a new VectorSplitterBlock
  66249. * @param name defines the block name
  66250. */
  66251. constructor(name: string);
  66252. /**
  66253. * Gets the current class name
  66254. * @returns the class name
  66255. */
  66256. getClassName(): string;
  66257. /**
  66258. * Gets the xyzw component (input)
  66259. */
  66260. get xyzw(): NodeMaterialConnectionPoint;
  66261. /**
  66262. * Gets the xyz component (input)
  66263. */
  66264. get xyzIn(): NodeMaterialConnectionPoint;
  66265. /**
  66266. * Gets the xy component (input)
  66267. */
  66268. get xyIn(): NodeMaterialConnectionPoint;
  66269. /**
  66270. * Gets the xyz component (output)
  66271. */
  66272. get xyzOut(): NodeMaterialConnectionPoint;
  66273. /**
  66274. * Gets the xy component (output)
  66275. */
  66276. get xyOut(): NodeMaterialConnectionPoint;
  66277. /**
  66278. * Gets the x component (output)
  66279. */
  66280. get x(): NodeMaterialConnectionPoint;
  66281. /**
  66282. * Gets the y component (output)
  66283. */
  66284. get y(): NodeMaterialConnectionPoint;
  66285. /**
  66286. * Gets the z component (output)
  66287. */
  66288. get z(): NodeMaterialConnectionPoint;
  66289. /**
  66290. * Gets the w component (output)
  66291. */
  66292. get w(): NodeMaterialConnectionPoint;
  66293. protected _inputRename(name: string): string;
  66294. protected _outputRename(name: string): string;
  66295. protected _buildBlock(state: NodeMaterialBuildState): this;
  66296. }
  66297. }
  66298. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  66299. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66300. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66301. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66302. /**
  66303. * Block used to lerp between 2 values
  66304. */
  66305. export class LerpBlock extends NodeMaterialBlock {
  66306. /**
  66307. * Creates a new LerpBlock
  66308. * @param name defines the block name
  66309. */
  66310. constructor(name: string);
  66311. /**
  66312. * Gets the current class name
  66313. * @returns the class name
  66314. */
  66315. getClassName(): string;
  66316. /**
  66317. * Gets the left operand input component
  66318. */
  66319. get left(): NodeMaterialConnectionPoint;
  66320. /**
  66321. * Gets the right operand input component
  66322. */
  66323. get right(): NodeMaterialConnectionPoint;
  66324. /**
  66325. * Gets the gradient operand input component
  66326. */
  66327. get gradient(): NodeMaterialConnectionPoint;
  66328. /**
  66329. * Gets the output component
  66330. */
  66331. get output(): NodeMaterialConnectionPoint;
  66332. protected _buildBlock(state: NodeMaterialBuildState): this;
  66333. }
  66334. }
  66335. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  66336. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66337. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66338. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66339. /**
  66340. * Block used to divide 2 vectors
  66341. */
  66342. export class DivideBlock extends NodeMaterialBlock {
  66343. /**
  66344. * Creates a new DivideBlock
  66345. * @param name defines the block name
  66346. */
  66347. constructor(name: string);
  66348. /**
  66349. * Gets the current class name
  66350. * @returns the class name
  66351. */
  66352. getClassName(): string;
  66353. /**
  66354. * Gets the left operand input component
  66355. */
  66356. get left(): NodeMaterialConnectionPoint;
  66357. /**
  66358. * Gets the right operand input component
  66359. */
  66360. get right(): NodeMaterialConnectionPoint;
  66361. /**
  66362. * Gets the output component
  66363. */
  66364. get output(): NodeMaterialConnectionPoint;
  66365. protected _buildBlock(state: NodeMaterialBuildState): this;
  66366. }
  66367. }
  66368. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  66369. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66370. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66371. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66372. /**
  66373. * Block used to subtract 2 vectors
  66374. */
  66375. export class SubtractBlock extends NodeMaterialBlock {
  66376. /**
  66377. * Creates a new SubtractBlock
  66378. * @param name defines the block name
  66379. */
  66380. constructor(name: string);
  66381. /**
  66382. * Gets the current class name
  66383. * @returns the class name
  66384. */
  66385. getClassName(): string;
  66386. /**
  66387. * Gets the left operand input component
  66388. */
  66389. get left(): NodeMaterialConnectionPoint;
  66390. /**
  66391. * Gets the right operand input component
  66392. */
  66393. get right(): NodeMaterialConnectionPoint;
  66394. /**
  66395. * Gets the output component
  66396. */
  66397. get output(): NodeMaterialConnectionPoint;
  66398. protected _buildBlock(state: NodeMaterialBuildState): this;
  66399. }
  66400. }
  66401. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  66402. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66403. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66404. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66405. /**
  66406. * Block used to step a value
  66407. */
  66408. export class StepBlock extends NodeMaterialBlock {
  66409. /**
  66410. * Creates a new StepBlock
  66411. * @param name defines the block name
  66412. */
  66413. constructor(name: string);
  66414. /**
  66415. * Gets the current class name
  66416. * @returns the class name
  66417. */
  66418. getClassName(): string;
  66419. /**
  66420. * Gets the value operand input component
  66421. */
  66422. get value(): NodeMaterialConnectionPoint;
  66423. /**
  66424. * Gets the edge operand input component
  66425. */
  66426. get edge(): NodeMaterialConnectionPoint;
  66427. /**
  66428. * Gets the output component
  66429. */
  66430. get output(): NodeMaterialConnectionPoint;
  66431. protected _buildBlock(state: NodeMaterialBuildState): this;
  66432. }
  66433. }
  66434. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66435. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66436. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66437. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66438. /**
  66439. * Block used to get the opposite (1 - x) of a value
  66440. */
  66441. export class OneMinusBlock extends NodeMaterialBlock {
  66442. /**
  66443. * Creates a new OneMinusBlock
  66444. * @param name defines the block name
  66445. */
  66446. constructor(name: string);
  66447. /**
  66448. * Gets the current class name
  66449. * @returns the class name
  66450. */
  66451. getClassName(): string;
  66452. /**
  66453. * Gets the input component
  66454. */
  66455. get input(): NodeMaterialConnectionPoint;
  66456. /**
  66457. * Gets the output component
  66458. */
  66459. get output(): NodeMaterialConnectionPoint;
  66460. protected _buildBlock(state: NodeMaterialBuildState): this;
  66461. }
  66462. }
  66463. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  66464. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66465. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66466. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66467. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66468. /**
  66469. * Block used to get the view direction
  66470. */
  66471. export class ViewDirectionBlock extends NodeMaterialBlock {
  66472. /**
  66473. * Creates a new ViewDirectionBlock
  66474. * @param name defines the block name
  66475. */
  66476. constructor(name: string);
  66477. /**
  66478. * Gets the current class name
  66479. * @returns the class name
  66480. */
  66481. getClassName(): string;
  66482. /**
  66483. * Gets the world position component
  66484. */
  66485. get worldPosition(): NodeMaterialConnectionPoint;
  66486. /**
  66487. * Gets the camera position component
  66488. */
  66489. get cameraPosition(): NodeMaterialConnectionPoint;
  66490. /**
  66491. * Gets the output component
  66492. */
  66493. get output(): NodeMaterialConnectionPoint;
  66494. autoConfigure(material: NodeMaterial): void;
  66495. protected _buildBlock(state: NodeMaterialBuildState): this;
  66496. }
  66497. }
  66498. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66499. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66500. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66501. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66502. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66503. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66504. /**
  66505. * Block used to compute fresnel value
  66506. */
  66507. export class FresnelBlock extends NodeMaterialBlock {
  66508. /**
  66509. * Create a new FresnelBlock
  66510. * @param name defines the block name
  66511. */
  66512. constructor(name: string);
  66513. /**
  66514. * Gets the current class name
  66515. * @returns the class name
  66516. */
  66517. getClassName(): string;
  66518. /**
  66519. * Gets the world normal input component
  66520. */
  66521. get worldNormal(): NodeMaterialConnectionPoint;
  66522. /**
  66523. * Gets the view direction input component
  66524. */
  66525. get viewDirection(): NodeMaterialConnectionPoint;
  66526. /**
  66527. * Gets the bias input component
  66528. */
  66529. get bias(): NodeMaterialConnectionPoint;
  66530. /**
  66531. * Gets the camera (or eye) position component
  66532. */
  66533. get power(): NodeMaterialConnectionPoint;
  66534. /**
  66535. * Gets the fresnel output component
  66536. */
  66537. get fresnel(): NodeMaterialConnectionPoint;
  66538. autoConfigure(material: NodeMaterial): void;
  66539. protected _buildBlock(state: NodeMaterialBuildState): this;
  66540. }
  66541. }
  66542. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66543. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66544. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66545. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66546. /**
  66547. * Block used to get the max of 2 values
  66548. */
  66549. export class MaxBlock extends NodeMaterialBlock {
  66550. /**
  66551. * Creates a new MaxBlock
  66552. * @param name defines the block name
  66553. */
  66554. constructor(name: string);
  66555. /**
  66556. * Gets the current class name
  66557. * @returns the class name
  66558. */
  66559. getClassName(): string;
  66560. /**
  66561. * Gets the left operand input component
  66562. */
  66563. get left(): NodeMaterialConnectionPoint;
  66564. /**
  66565. * Gets the right operand input component
  66566. */
  66567. get right(): NodeMaterialConnectionPoint;
  66568. /**
  66569. * Gets the output component
  66570. */
  66571. get output(): NodeMaterialConnectionPoint;
  66572. protected _buildBlock(state: NodeMaterialBuildState): this;
  66573. }
  66574. }
  66575. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66576. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66577. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66578. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66579. /**
  66580. * Block used to get the min of 2 values
  66581. */
  66582. export class MinBlock extends NodeMaterialBlock {
  66583. /**
  66584. * Creates a new MinBlock
  66585. * @param name defines the block name
  66586. */
  66587. constructor(name: string);
  66588. /**
  66589. * Gets the current class name
  66590. * @returns the class name
  66591. */
  66592. getClassName(): string;
  66593. /**
  66594. * Gets the left operand input component
  66595. */
  66596. get left(): NodeMaterialConnectionPoint;
  66597. /**
  66598. * Gets the right operand input component
  66599. */
  66600. get right(): NodeMaterialConnectionPoint;
  66601. /**
  66602. * Gets the output component
  66603. */
  66604. get output(): NodeMaterialConnectionPoint;
  66605. protected _buildBlock(state: NodeMaterialBuildState): this;
  66606. }
  66607. }
  66608. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66609. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66610. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66611. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66612. /**
  66613. * Block used to get the distance between 2 values
  66614. */
  66615. export class DistanceBlock extends NodeMaterialBlock {
  66616. /**
  66617. * Creates a new DistanceBlock
  66618. * @param name defines the block name
  66619. */
  66620. constructor(name: string);
  66621. /**
  66622. * Gets the current class name
  66623. * @returns the class name
  66624. */
  66625. getClassName(): string;
  66626. /**
  66627. * Gets the left operand input component
  66628. */
  66629. get left(): NodeMaterialConnectionPoint;
  66630. /**
  66631. * Gets the right operand input component
  66632. */
  66633. get right(): NodeMaterialConnectionPoint;
  66634. /**
  66635. * Gets the output component
  66636. */
  66637. get output(): NodeMaterialConnectionPoint;
  66638. protected _buildBlock(state: NodeMaterialBuildState): this;
  66639. }
  66640. }
  66641. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66642. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66643. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66644. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66645. /**
  66646. * Block used to get the length of a vector
  66647. */
  66648. export class LengthBlock extends NodeMaterialBlock {
  66649. /**
  66650. * Creates a new LengthBlock
  66651. * @param name defines the block name
  66652. */
  66653. constructor(name: string);
  66654. /**
  66655. * Gets the current class name
  66656. * @returns the class name
  66657. */
  66658. getClassName(): string;
  66659. /**
  66660. * Gets the value input component
  66661. */
  66662. get value(): NodeMaterialConnectionPoint;
  66663. /**
  66664. * Gets the output component
  66665. */
  66666. get output(): NodeMaterialConnectionPoint;
  66667. protected _buildBlock(state: NodeMaterialBuildState): this;
  66668. }
  66669. }
  66670. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66671. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66672. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66673. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66674. /**
  66675. * Block used to get negative version of a value (i.e. x * -1)
  66676. */
  66677. export class NegateBlock extends NodeMaterialBlock {
  66678. /**
  66679. * Creates a new NegateBlock
  66680. * @param name defines the block name
  66681. */
  66682. constructor(name: string);
  66683. /**
  66684. * Gets the current class name
  66685. * @returns the class name
  66686. */
  66687. getClassName(): string;
  66688. /**
  66689. * Gets the value input component
  66690. */
  66691. get value(): NodeMaterialConnectionPoint;
  66692. /**
  66693. * Gets the output component
  66694. */
  66695. get output(): NodeMaterialConnectionPoint;
  66696. protected _buildBlock(state: NodeMaterialBuildState): this;
  66697. }
  66698. }
  66699. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66700. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66701. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66702. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66703. /**
  66704. * Block used to get the value of the first parameter raised to the power of the second
  66705. */
  66706. export class PowBlock extends NodeMaterialBlock {
  66707. /**
  66708. * Creates a new PowBlock
  66709. * @param name defines the block name
  66710. */
  66711. constructor(name: string);
  66712. /**
  66713. * Gets the current class name
  66714. * @returns the class name
  66715. */
  66716. getClassName(): string;
  66717. /**
  66718. * Gets the value operand input component
  66719. */
  66720. get value(): NodeMaterialConnectionPoint;
  66721. /**
  66722. * Gets the power operand input component
  66723. */
  66724. get power(): NodeMaterialConnectionPoint;
  66725. /**
  66726. * Gets the output component
  66727. */
  66728. get output(): NodeMaterialConnectionPoint;
  66729. protected _buildBlock(state: NodeMaterialBuildState): this;
  66730. }
  66731. }
  66732. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66733. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66734. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66735. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66736. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66737. /**
  66738. * Block used to get a random number
  66739. */
  66740. export class RandomNumberBlock extends NodeMaterialBlock {
  66741. /**
  66742. * Creates a new RandomNumberBlock
  66743. * @param name defines the block name
  66744. */
  66745. constructor(name: string);
  66746. /**
  66747. * Gets the current class name
  66748. * @returns the class name
  66749. */
  66750. getClassName(): string;
  66751. /**
  66752. * Gets the seed input component
  66753. */
  66754. get seed(): NodeMaterialConnectionPoint;
  66755. /**
  66756. * Gets the output component
  66757. */
  66758. get output(): NodeMaterialConnectionPoint;
  66759. protected _buildBlock(state: NodeMaterialBuildState): this;
  66760. }
  66761. }
  66762. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  66763. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66764. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66765. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66766. /**
  66767. * Block used to compute arc tangent of 2 values
  66768. */
  66769. export class ArcTan2Block extends NodeMaterialBlock {
  66770. /**
  66771. * Creates a new ArcTan2Block
  66772. * @param name defines the block name
  66773. */
  66774. constructor(name: string);
  66775. /**
  66776. * Gets the current class name
  66777. * @returns the class name
  66778. */
  66779. getClassName(): string;
  66780. /**
  66781. * Gets the x operand input component
  66782. */
  66783. get x(): NodeMaterialConnectionPoint;
  66784. /**
  66785. * Gets the y operand input component
  66786. */
  66787. get y(): NodeMaterialConnectionPoint;
  66788. /**
  66789. * Gets the output component
  66790. */
  66791. get output(): NodeMaterialConnectionPoint;
  66792. protected _buildBlock(state: NodeMaterialBuildState): this;
  66793. }
  66794. }
  66795. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  66796. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66797. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66798. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66799. /**
  66800. * Block used to smooth step a value
  66801. */
  66802. export class SmoothStepBlock extends NodeMaterialBlock {
  66803. /**
  66804. * Creates a new SmoothStepBlock
  66805. * @param name defines the block name
  66806. */
  66807. constructor(name: string);
  66808. /**
  66809. * Gets the current class name
  66810. * @returns the class name
  66811. */
  66812. getClassName(): string;
  66813. /**
  66814. * Gets the value operand input component
  66815. */
  66816. get value(): NodeMaterialConnectionPoint;
  66817. /**
  66818. * Gets the first edge operand input component
  66819. */
  66820. get edge0(): NodeMaterialConnectionPoint;
  66821. /**
  66822. * Gets the second edge operand input component
  66823. */
  66824. get edge1(): NodeMaterialConnectionPoint;
  66825. /**
  66826. * Gets the output component
  66827. */
  66828. get output(): NodeMaterialConnectionPoint;
  66829. protected _buildBlock(state: NodeMaterialBuildState): this;
  66830. }
  66831. }
  66832. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  66833. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66834. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66835. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66836. /**
  66837. * Block used to get the reciprocal (1 / x) of a value
  66838. */
  66839. export class ReciprocalBlock extends NodeMaterialBlock {
  66840. /**
  66841. * Creates a new ReciprocalBlock
  66842. * @param name defines the block name
  66843. */
  66844. constructor(name: string);
  66845. /**
  66846. * Gets the current class name
  66847. * @returns the class name
  66848. */
  66849. getClassName(): string;
  66850. /**
  66851. * Gets the input component
  66852. */
  66853. get input(): NodeMaterialConnectionPoint;
  66854. /**
  66855. * Gets the output component
  66856. */
  66857. get output(): NodeMaterialConnectionPoint;
  66858. protected _buildBlock(state: NodeMaterialBuildState): this;
  66859. }
  66860. }
  66861. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  66862. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66863. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66864. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66865. /**
  66866. * Block used to replace a color by another one
  66867. */
  66868. export class ReplaceColorBlock extends NodeMaterialBlock {
  66869. /**
  66870. * Creates a new ReplaceColorBlock
  66871. * @param name defines the block name
  66872. */
  66873. constructor(name: string);
  66874. /**
  66875. * Gets the current class name
  66876. * @returns the class name
  66877. */
  66878. getClassName(): string;
  66879. /**
  66880. * Gets the value input component
  66881. */
  66882. get value(): NodeMaterialConnectionPoint;
  66883. /**
  66884. * Gets the reference input component
  66885. */
  66886. get reference(): NodeMaterialConnectionPoint;
  66887. /**
  66888. * Gets the distance input component
  66889. */
  66890. get distance(): NodeMaterialConnectionPoint;
  66891. /**
  66892. * Gets the replacement input component
  66893. */
  66894. get replacement(): NodeMaterialConnectionPoint;
  66895. /**
  66896. * Gets the output component
  66897. */
  66898. get output(): NodeMaterialConnectionPoint;
  66899. protected _buildBlock(state: NodeMaterialBuildState): this;
  66900. }
  66901. }
  66902. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  66903. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66904. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66905. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66906. /**
  66907. * Block used to posterize a value
  66908. * @see https://en.wikipedia.org/wiki/Posterization
  66909. */
  66910. export class PosterizeBlock extends NodeMaterialBlock {
  66911. /**
  66912. * Creates a new PosterizeBlock
  66913. * @param name defines the block name
  66914. */
  66915. constructor(name: string);
  66916. /**
  66917. * Gets the current class name
  66918. * @returns the class name
  66919. */
  66920. getClassName(): string;
  66921. /**
  66922. * Gets the value input component
  66923. */
  66924. get value(): NodeMaterialConnectionPoint;
  66925. /**
  66926. * Gets the steps input component
  66927. */
  66928. get steps(): NodeMaterialConnectionPoint;
  66929. /**
  66930. * Gets the output component
  66931. */
  66932. get output(): NodeMaterialConnectionPoint;
  66933. protected _buildBlock(state: NodeMaterialBuildState): this;
  66934. }
  66935. }
  66936. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  66937. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66938. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66939. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66940. import { Scene } from "babylonjs/scene";
  66941. /**
  66942. * Operations supported by the Wave block
  66943. */
  66944. export enum WaveBlockKind {
  66945. /** SawTooth */
  66946. SawTooth = 0,
  66947. /** Square */
  66948. Square = 1,
  66949. /** Triangle */
  66950. Triangle = 2
  66951. }
  66952. /**
  66953. * Block used to apply wave operation to floats
  66954. */
  66955. export class WaveBlock extends NodeMaterialBlock {
  66956. /**
  66957. * Gets or sets the kibnd of wave to be applied by the block
  66958. */
  66959. kind: WaveBlockKind;
  66960. /**
  66961. * Creates a new WaveBlock
  66962. * @param name defines the block name
  66963. */
  66964. constructor(name: string);
  66965. /**
  66966. * Gets the current class name
  66967. * @returns the class name
  66968. */
  66969. getClassName(): string;
  66970. /**
  66971. * Gets the input component
  66972. */
  66973. get input(): NodeMaterialConnectionPoint;
  66974. /**
  66975. * Gets the output component
  66976. */
  66977. get output(): NodeMaterialConnectionPoint;
  66978. protected _buildBlock(state: NodeMaterialBuildState): this;
  66979. serialize(): any;
  66980. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66981. }
  66982. }
  66983. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  66984. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66985. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66986. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66987. import { Color3 } from "babylonjs/Maths/math.color";
  66988. import { Scene } from "babylonjs/scene";
  66989. /**
  66990. * Class used to store a color step for the GradientBlock
  66991. */
  66992. export class GradientBlockColorStep {
  66993. /**
  66994. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66995. */
  66996. step: number;
  66997. /**
  66998. * Gets or sets the color associated with this step
  66999. */
  67000. color: Color3;
  67001. /**
  67002. * Creates a new GradientBlockColorStep
  67003. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  67004. * @param color defines the color associated with this step
  67005. */
  67006. constructor(
  67007. /**
  67008. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  67009. */
  67010. step: number,
  67011. /**
  67012. * Gets or sets the color associated with this step
  67013. */
  67014. color: Color3);
  67015. }
  67016. /**
  67017. * Block used to return a color from a gradient based on an input value between 0 and 1
  67018. */
  67019. export class GradientBlock extends NodeMaterialBlock {
  67020. /**
  67021. * Gets or sets the list of color steps
  67022. */
  67023. colorSteps: GradientBlockColorStep[];
  67024. /**
  67025. * Creates a new GradientBlock
  67026. * @param name defines the block name
  67027. */
  67028. constructor(name: string);
  67029. /**
  67030. * Gets the current class name
  67031. * @returns the class name
  67032. */
  67033. getClassName(): string;
  67034. /**
  67035. * Gets the gradient input component
  67036. */
  67037. get gradient(): NodeMaterialConnectionPoint;
  67038. /**
  67039. * Gets the output component
  67040. */
  67041. get output(): NodeMaterialConnectionPoint;
  67042. private _writeColorConstant;
  67043. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67044. serialize(): any;
  67045. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67046. protected _dumpPropertiesCode(): string;
  67047. }
  67048. }
  67049. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  67050. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67051. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67052. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67053. /**
  67054. * Block used to normalize lerp between 2 values
  67055. */
  67056. export class NLerpBlock extends NodeMaterialBlock {
  67057. /**
  67058. * Creates a new NLerpBlock
  67059. * @param name defines the block name
  67060. */
  67061. constructor(name: string);
  67062. /**
  67063. * Gets the current class name
  67064. * @returns the class name
  67065. */
  67066. getClassName(): string;
  67067. /**
  67068. * Gets the left operand input component
  67069. */
  67070. get left(): NodeMaterialConnectionPoint;
  67071. /**
  67072. * Gets the right operand input component
  67073. */
  67074. get right(): NodeMaterialConnectionPoint;
  67075. /**
  67076. * Gets the gradient operand input component
  67077. */
  67078. get gradient(): NodeMaterialConnectionPoint;
  67079. /**
  67080. * Gets the output component
  67081. */
  67082. get output(): NodeMaterialConnectionPoint;
  67083. protected _buildBlock(state: NodeMaterialBuildState): this;
  67084. }
  67085. }
  67086. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  67087. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67088. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67089. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67090. import { Scene } from "babylonjs/scene";
  67091. /**
  67092. * block used to Generate a Worley Noise 3D Noise Pattern
  67093. */
  67094. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67095. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67096. manhattanDistance: boolean;
  67097. /**
  67098. * Creates a new WorleyNoise3DBlock
  67099. * @param name defines the block name
  67100. */
  67101. constructor(name: string);
  67102. /**
  67103. * Gets the current class name
  67104. * @returns the class name
  67105. */
  67106. getClassName(): string;
  67107. /**
  67108. * Gets the seed input component
  67109. */
  67110. get seed(): NodeMaterialConnectionPoint;
  67111. /**
  67112. * Gets the jitter input component
  67113. */
  67114. get jitter(): NodeMaterialConnectionPoint;
  67115. /**
  67116. * Gets the output component
  67117. */
  67118. get output(): NodeMaterialConnectionPoint;
  67119. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67120. /**
  67121. * Exposes the properties to the UI?
  67122. */
  67123. protected _dumpPropertiesCode(): string;
  67124. /**
  67125. * Exposes the properties to the Seralize?
  67126. */
  67127. serialize(): any;
  67128. /**
  67129. * Exposes the properties to the deseralize?
  67130. */
  67131. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67132. }
  67133. }
  67134. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  67135. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67136. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67137. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67138. /**
  67139. * block used to Generate a Simplex Perlin 3d Noise Pattern
  67140. */
  67141. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  67142. /**
  67143. * Creates a new SimplexPerlin3DBlock
  67144. * @param name defines the block name
  67145. */
  67146. constructor(name: string);
  67147. /**
  67148. * Gets the current class name
  67149. * @returns the class name
  67150. */
  67151. getClassName(): string;
  67152. /**
  67153. * Gets the seed operand input component
  67154. */
  67155. get seed(): NodeMaterialConnectionPoint;
  67156. /**
  67157. * Gets the output component
  67158. */
  67159. get output(): NodeMaterialConnectionPoint;
  67160. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67161. }
  67162. }
  67163. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  67164. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67165. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67166. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67167. /**
  67168. * Block used to blend normals
  67169. */
  67170. export class NormalBlendBlock extends NodeMaterialBlock {
  67171. /**
  67172. * Creates a new NormalBlendBlock
  67173. * @param name defines the block name
  67174. */
  67175. constructor(name: string);
  67176. /**
  67177. * Gets the current class name
  67178. * @returns the class name
  67179. */
  67180. getClassName(): string;
  67181. /**
  67182. * Gets the first input component
  67183. */
  67184. get normalMap0(): NodeMaterialConnectionPoint;
  67185. /**
  67186. * Gets the second input component
  67187. */
  67188. get normalMap1(): NodeMaterialConnectionPoint;
  67189. /**
  67190. * Gets the output component
  67191. */
  67192. get output(): NodeMaterialConnectionPoint;
  67193. protected _buildBlock(state: NodeMaterialBuildState): this;
  67194. }
  67195. }
  67196. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  67197. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67198. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67199. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67200. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67201. /**
  67202. * Block used to rotate a 2d vector by a given angle
  67203. */
  67204. export class Rotate2dBlock extends NodeMaterialBlock {
  67205. /**
  67206. * Creates a new Rotate2dBlock
  67207. * @param name defines the block name
  67208. */
  67209. constructor(name: string);
  67210. /**
  67211. * Gets the current class name
  67212. * @returns the class name
  67213. */
  67214. getClassName(): string;
  67215. /**
  67216. * Gets the input vector
  67217. */
  67218. get input(): NodeMaterialConnectionPoint;
  67219. /**
  67220. * Gets the input angle
  67221. */
  67222. get angle(): NodeMaterialConnectionPoint;
  67223. /**
  67224. * Gets the output component
  67225. */
  67226. get output(): NodeMaterialConnectionPoint;
  67227. autoConfigure(material: NodeMaterial): void;
  67228. protected _buildBlock(state: NodeMaterialBuildState): this;
  67229. }
  67230. }
  67231. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  67232. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67233. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67234. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67235. /**
  67236. * Block used to get the reflected vector from a direction and a normal
  67237. */
  67238. export class ReflectBlock extends NodeMaterialBlock {
  67239. /**
  67240. * Creates a new ReflectBlock
  67241. * @param name defines the block name
  67242. */
  67243. constructor(name: string);
  67244. /**
  67245. * Gets the current class name
  67246. * @returns the class name
  67247. */
  67248. getClassName(): string;
  67249. /**
  67250. * Gets the incident component
  67251. */
  67252. get incident(): NodeMaterialConnectionPoint;
  67253. /**
  67254. * Gets the normal component
  67255. */
  67256. get normal(): NodeMaterialConnectionPoint;
  67257. /**
  67258. * Gets the output component
  67259. */
  67260. get output(): NodeMaterialConnectionPoint;
  67261. protected _buildBlock(state: NodeMaterialBuildState): this;
  67262. }
  67263. }
  67264. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  67265. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67266. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67267. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67268. /**
  67269. * Block used to get the refracted vector from a direction and a normal
  67270. */
  67271. export class RefractBlock extends NodeMaterialBlock {
  67272. /**
  67273. * Creates a new RefractBlock
  67274. * @param name defines the block name
  67275. */
  67276. constructor(name: string);
  67277. /**
  67278. * Gets the current class name
  67279. * @returns the class name
  67280. */
  67281. getClassName(): string;
  67282. /**
  67283. * Gets the incident component
  67284. */
  67285. get incident(): NodeMaterialConnectionPoint;
  67286. /**
  67287. * Gets the normal component
  67288. */
  67289. get normal(): NodeMaterialConnectionPoint;
  67290. /**
  67291. * Gets the index of refraction component
  67292. */
  67293. get ior(): NodeMaterialConnectionPoint;
  67294. /**
  67295. * Gets the output component
  67296. */
  67297. get output(): NodeMaterialConnectionPoint;
  67298. protected _buildBlock(state: NodeMaterialBuildState): this;
  67299. }
  67300. }
  67301. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  67302. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67303. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67304. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67305. /**
  67306. * Block used to desaturate a color
  67307. */
  67308. export class DesaturateBlock extends NodeMaterialBlock {
  67309. /**
  67310. * Creates a new DesaturateBlock
  67311. * @param name defines the block name
  67312. */
  67313. constructor(name: string);
  67314. /**
  67315. * Gets the current class name
  67316. * @returns the class name
  67317. */
  67318. getClassName(): string;
  67319. /**
  67320. * Gets the color operand input component
  67321. */
  67322. get color(): NodeMaterialConnectionPoint;
  67323. /**
  67324. * Gets the level operand input component
  67325. */
  67326. get level(): NodeMaterialConnectionPoint;
  67327. /**
  67328. * Gets the output component
  67329. */
  67330. get output(): NodeMaterialConnectionPoint;
  67331. protected _buildBlock(state: NodeMaterialBuildState): this;
  67332. }
  67333. }
  67334. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  67335. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67336. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67337. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67338. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67339. import { Nullable } from "babylonjs/types";
  67340. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67341. import { Scene } from "babylonjs/scene";
  67342. /**
  67343. * Block used to implement the ambient occlusion module of the PBR material
  67344. */
  67345. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  67346. /**
  67347. * Create a new AmbientOcclusionBlock
  67348. * @param name defines the block name
  67349. */
  67350. constructor(name: string);
  67351. /**
  67352. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  67353. */
  67354. useAmbientInGrayScale: boolean;
  67355. /**
  67356. * Initialize the block and prepare the context for build
  67357. * @param state defines the state that will be used for the build
  67358. */
  67359. initialize(state: NodeMaterialBuildState): void;
  67360. /**
  67361. * Gets the current class name
  67362. * @returns the class name
  67363. */
  67364. getClassName(): string;
  67365. /**
  67366. * Gets the texture input component
  67367. */
  67368. get texture(): NodeMaterialConnectionPoint;
  67369. /**
  67370. * Gets the texture intensity component
  67371. */
  67372. get intensity(): NodeMaterialConnectionPoint;
  67373. /**
  67374. * Gets the direct light intensity input component
  67375. */
  67376. get directLightIntensity(): NodeMaterialConnectionPoint;
  67377. /**
  67378. * Gets the ambient occlusion object output component
  67379. */
  67380. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67381. /**
  67382. * Gets the main code of the block (fragment side)
  67383. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  67384. * @returns the shader code
  67385. */
  67386. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  67387. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67388. protected _buildBlock(state: NodeMaterialBuildState): this;
  67389. protected _dumpPropertiesCode(): string;
  67390. serialize(): any;
  67391. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67392. }
  67393. }
  67394. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  67395. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67396. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67397. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67398. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  67399. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67400. import { Nullable } from "babylonjs/types";
  67401. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  67402. import { Mesh } from "babylonjs/Meshes/mesh";
  67403. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67404. import { Effect } from "babylonjs/Materials/effect";
  67405. import { Scene } from "babylonjs/scene";
  67406. /**
  67407. * Block used to implement the reflection module of the PBR material
  67408. */
  67409. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  67410. /** @hidden */
  67411. _defineLODReflectionAlpha: string;
  67412. /** @hidden */
  67413. _defineLinearSpecularReflection: string;
  67414. private _vEnvironmentIrradianceName;
  67415. /** @hidden */
  67416. _vReflectionMicrosurfaceInfosName: string;
  67417. /** @hidden */
  67418. _vReflectionInfosName: string;
  67419. /** @hidden */
  67420. _vReflectionFilteringInfoName: string;
  67421. private _scene;
  67422. /**
  67423. * The three properties below are set by the main PBR block prior to calling methods of this class.
  67424. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67425. * It's less burden on the user side in the editor part.
  67426. */
  67427. /** @hidden */
  67428. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67429. /** @hidden */
  67430. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67431. /** @hidden */
  67432. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67433. /**
  67434. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67435. * diffuse part of the IBL.
  67436. */
  67437. useSphericalHarmonics: boolean;
  67438. /**
  67439. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67440. */
  67441. forceIrradianceInFragment: boolean;
  67442. /**
  67443. * Create a new ReflectionBlock
  67444. * @param name defines the block name
  67445. */
  67446. constructor(name: string);
  67447. /**
  67448. * Gets the current class name
  67449. * @returns the class name
  67450. */
  67451. getClassName(): string;
  67452. /**
  67453. * Gets the position input component
  67454. */
  67455. get position(): NodeMaterialConnectionPoint;
  67456. /**
  67457. * Gets the world position input component
  67458. */
  67459. get worldPosition(): NodeMaterialConnectionPoint;
  67460. /**
  67461. * Gets the world normal input component
  67462. */
  67463. get worldNormal(): NodeMaterialConnectionPoint;
  67464. /**
  67465. * Gets the world input component
  67466. */
  67467. get world(): NodeMaterialConnectionPoint;
  67468. /**
  67469. * Gets the camera (or eye) position component
  67470. */
  67471. get cameraPosition(): NodeMaterialConnectionPoint;
  67472. /**
  67473. * Gets the view input component
  67474. */
  67475. get view(): NodeMaterialConnectionPoint;
  67476. /**
  67477. * Gets the color input component
  67478. */
  67479. get color(): NodeMaterialConnectionPoint;
  67480. /**
  67481. * Gets the reflection object output component
  67482. */
  67483. get reflection(): NodeMaterialConnectionPoint;
  67484. /**
  67485. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67486. */
  67487. get hasTexture(): boolean;
  67488. /**
  67489. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67490. */
  67491. get reflectionColor(): string;
  67492. protected _getTexture(): Nullable<BaseTexture>;
  67493. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67494. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67495. /**
  67496. * Gets the code to inject in the vertex shader
  67497. * @param state current state of the node material building
  67498. * @returns the shader code
  67499. */
  67500. handleVertexSide(state: NodeMaterialBuildState): string;
  67501. /**
  67502. * Gets the main code of the block (fragment side)
  67503. * @param state current state of the node material building
  67504. * @param normalVarName name of the existing variable corresponding to the normal
  67505. * @returns the shader code
  67506. */
  67507. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67508. protected _buildBlock(state: NodeMaterialBuildState): this;
  67509. protected _dumpPropertiesCode(): string;
  67510. serialize(): any;
  67511. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67512. }
  67513. }
  67514. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67515. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67516. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67517. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67518. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67519. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67520. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67521. import { Scene } from "babylonjs/scene";
  67522. import { Nullable } from "babylonjs/types";
  67523. /**
  67524. * Block used to implement the sheen module of the PBR material
  67525. */
  67526. export class SheenBlock extends NodeMaterialBlock {
  67527. /**
  67528. * Create a new SheenBlock
  67529. * @param name defines the block name
  67530. */
  67531. constructor(name: string);
  67532. /**
  67533. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67534. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67535. * making it easier to setup and tweak the effect
  67536. */
  67537. albedoScaling: boolean;
  67538. /**
  67539. * Defines if the sheen is linked to the sheen color.
  67540. */
  67541. linkSheenWithAlbedo: boolean;
  67542. /**
  67543. * Initialize the block and prepare the context for build
  67544. * @param state defines the state that will be used for the build
  67545. */
  67546. initialize(state: NodeMaterialBuildState): void;
  67547. /**
  67548. * Gets the current class name
  67549. * @returns the class name
  67550. */
  67551. getClassName(): string;
  67552. /**
  67553. * Gets the intensity input component
  67554. */
  67555. get intensity(): NodeMaterialConnectionPoint;
  67556. /**
  67557. * Gets the color input component
  67558. */
  67559. get color(): NodeMaterialConnectionPoint;
  67560. /**
  67561. * Gets the roughness input component
  67562. */
  67563. get roughness(): NodeMaterialConnectionPoint;
  67564. /**
  67565. * Gets the sheen object output component
  67566. */
  67567. get sheen(): NodeMaterialConnectionPoint;
  67568. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67569. /**
  67570. * Gets the main code of the block (fragment side)
  67571. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67572. * @returns the shader code
  67573. */
  67574. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67575. protected _buildBlock(state: NodeMaterialBuildState): this;
  67576. protected _dumpPropertiesCode(): string;
  67577. serialize(): any;
  67578. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67579. }
  67580. }
  67581. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67582. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67583. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67584. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67585. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67586. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67587. import { Scene } from "babylonjs/scene";
  67588. import { Nullable } from "babylonjs/types";
  67589. import { Mesh } from "babylonjs/Meshes/mesh";
  67590. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67591. import { Effect } from "babylonjs/Materials/effect";
  67592. /**
  67593. * Block used to implement the reflectivity module of the PBR material
  67594. */
  67595. export class ReflectivityBlock extends NodeMaterialBlock {
  67596. private _metallicReflectanceColor;
  67597. private _metallicF0Factor;
  67598. /** @hidden */
  67599. _vMetallicReflectanceFactorsName: string;
  67600. /**
  67601. * The property below is set by the main PBR block prior to calling methods of this class.
  67602. */
  67603. /** @hidden */
  67604. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67605. /**
  67606. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67607. */
  67608. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67609. /**
  67610. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67611. */
  67612. useMetallnessFromMetallicTextureBlue: boolean;
  67613. /**
  67614. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67615. */
  67616. useRoughnessFromMetallicTextureAlpha: boolean;
  67617. /**
  67618. * Specifies if the metallic texture contains the roughness information in its green channel.
  67619. */
  67620. useRoughnessFromMetallicTextureGreen: boolean;
  67621. /**
  67622. * Create a new ReflectivityBlock
  67623. * @param name defines the block name
  67624. */
  67625. constructor(name: string);
  67626. /**
  67627. * Initialize the block and prepare the context for build
  67628. * @param state defines the state that will be used for the build
  67629. */
  67630. initialize(state: NodeMaterialBuildState): void;
  67631. /**
  67632. * Gets the current class name
  67633. * @returns the class name
  67634. */
  67635. getClassName(): string;
  67636. /**
  67637. * Gets the metallic input component
  67638. */
  67639. get metallic(): NodeMaterialConnectionPoint;
  67640. /**
  67641. * Gets the roughness input component
  67642. */
  67643. get roughness(): NodeMaterialConnectionPoint;
  67644. /**
  67645. * Gets the texture input component
  67646. */
  67647. get texture(): NodeMaterialConnectionPoint;
  67648. /**
  67649. * Gets the reflectivity object output component
  67650. */
  67651. get reflectivity(): NodeMaterialConnectionPoint;
  67652. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67653. /**
  67654. * Gets the main code of the block (fragment side)
  67655. * @param state current state of the node material building
  67656. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67657. * @returns the shader code
  67658. */
  67659. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67660. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67661. protected _buildBlock(state: NodeMaterialBuildState): this;
  67662. protected _dumpPropertiesCode(): string;
  67663. serialize(): any;
  67664. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67665. }
  67666. }
  67667. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67668. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67669. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67670. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67671. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67672. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67673. /**
  67674. * Block used to implement the anisotropy module of the PBR material
  67675. */
  67676. export class AnisotropyBlock extends NodeMaterialBlock {
  67677. /**
  67678. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67679. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67680. * It's less burden on the user side in the editor part.
  67681. */
  67682. /** @hidden */
  67683. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67684. /** @hidden */
  67685. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67686. /**
  67687. * Create a new AnisotropyBlock
  67688. * @param name defines the block name
  67689. */
  67690. constructor(name: string);
  67691. /**
  67692. * Initialize the block and prepare the context for build
  67693. * @param state defines the state that will be used for the build
  67694. */
  67695. initialize(state: NodeMaterialBuildState): void;
  67696. /**
  67697. * Gets the current class name
  67698. * @returns the class name
  67699. */
  67700. getClassName(): string;
  67701. /**
  67702. * Gets the intensity input component
  67703. */
  67704. get intensity(): NodeMaterialConnectionPoint;
  67705. /**
  67706. * Gets the direction input component
  67707. */
  67708. get direction(): NodeMaterialConnectionPoint;
  67709. /**
  67710. * Gets the texture input component
  67711. */
  67712. get texture(): NodeMaterialConnectionPoint;
  67713. /**
  67714. * Gets the uv input component
  67715. */
  67716. get uv(): NodeMaterialConnectionPoint;
  67717. /**
  67718. * Gets the worldTangent input component
  67719. */
  67720. get worldTangent(): NodeMaterialConnectionPoint;
  67721. /**
  67722. * Gets the anisotropy object output component
  67723. */
  67724. get anisotropy(): NodeMaterialConnectionPoint;
  67725. private _generateTBNSpace;
  67726. /**
  67727. * Gets the main code of the block (fragment side)
  67728. * @param state current state of the node material building
  67729. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67730. * @returns the shader code
  67731. */
  67732. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67733. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67734. protected _buildBlock(state: NodeMaterialBuildState): this;
  67735. }
  67736. }
  67737. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67738. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67739. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67740. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67741. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67742. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67743. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67744. import { Nullable } from "babylonjs/types";
  67745. import { Mesh } from "babylonjs/Meshes/mesh";
  67746. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67747. import { Effect } from "babylonjs/Materials/effect";
  67748. /**
  67749. * Block used to implement the clear coat module of the PBR material
  67750. */
  67751. export class ClearCoatBlock extends NodeMaterialBlock {
  67752. private _scene;
  67753. /**
  67754. * Create a new ClearCoatBlock
  67755. * @param name defines the block name
  67756. */
  67757. constructor(name: string);
  67758. /**
  67759. * Initialize the block and prepare the context for build
  67760. * @param state defines the state that will be used for the build
  67761. */
  67762. initialize(state: NodeMaterialBuildState): void;
  67763. /**
  67764. * Gets the current class name
  67765. * @returns the class name
  67766. */
  67767. getClassName(): string;
  67768. /**
  67769. * Gets the intensity input component
  67770. */
  67771. get intensity(): NodeMaterialConnectionPoint;
  67772. /**
  67773. * Gets the roughness input component
  67774. */
  67775. get roughness(): NodeMaterialConnectionPoint;
  67776. /**
  67777. * Gets the ior input component
  67778. */
  67779. get ior(): NodeMaterialConnectionPoint;
  67780. /**
  67781. * Gets the texture input component
  67782. */
  67783. get texture(): NodeMaterialConnectionPoint;
  67784. /**
  67785. * Gets the bump texture input component
  67786. */
  67787. get bumpTexture(): NodeMaterialConnectionPoint;
  67788. /**
  67789. * Gets the uv input component
  67790. */
  67791. get uv(): NodeMaterialConnectionPoint;
  67792. /**
  67793. * Gets the tint color input component
  67794. */
  67795. get tintColor(): NodeMaterialConnectionPoint;
  67796. /**
  67797. * Gets the tint "at distance" input component
  67798. */
  67799. get tintAtDistance(): NodeMaterialConnectionPoint;
  67800. /**
  67801. * Gets the tint thickness input component
  67802. */
  67803. get tintThickness(): NodeMaterialConnectionPoint;
  67804. /**
  67805. * Gets the world tangent input component
  67806. */
  67807. get worldTangent(): NodeMaterialConnectionPoint;
  67808. /**
  67809. * Gets the clear coat object output component
  67810. */
  67811. get clearcoat(): NodeMaterialConnectionPoint;
  67812. autoConfigure(material: NodeMaterial): void;
  67813. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67814. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67815. private _generateTBNSpace;
  67816. /**
  67817. * Gets the main code of the block (fragment side)
  67818. * @param state current state of the node material building
  67819. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  67820. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67821. * @param worldPosVarName name of the variable holding the world position
  67822. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67823. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  67824. * @param worldNormalVarName name of the variable holding the world normal
  67825. * @returns the shader code
  67826. */
  67827. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  67828. protected _buildBlock(state: NodeMaterialBuildState): this;
  67829. }
  67830. }
  67831. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  67832. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67833. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67834. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67835. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67836. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67837. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67838. import { Nullable } from "babylonjs/types";
  67839. /**
  67840. * Block used to implement the sub surface module of the PBR material
  67841. */
  67842. export class SubSurfaceBlock extends NodeMaterialBlock {
  67843. /**
  67844. * Create a new SubSurfaceBlock
  67845. * @param name defines the block name
  67846. */
  67847. constructor(name: string);
  67848. /**
  67849. * Stores the intensity of the different subsurface effects in the thickness texture.
  67850. * * the green channel is the translucency intensity.
  67851. * * the blue channel is the scattering intensity.
  67852. * * the alpha channel is the refraction intensity.
  67853. */
  67854. useMaskFromThicknessTexture: boolean;
  67855. /**
  67856. * Initialize the block and prepare the context for build
  67857. * @param state defines the state that will be used for the build
  67858. */
  67859. initialize(state: NodeMaterialBuildState): void;
  67860. /**
  67861. * Gets the current class name
  67862. * @returns the class name
  67863. */
  67864. getClassName(): string;
  67865. /**
  67866. * Gets the min thickness input component
  67867. */
  67868. get minThickness(): NodeMaterialConnectionPoint;
  67869. /**
  67870. * Gets the max thickness input component
  67871. */
  67872. get maxThickness(): NodeMaterialConnectionPoint;
  67873. /**
  67874. * Gets the thickness texture component
  67875. */
  67876. get thicknessTexture(): NodeMaterialConnectionPoint;
  67877. /**
  67878. * Gets the tint color input component
  67879. */
  67880. get tintColor(): NodeMaterialConnectionPoint;
  67881. /**
  67882. * Gets the translucency intensity input component
  67883. */
  67884. get translucencyIntensity(): NodeMaterialConnectionPoint;
  67885. /**
  67886. * Gets the translucency diffusion distance input component
  67887. */
  67888. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  67889. /**
  67890. * Gets the refraction object parameters
  67891. */
  67892. get refraction(): NodeMaterialConnectionPoint;
  67893. /**
  67894. * Gets the sub surface object output component
  67895. */
  67896. get subsurface(): NodeMaterialConnectionPoint;
  67897. autoConfigure(material: NodeMaterial): void;
  67898. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67899. /**
  67900. * Gets the main code of the block (fragment side)
  67901. * @param state current state of the node material building
  67902. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  67903. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67904. * @param worldPosVarName name of the variable holding the world position
  67905. * @returns the shader code
  67906. */
  67907. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  67908. protected _buildBlock(state: NodeMaterialBuildState): this;
  67909. }
  67910. }
  67911. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  67912. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67913. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67914. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67915. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67916. import { Light } from "babylonjs/Lights/light";
  67917. import { Nullable } from "babylonjs/types";
  67918. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67919. import { Effect } from "babylonjs/Materials/effect";
  67920. import { Mesh } from "babylonjs/Meshes/mesh";
  67921. import { Scene } from "babylonjs/scene";
  67922. /**
  67923. * Block used to implement the PBR metallic/roughness model
  67924. */
  67925. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  67926. /**
  67927. * Gets or sets the light associated with this block
  67928. */
  67929. light: Nullable<Light>;
  67930. private _lightId;
  67931. private _scene;
  67932. private _environmentBRDFTexture;
  67933. private _environmentBrdfSamplerName;
  67934. private _vNormalWName;
  67935. private _invertNormalName;
  67936. /**
  67937. * Create a new ReflectionBlock
  67938. * @param name defines the block name
  67939. */
  67940. constructor(name: string);
  67941. /**
  67942. * Intensity of the direct lights e.g. the four lights available in your scene.
  67943. * This impacts both the direct diffuse and specular highlights.
  67944. */
  67945. directIntensity: number;
  67946. /**
  67947. * Intensity of the environment e.g. how much the environment will light the object
  67948. * either through harmonics for rough material or through the refelction for shiny ones.
  67949. */
  67950. environmentIntensity: number;
  67951. /**
  67952. * This is a special control allowing the reduction of the specular highlights coming from the
  67953. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  67954. */
  67955. specularIntensity: number;
  67956. /**
  67957. * Defines the falloff type used in this material.
  67958. * It by default is Physical.
  67959. */
  67960. lightFalloff: number;
  67961. /**
  67962. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  67963. */
  67964. useAlphaFromAlbedoTexture: boolean;
  67965. /**
  67966. * Specifies that alpha test should be used
  67967. */
  67968. useAlphaTest: boolean;
  67969. /**
  67970. * Defines the alpha limits in alpha test mode.
  67971. */
  67972. alphaTestCutoff: number;
  67973. /**
  67974. * Specifies that alpha blending should be used
  67975. */
  67976. useAlphaBlending: boolean;
  67977. /**
  67978. * Defines if the alpha value should be determined via the rgb values.
  67979. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  67980. */
  67981. opacityRGB: boolean;
  67982. /**
  67983. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  67984. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  67985. */
  67986. useRadianceOverAlpha: boolean;
  67987. /**
  67988. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  67989. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  67990. */
  67991. useSpecularOverAlpha: boolean;
  67992. /**
  67993. * Enables specular anti aliasing in the PBR shader.
  67994. * It will both interacts on the Geometry for analytical and IBL lighting.
  67995. * It also prefilter the roughness map based on the bump values.
  67996. */
  67997. enableSpecularAntiAliasing: boolean;
  67998. /**
  67999. * Enables realtime filtering on the texture.
  68000. */
  68001. realTimeFiltering: boolean;
  68002. /**
  68003. * Quality switch for realtime filtering
  68004. */
  68005. realTimeFilteringQuality: number;
  68006. /**
  68007. * Defines if the material uses energy conservation.
  68008. */
  68009. useEnergyConservation: boolean;
  68010. /**
  68011. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  68012. * too much the area relying on ambient texture to define their ambient occlusion.
  68013. */
  68014. useRadianceOcclusion: boolean;
  68015. /**
  68016. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  68017. * makes the reflect vector face the model (under horizon).
  68018. */
  68019. useHorizonOcclusion: boolean;
  68020. /**
  68021. * If set to true, no lighting calculations will be applied.
  68022. */
  68023. unlit: boolean;
  68024. /**
  68025. * Force normal to face away from face.
  68026. */
  68027. forceNormalForward: boolean;
  68028. /**
  68029. * Defines the material debug mode.
  68030. * It helps seeing only some components of the material while troubleshooting.
  68031. */
  68032. debugMode: number;
  68033. /**
  68034. * Specify from where on screen the debug mode should start.
  68035. * The value goes from -1 (full screen) to 1 (not visible)
  68036. * It helps with side by side comparison against the final render
  68037. * This defaults to 0
  68038. */
  68039. debugLimit: number;
  68040. /**
  68041. * As the default viewing range might not be enough (if the ambient is really small for instance)
  68042. * You can use the factor to better multiply the final value.
  68043. */
  68044. debugFactor: number;
  68045. /**
  68046. * Initialize the block and prepare the context for build
  68047. * @param state defines the state that will be used for the build
  68048. */
  68049. initialize(state: NodeMaterialBuildState): void;
  68050. /**
  68051. * Gets the current class name
  68052. * @returns the class name
  68053. */
  68054. getClassName(): string;
  68055. /**
  68056. * Gets the world position input component
  68057. */
  68058. get worldPosition(): NodeMaterialConnectionPoint;
  68059. /**
  68060. * Gets the world normal input component
  68061. */
  68062. get worldNormal(): NodeMaterialConnectionPoint;
  68063. /**
  68064. * Gets the perturbed normal input component
  68065. */
  68066. get perturbedNormal(): NodeMaterialConnectionPoint;
  68067. /**
  68068. * Gets the camera position input component
  68069. */
  68070. get cameraPosition(): NodeMaterialConnectionPoint;
  68071. /**
  68072. * Gets the base color input component
  68073. */
  68074. get baseColor(): NodeMaterialConnectionPoint;
  68075. /**
  68076. * Gets the opacity texture input component
  68077. */
  68078. get opacityTexture(): NodeMaterialConnectionPoint;
  68079. /**
  68080. * Gets the ambient color input component
  68081. */
  68082. get ambientColor(): NodeMaterialConnectionPoint;
  68083. /**
  68084. * Gets the reflectivity object parameters
  68085. */
  68086. get reflectivity(): NodeMaterialConnectionPoint;
  68087. /**
  68088. * Gets the ambient occlusion object parameters
  68089. */
  68090. get ambientOcclusion(): NodeMaterialConnectionPoint;
  68091. /**
  68092. * Gets the reflection object parameters
  68093. */
  68094. get reflection(): NodeMaterialConnectionPoint;
  68095. /**
  68096. * Gets the sheen object parameters
  68097. */
  68098. get sheen(): NodeMaterialConnectionPoint;
  68099. /**
  68100. * Gets the clear coat object parameters
  68101. */
  68102. get clearcoat(): NodeMaterialConnectionPoint;
  68103. /**
  68104. * Gets the sub surface object parameters
  68105. */
  68106. get subsurface(): NodeMaterialConnectionPoint;
  68107. /**
  68108. * Gets the anisotropy object parameters
  68109. */
  68110. get anisotropy(): NodeMaterialConnectionPoint;
  68111. /**
  68112. * Gets the ambient output component
  68113. */
  68114. get ambient(): NodeMaterialConnectionPoint;
  68115. /**
  68116. * Gets the diffuse output component
  68117. */
  68118. get diffuse(): NodeMaterialConnectionPoint;
  68119. /**
  68120. * Gets the specular output component
  68121. */
  68122. get specular(): NodeMaterialConnectionPoint;
  68123. /**
  68124. * Gets the sheen output component
  68125. */
  68126. get sheenDir(): NodeMaterialConnectionPoint;
  68127. /**
  68128. * Gets the clear coat output component
  68129. */
  68130. get clearcoatDir(): NodeMaterialConnectionPoint;
  68131. /**
  68132. * Gets the indirect diffuse output component
  68133. */
  68134. get diffuseIndirect(): NodeMaterialConnectionPoint;
  68135. /**
  68136. * Gets the indirect specular output component
  68137. */
  68138. get specularIndirect(): NodeMaterialConnectionPoint;
  68139. /**
  68140. * Gets the indirect sheen output component
  68141. */
  68142. get sheenIndirect(): NodeMaterialConnectionPoint;
  68143. /**
  68144. * Gets the indirect clear coat output component
  68145. */
  68146. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  68147. /**
  68148. * Gets the refraction output component
  68149. */
  68150. get refraction(): NodeMaterialConnectionPoint;
  68151. /**
  68152. * Gets the global lighting output component
  68153. */
  68154. get lighting(): NodeMaterialConnectionPoint;
  68155. /**
  68156. * Gets the shadow output component
  68157. */
  68158. get shadow(): NodeMaterialConnectionPoint;
  68159. /**
  68160. * Gets the alpha output component
  68161. */
  68162. get alpha(): NodeMaterialConnectionPoint;
  68163. autoConfigure(material: NodeMaterial): void;
  68164. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68165. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  68166. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  68167. private _injectVertexCode;
  68168. /**
  68169. * Gets the code corresponding to the albedo/opacity module
  68170. * @returns the shader code
  68171. */
  68172. getAlbedoOpacityCode(): string;
  68173. protected _buildBlock(state: NodeMaterialBuildState): this;
  68174. protected _dumpPropertiesCode(): string;
  68175. serialize(): any;
  68176. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68177. }
  68178. }
  68179. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  68180. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  68181. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  68182. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  68183. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  68184. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  68185. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68186. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  68187. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  68188. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  68189. }
  68190. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  68191. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  68192. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  68193. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  68194. }
  68195. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  68196. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68197. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68198. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68199. /**
  68200. * Block used to compute value of one parameter modulo another
  68201. */
  68202. export class ModBlock extends NodeMaterialBlock {
  68203. /**
  68204. * Creates a new ModBlock
  68205. * @param name defines the block name
  68206. */
  68207. constructor(name: string);
  68208. /**
  68209. * Gets the current class name
  68210. * @returns the class name
  68211. */
  68212. getClassName(): string;
  68213. /**
  68214. * Gets the left operand input component
  68215. */
  68216. get left(): NodeMaterialConnectionPoint;
  68217. /**
  68218. * Gets the right operand input component
  68219. */
  68220. get right(): NodeMaterialConnectionPoint;
  68221. /**
  68222. * Gets the output component
  68223. */
  68224. get output(): NodeMaterialConnectionPoint;
  68225. protected _buildBlock(state: NodeMaterialBuildState): this;
  68226. }
  68227. }
  68228. declare module "babylonjs/Materials/Node/Blocks/index" {
  68229. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  68230. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  68231. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  68232. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  68233. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  68234. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  68235. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  68236. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  68237. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  68238. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  68239. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  68240. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  68241. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  68242. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  68243. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  68244. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  68245. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  68246. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  68247. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  68248. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  68249. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  68250. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  68251. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  68252. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  68253. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  68254. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  68255. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  68256. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  68257. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  68258. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  68259. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  68260. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  68261. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  68262. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  68263. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  68264. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  68265. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  68266. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  68267. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  68268. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  68269. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  68270. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  68271. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  68272. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  68273. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  68274. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  68275. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  68276. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  68277. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  68278. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  68279. }
  68280. declare module "babylonjs/Materials/Node/Optimizers/index" {
  68281. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  68282. }
  68283. declare module "babylonjs/Materials/Node/index" {
  68284. export * from "babylonjs/Materials/Node/Enums/index";
  68285. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68286. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  68287. export * from "babylonjs/Materials/Node/nodeMaterial";
  68288. export * from "babylonjs/Materials/Node/Blocks/index";
  68289. export * from "babylonjs/Materials/Node/Optimizers/index";
  68290. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  68291. }
  68292. declare module "babylonjs/Materials/index" {
  68293. export * from "babylonjs/Materials/Background/index";
  68294. export * from "babylonjs/Materials/colorCurves";
  68295. export * from "babylonjs/Materials/iEffectFallbacks";
  68296. export * from "babylonjs/Materials/effectFallbacks";
  68297. export * from "babylonjs/Materials/effect";
  68298. export * from "babylonjs/Materials/fresnelParameters";
  68299. export * from "babylonjs/Materials/imageProcessingConfiguration";
  68300. export * from "babylonjs/Materials/material";
  68301. export * from "babylonjs/Materials/materialDefines";
  68302. export * from "babylonjs/Materials/thinMaterialHelper";
  68303. export * from "babylonjs/Materials/materialHelper";
  68304. export * from "babylonjs/Materials/multiMaterial";
  68305. export * from "babylonjs/Materials/PBR/index";
  68306. export * from "babylonjs/Materials/pushMaterial";
  68307. export * from "babylonjs/Materials/shaderMaterial";
  68308. export * from "babylonjs/Materials/standardMaterial";
  68309. export * from "babylonjs/Materials/Textures/index";
  68310. export * from "babylonjs/Materials/uniformBuffer";
  68311. export * from "babylonjs/Materials/materialFlags";
  68312. export * from "babylonjs/Materials/Node/index";
  68313. export * from "babylonjs/Materials/effectRenderer";
  68314. export * from "babylonjs/Materials/shadowDepthWrapper";
  68315. }
  68316. declare module "babylonjs/Maths/index" {
  68317. export * from "babylonjs/Maths/math.scalar";
  68318. export * from "babylonjs/Maths/math";
  68319. export * from "babylonjs/Maths/sphericalPolynomial";
  68320. }
  68321. declare module "babylonjs/Misc/workerPool" {
  68322. import { IDisposable } from "babylonjs/scene";
  68323. /**
  68324. * Helper class to push actions to a pool of workers.
  68325. */
  68326. export class WorkerPool implements IDisposable {
  68327. private _workerInfos;
  68328. private _pendingActions;
  68329. /**
  68330. * Constructor
  68331. * @param workers Array of workers to use for actions
  68332. */
  68333. constructor(workers: Array<Worker>);
  68334. /**
  68335. * Terminates all workers and clears any pending actions.
  68336. */
  68337. dispose(): void;
  68338. /**
  68339. * Pushes an action to the worker pool. If all the workers are active, the action will be
  68340. * pended until a worker has completed its action.
  68341. * @param action The action to perform. Call onComplete when the action is complete.
  68342. */
  68343. push(action: (worker: Worker, onComplete: () => void) => void): void;
  68344. private _execute;
  68345. }
  68346. }
  68347. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  68348. import { IDisposable } from "babylonjs/scene";
  68349. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68350. /**
  68351. * Configuration for Draco compression
  68352. */
  68353. export interface IDracoCompressionConfiguration {
  68354. /**
  68355. * Configuration for the decoder.
  68356. */
  68357. decoder: {
  68358. /**
  68359. * The url to the WebAssembly module.
  68360. */
  68361. wasmUrl?: string;
  68362. /**
  68363. * The url to the WebAssembly binary.
  68364. */
  68365. wasmBinaryUrl?: string;
  68366. /**
  68367. * The url to the fallback JavaScript module.
  68368. */
  68369. fallbackUrl?: string;
  68370. };
  68371. }
  68372. /**
  68373. * Draco compression (https://google.github.io/draco/)
  68374. *
  68375. * This class wraps the Draco module.
  68376. *
  68377. * **Encoder**
  68378. *
  68379. * The encoder is not currently implemented.
  68380. *
  68381. * **Decoder**
  68382. *
  68383. * 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.
  68384. *
  68385. * To update the configuration, use the following code:
  68386. * ```javascript
  68387. * DracoCompression.Configuration = {
  68388. * decoder: {
  68389. * wasmUrl: "<url to the WebAssembly library>",
  68390. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  68391. * fallbackUrl: "<url to the fallback JavaScript library>",
  68392. * }
  68393. * };
  68394. * ```
  68395. *
  68396. * 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.
  68397. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  68398. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  68399. *
  68400. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  68401. * ```javascript
  68402. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  68403. * ```
  68404. *
  68405. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  68406. */
  68407. export class DracoCompression implements IDisposable {
  68408. private _workerPoolPromise?;
  68409. private _decoderModulePromise?;
  68410. /**
  68411. * The configuration. Defaults to the following urls:
  68412. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  68413. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  68414. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  68415. */
  68416. static Configuration: IDracoCompressionConfiguration;
  68417. /**
  68418. * Returns true if the decoder configuration is available.
  68419. */
  68420. static get DecoderAvailable(): boolean;
  68421. /**
  68422. * Default number of workers to create when creating the draco compression object.
  68423. */
  68424. static DefaultNumWorkers: number;
  68425. private static GetDefaultNumWorkers;
  68426. private static _Default;
  68427. /**
  68428. * Default instance for the draco compression object.
  68429. */
  68430. static get Default(): DracoCompression;
  68431. /**
  68432. * Constructor
  68433. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68434. */
  68435. constructor(numWorkers?: number);
  68436. /**
  68437. * Stop all async operations and release resources.
  68438. */
  68439. dispose(): void;
  68440. /**
  68441. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68442. * @returns a promise that resolves when ready
  68443. */
  68444. whenReadyAsync(): Promise<void>;
  68445. /**
  68446. * Decode Draco compressed mesh data to vertex data.
  68447. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68448. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68449. * @returns A promise that resolves with the decoded vertex data
  68450. */
  68451. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68452. [kind: string]: number;
  68453. }): Promise<VertexData>;
  68454. }
  68455. }
  68456. declare module "babylonjs/Meshes/Compression/index" {
  68457. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68458. }
  68459. declare module "babylonjs/Meshes/csg" {
  68460. import { Nullable } from "babylonjs/types";
  68461. import { Scene } from "babylonjs/scene";
  68462. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68463. import { Mesh } from "babylonjs/Meshes/mesh";
  68464. import { Material } from "babylonjs/Materials/material";
  68465. /**
  68466. * Class for building Constructive Solid Geometry
  68467. */
  68468. export class CSG {
  68469. private polygons;
  68470. /**
  68471. * The world matrix
  68472. */
  68473. matrix: Matrix;
  68474. /**
  68475. * Stores the position
  68476. */
  68477. position: Vector3;
  68478. /**
  68479. * Stores the rotation
  68480. */
  68481. rotation: Vector3;
  68482. /**
  68483. * Stores the rotation quaternion
  68484. */
  68485. rotationQuaternion: Nullable<Quaternion>;
  68486. /**
  68487. * Stores the scaling vector
  68488. */
  68489. scaling: Vector3;
  68490. /**
  68491. * Convert the Mesh to CSG
  68492. * @param mesh The Mesh to convert to CSG
  68493. * @returns A new CSG from the Mesh
  68494. */
  68495. static FromMesh(mesh: Mesh): CSG;
  68496. /**
  68497. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68498. * @param polygons Polygons used to construct a CSG solid
  68499. */
  68500. private static FromPolygons;
  68501. /**
  68502. * Clones, or makes a deep copy, of the CSG
  68503. * @returns A new CSG
  68504. */
  68505. clone(): CSG;
  68506. /**
  68507. * Unions this CSG with another CSG
  68508. * @param csg The CSG to union against this CSG
  68509. * @returns The unioned CSG
  68510. */
  68511. union(csg: CSG): CSG;
  68512. /**
  68513. * Unions this CSG with another CSG in place
  68514. * @param csg The CSG to union against this CSG
  68515. */
  68516. unionInPlace(csg: CSG): void;
  68517. /**
  68518. * Subtracts this CSG with another CSG
  68519. * @param csg The CSG to subtract against this CSG
  68520. * @returns A new CSG
  68521. */
  68522. subtract(csg: CSG): CSG;
  68523. /**
  68524. * Subtracts this CSG with another CSG in place
  68525. * @param csg The CSG to subtact against this CSG
  68526. */
  68527. subtractInPlace(csg: CSG): void;
  68528. /**
  68529. * Intersect this CSG with another CSG
  68530. * @param csg The CSG to intersect against this CSG
  68531. * @returns A new CSG
  68532. */
  68533. intersect(csg: CSG): CSG;
  68534. /**
  68535. * Intersects this CSG with another CSG in place
  68536. * @param csg The CSG to intersect against this CSG
  68537. */
  68538. intersectInPlace(csg: CSG): void;
  68539. /**
  68540. * Return a new CSG solid with solid and empty space switched. This solid is
  68541. * not modified.
  68542. * @returns A new CSG solid with solid and empty space switched
  68543. */
  68544. inverse(): CSG;
  68545. /**
  68546. * Inverses the CSG in place
  68547. */
  68548. inverseInPlace(): void;
  68549. /**
  68550. * This is used to keep meshes transformations so they can be restored
  68551. * when we build back a Babylon Mesh
  68552. * NB : All CSG operations are performed in world coordinates
  68553. * @param csg The CSG to copy the transform attributes from
  68554. * @returns This CSG
  68555. */
  68556. copyTransformAttributes(csg: CSG): CSG;
  68557. /**
  68558. * Build Raw mesh from CSG
  68559. * Coordinates here are in world space
  68560. * @param name The name of the mesh geometry
  68561. * @param scene The Scene
  68562. * @param keepSubMeshes Specifies if the submeshes should be kept
  68563. * @returns A new Mesh
  68564. */
  68565. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68566. /**
  68567. * Build Mesh from CSG taking material and transforms into account
  68568. * @param name The name of the Mesh
  68569. * @param material The material of the Mesh
  68570. * @param scene The Scene
  68571. * @param keepSubMeshes Specifies if submeshes should be kept
  68572. * @returns The new Mesh
  68573. */
  68574. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68575. }
  68576. }
  68577. declare module "babylonjs/Meshes/trailMesh" {
  68578. import { Mesh } from "babylonjs/Meshes/mesh";
  68579. import { Scene } from "babylonjs/scene";
  68580. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68581. /**
  68582. * Class used to create a trail following a mesh
  68583. */
  68584. export class TrailMesh extends Mesh {
  68585. private _generator;
  68586. private _autoStart;
  68587. private _running;
  68588. private _diameter;
  68589. private _length;
  68590. private _sectionPolygonPointsCount;
  68591. private _sectionVectors;
  68592. private _sectionNormalVectors;
  68593. private _beforeRenderObserver;
  68594. /**
  68595. * @constructor
  68596. * @param name The value used by scene.getMeshByName() to do a lookup.
  68597. * @param generator The mesh or transform node to generate a trail.
  68598. * @param scene The scene to add this mesh to.
  68599. * @param diameter Diameter of trailing mesh. Default is 1.
  68600. * @param length Length of trailing mesh. Default is 60.
  68601. * @param autoStart Automatically start trailing mesh. Default true.
  68602. */
  68603. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68604. /**
  68605. * "TrailMesh"
  68606. * @returns "TrailMesh"
  68607. */
  68608. getClassName(): string;
  68609. private _createMesh;
  68610. /**
  68611. * Start trailing mesh.
  68612. */
  68613. start(): void;
  68614. /**
  68615. * Stop trailing mesh.
  68616. */
  68617. stop(): void;
  68618. /**
  68619. * Update trailing mesh geometry.
  68620. */
  68621. update(): void;
  68622. /**
  68623. * Returns a new TrailMesh object.
  68624. * @param name is a string, the name given to the new mesh
  68625. * @param newGenerator use new generator object for cloned trail mesh
  68626. * @returns a new mesh
  68627. */
  68628. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68629. /**
  68630. * Serializes this trail mesh
  68631. * @param serializationObject object to write serialization to
  68632. */
  68633. serialize(serializationObject: any): void;
  68634. /**
  68635. * Parses a serialized trail mesh
  68636. * @param parsedMesh the serialized mesh
  68637. * @param scene the scene to create the trail mesh in
  68638. * @returns the created trail mesh
  68639. */
  68640. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68641. }
  68642. }
  68643. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68644. import { Nullable } from "babylonjs/types";
  68645. import { Scene } from "babylonjs/scene";
  68646. import { Vector4 } from "babylonjs/Maths/math.vector";
  68647. import { Color4 } from "babylonjs/Maths/math.color";
  68648. import { Mesh } from "babylonjs/Meshes/mesh";
  68649. /**
  68650. * Class containing static functions to help procedurally build meshes
  68651. */
  68652. export class TiledBoxBuilder {
  68653. /**
  68654. * Creates a box mesh
  68655. * 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)
  68656. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68657. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68658. * * 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
  68659. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68660. * @param name defines the name of the mesh
  68661. * @param options defines the options used to create the mesh
  68662. * @param scene defines the hosting scene
  68663. * @returns the box mesh
  68664. */
  68665. static CreateTiledBox(name: string, options: {
  68666. pattern?: number;
  68667. width?: number;
  68668. height?: number;
  68669. depth?: number;
  68670. tileSize?: number;
  68671. tileWidth?: number;
  68672. tileHeight?: number;
  68673. alignHorizontal?: number;
  68674. alignVertical?: number;
  68675. faceUV?: Vector4[];
  68676. faceColors?: Color4[];
  68677. sideOrientation?: number;
  68678. updatable?: boolean;
  68679. }, scene?: Nullable<Scene>): Mesh;
  68680. }
  68681. }
  68682. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68683. import { Vector4 } from "babylonjs/Maths/math.vector";
  68684. import { Mesh } from "babylonjs/Meshes/mesh";
  68685. /**
  68686. * Class containing static functions to help procedurally build meshes
  68687. */
  68688. export class TorusKnotBuilder {
  68689. /**
  68690. * Creates a torus knot mesh
  68691. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68692. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68693. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68694. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68695. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68696. * * 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
  68697. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68698. * @param name defines the name of the mesh
  68699. * @param options defines the options used to create the mesh
  68700. * @param scene defines the hosting scene
  68701. * @returns the torus knot mesh
  68702. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68703. */
  68704. static CreateTorusKnot(name: string, options: {
  68705. radius?: number;
  68706. tube?: number;
  68707. radialSegments?: number;
  68708. tubularSegments?: number;
  68709. p?: number;
  68710. q?: number;
  68711. updatable?: boolean;
  68712. sideOrientation?: number;
  68713. frontUVs?: Vector4;
  68714. backUVs?: Vector4;
  68715. }, scene: any): Mesh;
  68716. }
  68717. }
  68718. declare module "babylonjs/Meshes/polygonMesh" {
  68719. import { Scene } from "babylonjs/scene";
  68720. import { Vector2 } from "babylonjs/Maths/math.vector";
  68721. import { Mesh } from "babylonjs/Meshes/mesh";
  68722. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68723. import { Path2 } from "babylonjs/Maths/math.path";
  68724. /**
  68725. * Polygon
  68726. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68727. */
  68728. export class Polygon {
  68729. /**
  68730. * Creates a rectangle
  68731. * @param xmin bottom X coord
  68732. * @param ymin bottom Y coord
  68733. * @param xmax top X coord
  68734. * @param ymax top Y coord
  68735. * @returns points that make the resulting rectation
  68736. */
  68737. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68738. /**
  68739. * Creates a circle
  68740. * @param radius radius of circle
  68741. * @param cx scale in x
  68742. * @param cy scale in y
  68743. * @param numberOfSides number of sides that make up the circle
  68744. * @returns points that make the resulting circle
  68745. */
  68746. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68747. /**
  68748. * Creates a polygon from input string
  68749. * @param input Input polygon data
  68750. * @returns the parsed points
  68751. */
  68752. static Parse(input: string): Vector2[];
  68753. /**
  68754. * Starts building a polygon from x and y coordinates
  68755. * @param x x coordinate
  68756. * @param y y coordinate
  68757. * @returns the started path2
  68758. */
  68759. static StartingAt(x: number, y: number): Path2;
  68760. }
  68761. /**
  68762. * Builds a polygon
  68763. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68764. */
  68765. export class PolygonMeshBuilder {
  68766. private _points;
  68767. private _outlinepoints;
  68768. private _holes;
  68769. private _name;
  68770. private _scene;
  68771. private _epoints;
  68772. private _eholes;
  68773. private _addToepoint;
  68774. /**
  68775. * Babylon reference to the earcut plugin.
  68776. */
  68777. bjsEarcut: any;
  68778. /**
  68779. * Creates a PolygonMeshBuilder
  68780. * @param name name of the builder
  68781. * @param contours Path of the polygon
  68782. * @param scene scene to add to when creating the mesh
  68783. * @param earcutInjection can be used to inject your own earcut reference
  68784. */
  68785. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  68786. /**
  68787. * Adds a whole within the polygon
  68788. * @param hole Array of points defining the hole
  68789. * @returns this
  68790. */
  68791. addHole(hole: Vector2[]): PolygonMeshBuilder;
  68792. /**
  68793. * Creates the polygon
  68794. * @param updatable If the mesh should be updatable
  68795. * @param depth The depth of the mesh created
  68796. * @returns the created mesh
  68797. */
  68798. build(updatable?: boolean, depth?: number): Mesh;
  68799. /**
  68800. * Creates the polygon
  68801. * @param depth The depth of the mesh created
  68802. * @returns the created VertexData
  68803. */
  68804. buildVertexData(depth?: number): VertexData;
  68805. /**
  68806. * Adds a side to the polygon
  68807. * @param positions points that make the polygon
  68808. * @param normals normals of the polygon
  68809. * @param uvs uvs of the polygon
  68810. * @param indices indices of the polygon
  68811. * @param bounds bounds of the polygon
  68812. * @param points points of the polygon
  68813. * @param depth depth of the polygon
  68814. * @param flip flip of the polygon
  68815. */
  68816. private addSide;
  68817. }
  68818. }
  68819. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  68820. import { Scene } from "babylonjs/scene";
  68821. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68822. import { Color4 } from "babylonjs/Maths/math.color";
  68823. import { Mesh } from "babylonjs/Meshes/mesh";
  68824. import { Nullable } from "babylonjs/types";
  68825. /**
  68826. * Class containing static functions to help procedurally build meshes
  68827. */
  68828. export class PolygonBuilder {
  68829. /**
  68830. * Creates a polygon mesh
  68831. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68832. * * 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
  68833. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68834. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68835. * * 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)
  68836. * * Remember you can only change the shape positions, not their number when updating a polygon
  68837. * @param name defines the name of the mesh
  68838. * @param options defines the options used to create the mesh
  68839. * @param scene defines the hosting scene
  68840. * @param earcutInjection can be used to inject your own earcut reference
  68841. * @returns the polygon mesh
  68842. */
  68843. static CreatePolygon(name: string, options: {
  68844. shape: Vector3[];
  68845. holes?: Vector3[][];
  68846. depth?: number;
  68847. faceUV?: Vector4[];
  68848. faceColors?: Color4[];
  68849. updatable?: boolean;
  68850. sideOrientation?: number;
  68851. frontUVs?: Vector4;
  68852. backUVs?: Vector4;
  68853. wrap?: boolean;
  68854. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68855. /**
  68856. * Creates an extruded polygon mesh, with depth in the Y direction.
  68857. * * 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)
  68858. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68859. * @param name defines the name of the mesh
  68860. * @param options defines the options used to create the mesh
  68861. * @param scene defines the hosting scene
  68862. * @param earcutInjection can be used to inject your own earcut reference
  68863. * @returns the polygon mesh
  68864. */
  68865. static ExtrudePolygon(name: string, options: {
  68866. shape: Vector3[];
  68867. holes?: Vector3[][];
  68868. depth?: number;
  68869. faceUV?: Vector4[];
  68870. faceColors?: Color4[];
  68871. updatable?: boolean;
  68872. sideOrientation?: number;
  68873. frontUVs?: Vector4;
  68874. backUVs?: Vector4;
  68875. wrap?: boolean;
  68876. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68877. }
  68878. }
  68879. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  68880. import { Scene } from "babylonjs/scene";
  68881. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68882. import { Mesh } from "babylonjs/Meshes/mesh";
  68883. import { Nullable } from "babylonjs/types";
  68884. /**
  68885. * Class containing static functions to help procedurally build meshes
  68886. */
  68887. export class LatheBuilder {
  68888. /**
  68889. * Creates lathe mesh.
  68890. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68891. * * 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
  68892. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68893. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68894. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68895. * * 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
  68896. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68897. * * 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
  68898. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68899. * * 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
  68900. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68901. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68902. * @param name defines the name of the mesh
  68903. * @param options defines the options used to create the mesh
  68904. * @param scene defines the hosting scene
  68905. * @returns the lathe mesh
  68906. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68907. */
  68908. static CreateLathe(name: string, options: {
  68909. shape: Vector3[];
  68910. radius?: number;
  68911. tessellation?: number;
  68912. clip?: number;
  68913. arc?: number;
  68914. closed?: boolean;
  68915. updatable?: boolean;
  68916. sideOrientation?: number;
  68917. frontUVs?: Vector4;
  68918. backUVs?: Vector4;
  68919. cap?: number;
  68920. invertUV?: boolean;
  68921. }, scene?: Nullable<Scene>): Mesh;
  68922. }
  68923. }
  68924. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  68925. import { Nullable } from "babylonjs/types";
  68926. import { Scene } from "babylonjs/scene";
  68927. import { Vector4 } from "babylonjs/Maths/math.vector";
  68928. import { Mesh } from "babylonjs/Meshes/mesh";
  68929. /**
  68930. * Class containing static functions to help procedurally build meshes
  68931. */
  68932. export class TiledPlaneBuilder {
  68933. /**
  68934. * Creates a tiled plane mesh
  68935. * * The parameter `pattern` will, depending on value, do nothing or
  68936. * * * flip (reflect about central vertical) alternate tiles across and up
  68937. * * * flip every tile on alternate rows
  68938. * * * rotate (180 degs) alternate tiles across and up
  68939. * * * rotate every tile on alternate rows
  68940. * * * flip and rotate alternate tiles across and up
  68941. * * * flip and rotate every tile on alternate rows
  68942. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  68943. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  68944. * * 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
  68945. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68946. * * 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)
  68947. * * 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)
  68948. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68949. * @param name defines the name of the mesh
  68950. * @param options defines the options used to create the mesh
  68951. * @param scene defines the hosting scene
  68952. * @returns the box mesh
  68953. */
  68954. static CreateTiledPlane(name: string, options: {
  68955. pattern?: number;
  68956. tileSize?: number;
  68957. tileWidth?: number;
  68958. tileHeight?: number;
  68959. size?: number;
  68960. width?: number;
  68961. height?: number;
  68962. alignHorizontal?: number;
  68963. alignVertical?: number;
  68964. sideOrientation?: number;
  68965. frontUVs?: Vector4;
  68966. backUVs?: Vector4;
  68967. updatable?: boolean;
  68968. }, scene?: Nullable<Scene>): Mesh;
  68969. }
  68970. }
  68971. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  68972. import { Nullable } from "babylonjs/types";
  68973. import { Scene } from "babylonjs/scene";
  68974. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68975. import { Mesh } from "babylonjs/Meshes/mesh";
  68976. /**
  68977. * Class containing static functions to help procedurally build meshes
  68978. */
  68979. export class TubeBuilder {
  68980. /**
  68981. * Creates a tube mesh.
  68982. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68983. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  68984. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  68985. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  68986. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  68987. * * 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)
  68988. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  68989. * * 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
  68990. * * 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
  68991. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68992. * * 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
  68993. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68994. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68995. * @param name defines the name of the mesh
  68996. * @param options defines the options used to create the mesh
  68997. * @param scene defines the hosting scene
  68998. * @returns the tube mesh
  68999. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69000. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69001. */
  69002. static CreateTube(name: string, options: {
  69003. path: Vector3[];
  69004. radius?: number;
  69005. tessellation?: number;
  69006. radiusFunction?: {
  69007. (i: number, distance: number): number;
  69008. };
  69009. cap?: number;
  69010. arc?: number;
  69011. updatable?: boolean;
  69012. sideOrientation?: number;
  69013. frontUVs?: Vector4;
  69014. backUVs?: Vector4;
  69015. instance?: Mesh;
  69016. invertUV?: boolean;
  69017. }, scene?: Nullable<Scene>): Mesh;
  69018. }
  69019. }
  69020. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  69021. import { Scene } from "babylonjs/scene";
  69022. import { Vector4 } from "babylonjs/Maths/math.vector";
  69023. import { Mesh } from "babylonjs/Meshes/mesh";
  69024. import { Nullable } from "babylonjs/types";
  69025. /**
  69026. * Class containing static functions to help procedurally build meshes
  69027. */
  69028. export class IcoSphereBuilder {
  69029. /**
  69030. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69031. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69032. * * 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`)
  69033. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69034. * * 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
  69035. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69036. * * 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
  69037. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69038. * @param name defines the name of the mesh
  69039. * @param options defines the options used to create the mesh
  69040. * @param scene defines the hosting scene
  69041. * @returns the icosahedron mesh
  69042. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69043. */
  69044. static CreateIcoSphere(name: string, options: {
  69045. radius?: number;
  69046. radiusX?: number;
  69047. radiusY?: number;
  69048. radiusZ?: number;
  69049. flat?: boolean;
  69050. subdivisions?: number;
  69051. sideOrientation?: number;
  69052. frontUVs?: Vector4;
  69053. backUVs?: Vector4;
  69054. updatable?: boolean;
  69055. }, scene?: Nullable<Scene>): Mesh;
  69056. }
  69057. }
  69058. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  69059. import { Vector3 } from "babylonjs/Maths/math.vector";
  69060. import { Mesh } from "babylonjs/Meshes/mesh";
  69061. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69062. /**
  69063. * Class containing static functions to help procedurally build meshes
  69064. */
  69065. export class DecalBuilder {
  69066. /**
  69067. * Creates a decal mesh.
  69068. * 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
  69069. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69070. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69071. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69072. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69073. * @param name defines the name of the mesh
  69074. * @param sourceMesh defines the mesh where the decal must be applied
  69075. * @param options defines the options used to create the mesh
  69076. * @param scene defines the hosting scene
  69077. * @returns the decal mesh
  69078. * @see https://doc.babylonjs.com/how_to/decals
  69079. */
  69080. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69081. position?: Vector3;
  69082. normal?: Vector3;
  69083. size?: Vector3;
  69084. angle?: number;
  69085. }): Mesh;
  69086. }
  69087. }
  69088. declare module "babylonjs/Meshes/meshBuilder" {
  69089. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69090. import { Nullable } from "babylonjs/types";
  69091. import { Scene } from "babylonjs/scene";
  69092. import { Mesh } from "babylonjs/Meshes/mesh";
  69093. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69094. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69095. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69096. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69097. import { Plane } from "babylonjs/Maths/math.plane";
  69098. /**
  69099. * Class containing static functions to help procedurally build meshes
  69100. */
  69101. export class MeshBuilder {
  69102. /**
  69103. * Creates a box mesh
  69104. * * The parameter `size` sets the size (float) of each box side (default 1)
  69105. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69106. * * 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)
  69107. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69108. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69109. * * 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
  69110. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69111. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69112. * @param name defines the name of the mesh
  69113. * @param options defines the options used to create the mesh
  69114. * @param scene defines the hosting scene
  69115. * @returns the box mesh
  69116. */
  69117. static CreateBox(name: string, options: {
  69118. size?: number;
  69119. width?: number;
  69120. height?: number;
  69121. depth?: number;
  69122. faceUV?: Vector4[];
  69123. faceColors?: Color4[];
  69124. sideOrientation?: number;
  69125. frontUVs?: Vector4;
  69126. backUVs?: Vector4;
  69127. wrap?: boolean;
  69128. topBaseAt?: number;
  69129. bottomBaseAt?: number;
  69130. updatable?: boolean;
  69131. }, scene?: Nullable<Scene>): Mesh;
  69132. /**
  69133. * Creates a tiled box mesh
  69134. * * faceTiles sets the pattern, tile size and number of tiles for a face
  69135. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69136. * @param name defines the name of the mesh
  69137. * @param options defines the options used to create the mesh
  69138. * @param scene defines the hosting scene
  69139. * @returns the tiled box mesh
  69140. */
  69141. static CreateTiledBox(name: string, options: {
  69142. pattern?: number;
  69143. size?: number;
  69144. width?: number;
  69145. height?: number;
  69146. depth: number;
  69147. tileSize?: number;
  69148. tileWidth?: number;
  69149. tileHeight?: number;
  69150. faceUV?: Vector4[];
  69151. faceColors?: Color4[];
  69152. alignHorizontal?: number;
  69153. alignVertical?: number;
  69154. sideOrientation?: number;
  69155. updatable?: boolean;
  69156. }, scene?: Nullable<Scene>): Mesh;
  69157. /**
  69158. * Creates a sphere mesh
  69159. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  69160. * * 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`)
  69161. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  69162. * * 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
  69163. * * 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)
  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 sphere mesh
  69171. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  69172. */
  69173. static CreateSphere(name: string, options: {
  69174. segments?: number;
  69175. diameter?: number;
  69176. diameterX?: number;
  69177. diameterY?: number;
  69178. diameterZ?: number;
  69179. arc?: number;
  69180. slice?: number;
  69181. sideOrientation?: number;
  69182. frontUVs?: Vector4;
  69183. backUVs?: Vector4;
  69184. updatable?: boolean;
  69185. }, scene?: Nullable<Scene>): Mesh;
  69186. /**
  69187. * Creates a plane polygonal mesh. By default, this is a disc
  69188. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  69189. * * 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
  69190. * * 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
  69191. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69192. * * 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
  69193. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69194. * @param name defines the name of the mesh
  69195. * @param options defines the options used to create the mesh
  69196. * @param scene defines the hosting scene
  69197. * @returns the plane polygonal mesh
  69198. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  69199. */
  69200. static CreateDisc(name: string, options: {
  69201. radius?: number;
  69202. tessellation?: number;
  69203. arc?: number;
  69204. updatable?: boolean;
  69205. sideOrientation?: number;
  69206. frontUVs?: Vector4;
  69207. backUVs?: Vector4;
  69208. }, scene?: Nullable<Scene>): Mesh;
  69209. /**
  69210. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69211. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69212. * * 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`)
  69213. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69214. * * 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
  69215. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69216. * * 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
  69217. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69218. * @param name defines the name of the mesh
  69219. * @param options defines the options used to create the mesh
  69220. * @param scene defines the hosting scene
  69221. * @returns the icosahedron mesh
  69222. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69223. */
  69224. static CreateIcoSphere(name: string, options: {
  69225. radius?: number;
  69226. radiusX?: number;
  69227. radiusY?: number;
  69228. radiusZ?: number;
  69229. flat?: boolean;
  69230. subdivisions?: number;
  69231. sideOrientation?: number;
  69232. frontUVs?: Vector4;
  69233. backUVs?: Vector4;
  69234. updatable?: boolean;
  69235. }, scene?: Nullable<Scene>): Mesh;
  69236. /**
  69237. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69238. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  69239. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  69240. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  69241. * * 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
  69242. * * 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
  69243. * * 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
  69244. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69245. * * 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
  69246. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69247. * * 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
  69248. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  69249. * * 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
  69250. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  69251. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69252. * @param name defines the name of the mesh
  69253. * @param options defines the options used to create the mesh
  69254. * @param scene defines the hosting scene
  69255. * @returns the ribbon mesh
  69256. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  69257. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69258. */
  69259. static CreateRibbon(name: string, options: {
  69260. pathArray: Vector3[][];
  69261. closeArray?: boolean;
  69262. closePath?: boolean;
  69263. offset?: number;
  69264. updatable?: boolean;
  69265. sideOrientation?: number;
  69266. frontUVs?: Vector4;
  69267. backUVs?: Vector4;
  69268. instance?: Mesh;
  69269. invertUV?: boolean;
  69270. uvs?: Vector2[];
  69271. colors?: Color4[];
  69272. }, scene?: Nullable<Scene>): Mesh;
  69273. /**
  69274. * Creates a cylinder or a cone mesh
  69275. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  69276. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  69277. * * 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.
  69278. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  69279. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  69280. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  69281. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  69282. * * 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).
  69283. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  69284. * * 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).
  69285. * * 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
  69286. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  69287. * * 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
  69288. * * 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.
  69289. * * If `enclose` is false, a ring surface is one element.
  69290. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  69291. * * 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
  69292. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69293. * * 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
  69294. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69295. * @param name defines the name of the mesh
  69296. * @param options defines the options used to create the mesh
  69297. * @param scene defines the hosting scene
  69298. * @returns the cylinder mesh
  69299. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  69300. */
  69301. static CreateCylinder(name: string, options: {
  69302. height?: number;
  69303. diameterTop?: number;
  69304. diameterBottom?: number;
  69305. diameter?: number;
  69306. tessellation?: number;
  69307. subdivisions?: number;
  69308. arc?: number;
  69309. faceColors?: Color4[];
  69310. faceUV?: Vector4[];
  69311. updatable?: boolean;
  69312. hasRings?: boolean;
  69313. enclose?: boolean;
  69314. cap?: number;
  69315. sideOrientation?: number;
  69316. frontUVs?: Vector4;
  69317. backUVs?: Vector4;
  69318. }, scene?: Nullable<Scene>): Mesh;
  69319. /**
  69320. * Creates a torus mesh
  69321. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  69322. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  69323. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  69324. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69325. * * 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
  69326. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69327. * @param name defines the name of the mesh
  69328. * @param options defines the options used to create the mesh
  69329. * @param scene defines the hosting scene
  69330. * @returns the torus mesh
  69331. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  69332. */
  69333. static CreateTorus(name: string, options: {
  69334. diameter?: number;
  69335. thickness?: number;
  69336. tessellation?: number;
  69337. updatable?: boolean;
  69338. sideOrientation?: number;
  69339. frontUVs?: Vector4;
  69340. backUVs?: Vector4;
  69341. }, scene?: Nullable<Scene>): Mesh;
  69342. /**
  69343. * Creates a torus knot mesh
  69344. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69345. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69346. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69347. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69348. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69349. * * 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
  69350. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69351. * @param name defines the name of the mesh
  69352. * @param options defines the options used to create the mesh
  69353. * @param scene defines the hosting scene
  69354. * @returns the torus knot mesh
  69355. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69356. */
  69357. static CreateTorusKnot(name: string, options: {
  69358. radius?: number;
  69359. tube?: number;
  69360. radialSegments?: number;
  69361. tubularSegments?: number;
  69362. p?: number;
  69363. q?: number;
  69364. updatable?: boolean;
  69365. sideOrientation?: number;
  69366. frontUVs?: Vector4;
  69367. backUVs?: Vector4;
  69368. }, scene?: Nullable<Scene>): Mesh;
  69369. /**
  69370. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  69371. * * 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
  69372. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  69373. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  69374. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  69375. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  69376. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  69377. * * 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
  69378. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  69379. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69380. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  69381. * @param name defines the name of the new line system
  69382. * @param options defines the options used to create the line system
  69383. * @param scene defines the hosting scene
  69384. * @returns a new line system mesh
  69385. */
  69386. static CreateLineSystem(name: string, options: {
  69387. lines: Vector3[][];
  69388. updatable?: boolean;
  69389. instance?: Nullable<LinesMesh>;
  69390. colors?: Nullable<Color4[][]>;
  69391. useVertexAlpha?: boolean;
  69392. }, scene: Nullable<Scene>): LinesMesh;
  69393. /**
  69394. * Creates a line mesh
  69395. * 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
  69396. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69397. * * The parameter `points` is an array successive Vector3
  69398. * * 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
  69399. * * The optional parameter `colors` is an array of successive Color4, one per line point
  69400. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  69401. * * When updating an instance, remember that only point positions can change, not the number of points
  69402. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69403. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  69404. * @param name defines the name of the new line system
  69405. * @param options defines the options used to create the line system
  69406. * @param scene defines the hosting scene
  69407. * @returns a new line mesh
  69408. */
  69409. static CreateLines(name: string, options: {
  69410. points: Vector3[];
  69411. updatable?: boolean;
  69412. instance?: Nullable<LinesMesh>;
  69413. colors?: Color4[];
  69414. useVertexAlpha?: boolean;
  69415. }, scene?: Nullable<Scene>): LinesMesh;
  69416. /**
  69417. * Creates a dashed line mesh
  69418. * * 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
  69419. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69420. * * The parameter `points` is an array successive Vector3
  69421. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  69422. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  69423. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  69424. * * 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
  69425. * * When updating an instance, remember that only point positions can change, not the number of points
  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 dashed line mesh
  69431. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69432. */
  69433. static CreateDashedLines(name: string, options: {
  69434. points: Vector3[];
  69435. dashSize?: number;
  69436. gapSize?: number;
  69437. dashNb?: number;
  69438. updatable?: boolean;
  69439. instance?: LinesMesh;
  69440. }, scene?: Nullable<Scene>): LinesMesh;
  69441. /**
  69442. * 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.
  69443. * * 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.
  69444. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69445. * * 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.
  69446. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69447. * * 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
  69448. * * 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
  69449. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69450. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69451. * * 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
  69452. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69453. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69454. * @param name defines the name of the mesh
  69455. * @param options defines the options used to create the mesh
  69456. * @param scene defines the hosting scene
  69457. * @returns the extruded shape mesh
  69458. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69459. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69460. */
  69461. static ExtrudeShape(name: string, options: {
  69462. shape: Vector3[];
  69463. path: Vector3[];
  69464. scale?: number;
  69465. rotation?: number;
  69466. cap?: number;
  69467. updatable?: boolean;
  69468. sideOrientation?: number;
  69469. frontUVs?: Vector4;
  69470. backUVs?: Vector4;
  69471. instance?: Mesh;
  69472. invertUV?: boolean;
  69473. }, scene?: Nullable<Scene>): Mesh;
  69474. /**
  69475. * Creates an custom extruded shape mesh.
  69476. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69477. * * 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.
  69478. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69479. * * 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
  69480. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69481. * * 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
  69482. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69483. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69484. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69485. * * 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
  69486. * * 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
  69487. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69488. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69489. * * 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
  69490. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69491. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69492. * @param name defines the name of the mesh
  69493. * @param options defines the options used to create the mesh
  69494. * @param scene defines the hosting scene
  69495. * @returns the custom extruded shape mesh
  69496. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69497. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69498. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69499. */
  69500. static ExtrudeShapeCustom(name: string, options: {
  69501. shape: Vector3[];
  69502. path: Vector3[];
  69503. scaleFunction?: any;
  69504. rotationFunction?: any;
  69505. ribbonCloseArray?: boolean;
  69506. ribbonClosePath?: boolean;
  69507. cap?: number;
  69508. updatable?: boolean;
  69509. sideOrientation?: number;
  69510. frontUVs?: Vector4;
  69511. backUVs?: Vector4;
  69512. instance?: Mesh;
  69513. invertUV?: boolean;
  69514. }, scene?: Nullable<Scene>): Mesh;
  69515. /**
  69516. * Creates lathe mesh.
  69517. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69518. * * 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
  69519. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69520. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69521. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69522. * * 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
  69523. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69524. * * 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
  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 optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69528. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69529. * @param name defines the name of the mesh
  69530. * @param options defines the options used to create the mesh
  69531. * @param scene defines the hosting scene
  69532. * @returns the lathe mesh
  69533. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69534. */
  69535. static CreateLathe(name: string, options: {
  69536. shape: Vector3[];
  69537. radius?: number;
  69538. tessellation?: number;
  69539. clip?: number;
  69540. arc?: number;
  69541. closed?: boolean;
  69542. updatable?: boolean;
  69543. sideOrientation?: number;
  69544. frontUVs?: Vector4;
  69545. backUVs?: Vector4;
  69546. cap?: number;
  69547. invertUV?: boolean;
  69548. }, scene?: Nullable<Scene>): Mesh;
  69549. /**
  69550. * Creates a tiled plane mesh
  69551. * * You can set a limited pattern arrangement with the tiles
  69552. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69553. * * 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
  69554. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69555. * @param name defines the name of the mesh
  69556. * @param options defines the options used to create the mesh
  69557. * @param scene defines the hosting scene
  69558. * @returns the plane mesh
  69559. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69560. */
  69561. static CreateTiledPlane(name: string, options: {
  69562. pattern?: number;
  69563. tileSize?: number;
  69564. tileWidth?: number;
  69565. tileHeight?: number;
  69566. size?: number;
  69567. width?: number;
  69568. height?: number;
  69569. alignHorizontal?: number;
  69570. alignVertical?: number;
  69571. sideOrientation?: number;
  69572. frontUVs?: Vector4;
  69573. backUVs?: Vector4;
  69574. updatable?: boolean;
  69575. }, scene?: Nullable<Scene>): Mesh;
  69576. /**
  69577. * Creates a plane mesh
  69578. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69579. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69580. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69581. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69582. * * 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
  69583. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69584. * @param name defines the name of the mesh
  69585. * @param options defines the options used to create the mesh
  69586. * @param scene defines the hosting scene
  69587. * @returns the plane mesh
  69588. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69589. */
  69590. static CreatePlane(name: string, options: {
  69591. size?: number;
  69592. width?: number;
  69593. height?: number;
  69594. sideOrientation?: number;
  69595. frontUVs?: Vector4;
  69596. backUVs?: Vector4;
  69597. updatable?: boolean;
  69598. sourcePlane?: Plane;
  69599. }, scene?: Nullable<Scene>): Mesh;
  69600. /**
  69601. * Creates a ground mesh
  69602. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69603. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  69604. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69605. * @param name defines the name of the mesh
  69606. * @param options defines the options used to create the mesh
  69607. * @param scene defines the hosting scene
  69608. * @returns the ground mesh
  69609. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69610. */
  69611. static CreateGround(name: string, options: {
  69612. width?: number;
  69613. height?: number;
  69614. subdivisions?: number;
  69615. subdivisionsX?: number;
  69616. subdivisionsY?: number;
  69617. updatable?: boolean;
  69618. }, scene?: Nullable<Scene>): Mesh;
  69619. /**
  69620. * Creates a tiled ground mesh
  69621. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69622. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69623. * * 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
  69624. * * 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
  69625. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69626. * @param name defines the name of the mesh
  69627. * @param options defines the options used to create the mesh
  69628. * @param scene defines the hosting scene
  69629. * @returns the tiled ground mesh
  69630. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69631. */
  69632. static CreateTiledGround(name: string, options: {
  69633. xmin: number;
  69634. zmin: number;
  69635. xmax: number;
  69636. zmax: number;
  69637. subdivisions?: {
  69638. w: number;
  69639. h: number;
  69640. };
  69641. precision?: {
  69642. w: number;
  69643. h: number;
  69644. };
  69645. updatable?: boolean;
  69646. }, scene?: Nullable<Scene>): Mesh;
  69647. /**
  69648. * Creates a ground mesh from a height map
  69649. * * The parameter `url` sets the URL of the height map image resource.
  69650. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69651. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69652. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69653. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69654. * * 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.
  69655. * * 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).
  69656. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69657. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69658. * @param name defines the name of the mesh
  69659. * @param url defines the url to the height map
  69660. * @param options defines the options used to create the mesh
  69661. * @param scene defines the hosting scene
  69662. * @returns the ground mesh
  69663. * @see https://doc.babylonjs.com/babylon101/height_map
  69664. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69665. */
  69666. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69667. width?: number;
  69668. height?: number;
  69669. subdivisions?: number;
  69670. minHeight?: number;
  69671. maxHeight?: number;
  69672. colorFilter?: Color3;
  69673. alphaFilter?: number;
  69674. updatable?: boolean;
  69675. onReady?: (mesh: GroundMesh) => void;
  69676. }, scene?: Nullable<Scene>): GroundMesh;
  69677. /**
  69678. * Creates a polygon mesh
  69679. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69680. * * 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
  69681. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69682. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69683. * * 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)
  69684. * * Remember you can only change the shape positions, not their number when updating a polygon
  69685. * @param name defines the name of the mesh
  69686. * @param options defines the options used to create the mesh
  69687. * @param scene defines the hosting scene
  69688. * @param earcutInjection can be used to inject your own earcut reference
  69689. * @returns the polygon mesh
  69690. */
  69691. static CreatePolygon(name: string, options: {
  69692. shape: Vector3[];
  69693. holes?: Vector3[][];
  69694. depth?: number;
  69695. faceUV?: Vector4[];
  69696. faceColors?: Color4[];
  69697. updatable?: boolean;
  69698. sideOrientation?: number;
  69699. frontUVs?: Vector4;
  69700. backUVs?: Vector4;
  69701. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69702. /**
  69703. * Creates an extruded polygon mesh, with depth in the Y direction.
  69704. * * 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)
  69705. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69706. * @param name defines the name of the mesh
  69707. * @param options defines the options used to create the mesh
  69708. * @param scene defines the hosting scene
  69709. * @param earcutInjection can be used to inject your own earcut reference
  69710. * @returns the polygon mesh
  69711. */
  69712. static ExtrudePolygon(name: string, options: {
  69713. shape: Vector3[];
  69714. holes?: Vector3[][];
  69715. depth?: number;
  69716. faceUV?: Vector4[];
  69717. faceColors?: Color4[];
  69718. updatable?: boolean;
  69719. sideOrientation?: number;
  69720. frontUVs?: Vector4;
  69721. backUVs?: Vector4;
  69722. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69723. /**
  69724. * Creates a tube mesh.
  69725. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69726. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69727. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69728. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69729. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69730. * * 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)
  69731. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69732. * * 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
  69733. * * 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
  69734. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69735. * * 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
  69736. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69737. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69738. * @param name defines the name of the mesh
  69739. * @param options defines the options used to create the mesh
  69740. * @param scene defines the hosting scene
  69741. * @returns the tube mesh
  69742. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69743. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69744. */
  69745. static CreateTube(name: string, options: {
  69746. path: Vector3[];
  69747. radius?: number;
  69748. tessellation?: number;
  69749. radiusFunction?: {
  69750. (i: number, distance: number): number;
  69751. };
  69752. cap?: number;
  69753. arc?: number;
  69754. updatable?: boolean;
  69755. sideOrientation?: number;
  69756. frontUVs?: Vector4;
  69757. backUVs?: Vector4;
  69758. instance?: Mesh;
  69759. invertUV?: boolean;
  69760. }, scene?: Nullable<Scene>): Mesh;
  69761. /**
  69762. * Creates a polyhedron mesh
  69763. * * 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
  69764. * * The parameter `size` (positive float, default 1) sets the polygon size
  69765. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69766. * * 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`
  69767. * * 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
  69768. * * 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)`)
  69769. * * 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
  69770. * * 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
  69771. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69772. * * 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
  69773. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69774. * @param name defines the name of the mesh
  69775. * @param options defines the options used to create the mesh
  69776. * @param scene defines the hosting scene
  69777. * @returns the polyhedron mesh
  69778. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  69779. */
  69780. static CreatePolyhedron(name: string, options: {
  69781. type?: number;
  69782. size?: number;
  69783. sizeX?: number;
  69784. sizeY?: number;
  69785. sizeZ?: number;
  69786. custom?: any;
  69787. faceUV?: Vector4[];
  69788. faceColors?: Color4[];
  69789. flat?: boolean;
  69790. updatable?: boolean;
  69791. sideOrientation?: number;
  69792. frontUVs?: Vector4;
  69793. backUVs?: Vector4;
  69794. }, scene?: Nullable<Scene>): Mesh;
  69795. /**
  69796. * Creates a decal mesh.
  69797. * 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
  69798. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69799. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69800. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69801. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69802. * @param name defines the name of the mesh
  69803. * @param sourceMesh defines the mesh where the decal must be applied
  69804. * @param options defines the options used to create the mesh
  69805. * @param scene defines the hosting scene
  69806. * @returns the decal mesh
  69807. * @see https://doc.babylonjs.com/how_to/decals
  69808. */
  69809. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69810. position?: Vector3;
  69811. normal?: Vector3;
  69812. size?: Vector3;
  69813. angle?: number;
  69814. }): Mesh;
  69815. }
  69816. }
  69817. declare module "babylonjs/Meshes/meshSimplification" {
  69818. import { Mesh } from "babylonjs/Meshes/mesh";
  69819. /**
  69820. * A simplifier interface for future simplification implementations
  69821. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69822. */
  69823. export interface ISimplifier {
  69824. /**
  69825. * Simplification of a given mesh according to the given settings.
  69826. * Since this requires computation, it is assumed that the function runs async.
  69827. * @param settings The settings of the simplification, including quality and distance
  69828. * @param successCallback A callback that will be called after the mesh was simplified.
  69829. * @param errorCallback in case of an error, this callback will be called. optional.
  69830. */
  69831. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  69832. }
  69833. /**
  69834. * Expected simplification settings.
  69835. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  69836. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69837. */
  69838. export interface ISimplificationSettings {
  69839. /**
  69840. * Gets or sets the expected quality
  69841. */
  69842. quality: number;
  69843. /**
  69844. * Gets or sets the distance when this optimized version should be used
  69845. */
  69846. distance: number;
  69847. /**
  69848. * Gets an already optimized mesh
  69849. */
  69850. optimizeMesh?: boolean;
  69851. }
  69852. /**
  69853. * Class used to specify simplification options
  69854. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69855. */
  69856. export class SimplificationSettings implements ISimplificationSettings {
  69857. /** expected quality */
  69858. quality: number;
  69859. /** distance when this optimized version should be used */
  69860. distance: number;
  69861. /** already optimized mesh */
  69862. optimizeMesh?: boolean | undefined;
  69863. /**
  69864. * Creates a SimplificationSettings
  69865. * @param quality expected quality
  69866. * @param distance distance when this optimized version should be used
  69867. * @param optimizeMesh already optimized mesh
  69868. */
  69869. constructor(
  69870. /** expected quality */
  69871. quality: number,
  69872. /** distance when this optimized version should be used */
  69873. distance: number,
  69874. /** already optimized mesh */
  69875. optimizeMesh?: boolean | undefined);
  69876. }
  69877. /**
  69878. * Interface used to define a simplification task
  69879. */
  69880. export interface ISimplificationTask {
  69881. /**
  69882. * Array of settings
  69883. */
  69884. settings: Array<ISimplificationSettings>;
  69885. /**
  69886. * Simplification type
  69887. */
  69888. simplificationType: SimplificationType;
  69889. /**
  69890. * Mesh to simplify
  69891. */
  69892. mesh: Mesh;
  69893. /**
  69894. * Callback called on success
  69895. */
  69896. successCallback?: () => void;
  69897. /**
  69898. * Defines if parallel processing can be used
  69899. */
  69900. parallelProcessing: boolean;
  69901. }
  69902. /**
  69903. * Queue used to order the simplification tasks
  69904. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69905. */
  69906. export class SimplificationQueue {
  69907. private _simplificationArray;
  69908. /**
  69909. * Gets a boolean indicating that the process is still running
  69910. */
  69911. running: boolean;
  69912. /**
  69913. * Creates a new queue
  69914. */
  69915. constructor();
  69916. /**
  69917. * Adds a new simplification task
  69918. * @param task defines a task to add
  69919. */
  69920. addTask(task: ISimplificationTask): void;
  69921. /**
  69922. * Execute next task
  69923. */
  69924. executeNext(): void;
  69925. /**
  69926. * Execute a simplification task
  69927. * @param task defines the task to run
  69928. */
  69929. runSimplification(task: ISimplificationTask): void;
  69930. private getSimplifier;
  69931. }
  69932. /**
  69933. * The implemented types of simplification
  69934. * At the moment only Quadratic Error Decimation is implemented
  69935. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69936. */
  69937. export enum SimplificationType {
  69938. /** Quadratic error decimation */
  69939. QUADRATIC = 0
  69940. }
  69941. /**
  69942. * An implementation of the Quadratic Error simplification algorithm.
  69943. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  69944. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  69945. * @author RaananW
  69946. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69947. */
  69948. export class QuadraticErrorSimplification implements ISimplifier {
  69949. private _mesh;
  69950. private triangles;
  69951. private vertices;
  69952. private references;
  69953. private _reconstructedMesh;
  69954. /** Gets or sets the number pf sync interations */
  69955. syncIterations: number;
  69956. /** Gets or sets the aggressiveness of the simplifier */
  69957. aggressiveness: number;
  69958. /** Gets or sets the number of allowed iterations for decimation */
  69959. decimationIterations: number;
  69960. /** Gets or sets the espilon to use for bounding box computation */
  69961. boundingBoxEpsilon: number;
  69962. /**
  69963. * Creates a new QuadraticErrorSimplification
  69964. * @param _mesh defines the target mesh
  69965. */
  69966. constructor(_mesh: Mesh);
  69967. /**
  69968. * Simplification of a given mesh according to the given settings.
  69969. * Since this requires computation, it is assumed that the function runs async.
  69970. * @param settings The settings of the simplification, including quality and distance
  69971. * @param successCallback A callback that will be called after the mesh was simplified.
  69972. */
  69973. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  69974. private runDecimation;
  69975. private initWithMesh;
  69976. private init;
  69977. private reconstructMesh;
  69978. private initDecimatedMesh;
  69979. private isFlipped;
  69980. private updateTriangles;
  69981. private identifyBorder;
  69982. private updateMesh;
  69983. private vertexError;
  69984. private calculateError;
  69985. }
  69986. }
  69987. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  69988. import { Scene } from "babylonjs/scene";
  69989. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  69990. import { ISceneComponent } from "babylonjs/sceneComponent";
  69991. module "babylonjs/scene" {
  69992. interface Scene {
  69993. /** @hidden (Backing field) */
  69994. _simplificationQueue: SimplificationQueue;
  69995. /**
  69996. * Gets or sets the simplification queue attached to the scene
  69997. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69998. */
  69999. simplificationQueue: SimplificationQueue;
  70000. }
  70001. }
  70002. module "babylonjs/Meshes/mesh" {
  70003. interface Mesh {
  70004. /**
  70005. * Simplify the mesh according to the given array of settings.
  70006. * Function will return immediately and will simplify async
  70007. * @param settings a collection of simplification settings
  70008. * @param parallelProcessing should all levels calculate parallel or one after the other
  70009. * @param simplificationType the type of simplification to run
  70010. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  70011. * @returns the current mesh
  70012. */
  70013. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  70014. }
  70015. }
  70016. /**
  70017. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  70018. * created in a scene
  70019. */
  70020. export class SimplicationQueueSceneComponent implements ISceneComponent {
  70021. /**
  70022. * The component name helpfull to identify the component in the list of scene components.
  70023. */
  70024. readonly name: string;
  70025. /**
  70026. * The scene the component belongs to.
  70027. */
  70028. scene: Scene;
  70029. /**
  70030. * Creates a new instance of the component for the given scene
  70031. * @param scene Defines the scene to register the component in
  70032. */
  70033. constructor(scene: Scene);
  70034. /**
  70035. * Registers the component in a given scene
  70036. */
  70037. register(): void;
  70038. /**
  70039. * Rebuilds the elements related to this component in case of
  70040. * context lost for instance.
  70041. */
  70042. rebuild(): void;
  70043. /**
  70044. * Disposes the component and the associated ressources
  70045. */
  70046. dispose(): void;
  70047. private _beforeCameraUpdate;
  70048. }
  70049. }
  70050. declare module "babylonjs/Meshes/Builders/index" {
  70051. export * from "babylonjs/Meshes/Builders/boxBuilder";
  70052. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  70053. export * from "babylonjs/Meshes/Builders/discBuilder";
  70054. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  70055. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  70056. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  70057. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  70058. export * from "babylonjs/Meshes/Builders/torusBuilder";
  70059. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  70060. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70061. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70062. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70063. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70064. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70065. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70066. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70067. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70068. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70069. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70070. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70071. }
  70072. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70073. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70074. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70075. import { Matrix } from "babylonjs/Maths/math.vector";
  70076. module "babylonjs/Meshes/mesh" {
  70077. interface Mesh {
  70078. /**
  70079. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70080. */
  70081. thinInstanceEnablePicking: boolean;
  70082. /**
  70083. * Creates a new thin instance
  70084. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70085. * @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
  70086. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70087. */
  70088. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70089. /**
  70090. * Adds the transformation (matrix) of the current mesh as a thin instance
  70091. * @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
  70092. * @returns the thin instance index number
  70093. */
  70094. thinInstanceAddSelf(refresh: boolean): number;
  70095. /**
  70096. * Registers a custom attribute to be used with thin instances
  70097. * @param kind name of the attribute
  70098. * @param stride size in floats of the attribute
  70099. */
  70100. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70101. /**
  70102. * Sets the matrix of a thin instance
  70103. * @param index index of the thin instance
  70104. * @param matrix matrix to set
  70105. * @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
  70106. */
  70107. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70108. /**
  70109. * Sets the value of a custom attribute for a thin instance
  70110. * @param kind name of the attribute
  70111. * @param index index of the thin instance
  70112. * @param value value to set
  70113. * @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
  70114. */
  70115. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  70116. /**
  70117. * 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.
  70118. */
  70119. thinInstanceCount: number;
  70120. /**
  70121. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  70122. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  70123. * @param buffer buffer to set
  70124. * @param stride size in floats of each value of the buffer
  70125. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  70126. */
  70127. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  70128. /**
  70129. * Gets the list of world matrices
  70130. * @return an array containing all the world matrices from the thin instances
  70131. */
  70132. thinInstanceGetWorldMatrices(): Matrix[];
  70133. /**
  70134. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  70135. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70136. */
  70137. thinInstanceBufferUpdated(kind: string): void;
  70138. /**
  70139. * Applies a partial update to a buffer directly on the GPU
  70140. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  70141. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70142. * @param data the data to set in the GPU buffer
  70143. * @param offset the offset in the GPU buffer where to update the data
  70144. */
  70145. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  70146. /**
  70147. * Refreshes the bounding info, taking into account all the thin instances defined
  70148. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  70149. */
  70150. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  70151. /** @hidden */
  70152. _thinInstanceInitializeUserStorage(): void;
  70153. /** @hidden */
  70154. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  70155. /** @hidden */
  70156. _userThinInstanceBuffersStorage: {
  70157. data: {
  70158. [key: string]: Float32Array;
  70159. };
  70160. sizes: {
  70161. [key: string]: number;
  70162. };
  70163. vertexBuffers: {
  70164. [key: string]: Nullable<VertexBuffer>;
  70165. };
  70166. strides: {
  70167. [key: string]: number;
  70168. };
  70169. };
  70170. }
  70171. }
  70172. }
  70173. declare module "babylonjs/Meshes/index" {
  70174. export * from "babylonjs/Meshes/abstractMesh";
  70175. export * from "babylonjs/Meshes/buffer";
  70176. export * from "babylonjs/Meshes/Compression/index";
  70177. export * from "babylonjs/Meshes/csg";
  70178. export * from "babylonjs/Meshes/geometry";
  70179. export * from "babylonjs/Meshes/groundMesh";
  70180. export * from "babylonjs/Meshes/trailMesh";
  70181. export * from "babylonjs/Meshes/instancedMesh";
  70182. export * from "babylonjs/Meshes/linesMesh";
  70183. export * from "babylonjs/Meshes/mesh";
  70184. export * from "babylonjs/Meshes/mesh.vertexData";
  70185. export * from "babylonjs/Meshes/meshBuilder";
  70186. export * from "babylonjs/Meshes/meshSimplification";
  70187. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  70188. export * from "babylonjs/Meshes/polygonMesh";
  70189. export * from "babylonjs/Meshes/subMesh";
  70190. export * from "babylonjs/Meshes/meshLODLevel";
  70191. export * from "babylonjs/Meshes/transformNode";
  70192. export * from "babylonjs/Meshes/Builders/index";
  70193. export * from "babylonjs/Meshes/dataBuffer";
  70194. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  70195. import "babylonjs/Meshes/thinInstanceMesh";
  70196. export * from "babylonjs/Meshes/thinInstanceMesh";
  70197. }
  70198. declare module "babylonjs/Morph/index" {
  70199. export * from "babylonjs/Morph/morphTarget";
  70200. export * from "babylonjs/Morph/morphTargetManager";
  70201. }
  70202. declare module "babylonjs/Navigation/INavigationEngine" {
  70203. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70204. import { Vector3 } from "babylonjs/Maths/math";
  70205. import { Mesh } from "babylonjs/Meshes/mesh";
  70206. import { Scene } from "babylonjs/scene";
  70207. /**
  70208. * Navigation plugin interface to add navigation constrained by a navigation mesh
  70209. */
  70210. export interface INavigationEnginePlugin {
  70211. /**
  70212. * plugin name
  70213. */
  70214. name: string;
  70215. /**
  70216. * Creates a navigation mesh
  70217. * @param meshes array of all the geometry used to compute the navigatio mesh
  70218. * @param parameters bunch of parameters used to filter geometry
  70219. */
  70220. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70221. /**
  70222. * Create a navigation mesh debug mesh
  70223. * @param scene is where the mesh will be added
  70224. * @returns debug display mesh
  70225. */
  70226. createDebugNavMesh(scene: Scene): Mesh;
  70227. /**
  70228. * Get a navigation mesh constrained position, closest to the parameter position
  70229. * @param position world position
  70230. * @returns the closest point to position constrained by the navigation mesh
  70231. */
  70232. getClosestPoint(position: Vector3): Vector3;
  70233. /**
  70234. * Get a navigation mesh constrained position, closest to the parameter position
  70235. * @param position world position
  70236. * @param result output the closest point to position constrained by the navigation mesh
  70237. */
  70238. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70239. /**
  70240. * Get a navigation mesh constrained position, within a particular radius
  70241. * @param position world position
  70242. * @param maxRadius the maximum distance to the constrained world position
  70243. * @returns the closest point to position constrained by the navigation mesh
  70244. */
  70245. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70246. /**
  70247. * Get a navigation mesh constrained position, within a particular radius
  70248. * @param position world position
  70249. * @param maxRadius the maximum distance to the constrained world position
  70250. * @param result output the closest point to position constrained by the navigation mesh
  70251. */
  70252. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70253. /**
  70254. * Compute the final position from a segment made of destination-position
  70255. * @param position world position
  70256. * @param destination world position
  70257. * @returns the resulting point along the navmesh
  70258. */
  70259. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70260. /**
  70261. * Compute the final position from a segment made of destination-position
  70262. * @param position world position
  70263. * @param destination world position
  70264. * @param result output the resulting point along the navmesh
  70265. */
  70266. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70267. /**
  70268. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70269. * @param start world position
  70270. * @param end world position
  70271. * @returns array containing world position composing the path
  70272. */
  70273. computePath(start: Vector3, end: Vector3): Vector3[];
  70274. /**
  70275. * If this plugin is supported
  70276. * @returns true if plugin is supported
  70277. */
  70278. isSupported(): boolean;
  70279. /**
  70280. * Create a new Crowd so you can add agents
  70281. * @param maxAgents the maximum agent count in the crowd
  70282. * @param maxAgentRadius the maximum radius an agent can have
  70283. * @param scene to attach the crowd to
  70284. * @returns the crowd you can add agents to
  70285. */
  70286. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70287. /**
  70288. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70289. * The queries will try to find a solution within those bounds
  70290. * default is (1,1,1)
  70291. * @param extent x,y,z value that define the extent around the queries point of reference
  70292. */
  70293. setDefaultQueryExtent(extent: Vector3): void;
  70294. /**
  70295. * Get the Bounding box extent specified by setDefaultQueryExtent
  70296. * @returns the box extent values
  70297. */
  70298. getDefaultQueryExtent(): Vector3;
  70299. /**
  70300. * build the navmesh from a previously saved state using getNavmeshData
  70301. * @param data the Uint8Array returned by getNavmeshData
  70302. */
  70303. buildFromNavmeshData(data: Uint8Array): void;
  70304. /**
  70305. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70306. * @returns data the Uint8Array that can be saved and reused
  70307. */
  70308. getNavmeshData(): Uint8Array;
  70309. /**
  70310. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70311. * @param result output the box extent values
  70312. */
  70313. getDefaultQueryExtentToRef(result: Vector3): void;
  70314. /**
  70315. * Release all resources
  70316. */
  70317. dispose(): void;
  70318. }
  70319. /**
  70320. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  70321. */
  70322. export interface ICrowd {
  70323. /**
  70324. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70325. * You can attach anything to that node. The node position is updated in the scene update tick.
  70326. * @param pos world position that will be constrained by the navigation mesh
  70327. * @param parameters agent parameters
  70328. * @param transform hooked to the agent that will be update by the scene
  70329. * @returns agent index
  70330. */
  70331. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70332. /**
  70333. * Returns the agent position in world space
  70334. * @param index agent index returned by addAgent
  70335. * @returns world space position
  70336. */
  70337. getAgentPosition(index: number): Vector3;
  70338. /**
  70339. * Gets the agent position result in world space
  70340. * @param index agent index returned by addAgent
  70341. * @param result output world space position
  70342. */
  70343. getAgentPositionToRef(index: number, result: Vector3): void;
  70344. /**
  70345. * Gets the agent velocity in world space
  70346. * @param index agent index returned by addAgent
  70347. * @returns world space velocity
  70348. */
  70349. getAgentVelocity(index: number): Vector3;
  70350. /**
  70351. * Gets the agent velocity result in world space
  70352. * @param index agent index returned by addAgent
  70353. * @param result output world space velocity
  70354. */
  70355. getAgentVelocityToRef(index: number, result: Vector3): void;
  70356. /**
  70357. * remove a particular agent previously created
  70358. * @param index agent index returned by addAgent
  70359. */
  70360. removeAgent(index: number): void;
  70361. /**
  70362. * get the list of all agents attached to this crowd
  70363. * @returns list of agent indices
  70364. */
  70365. getAgents(): number[];
  70366. /**
  70367. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70368. * @param deltaTime in seconds
  70369. */
  70370. update(deltaTime: number): void;
  70371. /**
  70372. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70373. * @param index agent index returned by addAgent
  70374. * @param destination targeted world position
  70375. */
  70376. agentGoto(index: number, destination: Vector3): void;
  70377. /**
  70378. * Teleport the agent to a new position
  70379. * @param index agent index returned by addAgent
  70380. * @param destination targeted world position
  70381. */
  70382. agentTeleport(index: number, destination: Vector3): void;
  70383. /**
  70384. * Update agent parameters
  70385. * @param index agent index returned by addAgent
  70386. * @param parameters agent parameters
  70387. */
  70388. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70389. /**
  70390. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70391. * The queries will try to find a solution within those bounds
  70392. * default is (1,1,1)
  70393. * @param extent x,y,z value that define the extent around the queries point of reference
  70394. */
  70395. setDefaultQueryExtent(extent: Vector3): void;
  70396. /**
  70397. * Get the Bounding box extent specified by setDefaultQueryExtent
  70398. * @returns the box extent values
  70399. */
  70400. getDefaultQueryExtent(): Vector3;
  70401. /**
  70402. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70403. * @param result output the box extent values
  70404. */
  70405. getDefaultQueryExtentToRef(result: Vector3): void;
  70406. /**
  70407. * Release all resources
  70408. */
  70409. dispose(): void;
  70410. }
  70411. /**
  70412. * Configures an agent
  70413. */
  70414. export interface IAgentParameters {
  70415. /**
  70416. * Agent radius. [Limit: >= 0]
  70417. */
  70418. radius: number;
  70419. /**
  70420. * Agent height. [Limit: > 0]
  70421. */
  70422. height: number;
  70423. /**
  70424. * Maximum allowed acceleration. [Limit: >= 0]
  70425. */
  70426. maxAcceleration: number;
  70427. /**
  70428. * Maximum allowed speed. [Limit: >= 0]
  70429. */
  70430. maxSpeed: number;
  70431. /**
  70432. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  70433. */
  70434. collisionQueryRange: number;
  70435. /**
  70436. * The path visibility optimization range. [Limit: > 0]
  70437. */
  70438. pathOptimizationRange: number;
  70439. /**
  70440. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  70441. */
  70442. separationWeight: number;
  70443. }
  70444. /**
  70445. * Configures the navigation mesh creation
  70446. */
  70447. export interface INavMeshParameters {
  70448. /**
  70449. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70450. */
  70451. cs: number;
  70452. /**
  70453. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70454. */
  70455. ch: number;
  70456. /**
  70457. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70458. */
  70459. walkableSlopeAngle: number;
  70460. /**
  70461. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70462. * be considered walkable. [Limit: >= 3] [Units: vx]
  70463. */
  70464. walkableHeight: number;
  70465. /**
  70466. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70467. */
  70468. walkableClimb: number;
  70469. /**
  70470. * The distance to erode/shrink the walkable area of the heightfield away from
  70471. * obstructions. [Limit: >=0] [Units: vx]
  70472. */
  70473. walkableRadius: number;
  70474. /**
  70475. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70476. */
  70477. maxEdgeLen: number;
  70478. /**
  70479. * The maximum distance a simplfied contour's border edges should deviate
  70480. * the original raw contour. [Limit: >=0] [Units: vx]
  70481. */
  70482. maxSimplificationError: number;
  70483. /**
  70484. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70485. */
  70486. minRegionArea: number;
  70487. /**
  70488. * Any regions with a span count smaller than this value will, if possible,
  70489. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70490. */
  70491. mergeRegionArea: number;
  70492. /**
  70493. * The maximum number of vertices allowed for polygons generated during the
  70494. * contour to polygon conversion process. [Limit: >= 3]
  70495. */
  70496. maxVertsPerPoly: number;
  70497. /**
  70498. * Sets the sampling distance to use when generating the detail mesh.
  70499. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70500. */
  70501. detailSampleDist: number;
  70502. /**
  70503. * The maximum distance the detail mesh surface should deviate from heightfield
  70504. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70505. */
  70506. detailSampleMaxError: number;
  70507. }
  70508. }
  70509. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70510. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70511. import { Mesh } from "babylonjs/Meshes/mesh";
  70512. import { Scene } from "babylonjs/scene";
  70513. import { Vector3 } from "babylonjs/Maths/math";
  70514. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70515. /**
  70516. * RecastJS navigation plugin
  70517. */
  70518. export class RecastJSPlugin implements INavigationEnginePlugin {
  70519. /**
  70520. * Reference to the Recast library
  70521. */
  70522. bjsRECAST: any;
  70523. /**
  70524. * plugin name
  70525. */
  70526. name: string;
  70527. /**
  70528. * the first navmesh created. We might extend this to support multiple navmeshes
  70529. */
  70530. navMesh: any;
  70531. /**
  70532. * Initializes the recastJS plugin
  70533. * @param recastInjection can be used to inject your own recast reference
  70534. */
  70535. constructor(recastInjection?: any);
  70536. /**
  70537. * Creates a navigation mesh
  70538. * @param meshes array of all the geometry used to compute the navigatio mesh
  70539. * @param parameters bunch of parameters used to filter geometry
  70540. */
  70541. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70542. /**
  70543. * Create a navigation mesh debug mesh
  70544. * @param scene is where the mesh will be added
  70545. * @returns debug display mesh
  70546. */
  70547. createDebugNavMesh(scene: Scene): Mesh;
  70548. /**
  70549. * Get a navigation mesh constrained position, closest to the parameter position
  70550. * @param position world position
  70551. * @returns the closest point to position constrained by the navigation mesh
  70552. */
  70553. getClosestPoint(position: Vector3): Vector3;
  70554. /**
  70555. * Get a navigation mesh constrained position, closest to the parameter position
  70556. * @param position world position
  70557. * @param result output the closest point to position constrained by the navigation mesh
  70558. */
  70559. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70560. /**
  70561. * Get a navigation mesh constrained position, within a particular radius
  70562. * @param position world position
  70563. * @param maxRadius the maximum distance to the constrained world position
  70564. * @returns the closest point to position constrained by the navigation mesh
  70565. */
  70566. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70567. /**
  70568. * Get a navigation mesh constrained position, within a particular radius
  70569. * @param position world position
  70570. * @param maxRadius the maximum distance to the constrained world position
  70571. * @param result output the closest point to position constrained by the navigation mesh
  70572. */
  70573. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70574. /**
  70575. * Compute the final position from a segment made of destination-position
  70576. * @param position world position
  70577. * @param destination world position
  70578. * @returns the resulting point along the navmesh
  70579. */
  70580. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70581. /**
  70582. * Compute the final position from a segment made of destination-position
  70583. * @param position world position
  70584. * @param destination world position
  70585. * @param result output the resulting point along the navmesh
  70586. */
  70587. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70588. /**
  70589. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70590. * @param start world position
  70591. * @param end world position
  70592. * @returns array containing world position composing the path
  70593. */
  70594. computePath(start: Vector3, end: Vector3): Vector3[];
  70595. /**
  70596. * Create a new Crowd so you can add agents
  70597. * @param maxAgents the maximum agent count in the crowd
  70598. * @param maxAgentRadius the maximum radius an agent can have
  70599. * @param scene to attach the crowd to
  70600. * @returns the crowd you can add agents to
  70601. */
  70602. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70603. /**
  70604. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70605. * The queries will try to find a solution within those bounds
  70606. * default is (1,1,1)
  70607. * @param extent x,y,z value that define the extent around the queries point of reference
  70608. */
  70609. setDefaultQueryExtent(extent: Vector3): void;
  70610. /**
  70611. * Get the Bounding box extent specified by setDefaultQueryExtent
  70612. * @returns the box extent values
  70613. */
  70614. getDefaultQueryExtent(): Vector3;
  70615. /**
  70616. * build the navmesh from a previously saved state using getNavmeshData
  70617. * @param data the Uint8Array returned by getNavmeshData
  70618. */
  70619. buildFromNavmeshData(data: Uint8Array): void;
  70620. /**
  70621. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70622. * @returns data the Uint8Array that can be saved and reused
  70623. */
  70624. getNavmeshData(): Uint8Array;
  70625. /**
  70626. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70627. * @param result output the box extent values
  70628. */
  70629. getDefaultQueryExtentToRef(result: Vector3): void;
  70630. /**
  70631. * Disposes
  70632. */
  70633. dispose(): void;
  70634. /**
  70635. * If this plugin is supported
  70636. * @returns true if plugin is supported
  70637. */
  70638. isSupported(): boolean;
  70639. }
  70640. /**
  70641. * Recast detour crowd implementation
  70642. */
  70643. export class RecastJSCrowd implements ICrowd {
  70644. /**
  70645. * Recast/detour plugin
  70646. */
  70647. bjsRECASTPlugin: RecastJSPlugin;
  70648. /**
  70649. * Link to the detour crowd
  70650. */
  70651. recastCrowd: any;
  70652. /**
  70653. * One transform per agent
  70654. */
  70655. transforms: TransformNode[];
  70656. /**
  70657. * All agents created
  70658. */
  70659. agents: number[];
  70660. /**
  70661. * Link to the scene is kept to unregister the crowd from the scene
  70662. */
  70663. private _scene;
  70664. /**
  70665. * Observer for crowd updates
  70666. */
  70667. private _onBeforeAnimationsObserver;
  70668. /**
  70669. * Constructor
  70670. * @param plugin recastJS plugin
  70671. * @param maxAgents the maximum agent count in the crowd
  70672. * @param maxAgentRadius the maximum radius an agent can have
  70673. * @param scene to attach the crowd to
  70674. * @returns the crowd you can add agents to
  70675. */
  70676. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70677. /**
  70678. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70679. * You can attach anything to that node. The node position is updated in the scene update tick.
  70680. * @param pos world position that will be constrained by the navigation mesh
  70681. * @param parameters agent parameters
  70682. * @param transform hooked to the agent that will be update by the scene
  70683. * @returns agent index
  70684. */
  70685. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70686. /**
  70687. * Returns the agent position in world space
  70688. * @param index agent index returned by addAgent
  70689. * @returns world space position
  70690. */
  70691. getAgentPosition(index: number): Vector3;
  70692. /**
  70693. * Returns the agent position result in world space
  70694. * @param index agent index returned by addAgent
  70695. * @param result output world space position
  70696. */
  70697. getAgentPositionToRef(index: number, result: Vector3): void;
  70698. /**
  70699. * Returns the agent velocity in world space
  70700. * @param index agent index returned by addAgent
  70701. * @returns world space velocity
  70702. */
  70703. getAgentVelocity(index: number): Vector3;
  70704. /**
  70705. * Returns the agent velocity result in world space
  70706. * @param index agent index returned by addAgent
  70707. * @param result output world space velocity
  70708. */
  70709. getAgentVelocityToRef(index: number, result: Vector3): void;
  70710. /**
  70711. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70712. * @param index agent index returned by addAgent
  70713. * @param destination targeted world position
  70714. */
  70715. agentGoto(index: number, destination: Vector3): void;
  70716. /**
  70717. * Teleport the agent to a new position
  70718. * @param index agent index returned by addAgent
  70719. * @param destination targeted world position
  70720. */
  70721. agentTeleport(index: number, destination: Vector3): void;
  70722. /**
  70723. * Update agent parameters
  70724. * @param index agent index returned by addAgent
  70725. * @param parameters agent parameters
  70726. */
  70727. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70728. /**
  70729. * remove a particular agent previously created
  70730. * @param index agent index returned by addAgent
  70731. */
  70732. removeAgent(index: number): void;
  70733. /**
  70734. * get the list of all agents attached to this crowd
  70735. * @returns list of agent indices
  70736. */
  70737. getAgents(): number[];
  70738. /**
  70739. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70740. * @param deltaTime in seconds
  70741. */
  70742. update(deltaTime: number): void;
  70743. /**
  70744. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70745. * The queries will try to find a solution within those bounds
  70746. * default is (1,1,1)
  70747. * @param extent x,y,z value that define the extent around the queries point of reference
  70748. */
  70749. setDefaultQueryExtent(extent: Vector3): void;
  70750. /**
  70751. * Get the Bounding box extent specified by setDefaultQueryExtent
  70752. * @returns the box extent values
  70753. */
  70754. getDefaultQueryExtent(): Vector3;
  70755. /**
  70756. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70757. * @param result output the box extent values
  70758. */
  70759. getDefaultQueryExtentToRef(result: Vector3): void;
  70760. /**
  70761. * Release all resources
  70762. */
  70763. dispose(): void;
  70764. }
  70765. }
  70766. declare module "babylonjs/Navigation/Plugins/index" {
  70767. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  70768. }
  70769. declare module "babylonjs/Navigation/index" {
  70770. export * from "babylonjs/Navigation/INavigationEngine";
  70771. export * from "babylonjs/Navigation/Plugins/index";
  70772. }
  70773. declare module "babylonjs/Offline/database" {
  70774. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  70775. /**
  70776. * Class used to enable access to IndexedDB
  70777. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70778. */
  70779. export class Database implements IOfflineProvider {
  70780. private _callbackManifestChecked;
  70781. private _currentSceneUrl;
  70782. private _db;
  70783. private _enableSceneOffline;
  70784. private _enableTexturesOffline;
  70785. private _manifestVersionFound;
  70786. private _mustUpdateRessources;
  70787. private _hasReachedQuota;
  70788. private _isSupported;
  70789. private _idbFactory;
  70790. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  70791. private static IsUASupportingBlobStorage;
  70792. /**
  70793. * Gets a boolean indicating if Database storate is enabled (off by default)
  70794. */
  70795. static IDBStorageEnabled: boolean;
  70796. /**
  70797. * Gets a boolean indicating if scene must be saved in the database
  70798. */
  70799. get enableSceneOffline(): boolean;
  70800. /**
  70801. * Gets a boolean indicating if textures must be saved in the database
  70802. */
  70803. get enableTexturesOffline(): boolean;
  70804. /**
  70805. * Creates a new Database
  70806. * @param urlToScene defines the url to load the scene
  70807. * @param callbackManifestChecked defines the callback to use when manifest is checked
  70808. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  70809. */
  70810. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  70811. private static _ParseURL;
  70812. private static _ReturnFullUrlLocation;
  70813. private _checkManifestFile;
  70814. /**
  70815. * Open the database and make it available
  70816. * @param successCallback defines the callback to call on success
  70817. * @param errorCallback defines the callback to call on error
  70818. */
  70819. open(successCallback: () => void, errorCallback: () => void): void;
  70820. /**
  70821. * Loads an image from the database
  70822. * @param url defines the url to load from
  70823. * @param image defines the target DOM image
  70824. */
  70825. loadImage(url: string, image: HTMLImageElement): void;
  70826. private _loadImageFromDBAsync;
  70827. private _saveImageIntoDBAsync;
  70828. private _checkVersionFromDB;
  70829. private _loadVersionFromDBAsync;
  70830. private _saveVersionIntoDBAsync;
  70831. /**
  70832. * Loads a file from database
  70833. * @param url defines the URL to load from
  70834. * @param sceneLoaded defines a callback to call on success
  70835. * @param progressCallBack defines a callback to call when progress changed
  70836. * @param errorCallback defines a callback to call on error
  70837. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70838. */
  70839. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70840. private _loadFileAsync;
  70841. private _saveFileAsync;
  70842. /**
  70843. * Validates if xhr data is correct
  70844. * @param xhr defines the request to validate
  70845. * @param dataType defines the expected data type
  70846. * @returns true if data is correct
  70847. */
  70848. private static _ValidateXHRData;
  70849. }
  70850. }
  70851. declare module "babylonjs/Offline/index" {
  70852. export * from "babylonjs/Offline/database";
  70853. export * from "babylonjs/Offline/IOfflineProvider";
  70854. }
  70855. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  70856. /** @hidden */
  70857. export var gpuUpdateParticlesPixelShader: {
  70858. name: string;
  70859. shader: string;
  70860. };
  70861. }
  70862. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  70863. /** @hidden */
  70864. export var gpuUpdateParticlesVertexShader: {
  70865. name: string;
  70866. shader: string;
  70867. };
  70868. }
  70869. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  70870. /** @hidden */
  70871. export var clipPlaneFragmentDeclaration2: {
  70872. name: string;
  70873. shader: string;
  70874. };
  70875. }
  70876. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  70877. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  70878. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  70879. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  70880. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  70881. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  70882. /** @hidden */
  70883. export var gpuRenderParticlesPixelShader: {
  70884. name: string;
  70885. shader: string;
  70886. };
  70887. }
  70888. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  70889. /** @hidden */
  70890. export var clipPlaneVertexDeclaration2: {
  70891. name: string;
  70892. shader: string;
  70893. };
  70894. }
  70895. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  70896. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  70897. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  70898. /** @hidden */
  70899. export var gpuRenderParticlesVertexShader: {
  70900. name: string;
  70901. shader: string;
  70902. };
  70903. }
  70904. declare module "babylonjs/Particles/gpuParticleSystem" {
  70905. import { Nullable } from "babylonjs/types";
  70906. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  70907. import { Observable } from "babylonjs/Misc/observable";
  70908. import { Matrix } from "babylonjs/Maths/math.vector";
  70909. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  70910. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70911. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  70912. import { IDisposable } from "babylonjs/scene";
  70913. import { Effect } from "babylonjs/Materials/effect";
  70914. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  70915. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  70916. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  70917. import { Scene } from "babylonjs/scene";
  70918. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  70919. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  70920. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  70921. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  70922. /**
  70923. * This represents a GPU particle system in Babylon
  70924. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  70925. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  70926. */
  70927. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  70928. /**
  70929. * The layer mask we are rendering the particles through.
  70930. */
  70931. layerMask: number;
  70932. private _capacity;
  70933. private _activeCount;
  70934. private _currentActiveCount;
  70935. private _accumulatedCount;
  70936. private _renderEffect;
  70937. private _updateEffect;
  70938. private _buffer0;
  70939. private _buffer1;
  70940. private _spriteBuffer;
  70941. private _updateVAO;
  70942. private _renderVAO;
  70943. private _targetIndex;
  70944. private _sourceBuffer;
  70945. private _targetBuffer;
  70946. private _currentRenderId;
  70947. private _started;
  70948. private _stopped;
  70949. private _timeDelta;
  70950. private _randomTexture;
  70951. private _randomTexture2;
  70952. private _attributesStrideSize;
  70953. private _updateEffectOptions;
  70954. private _randomTextureSize;
  70955. private _actualFrame;
  70956. private _customEffect;
  70957. private readonly _rawTextureWidth;
  70958. /**
  70959. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  70960. */
  70961. static get IsSupported(): boolean;
  70962. /**
  70963. * An event triggered when the system is disposed.
  70964. */
  70965. onDisposeObservable: Observable<IParticleSystem>;
  70966. /**
  70967. * Gets the maximum number of particles active at the same time.
  70968. * @returns The max number of active particles.
  70969. */
  70970. getCapacity(): number;
  70971. /**
  70972. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  70973. * to override the particles.
  70974. */
  70975. forceDepthWrite: boolean;
  70976. /**
  70977. * Gets or set the number of active particles
  70978. */
  70979. get activeParticleCount(): number;
  70980. set activeParticleCount(value: number);
  70981. private _preWarmDone;
  70982. /**
  70983. * Specifies if the particles are updated in emitter local space or world space.
  70984. */
  70985. isLocal: boolean;
  70986. /** Gets or sets a matrix to use to compute projection */
  70987. defaultProjectionMatrix: Matrix;
  70988. /**
  70989. * Is this system ready to be used/rendered
  70990. * @return true if the system is ready
  70991. */
  70992. isReady(): boolean;
  70993. /**
  70994. * Gets if the system has been started. (Note: this will still be true after stop is called)
  70995. * @returns True if it has been started, otherwise false.
  70996. */
  70997. isStarted(): boolean;
  70998. /**
  70999. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  71000. * @returns True if it has been stopped, otherwise false.
  71001. */
  71002. isStopped(): boolean;
  71003. /**
  71004. * Gets a boolean indicating that the system is stopping
  71005. * @returns true if the system is currently stopping
  71006. */
  71007. isStopping(): boolean;
  71008. /**
  71009. * Gets the number of particles active at the same time.
  71010. * @returns The number of active particles.
  71011. */
  71012. getActiveCount(): number;
  71013. /**
  71014. * Starts the particle system and begins to emit
  71015. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  71016. */
  71017. start(delay?: number): void;
  71018. /**
  71019. * Stops the particle system.
  71020. */
  71021. stop(): void;
  71022. /**
  71023. * Remove all active particles
  71024. */
  71025. reset(): void;
  71026. /**
  71027. * Returns the string "GPUParticleSystem"
  71028. * @returns a string containing the class name
  71029. */
  71030. getClassName(): string;
  71031. /**
  71032. * Gets the custom effect used to render the particles
  71033. * @param blendMode Blend mode for which the effect should be retrieved
  71034. * @returns The effect
  71035. */
  71036. getCustomEffect(blendMode?: number): Nullable<Effect>;
  71037. /**
  71038. * Sets the custom effect used to render the particles
  71039. * @param effect The effect to set
  71040. * @param blendMode Blend mode for which the effect should be set
  71041. */
  71042. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  71043. /** @hidden */
  71044. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  71045. /**
  71046. * Observable that will be called just before the particles are drawn
  71047. */
  71048. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  71049. /**
  71050. * Gets the name of the particle vertex shader
  71051. */
  71052. get vertexShaderName(): string;
  71053. private _colorGradientsTexture;
  71054. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  71055. /**
  71056. * Adds a new color gradient
  71057. * @param gradient defines the gradient to use (between 0 and 1)
  71058. * @param color1 defines the color to affect to the specified gradient
  71059. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  71060. * @returns the current particle system
  71061. */
  71062. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  71063. private _refreshColorGradient;
  71064. /** Force the system to rebuild all gradients that need to be resync */
  71065. forceRefreshGradients(): void;
  71066. /**
  71067. * Remove a specific color gradient
  71068. * @param gradient defines the gradient to remove
  71069. * @returns the current particle system
  71070. */
  71071. removeColorGradient(gradient: number): GPUParticleSystem;
  71072. private _angularSpeedGradientsTexture;
  71073. private _sizeGradientsTexture;
  71074. private _velocityGradientsTexture;
  71075. private _limitVelocityGradientsTexture;
  71076. private _dragGradientsTexture;
  71077. private _addFactorGradient;
  71078. /**
  71079. * Adds a new size gradient
  71080. * @param gradient defines the gradient to use (between 0 and 1)
  71081. * @param factor defines the size factor to affect to the specified gradient
  71082. * @returns the current particle system
  71083. */
  71084. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71085. /**
  71086. * Remove a specific size gradient
  71087. * @param gradient defines the gradient to remove
  71088. * @returns the current particle system
  71089. */
  71090. removeSizeGradient(gradient: number): GPUParticleSystem;
  71091. private _refreshFactorGradient;
  71092. /**
  71093. * Adds a new angular speed gradient
  71094. * @param gradient defines the gradient to use (between 0 and 1)
  71095. * @param factor defines the angular speed to affect to the specified gradient
  71096. * @returns the current particle system
  71097. */
  71098. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71099. /**
  71100. * Remove a specific angular speed gradient
  71101. * @param gradient defines the gradient to remove
  71102. * @returns the current particle system
  71103. */
  71104. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71105. /**
  71106. * Adds a new velocity gradient
  71107. * @param gradient defines the gradient to use (between 0 and 1)
  71108. * @param factor defines the velocity to affect to the specified gradient
  71109. * @returns the current particle system
  71110. */
  71111. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71112. /**
  71113. * Remove a specific velocity gradient
  71114. * @param gradient defines the gradient to remove
  71115. * @returns the current particle system
  71116. */
  71117. removeVelocityGradient(gradient: number): GPUParticleSystem;
  71118. /**
  71119. * Adds a new limit velocity gradient
  71120. * @param gradient defines the gradient to use (between 0 and 1)
  71121. * @param factor defines the limit velocity value to affect to the specified gradient
  71122. * @returns the current particle system
  71123. */
  71124. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71125. /**
  71126. * Remove a specific limit velocity gradient
  71127. * @param gradient defines the gradient to remove
  71128. * @returns the current particle system
  71129. */
  71130. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  71131. /**
  71132. * Adds a new drag gradient
  71133. * @param gradient defines the gradient to use (between 0 and 1)
  71134. * @param factor defines the drag value to affect to the specified gradient
  71135. * @returns the current particle system
  71136. */
  71137. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  71138. /**
  71139. * Remove a specific drag gradient
  71140. * @param gradient defines the gradient to remove
  71141. * @returns the current particle system
  71142. */
  71143. removeDragGradient(gradient: number): GPUParticleSystem;
  71144. /**
  71145. * Not supported by GPUParticleSystem
  71146. * @param gradient defines the gradient to use (between 0 and 1)
  71147. * @param factor defines the emit rate value to affect to the specified gradient
  71148. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71149. * @returns the current particle system
  71150. */
  71151. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71152. /**
  71153. * Not supported by GPUParticleSystem
  71154. * @param gradient defines the gradient to remove
  71155. * @returns the current particle system
  71156. */
  71157. removeEmitRateGradient(gradient: number): IParticleSystem;
  71158. /**
  71159. * Not supported by GPUParticleSystem
  71160. * @param gradient defines the gradient to use (between 0 and 1)
  71161. * @param factor defines the start size value to affect to the specified gradient
  71162. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71163. * @returns the current particle system
  71164. */
  71165. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71166. /**
  71167. * Not supported by GPUParticleSystem
  71168. * @param gradient defines the gradient to remove
  71169. * @returns the current particle system
  71170. */
  71171. removeStartSizeGradient(gradient: number): IParticleSystem;
  71172. /**
  71173. * Not supported by GPUParticleSystem
  71174. * @param gradient defines the gradient to use (between 0 and 1)
  71175. * @param min defines the color remap minimal range
  71176. * @param max defines the color remap maximal range
  71177. * @returns the current particle system
  71178. */
  71179. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71180. /**
  71181. * Not supported by GPUParticleSystem
  71182. * @param gradient defines the gradient to remove
  71183. * @returns the current particle system
  71184. */
  71185. removeColorRemapGradient(): IParticleSystem;
  71186. /**
  71187. * Not supported by GPUParticleSystem
  71188. * @param gradient defines the gradient to use (between 0 and 1)
  71189. * @param min defines the alpha remap minimal range
  71190. * @param max defines the alpha remap maximal range
  71191. * @returns the current particle system
  71192. */
  71193. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71194. /**
  71195. * Not supported by GPUParticleSystem
  71196. * @param gradient defines the gradient to remove
  71197. * @returns the current particle system
  71198. */
  71199. removeAlphaRemapGradient(): IParticleSystem;
  71200. /**
  71201. * Not supported by GPUParticleSystem
  71202. * @param gradient defines the gradient to use (between 0 and 1)
  71203. * @param color defines the color to affect to the specified gradient
  71204. * @returns the current particle system
  71205. */
  71206. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  71207. /**
  71208. * Not supported by GPUParticleSystem
  71209. * @param gradient defines the gradient to remove
  71210. * @returns the current particle system
  71211. */
  71212. removeRampGradient(): IParticleSystem;
  71213. /**
  71214. * Not supported by GPUParticleSystem
  71215. * @returns the list of ramp gradients
  71216. */
  71217. getRampGradients(): Nullable<Array<Color3Gradient>>;
  71218. /**
  71219. * Not supported by GPUParticleSystem
  71220. * Gets or sets a boolean indicating that ramp gradients must be used
  71221. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  71222. */
  71223. get useRampGradients(): boolean;
  71224. set useRampGradients(value: boolean);
  71225. /**
  71226. * Not supported by GPUParticleSystem
  71227. * @param gradient defines the gradient to use (between 0 and 1)
  71228. * @param factor defines the life time factor to affect to the specified gradient
  71229. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71230. * @returns the current particle system
  71231. */
  71232. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71233. /**
  71234. * Not supported by GPUParticleSystem
  71235. * @param gradient defines the gradient to remove
  71236. * @returns the current particle system
  71237. */
  71238. removeLifeTimeGradient(gradient: number): IParticleSystem;
  71239. /**
  71240. * Instantiates a GPU particle system.
  71241. * 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.
  71242. * @param name The name of the particle system
  71243. * @param options The options used to create the system
  71244. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  71245. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  71246. * @param customEffect a custom effect used to change the way particles are rendered by default
  71247. */
  71248. constructor(name: string, options: Partial<{
  71249. capacity: number;
  71250. randomTextureSize: number;
  71251. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  71252. protected _reset(): void;
  71253. private _createUpdateVAO;
  71254. private _createRenderVAO;
  71255. private _initialize;
  71256. /** @hidden */
  71257. _recreateUpdateEffect(): void;
  71258. private _getEffect;
  71259. /**
  71260. * Fill the defines array according to the current settings of the particle system
  71261. * @param defines Array to be updated
  71262. * @param blendMode blend mode to take into account when updating the array
  71263. */
  71264. fillDefines(defines: Array<string>, blendMode?: number): void;
  71265. /**
  71266. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  71267. * @param uniforms Uniforms array to fill
  71268. * @param attributes Attributes array to fill
  71269. * @param samplers Samplers array to fill
  71270. */
  71271. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  71272. /** @hidden */
  71273. _recreateRenderEffect(): Effect;
  71274. /**
  71275. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  71276. * @param preWarm defines if we are in the pre-warmimg phase
  71277. */
  71278. animate(preWarm?: boolean): void;
  71279. private _createFactorGradientTexture;
  71280. private _createSizeGradientTexture;
  71281. private _createAngularSpeedGradientTexture;
  71282. private _createVelocityGradientTexture;
  71283. private _createLimitVelocityGradientTexture;
  71284. private _createDragGradientTexture;
  71285. private _createColorGradientTexture;
  71286. /**
  71287. * Renders the particle system in its current state
  71288. * @param preWarm defines if the system should only update the particles but not render them
  71289. * @returns the current number of particles
  71290. */
  71291. render(preWarm?: boolean): number;
  71292. /**
  71293. * Rebuilds the particle system
  71294. */
  71295. rebuild(): void;
  71296. private _releaseBuffers;
  71297. private _releaseVAOs;
  71298. /**
  71299. * Disposes the particle system and free the associated resources
  71300. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  71301. */
  71302. dispose(disposeTexture?: boolean): void;
  71303. /**
  71304. * Clones the particle system.
  71305. * @param name The name of the cloned object
  71306. * @param newEmitter The new emitter to use
  71307. * @returns the cloned particle system
  71308. */
  71309. clone(name: string, newEmitter: any): GPUParticleSystem;
  71310. /**
  71311. * Serializes the particle system to a JSON object
  71312. * @param serializeTexture defines if the texture must be serialized as well
  71313. * @returns the JSON object
  71314. */
  71315. serialize(serializeTexture?: boolean): any;
  71316. /**
  71317. * Parses a JSON object to create a GPU particle system.
  71318. * @param parsedParticleSystem The JSON object to parse
  71319. * @param sceneOrEngine The scene or the engine to create the particle system in
  71320. * @param rootUrl The root url to use to load external dependencies like texture
  71321. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  71322. * @returns the parsed GPU particle system
  71323. */
  71324. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  71325. }
  71326. }
  71327. declare module "babylonjs/Particles/particleSystemSet" {
  71328. import { Nullable } from "babylonjs/types";
  71329. import { Color3 } from "babylonjs/Maths/math.color";
  71330. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71331. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71332. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71333. import { Scene, IDisposable } from "babylonjs/scene";
  71334. /**
  71335. * Represents a set of particle systems working together to create a specific effect
  71336. */
  71337. export class ParticleSystemSet implements IDisposable {
  71338. /**
  71339. * Gets or sets base Assets URL
  71340. */
  71341. static BaseAssetsUrl: string;
  71342. private _emitterCreationOptions;
  71343. private _emitterNode;
  71344. /**
  71345. * Gets the particle system list
  71346. */
  71347. systems: IParticleSystem[];
  71348. /**
  71349. * Gets the emitter node used with this set
  71350. */
  71351. get emitterNode(): Nullable<TransformNode>;
  71352. /**
  71353. * Creates a new emitter mesh as a sphere
  71354. * @param options defines the options used to create the sphere
  71355. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  71356. * @param scene defines the hosting scene
  71357. */
  71358. setEmitterAsSphere(options: {
  71359. diameter: number;
  71360. segments: number;
  71361. color: Color3;
  71362. }, renderingGroupId: number, scene: Scene): void;
  71363. /**
  71364. * Starts all particle systems of the set
  71365. * @param emitter defines an optional mesh to use as emitter for the particle systems
  71366. */
  71367. start(emitter?: AbstractMesh): void;
  71368. /**
  71369. * Release all associated resources
  71370. */
  71371. dispose(): void;
  71372. /**
  71373. * Serialize the set into a JSON compatible object
  71374. * @param serializeTexture defines if the texture must be serialized as well
  71375. * @returns a JSON compatible representation of the set
  71376. */
  71377. serialize(serializeTexture?: boolean): any;
  71378. /**
  71379. * Parse a new ParticleSystemSet from a serialized source
  71380. * @param data defines a JSON compatible representation of the set
  71381. * @param scene defines the hosting scene
  71382. * @param gpu defines if we want GPU particles or CPU particles
  71383. * @returns a new ParticleSystemSet
  71384. */
  71385. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  71386. }
  71387. }
  71388. declare module "babylonjs/Particles/particleHelper" {
  71389. import { Nullable } from "babylonjs/types";
  71390. import { Scene } from "babylonjs/scene";
  71391. import { Vector3 } from "babylonjs/Maths/math.vector";
  71392. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71393. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71394. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  71395. /**
  71396. * This class is made for on one-liner static method to help creating particle system set.
  71397. */
  71398. export class ParticleHelper {
  71399. /**
  71400. * Gets or sets base Assets URL
  71401. */
  71402. static BaseAssetsUrl: string;
  71403. /** Define the Url to load snippets */
  71404. static SnippetUrl: string;
  71405. /**
  71406. * Create a default particle system that you can tweak
  71407. * @param emitter defines the emitter to use
  71408. * @param capacity defines the system capacity (default is 500 particles)
  71409. * @param scene defines the hosting scene
  71410. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  71411. * @returns the new Particle system
  71412. */
  71413. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  71414. /**
  71415. * This is the main static method (one-liner) of this helper to create different particle systems
  71416. * @param type This string represents the type to the particle system to create
  71417. * @param scene The scene where the particle system should live
  71418. * @param gpu If the system will use gpu
  71419. * @returns the ParticleSystemSet created
  71420. */
  71421. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  71422. /**
  71423. * Static function used to export a particle system to a ParticleSystemSet variable.
  71424. * Please note that the emitter shape is not exported
  71425. * @param systems defines the particle systems to export
  71426. * @returns the created particle system set
  71427. */
  71428. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  71429. /**
  71430. * Creates a particle system from a snippet saved in a remote file
  71431. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  71432. * @param url defines the url to load from
  71433. * @param scene defines the hosting scene
  71434. * @param gpu If the system will use gpu
  71435. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71436. * @returns a promise that will resolve to the new particle system
  71437. */
  71438. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71439. /**
  71440. * Creates a particle system from a snippet saved by the particle system editor
  71441. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  71442. * @param scene defines the hosting scene
  71443. * @param gpu If the system will use gpu
  71444. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71445. * @returns a promise that will resolve to the new particle system
  71446. */
  71447. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71448. }
  71449. }
  71450. declare module "babylonjs/Particles/particleSystemComponent" {
  71451. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71452. import { Effect } from "babylonjs/Materials/effect";
  71453. import "babylonjs/Shaders/particles.vertex";
  71454. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71455. module "babylonjs/Engines/engine" {
  71456. interface Engine {
  71457. /**
  71458. * Create an effect to use with particle systems.
  71459. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71460. * the particle system for which you want to create a custom effect in the last parameter
  71461. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71462. * @param uniformsNames defines a list of attribute names
  71463. * @param samplers defines an array of string used to represent textures
  71464. * @param defines defines the string containing the defines to use to compile the shaders
  71465. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71466. * @param onCompiled defines a function to call when the effect creation is successful
  71467. * @param onError defines a function to call when the effect creation has failed
  71468. * @param particleSystem the particle system you want to create the effect for
  71469. * @returns the new Effect
  71470. */
  71471. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71472. }
  71473. }
  71474. module "babylonjs/Meshes/mesh" {
  71475. interface Mesh {
  71476. /**
  71477. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71478. * @returns an array of IParticleSystem
  71479. */
  71480. getEmittedParticleSystems(): IParticleSystem[];
  71481. /**
  71482. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71483. * @returns an array of IParticleSystem
  71484. */
  71485. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71486. }
  71487. }
  71488. }
  71489. declare module "babylonjs/Particles/pointsCloudSystem" {
  71490. import { Color4 } from "babylonjs/Maths/math";
  71491. import { Mesh } from "babylonjs/Meshes/mesh";
  71492. import { Scene, IDisposable } from "babylonjs/scene";
  71493. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71494. /** Defines the 4 color options */
  71495. export enum PointColor {
  71496. /** color value */
  71497. Color = 2,
  71498. /** uv value */
  71499. UV = 1,
  71500. /** random value */
  71501. Random = 0,
  71502. /** stated value */
  71503. Stated = 3
  71504. }
  71505. /**
  71506. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71507. * 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.
  71508. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71509. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71510. *
  71511. * Full documentation here : TO BE ENTERED
  71512. */
  71513. export class PointsCloudSystem implements IDisposable {
  71514. /**
  71515. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71516. * Example : var p = SPS.particles[i];
  71517. */
  71518. particles: CloudPoint[];
  71519. /**
  71520. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71521. */
  71522. nbParticles: number;
  71523. /**
  71524. * This a counter for your own usage. It's not set by any SPS functions.
  71525. */
  71526. counter: number;
  71527. /**
  71528. * The PCS name. This name is also given to the underlying mesh.
  71529. */
  71530. name: string;
  71531. /**
  71532. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71533. */
  71534. mesh: Mesh;
  71535. /**
  71536. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71537. * Please read :
  71538. */
  71539. vars: any;
  71540. /**
  71541. * @hidden
  71542. */
  71543. _size: number;
  71544. private _scene;
  71545. private _promises;
  71546. private _positions;
  71547. private _indices;
  71548. private _normals;
  71549. private _colors;
  71550. private _uvs;
  71551. private _indices32;
  71552. private _positions32;
  71553. private _colors32;
  71554. private _uvs32;
  71555. private _updatable;
  71556. private _isVisibilityBoxLocked;
  71557. private _alwaysVisible;
  71558. private _groups;
  71559. private _groupCounter;
  71560. private _computeParticleColor;
  71561. private _computeParticleTexture;
  71562. private _computeParticleRotation;
  71563. private _computeBoundingBox;
  71564. private _isReady;
  71565. /**
  71566. * Creates a PCS (Points Cloud System) object
  71567. * @param name (String) is the PCS name, this will be the underlying mesh name
  71568. * @param pointSize (number) is the size for each point
  71569. * @param scene (Scene) is the scene in which the PCS is added
  71570. * @param options defines the options of the PCS e.g.
  71571. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71572. */
  71573. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71574. updatable?: boolean;
  71575. });
  71576. /**
  71577. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71578. * If no points were added to the PCS, the returned mesh is just a single point.
  71579. * @returns a promise for the created mesh
  71580. */
  71581. buildMeshAsync(): Promise<Mesh>;
  71582. /**
  71583. * @hidden
  71584. */
  71585. private _buildMesh;
  71586. private _addParticle;
  71587. private _randomUnitVector;
  71588. private _getColorIndicesForCoord;
  71589. private _setPointsColorOrUV;
  71590. private _colorFromTexture;
  71591. private _calculateDensity;
  71592. /**
  71593. * Adds points to the PCS in random positions within a unit sphere
  71594. * @param nb (positive integer) the number of particles to be created from this model
  71595. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71596. * @returns the number of groups in the system
  71597. */
  71598. addPoints(nb: number, pointFunction?: any): number;
  71599. /**
  71600. * Adds points to the PCS from the surface of the model shape
  71601. * @param mesh is any Mesh object that will be used as a surface model for the points
  71602. * @param nb (positive integer) the number of particles to be created from this model
  71603. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71604. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71605. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71606. * @returns the number of groups in the system
  71607. */
  71608. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71609. /**
  71610. * Adds points to the PCS inside the model shape
  71611. * @param mesh is any Mesh object that will be used as a surface model for the points
  71612. * @param nb (positive integer) the number of particles to be created from this model
  71613. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71614. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71615. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71616. * @returns the number of groups in the system
  71617. */
  71618. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71619. /**
  71620. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71621. * This method calls `updateParticle()` for each particle of the SPS.
  71622. * For an animated SPS, it is usually called within the render loop.
  71623. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71624. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71625. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71626. * @returns the PCS.
  71627. */
  71628. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71629. /**
  71630. * Disposes the PCS.
  71631. */
  71632. dispose(): void;
  71633. /**
  71634. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71635. * doc :
  71636. * @returns the PCS.
  71637. */
  71638. refreshVisibleSize(): PointsCloudSystem;
  71639. /**
  71640. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71641. * @param size the size (float) of the visibility box
  71642. * note : this doesn't lock the PCS mesh bounding box.
  71643. * doc :
  71644. */
  71645. setVisibilityBox(size: number): void;
  71646. /**
  71647. * Gets whether the PCS is always visible or not
  71648. * doc :
  71649. */
  71650. get isAlwaysVisible(): boolean;
  71651. /**
  71652. * Sets the PCS as always visible or not
  71653. * doc :
  71654. */
  71655. set isAlwaysVisible(val: boolean);
  71656. /**
  71657. * Tells to `setParticles()` to compute the particle rotations or not
  71658. * Default value : false. The PCS is faster when it's set to false
  71659. * Note : particle rotations are only applied to parent particles
  71660. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71661. */
  71662. set computeParticleRotation(val: boolean);
  71663. /**
  71664. * Tells to `setParticles()` to compute the particle colors or not.
  71665. * Default value : true. The PCS is faster when it's set to false.
  71666. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71667. */
  71668. set computeParticleColor(val: boolean);
  71669. set computeParticleTexture(val: boolean);
  71670. /**
  71671. * Gets if `setParticles()` computes the particle colors or not.
  71672. * Default value : false. The PCS is faster when it's set to false.
  71673. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71674. */
  71675. get computeParticleColor(): boolean;
  71676. /**
  71677. * Gets if `setParticles()` computes the particle textures or not.
  71678. * Default value : false. The PCS is faster when it's set to false.
  71679. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71680. */
  71681. get computeParticleTexture(): boolean;
  71682. /**
  71683. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71684. */
  71685. set computeBoundingBox(val: boolean);
  71686. /**
  71687. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71688. */
  71689. get computeBoundingBox(): boolean;
  71690. /**
  71691. * This function does nothing. It may be overwritten to set all the particle first values.
  71692. * The PCS doesn't call this function, you may have to call it by your own.
  71693. * doc :
  71694. */
  71695. initParticles(): void;
  71696. /**
  71697. * This function does nothing. It may be overwritten to recycle a particle
  71698. * The PCS doesn't call this function, you can to call it
  71699. * doc :
  71700. * @param particle The particle to recycle
  71701. * @returns the recycled particle
  71702. */
  71703. recycleParticle(particle: CloudPoint): CloudPoint;
  71704. /**
  71705. * Updates a particle : this function should be overwritten by the user.
  71706. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71707. * doc :
  71708. * @example : just set a particle position or velocity and recycle conditions
  71709. * @param particle The particle to update
  71710. * @returns the updated particle
  71711. */
  71712. updateParticle(particle: CloudPoint): CloudPoint;
  71713. /**
  71714. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71715. * This does nothing and may be overwritten by the user.
  71716. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71717. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71718. * @param update the boolean update value actually passed to setParticles()
  71719. */
  71720. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71721. /**
  71722. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71723. * This will be passed three parameters.
  71724. * This does nothing and may be overwritten by the user.
  71725. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71726. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71727. * @param update the boolean update value actually passed to setParticles()
  71728. */
  71729. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71730. }
  71731. }
  71732. declare module "babylonjs/Particles/cloudPoint" {
  71733. import { Nullable } from "babylonjs/types";
  71734. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71735. import { Mesh } from "babylonjs/Meshes/mesh";
  71736. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71737. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71738. /**
  71739. * Represents one particle of a points cloud system.
  71740. */
  71741. export class CloudPoint {
  71742. /**
  71743. * particle global index
  71744. */
  71745. idx: number;
  71746. /**
  71747. * The color of the particle
  71748. */
  71749. color: Nullable<Color4>;
  71750. /**
  71751. * The world space position of the particle.
  71752. */
  71753. position: Vector3;
  71754. /**
  71755. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71756. */
  71757. rotation: Vector3;
  71758. /**
  71759. * The world space rotation quaternion of the particle.
  71760. */
  71761. rotationQuaternion: Nullable<Quaternion>;
  71762. /**
  71763. * The uv of the particle.
  71764. */
  71765. uv: Nullable<Vector2>;
  71766. /**
  71767. * The current speed of the particle.
  71768. */
  71769. velocity: Vector3;
  71770. /**
  71771. * The pivot point in the particle local space.
  71772. */
  71773. pivot: Vector3;
  71774. /**
  71775. * Must the particle be translated from its pivot point in its local space ?
  71776. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  71777. * Default : false
  71778. */
  71779. translateFromPivot: boolean;
  71780. /**
  71781. * Index of this particle in the global "positions" array (Internal use)
  71782. * @hidden
  71783. */
  71784. _pos: number;
  71785. /**
  71786. * @hidden Index of this particle in the global "indices" array (Internal use)
  71787. */
  71788. _ind: number;
  71789. /**
  71790. * Group this particle belongs to
  71791. */
  71792. _group: PointsGroup;
  71793. /**
  71794. * Group id of this particle
  71795. */
  71796. groupId: number;
  71797. /**
  71798. * Index of the particle in its group id (Internal use)
  71799. */
  71800. idxInGroup: number;
  71801. /**
  71802. * @hidden Particle BoundingInfo object (Internal use)
  71803. */
  71804. _boundingInfo: BoundingInfo;
  71805. /**
  71806. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  71807. */
  71808. _pcs: PointsCloudSystem;
  71809. /**
  71810. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  71811. */
  71812. _stillInvisible: boolean;
  71813. /**
  71814. * @hidden Last computed particle rotation matrix
  71815. */
  71816. _rotationMatrix: number[];
  71817. /**
  71818. * Parent particle Id, if any.
  71819. * Default null.
  71820. */
  71821. parentId: Nullable<number>;
  71822. /**
  71823. * @hidden Internal global position in the PCS.
  71824. */
  71825. _globalPosition: Vector3;
  71826. /**
  71827. * Creates a Point Cloud object.
  71828. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  71829. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  71830. * @param group (PointsGroup) is the group the particle belongs to
  71831. * @param groupId (integer) is the group identifier in the PCS.
  71832. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  71833. * @param pcs defines the PCS it is associated to
  71834. */
  71835. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  71836. /**
  71837. * get point size
  71838. */
  71839. get size(): Vector3;
  71840. /**
  71841. * Set point size
  71842. */
  71843. set size(scale: Vector3);
  71844. /**
  71845. * Legacy support, changed quaternion to rotationQuaternion
  71846. */
  71847. get quaternion(): Nullable<Quaternion>;
  71848. /**
  71849. * Legacy support, changed quaternion to rotationQuaternion
  71850. */
  71851. set quaternion(q: Nullable<Quaternion>);
  71852. /**
  71853. * Returns a boolean. True if the particle intersects a mesh, else false
  71854. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  71855. * @param target is the object (point or mesh) what the intersection is computed against
  71856. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  71857. * @returns true if it intersects
  71858. */
  71859. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  71860. /**
  71861. * get the rotation matrix of the particle
  71862. * @hidden
  71863. */
  71864. getRotationMatrix(m: Matrix): void;
  71865. }
  71866. /**
  71867. * Represents a group of points in a points cloud system
  71868. * * PCS internal tool, don't use it manually.
  71869. */
  71870. export class PointsGroup {
  71871. /**
  71872. * The group id
  71873. * @hidden
  71874. */
  71875. groupID: number;
  71876. /**
  71877. * image data for group (internal use)
  71878. * @hidden
  71879. */
  71880. _groupImageData: Nullable<ArrayBufferView>;
  71881. /**
  71882. * Image Width (internal use)
  71883. * @hidden
  71884. */
  71885. _groupImgWidth: number;
  71886. /**
  71887. * Image Height (internal use)
  71888. * @hidden
  71889. */
  71890. _groupImgHeight: number;
  71891. /**
  71892. * Custom position function (internal use)
  71893. * @hidden
  71894. */
  71895. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  71896. /**
  71897. * density per facet for surface points
  71898. * @hidden
  71899. */
  71900. _groupDensity: number[];
  71901. /**
  71902. * Only when points are colored by texture carries pointer to texture list array
  71903. * @hidden
  71904. */
  71905. _textureNb: number;
  71906. /**
  71907. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  71908. * PCS internal tool, don't use it manually.
  71909. * @hidden
  71910. */
  71911. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  71912. }
  71913. }
  71914. declare module "babylonjs/Particles/index" {
  71915. export * from "babylonjs/Particles/baseParticleSystem";
  71916. export * from "babylonjs/Particles/EmitterTypes/index";
  71917. export * from "babylonjs/Particles/gpuParticleSystem";
  71918. export * from "babylonjs/Particles/IParticleSystem";
  71919. export * from "babylonjs/Particles/particle";
  71920. export * from "babylonjs/Particles/particleHelper";
  71921. export * from "babylonjs/Particles/particleSystem";
  71922. import "babylonjs/Particles/particleSystemComponent";
  71923. export * from "babylonjs/Particles/particleSystemComponent";
  71924. export * from "babylonjs/Particles/particleSystemSet";
  71925. export * from "babylonjs/Particles/solidParticle";
  71926. export * from "babylonjs/Particles/solidParticleSystem";
  71927. export * from "babylonjs/Particles/cloudPoint";
  71928. export * from "babylonjs/Particles/pointsCloudSystem";
  71929. export * from "babylonjs/Particles/subEmitter";
  71930. }
  71931. declare module "babylonjs/Physics/physicsEngineComponent" {
  71932. import { Nullable } from "babylonjs/types";
  71933. import { Observable, Observer } from "babylonjs/Misc/observable";
  71934. import { Vector3 } from "babylonjs/Maths/math.vector";
  71935. import { Mesh } from "babylonjs/Meshes/mesh";
  71936. import { ISceneComponent } from "babylonjs/sceneComponent";
  71937. import { Scene } from "babylonjs/scene";
  71938. import { Node } from "babylonjs/node";
  71939. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  71940. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71941. module "babylonjs/scene" {
  71942. interface Scene {
  71943. /** @hidden (Backing field) */
  71944. _physicsEngine: Nullable<IPhysicsEngine>;
  71945. /** @hidden */
  71946. _physicsTimeAccumulator: number;
  71947. /**
  71948. * Gets the current physics engine
  71949. * @returns a IPhysicsEngine or null if none attached
  71950. */
  71951. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  71952. /**
  71953. * Enables physics to the current scene
  71954. * @param gravity defines the scene's gravity for the physics engine
  71955. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  71956. * @return a boolean indicating if the physics engine was initialized
  71957. */
  71958. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  71959. /**
  71960. * Disables and disposes the physics engine associated with the scene
  71961. */
  71962. disablePhysicsEngine(): void;
  71963. /**
  71964. * Gets a boolean indicating if there is an active physics engine
  71965. * @returns a boolean indicating if there is an active physics engine
  71966. */
  71967. isPhysicsEnabled(): boolean;
  71968. /**
  71969. * Deletes a physics compound impostor
  71970. * @param compound defines the compound to delete
  71971. */
  71972. deleteCompoundImpostor(compound: any): void;
  71973. /**
  71974. * An event triggered when physic simulation is about to be run
  71975. */
  71976. onBeforePhysicsObservable: Observable<Scene>;
  71977. /**
  71978. * An event triggered when physic simulation has been done
  71979. */
  71980. onAfterPhysicsObservable: Observable<Scene>;
  71981. }
  71982. }
  71983. module "babylonjs/Meshes/abstractMesh" {
  71984. interface AbstractMesh {
  71985. /** @hidden */
  71986. _physicsImpostor: Nullable<PhysicsImpostor>;
  71987. /**
  71988. * Gets or sets impostor used for physic simulation
  71989. * @see https://doc.babylonjs.com/features/physics_engine
  71990. */
  71991. physicsImpostor: Nullable<PhysicsImpostor>;
  71992. /**
  71993. * Gets the current physics impostor
  71994. * @see https://doc.babylonjs.com/features/physics_engine
  71995. * @returns a physics impostor or null
  71996. */
  71997. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  71998. /** Apply a physic impulse to the mesh
  71999. * @param force defines the force to apply
  72000. * @param contactPoint defines where to apply the force
  72001. * @returns the current mesh
  72002. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  72003. */
  72004. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  72005. /**
  72006. * Creates a physic joint between two meshes
  72007. * @param otherMesh defines the other mesh to use
  72008. * @param pivot1 defines the pivot to use on this mesh
  72009. * @param pivot2 defines the pivot to use on the other mesh
  72010. * @param options defines additional options (can be plugin dependent)
  72011. * @returns the current mesh
  72012. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  72013. */
  72014. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  72015. /** @hidden */
  72016. _disposePhysicsObserver: Nullable<Observer<Node>>;
  72017. }
  72018. }
  72019. /**
  72020. * Defines the physics engine scene component responsible to manage a physics engine
  72021. */
  72022. export class PhysicsEngineSceneComponent implements ISceneComponent {
  72023. /**
  72024. * The component name helpful to identify the component in the list of scene components.
  72025. */
  72026. readonly name: string;
  72027. /**
  72028. * The scene the component belongs to.
  72029. */
  72030. scene: Scene;
  72031. /**
  72032. * Creates a new instance of the component for the given scene
  72033. * @param scene Defines the scene to register the component in
  72034. */
  72035. constructor(scene: Scene);
  72036. /**
  72037. * Registers the component in a given scene
  72038. */
  72039. register(): void;
  72040. /**
  72041. * Rebuilds the elements related to this component in case of
  72042. * context lost for instance.
  72043. */
  72044. rebuild(): void;
  72045. /**
  72046. * Disposes the component and the associated ressources
  72047. */
  72048. dispose(): void;
  72049. }
  72050. }
  72051. declare module "babylonjs/Physics/physicsHelper" {
  72052. import { Nullable } from "babylonjs/types";
  72053. import { Vector3 } from "babylonjs/Maths/math.vector";
  72054. import { Mesh } from "babylonjs/Meshes/mesh";
  72055. import { Scene } from "babylonjs/scene";
  72056. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72057. /**
  72058. * A helper for physics simulations
  72059. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72060. */
  72061. export class PhysicsHelper {
  72062. private _scene;
  72063. private _physicsEngine;
  72064. /**
  72065. * Initializes the Physics helper
  72066. * @param scene Babylon.js scene
  72067. */
  72068. constructor(scene: Scene);
  72069. /**
  72070. * Applies a radial explosion impulse
  72071. * @param origin the origin of the explosion
  72072. * @param radiusOrEventOptions the radius or the options of radial explosion
  72073. * @param strength the explosion strength
  72074. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72075. * @returns A physics radial explosion event, or null
  72076. */
  72077. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72078. /**
  72079. * Applies a radial explosion force
  72080. * @param origin the origin of the explosion
  72081. * @param radiusOrEventOptions the radius or the options of radial explosion
  72082. * @param strength the explosion strength
  72083. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72084. * @returns A physics radial explosion event, or null
  72085. */
  72086. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72087. /**
  72088. * Creates a gravitational field
  72089. * @param origin the origin of the explosion
  72090. * @param radiusOrEventOptions the radius or the options of radial explosion
  72091. * @param strength the explosion strength
  72092. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72093. * @returns A physics gravitational field event, or null
  72094. */
  72095. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72096. /**
  72097. * Creates a physics updraft event
  72098. * @param origin the origin of the updraft
  72099. * @param radiusOrEventOptions the radius or the options of the updraft
  72100. * @param strength the strength of the updraft
  72101. * @param height the height of the updraft
  72102. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72103. * @returns A physics updraft event, or null
  72104. */
  72105. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72106. /**
  72107. * Creates a physics vortex event
  72108. * @param origin the of the vortex
  72109. * @param radiusOrEventOptions the radius or the options of the vortex
  72110. * @param strength the strength of the vortex
  72111. * @param height the height of the vortex
  72112. * @returns a Physics vortex event, or null
  72113. * A physics vortex event or null
  72114. */
  72115. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  72116. }
  72117. /**
  72118. * Represents a physics radial explosion event
  72119. */
  72120. class PhysicsRadialExplosionEvent {
  72121. private _scene;
  72122. private _options;
  72123. private _sphere;
  72124. private _dataFetched;
  72125. /**
  72126. * Initializes a radial explosioin event
  72127. * @param _scene BabylonJS scene
  72128. * @param _options The options for the vortex event
  72129. */
  72130. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  72131. /**
  72132. * Returns the data related to the radial explosion event (sphere).
  72133. * @returns The radial explosion event data
  72134. */
  72135. getData(): PhysicsRadialExplosionEventData;
  72136. /**
  72137. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  72138. * @param impostor A physics imposter
  72139. * @param origin the origin of the explosion
  72140. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  72141. */
  72142. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  72143. /**
  72144. * Triggers affecterd impostors callbacks
  72145. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  72146. */
  72147. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  72148. /**
  72149. * Disposes the sphere.
  72150. * @param force Specifies if the sphere should be disposed by force
  72151. */
  72152. dispose(force?: boolean): void;
  72153. /*** Helpers ***/
  72154. private _prepareSphere;
  72155. private _intersectsWithSphere;
  72156. }
  72157. /**
  72158. * Represents a gravitational field event
  72159. */
  72160. class PhysicsGravitationalFieldEvent {
  72161. private _physicsHelper;
  72162. private _scene;
  72163. private _origin;
  72164. private _options;
  72165. private _tickCallback;
  72166. private _sphere;
  72167. private _dataFetched;
  72168. /**
  72169. * Initializes the physics gravitational field event
  72170. * @param _physicsHelper A physics helper
  72171. * @param _scene BabylonJS scene
  72172. * @param _origin The origin position of the gravitational field event
  72173. * @param _options The options for the vortex event
  72174. */
  72175. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  72176. /**
  72177. * Returns the data related to the gravitational field event (sphere).
  72178. * @returns A gravitational field event
  72179. */
  72180. getData(): PhysicsGravitationalFieldEventData;
  72181. /**
  72182. * Enables the gravitational field.
  72183. */
  72184. enable(): void;
  72185. /**
  72186. * Disables the gravitational field.
  72187. */
  72188. disable(): void;
  72189. /**
  72190. * Disposes the sphere.
  72191. * @param force The force to dispose from the gravitational field event
  72192. */
  72193. dispose(force?: boolean): void;
  72194. private _tick;
  72195. }
  72196. /**
  72197. * Represents a physics updraft event
  72198. */
  72199. class PhysicsUpdraftEvent {
  72200. private _scene;
  72201. private _origin;
  72202. private _options;
  72203. private _physicsEngine;
  72204. private _originTop;
  72205. private _originDirection;
  72206. private _tickCallback;
  72207. private _cylinder;
  72208. private _cylinderPosition;
  72209. private _dataFetched;
  72210. /**
  72211. * Initializes the physics updraft event
  72212. * @param _scene BabylonJS scene
  72213. * @param _origin The origin position of the updraft
  72214. * @param _options The options for the updraft event
  72215. */
  72216. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  72217. /**
  72218. * Returns the data related to the updraft event (cylinder).
  72219. * @returns A physics updraft event
  72220. */
  72221. getData(): PhysicsUpdraftEventData;
  72222. /**
  72223. * Enables the updraft.
  72224. */
  72225. enable(): void;
  72226. /**
  72227. * Disables the updraft.
  72228. */
  72229. disable(): void;
  72230. /**
  72231. * Disposes the cylinder.
  72232. * @param force Specifies if the updraft should be disposed by force
  72233. */
  72234. dispose(force?: boolean): void;
  72235. private getImpostorHitData;
  72236. private _tick;
  72237. /*** Helpers ***/
  72238. private _prepareCylinder;
  72239. private _intersectsWithCylinder;
  72240. }
  72241. /**
  72242. * Represents a physics vortex event
  72243. */
  72244. class PhysicsVortexEvent {
  72245. private _scene;
  72246. private _origin;
  72247. private _options;
  72248. private _physicsEngine;
  72249. private _originTop;
  72250. private _tickCallback;
  72251. private _cylinder;
  72252. private _cylinderPosition;
  72253. private _dataFetched;
  72254. /**
  72255. * Initializes the physics vortex event
  72256. * @param _scene The BabylonJS scene
  72257. * @param _origin The origin position of the vortex
  72258. * @param _options The options for the vortex event
  72259. */
  72260. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  72261. /**
  72262. * Returns the data related to the vortex event (cylinder).
  72263. * @returns The physics vortex event data
  72264. */
  72265. getData(): PhysicsVortexEventData;
  72266. /**
  72267. * Enables the vortex.
  72268. */
  72269. enable(): void;
  72270. /**
  72271. * Disables the cortex.
  72272. */
  72273. disable(): void;
  72274. /**
  72275. * Disposes the sphere.
  72276. * @param force
  72277. */
  72278. dispose(force?: boolean): void;
  72279. private getImpostorHitData;
  72280. private _tick;
  72281. /*** Helpers ***/
  72282. private _prepareCylinder;
  72283. private _intersectsWithCylinder;
  72284. }
  72285. /**
  72286. * Options fot the radial explosion event
  72287. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72288. */
  72289. export class PhysicsRadialExplosionEventOptions {
  72290. /**
  72291. * The radius of the sphere for the radial explosion.
  72292. */
  72293. radius: number;
  72294. /**
  72295. * The strenth of the explosion.
  72296. */
  72297. strength: number;
  72298. /**
  72299. * The strenght of the force in correspondence to the distance of the affected object
  72300. */
  72301. falloff: PhysicsRadialImpulseFalloff;
  72302. /**
  72303. * Sphere options for the radial explosion.
  72304. */
  72305. sphere: {
  72306. segments: number;
  72307. diameter: number;
  72308. };
  72309. /**
  72310. * Sphere options for the radial explosion.
  72311. */
  72312. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  72313. }
  72314. /**
  72315. * Options fot the updraft event
  72316. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72317. */
  72318. export class PhysicsUpdraftEventOptions {
  72319. /**
  72320. * The radius of the cylinder for the vortex
  72321. */
  72322. radius: number;
  72323. /**
  72324. * The strenth of the updraft.
  72325. */
  72326. strength: number;
  72327. /**
  72328. * The height of the cylinder for the updraft.
  72329. */
  72330. height: number;
  72331. /**
  72332. * The mode for the the updraft.
  72333. */
  72334. updraftMode: PhysicsUpdraftMode;
  72335. }
  72336. /**
  72337. * Options fot the vortex event
  72338. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72339. */
  72340. export class PhysicsVortexEventOptions {
  72341. /**
  72342. * The radius of the cylinder for the vortex
  72343. */
  72344. radius: number;
  72345. /**
  72346. * The strenth of the vortex.
  72347. */
  72348. strength: number;
  72349. /**
  72350. * The height of the cylinder for the vortex.
  72351. */
  72352. height: number;
  72353. /**
  72354. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  72355. */
  72356. centripetalForceThreshold: number;
  72357. /**
  72358. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  72359. */
  72360. centripetalForceMultiplier: number;
  72361. /**
  72362. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  72363. */
  72364. centrifugalForceMultiplier: number;
  72365. /**
  72366. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  72367. */
  72368. updraftForceMultiplier: number;
  72369. }
  72370. /**
  72371. * The strenght of the force in correspondence to the distance of the affected object
  72372. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72373. */
  72374. export enum PhysicsRadialImpulseFalloff {
  72375. /** Defines that impulse is constant in strength across it's whole radius */
  72376. Constant = 0,
  72377. /** Defines that impulse gets weaker if it's further from the origin */
  72378. Linear = 1
  72379. }
  72380. /**
  72381. * The strength of the force in correspondence to the distance of the affected object
  72382. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72383. */
  72384. export enum PhysicsUpdraftMode {
  72385. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  72386. Center = 0,
  72387. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  72388. Perpendicular = 1
  72389. }
  72390. /**
  72391. * Interface for a physics hit data
  72392. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72393. */
  72394. export interface PhysicsHitData {
  72395. /**
  72396. * The force applied at the contact point
  72397. */
  72398. force: Vector3;
  72399. /**
  72400. * The contact point
  72401. */
  72402. contactPoint: Vector3;
  72403. /**
  72404. * The distance from the origin to the contact point
  72405. */
  72406. distanceFromOrigin: number;
  72407. }
  72408. /**
  72409. * Interface for radial explosion event data
  72410. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72411. */
  72412. export interface PhysicsRadialExplosionEventData {
  72413. /**
  72414. * A sphere used for the radial explosion event
  72415. */
  72416. sphere: Mesh;
  72417. }
  72418. /**
  72419. * Interface for gravitational field event data
  72420. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72421. */
  72422. export interface PhysicsGravitationalFieldEventData {
  72423. /**
  72424. * A sphere mesh used for the gravitational field event
  72425. */
  72426. sphere: Mesh;
  72427. }
  72428. /**
  72429. * Interface for updraft event data
  72430. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72431. */
  72432. export interface PhysicsUpdraftEventData {
  72433. /**
  72434. * A cylinder used for the updraft event
  72435. */
  72436. cylinder: Mesh;
  72437. }
  72438. /**
  72439. * Interface for vortex event data
  72440. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72441. */
  72442. export interface PhysicsVortexEventData {
  72443. /**
  72444. * A cylinder used for the vortex event
  72445. */
  72446. cylinder: Mesh;
  72447. }
  72448. /**
  72449. * Interface for an affected physics impostor
  72450. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72451. */
  72452. export interface PhysicsAffectedImpostorWithData {
  72453. /**
  72454. * The impostor affected by the effect
  72455. */
  72456. impostor: PhysicsImpostor;
  72457. /**
  72458. * The data about the hit/horce from the explosion
  72459. */
  72460. hitData: PhysicsHitData;
  72461. }
  72462. }
  72463. declare module "babylonjs/Physics/Plugins/index" {
  72464. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72465. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72466. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72467. }
  72468. declare module "babylonjs/Physics/index" {
  72469. export * from "babylonjs/Physics/IPhysicsEngine";
  72470. export * from "babylonjs/Physics/physicsEngine";
  72471. export * from "babylonjs/Physics/physicsEngineComponent";
  72472. export * from "babylonjs/Physics/physicsHelper";
  72473. export * from "babylonjs/Physics/physicsImpostor";
  72474. export * from "babylonjs/Physics/physicsJoint";
  72475. export * from "babylonjs/Physics/Plugins/index";
  72476. }
  72477. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72478. /** @hidden */
  72479. export var blackAndWhitePixelShader: {
  72480. name: string;
  72481. shader: string;
  72482. };
  72483. }
  72484. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72485. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72486. import { Camera } from "babylonjs/Cameras/camera";
  72487. import { Engine } from "babylonjs/Engines/engine";
  72488. import "babylonjs/Shaders/blackAndWhite.fragment";
  72489. import { Nullable } from "babylonjs/types";
  72490. import { Scene } from "babylonjs/scene";
  72491. /**
  72492. * Post process used to render in black and white
  72493. */
  72494. export class BlackAndWhitePostProcess extends PostProcess {
  72495. /**
  72496. * Linear about to convert he result to black and white (default: 1)
  72497. */
  72498. degree: number;
  72499. /**
  72500. * Gets a string identifying the name of the class
  72501. * @returns "BlackAndWhitePostProcess" string
  72502. */
  72503. getClassName(): string;
  72504. /**
  72505. * Creates a black and white post process
  72506. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72507. * @param name The name of the effect.
  72508. * @param options The required width/height ratio to downsize to before computing the render pass.
  72509. * @param camera The camera to apply the render pass to.
  72510. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72511. * @param engine The engine which the post process will be applied. (default: current engine)
  72512. * @param reusable If the post process can be reused on the same frame. (default: false)
  72513. */
  72514. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72515. /** @hidden */
  72516. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  72517. }
  72518. }
  72519. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72520. import { Nullable } from "babylonjs/types";
  72521. import { Camera } from "babylonjs/Cameras/camera";
  72522. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72523. import { Engine } from "babylonjs/Engines/engine";
  72524. /**
  72525. * This represents a set of one or more post processes in Babylon.
  72526. * A post process can be used to apply a shader to a texture after it is rendered.
  72527. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72528. */
  72529. export class PostProcessRenderEffect {
  72530. private _postProcesses;
  72531. private _getPostProcesses;
  72532. private _singleInstance;
  72533. private _cameras;
  72534. private _indicesForCamera;
  72535. /**
  72536. * Name of the effect
  72537. * @hidden
  72538. */
  72539. _name: string;
  72540. /**
  72541. * Instantiates a post process render effect.
  72542. * A post process can be used to apply a shader to a texture after it is rendered.
  72543. * @param engine The engine the effect is tied to
  72544. * @param name The name of the effect
  72545. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72546. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72547. */
  72548. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72549. /**
  72550. * Checks if all the post processes in the effect are supported.
  72551. */
  72552. get isSupported(): boolean;
  72553. /**
  72554. * Updates the current state of the effect
  72555. * @hidden
  72556. */
  72557. _update(): void;
  72558. /**
  72559. * Attaches the effect on cameras
  72560. * @param cameras The camera to attach to.
  72561. * @hidden
  72562. */
  72563. _attachCameras(cameras: Camera): void;
  72564. /**
  72565. * Attaches the effect on cameras
  72566. * @param cameras The camera to attach to.
  72567. * @hidden
  72568. */
  72569. _attachCameras(cameras: Camera[]): void;
  72570. /**
  72571. * Detaches the effect on cameras
  72572. * @param cameras The camera to detatch from.
  72573. * @hidden
  72574. */
  72575. _detachCameras(cameras: Camera): void;
  72576. /**
  72577. * Detatches the effect on cameras
  72578. * @param cameras The camera to detatch from.
  72579. * @hidden
  72580. */
  72581. _detachCameras(cameras: Camera[]): void;
  72582. /**
  72583. * Enables the effect on given cameras
  72584. * @param cameras The camera to enable.
  72585. * @hidden
  72586. */
  72587. _enable(cameras: Camera): void;
  72588. /**
  72589. * Enables the effect on given cameras
  72590. * @param cameras The camera to enable.
  72591. * @hidden
  72592. */
  72593. _enable(cameras: Nullable<Camera[]>): void;
  72594. /**
  72595. * Disables the effect on the given cameras
  72596. * @param cameras The camera to disable.
  72597. * @hidden
  72598. */
  72599. _disable(cameras: Camera): void;
  72600. /**
  72601. * Disables the effect on the given cameras
  72602. * @param cameras The camera to disable.
  72603. * @hidden
  72604. */
  72605. _disable(cameras: Nullable<Camera[]>): void;
  72606. /**
  72607. * Gets a list of the post processes contained in the effect.
  72608. * @param camera The camera to get the post processes on.
  72609. * @returns The list of the post processes in the effect.
  72610. */
  72611. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72612. }
  72613. }
  72614. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72615. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72616. /** @hidden */
  72617. export var extractHighlightsPixelShader: {
  72618. name: string;
  72619. shader: string;
  72620. };
  72621. }
  72622. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72623. import { Nullable } from "babylonjs/types";
  72624. import { Camera } from "babylonjs/Cameras/camera";
  72625. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72626. import { Engine } from "babylonjs/Engines/engine";
  72627. import "babylonjs/Shaders/extractHighlights.fragment";
  72628. /**
  72629. * 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.
  72630. */
  72631. export class ExtractHighlightsPostProcess extends PostProcess {
  72632. /**
  72633. * The luminance threshold, pixels below this value will be set to black.
  72634. */
  72635. threshold: number;
  72636. /** @hidden */
  72637. _exposure: number;
  72638. /**
  72639. * Post process which has the input texture to be used when performing highlight extraction
  72640. * @hidden
  72641. */
  72642. _inputPostProcess: Nullable<PostProcess>;
  72643. /**
  72644. * Gets a string identifying the name of the class
  72645. * @returns "ExtractHighlightsPostProcess" string
  72646. */
  72647. getClassName(): string;
  72648. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72649. }
  72650. }
  72651. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72652. /** @hidden */
  72653. export var bloomMergePixelShader: {
  72654. name: string;
  72655. shader: string;
  72656. };
  72657. }
  72658. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72659. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72660. import { Nullable } from "babylonjs/types";
  72661. import { Engine } from "babylonjs/Engines/engine";
  72662. import { Camera } from "babylonjs/Cameras/camera";
  72663. import "babylonjs/Shaders/bloomMerge.fragment";
  72664. /**
  72665. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72666. */
  72667. export class BloomMergePostProcess extends PostProcess {
  72668. /** Weight of the bloom to be added to the original input. */
  72669. weight: number;
  72670. /**
  72671. * Gets a string identifying the name of the class
  72672. * @returns "BloomMergePostProcess" string
  72673. */
  72674. getClassName(): string;
  72675. /**
  72676. * Creates a new instance of @see BloomMergePostProcess
  72677. * @param name The name of the effect.
  72678. * @param originalFromInput Post process which's input will be used for the merge.
  72679. * @param blurred Blurred highlights post process which's output will be used.
  72680. * @param weight Weight of the bloom to be added to the original input.
  72681. * @param options The required width/height ratio to downsize to before computing the render pass.
  72682. * @param camera The camera to apply the render pass to.
  72683. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72684. * @param engine The engine which the post process will be applied. (default: current engine)
  72685. * @param reusable If the post process can be reused on the same frame. (default: false)
  72686. * @param textureType Type of textures used when performing the post process. (default: 0)
  72687. * @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)
  72688. */
  72689. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72690. /** Weight of the bloom to be added to the original input. */
  72691. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72692. }
  72693. }
  72694. declare module "babylonjs/PostProcesses/bloomEffect" {
  72695. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72696. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72697. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72698. import { Camera } from "babylonjs/Cameras/camera";
  72699. import { Scene } from "babylonjs/scene";
  72700. /**
  72701. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72702. */
  72703. export class BloomEffect extends PostProcessRenderEffect {
  72704. private bloomScale;
  72705. /**
  72706. * @hidden Internal
  72707. */
  72708. _effects: Array<PostProcess>;
  72709. /**
  72710. * @hidden Internal
  72711. */
  72712. _downscale: ExtractHighlightsPostProcess;
  72713. private _blurX;
  72714. private _blurY;
  72715. private _merge;
  72716. /**
  72717. * The luminance threshold to find bright areas of the image to bloom.
  72718. */
  72719. get threshold(): number;
  72720. set threshold(value: number);
  72721. /**
  72722. * The strength of the bloom.
  72723. */
  72724. get weight(): number;
  72725. set weight(value: number);
  72726. /**
  72727. * Specifies the size of the bloom blur kernel, relative to the final output size
  72728. */
  72729. get kernel(): number;
  72730. set kernel(value: number);
  72731. /**
  72732. * Creates a new instance of @see BloomEffect
  72733. * @param scene The scene the effect belongs to.
  72734. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72735. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72736. * @param bloomWeight The the strength of bloom.
  72737. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72738. * @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)
  72739. */
  72740. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72741. /**
  72742. * Disposes each of the internal effects for a given camera.
  72743. * @param camera The camera to dispose the effect on.
  72744. */
  72745. disposeEffects(camera: Camera): void;
  72746. /**
  72747. * @hidden Internal
  72748. */
  72749. _updateEffects(): void;
  72750. /**
  72751. * Internal
  72752. * @returns if all the contained post processes are ready.
  72753. * @hidden
  72754. */
  72755. _isReady(): boolean;
  72756. }
  72757. }
  72758. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  72759. /** @hidden */
  72760. export var chromaticAberrationPixelShader: {
  72761. name: string;
  72762. shader: string;
  72763. };
  72764. }
  72765. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  72766. import { Vector2 } from "babylonjs/Maths/math.vector";
  72767. import { Nullable } from "babylonjs/types";
  72768. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72769. import { Camera } from "babylonjs/Cameras/camera";
  72770. import { Engine } from "babylonjs/Engines/engine";
  72771. import "babylonjs/Shaders/chromaticAberration.fragment";
  72772. import { Scene } from "babylonjs/scene";
  72773. /**
  72774. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  72775. */
  72776. export class ChromaticAberrationPostProcess extends PostProcess {
  72777. /**
  72778. * The amount of seperation of rgb channels (default: 30)
  72779. */
  72780. aberrationAmount: number;
  72781. /**
  72782. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  72783. */
  72784. radialIntensity: number;
  72785. /**
  72786. * 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))
  72787. */
  72788. direction: Vector2;
  72789. /**
  72790. * 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))
  72791. */
  72792. centerPosition: Vector2;
  72793. /** The width of the screen to apply the effect on */
  72794. screenWidth: number;
  72795. /** The height of the screen to apply the effect on */
  72796. screenHeight: number;
  72797. /**
  72798. * Gets a string identifying the name of the class
  72799. * @returns "ChromaticAberrationPostProcess" string
  72800. */
  72801. getClassName(): string;
  72802. /**
  72803. * Creates a new instance ChromaticAberrationPostProcess
  72804. * @param name The name of the effect.
  72805. * @param screenWidth The width of the screen to apply the effect on.
  72806. * @param screenHeight The height of the screen to apply the effect on.
  72807. * @param options The required width/height ratio to downsize to before computing the render pass.
  72808. * @param camera The camera to apply the render pass to.
  72809. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72810. * @param engine The engine which the post process will be applied. (default: current engine)
  72811. * @param reusable If the post process can be reused on the same frame. (default: false)
  72812. * @param textureType Type of textures used when performing the post process. (default: 0)
  72813. * @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)
  72814. */
  72815. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72816. /** @hidden */
  72817. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  72818. }
  72819. }
  72820. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  72821. /** @hidden */
  72822. export var circleOfConfusionPixelShader: {
  72823. name: string;
  72824. shader: string;
  72825. };
  72826. }
  72827. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  72828. import { Nullable } from "babylonjs/types";
  72829. import { Engine } from "babylonjs/Engines/engine";
  72830. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72831. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72832. import { Camera } from "babylonjs/Cameras/camera";
  72833. import "babylonjs/Shaders/circleOfConfusion.fragment";
  72834. /**
  72835. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  72836. */
  72837. export class CircleOfConfusionPostProcess extends PostProcess {
  72838. /**
  72839. * 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.
  72840. */
  72841. lensSize: number;
  72842. /**
  72843. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72844. */
  72845. fStop: number;
  72846. /**
  72847. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72848. */
  72849. focusDistance: number;
  72850. /**
  72851. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  72852. */
  72853. focalLength: number;
  72854. /**
  72855. * Gets a string identifying the name of the class
  72856. * @returns "CircleOfConfusionPostProcess" string
  72857. */
  72858. getClassName(): string;
  72859. private _depthTexture;
  72860. /**
  72861. * Creates a new instance CircleOfConfusionPostProcess
  72862. * @param name The name of the effect.
  72863. * @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.
  72864. * @param options The required width/height ratio to downsize to before computing the render pass.
  72865. * @param camera The camera to apply the render pass to.
  72866. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72867. * @param engine The engine which the post process will be applied. (default: current engine)
  72868. * @param reusable If the post process can be reused on the same frame. (default: false)
  72869. * @param textureType Type of textures used when performing the post process. (default: 0)
  72870. * @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)
  72871. */
  72872. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72873. /**
  72874. * 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.
  72875. */
  72876. set depthTexture(value: RenderTargetTexture);
  72877. }
  72878. }
  72879. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  72880. /** @hidden */
  72881. export var colorCorrectionPixelShader: {
  72882. name: string;
  72883. shader: string;
  72884. };
  72885. }
  72886. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  72887. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72888. import { Engine } from "babylonjs/Engines/engine";
  72889. import { Camera } from "babylonjs/Cameras/camera";
  72890. import "babylonjs/Shaders/colorCorrection.fragment";
  72891. import { Nullable } from "babylonjs/types";
  72892. import { Scene } from "babylonjs/scene";
  72893. /**
  72894. *
  72895. * This post-process allows the modification of rendered colors by using
  72896. * a 'look-up table' (LUT). This effect is also called Color Grading.
  72897. *
  72898. * The object needs to be provided an url to a texture containing the color
  72899. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  72900. * Use an image editing software to tweak the LUT to match your needs.
  72901. *
  72902. * For an example of a color LUT, see here:
  72903. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  72904. * For explanations on color grading, see here:
  72905. * @see http://udn.epicgames.com/Three/ColorGrading.html
  72906. *
  72907. */
  72908. export class ColorCorrectionPostProcess extends PostProcess {
  72909. private _colorTableTexture;
  72910. /**
  72911. * Gets the color table url used to create the LUT texture
  72912. */
  72913. colorTableUrl: string;
  72914. /**
  72915. * Gets a string identifying the name of the class
  72916. * @returns "ColorCorrectionPostProcess" string
  72917. */
  72918. getClassName(): string;
  72919. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72920. /** @hidden */
  72921. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  72922. }
  72923. }
  72924. declare module "babylonjs/Shaders/convolution.fragment" {
  72925. /** @hidden */
  72926. export var convolutionPixelShader: {
  72927. name: string;
  72928. shader: string;
  72929. };
  72930. }
  72931. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  72932. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72933. import { Nullable } from "babylonjs/types";
  72934. import { Camera } from "babylonjs/Cameras/camera";
  72935. import { Engine } from "babylonjs/Engines/engine";
  72936. import "babylonjs/Shaders/convolution.fragment";
  72937. import { Scene } from "babylonjs/scene";
  72938. /**
  72939. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  72940. * input texture to perform effects such as edge detection or sharpening
  72941. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  72942. */
  72943. export class ConvolutionPostProcess extends PostProcess {
  72944. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  72945. kernel: number[];
  72946. /**
  72947. * Gets a string identifying the name of the class
  72948. * @returns "ConvolutionPostProcess" string
  72949. */
  72950. getClassName(): string;
  72951. /**
  72952. * Creates a new instance ConvolutionPostProcess
  72953. * @param name The name of the effect.
  72954. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  72955. * @param options The required width/height ratio to downsize to before computing the render pass.
  72956. * @param camera The camera to apply the render pass to.
  72957. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72958. * @param engine The engine which the post process will be applied. (default: current engine)
  72959. * @param reusable If the post process can be reused on the same frame. (default: false)
  72960. * @param textureType Type of textures used when performing the post process. (default: 0)
  72961. */
  72962. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72963. /** @hidden */
  72964. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  72965. /**
  72966. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72967. */
  72968. static EdgeDetect0Kernel: number[];
  72969. /**
  72970. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72971. */
  72972. static EdgeDetect1Kernel: number[];
  72973. /**
  72974. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72975. */
  72976. static EdgeDetect2Kernel: number[];
  72977. /**
  72978. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72979. */
  72980. static SharpenKernel: number[];
  72981. /**
  72982. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72983. */
  72984. static EmbossKernel: number[];
  72985. /**
  72986. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72987. */
  72988. static GaussianKernel: number[];
  72989. }
  72990. }
  72991. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  72992. import { Nullable } from "babylonjs/types";
  72993. import { Vector2 } from "babylonjs/Maths/math.vector";
  72994. import { Camera } from "babylonjs/Cameras/camera";
  72995. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72996. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  72997. import { Engine } from "babylonjs/Engines/engine";
  72998. import { Scene } from "babylonjs/scene";
  72999. /**
  73000. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  73001. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  73002. * based on samples that have a large difference in distance than the center pixel.
  73003. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  73004. */
  73005. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  73006. /**
  73007. * The direction the blur should be applied
  73008. */
  73009. direction: Vector2;
  73010. /**
  73011. * Gets a string identifying the name of the class
  73012. * @returns "DepthOfFieldBlurPostProcess" string
  73013. */
  73014. getClassName(): string;
  73015. /**
  73016. * Creates a new instance CircleOfConfusionPostProcess
  73017. * @param name The name of the effect.
  73018. * @param scene The scene the effect belongs to.
  73019. * @param direction The direction the blur should be applied.
  73020. * @param kernel The size of the kernel used to blur.
  73021. * @param options The required width/height ratio to downsize to before computing the render pass.
  73022. * @param camera The camera to apply the render pass to.
  73023. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  73024. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  73025. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73026. * @param engine The engine which the post process will be applied. (default: current engine)
  73027. * @param reusable If the post process can be reused on the same frame. (default: false)
  73028. * @param textureType Type of textures used when performing the post process. (default: 0)
  73029. * @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)
  73030. */
  73031. 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);
  73032. }
  73033. }
  73034. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  73035. /** @hidden */
  73036. export var depthOfFieldMergePixelShader: {
  73037. name: string;
  73038. shader: string;
  73039. };
  73040. }
  73041. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  73042. import { Nullable } from "babylonjs/types";
  73043. import { Camera } from "babylonjs/Cameras/camera";
  73044. import { Effect } from "babylonjs/Materials/effect";
  73045. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73046. import { Engine } from "babylonjs/Engines/engine";
  73047. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  73048. /**
  73049. * Options to be set when merging outputs from the default pipeline.
  73050. */
  73051. export class DepthOfFieldMergePostProcessOptions {
  73052. /**
  73053. * The original image to merge on top of
  73054. */
  73055. originalFromInput: PostProcess;
  73056. /**
  73057. * Parameters to perform the merge of the depth of field effect
  73058. */
  73059. depthOfField?: {
  73060. circleOfConfusion: PostProcess;
  73061. blurSteps: Array<PostProcess>;
  73062. };
  73063. /**
  73064. * Parameters to perform the merge of bloom effect
  73065. */
  73066. bloom?: {
  73067. blurred: PostProcess;
  73068. weight: number;
  73069. };
  73070. }
  73071. /**
  73072. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73073. */
  73074. export class DepthOfFieldMergePostProcess extends PostProcess {
  73075. private blurSteps;
  73076. /**
  73077. * Gets a string identifying the name of the class
  73078. * @returns "DepthOfFieldMergePostProcess" string
  73079. */
  73080. getClassName(): string;
  73081. /**
  73082. * Creates a new instance of DepthOfFieldMergePostProcess
  73083. * @param name The name of the effect.
  73084. * @param originalFromInput Post process which's input will be used for the merge.
  73085. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73086. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73087. * @param options The required width/height ratio to downsize to before computing the render pass.
  73088. * @param camera The camera to apply the render pass to.
  73089. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73090. * @param engine The engine which the post process will be applied. (default: current engine)
  73091. * @param reusable If the post process can be reused on the same frame. (default: false)
  73092. * @param textureType Type of textures used when performing the post process. (default: 0)
  73093. * @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)
  73094. */
  73095. 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);
  73096. /**
  73097. * Updates the effect with the current post process compile time values and recompiles the shader.
  73098. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73099. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73100. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73101. * @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
  73102. * @param onCompiled Called when the shader has been compiled.
  73103. * @param onError Called if there is an error when compiling a shader.
  73104. */
  73105. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73106. }
  73107. }
  73108. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73109. import { Nullable } from "babylonjs/types";
  73110. import { Camera } from "babylonjs/Cameras/camera";
  73111. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73112. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73113. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73114. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  73115. import { Scene } from "babylonjs/scene";
  73116. /**
  73117. * Specifies the level of max blur that should be applied when using the depth of field effect
  73118. */
  73119. export enum DepthOfFieldEffectBlurLevel {
  73120. /**
  73121. * Subtle blur
  73122. */
  73123. Low = 0,
  73124. /**
  73125. * Medium blur
  73126. */
  73127. Medium = 1,
  73128. /**
  73129. * Large blur
  73130. */
  73131. High = 2
  73132. }
  73133. /**
  73134. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  73135. */
  73136. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  73137. private _circleOfConfusion;
  73138. /**
  73139. * @hidden Internal, blurs from high to low
  73140. */
  73141. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  73142. private _depthOfFieldBlurY;
  73143. private _dofMerge;
  73144. /**
  73145. * @hidden Internal post processes in depth of field effect
  73146. */
  73147. _effects: Array<PostProcess>;
  73148. /**
  73149. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  73150. */
  73151. set focalLength(value: number);
  73152. get focalLength(): number;
  73153. /**
  73154. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73155. */
  73156. set fStop(value: number);
  73157. get fStop(): number;
  73158. /**
  73159. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73160. */
  73161. set focusDistance(value: number);
  73162. get focusDistance(): number;
  73163. /**
  73164. * 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.
  73165. */
  73166. set lensSize(value: number);
  73167. get lensSize(): number;
  73168. /**
  73169. * Creates a new instance DepthOfFieldEffect
  73170. * @param scene The scene the effect belongs to.
  73171. * @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.
  73172. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73173. * @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)
  73174. */
  73175. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  73176. /**
  73177. * Get the current class name of the current effet
  73178. * @returns "DepthOfFieldEffect"
  73179. */
  73180. getClassName(): string;
  73181. /**
  73182. * 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.
  73183. */
  73184. set depthTexture(value: RenderTargetTexture);
  73185. /**
  73186. * Disposes each of the internal effects for a given camera.
  73187. * @param camera The camera to dispose the effect on.
  73188. */
  73189. disposeEffects(camera: Camera): void;
  73190. /**
  73191. * @hidden Internal
  73192. */
  73193. _updateEffects(): void;
  73194. /**
  73195. * Internal
  73196. * @returns if all the contained post processes are ready.
  73197. * @hidden
  73198. */
  73199. _isReady(): boolean;
  73200. }
  73201. }
  73202. declare module "babylonjs/Shaders/displayPass.fragment" {
  73203. /** @hidden */
  73204. export var displayPassPixelShader: {
  73205. name: string;
  73206. shader: string;
  73207. };
  73208. }
  73209. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  73210. import { Nullable } from "babylonjs/types";
  73211. import { Camera } from "babylonjs/Cameras/camera";
  73212. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73213. import { Engine } from "babylonjs/Engines/engine";
  73214. import "babylonjs/Shaders/displayPass.fragment";
  73215. import { Scene } from "babylonjs/scene";
  73216. /**
  73217. * DisplayPassPostProcess which produces an output the same as it's input
  73218. */
  73219. export class DisplayPassPostProcess extends PostProcess {
  73220. /**
  73221. * Gets a string identifying the name of the class
  73222. * @returns "DisplayPassPostProcess" string
  73223. */
  73224. getClassName(): string;
  73225. /**
  73226. * Creates the DisplayPassPostProcess
  73227. * @param name The name of the effect.
  73228. * @param options The required width/height ratio to downsize to before computing the render pass.
  73229. * @param camera The camera to apply the render pass to.
  73230. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73231. * @param engine The engine which the post process will be applied. (default: current engine)
  73232. * @param reusable If the post process can be reused on the same frame. (default: false)
  73233. */
  73234. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73235. /** @hidden */
  73236. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  73237. }
  73238. }
  73239. declare module "babylonjs/Shaders/filter.fragment" {
  73240. /** @hidden */
  73241. export var filterPixelShader: {
  73242. name: string;
  73243. shader: string;
  73244. };
  73245. }
  73246. declare module "babylonjs/PostProcesses/filterPostProcess" {
  73247. import { Nullable } from "babylonjs/types";
  73248. import { Matrix } from "babylonjs/Maths/math.vector";
  73249. import { Camera } from "babylonjs/Cameras/camera";
  73250. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73251. import { Engine } from "babylonjs/Engines/engine";
  73252. import "babylonjs/Shaders/filter.fragment";
  73253. import { Scene } from "babylonjs/scene";
  73254. /**
  73255. * Applies a kernel filter to the image
  73256. */
  73257. export class FilterPostProcess extends PostProcess {
  73258. /** The matrix to be applied to the image */
  73259. kernelMatrix: Matrix;
  73260. /**
  73261. * Gets a string identifying the name of the class
  73262. * @returns "FilterPostProcess" string
  73263. */
  73264. getClassName(): string;
  73265. /**
  73266. *
  73267. * @param name The name of the effect.
  73268. * @param kernelMatrix The matrix to be applied to the image
  73269. * @param options The required width/height ratio to downsize to before computing the render pass.
  73270. * @param camera The camera to apply the render pass to.
  73271. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73272. * @param engine The engine which the post process will be applied. (default: current engine)
  73273. * @param reusable If the post process can be reused on the same frame. (default: false)
  73274. */
  73275. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73276. /** @hidden */
  73277. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  73278. }
  73279. }
  73280. declare module "babylonjs/Shaders/fxaa.fragment" {
  73281. /** @hidden */
  73282. export var fxaaPixelShader: {
  73283. name: string;
  73284. shader: string;
  73285. };
  73286. }
  73287. declare module "babylonjs/Shaders/fxaa.vertex" {
  73288. /** @hidden */
  73289. export var fxaaVertexShader: {
  73290. name: string;
  73291. shader: string;
  73292. };
  73293. }
  73294. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  73295. import { Nullable } from "babylonjs/types";
  73296. import { Camera } from "babylonjs/Cameras/camera";
  73297. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73298. import { Engine } from "babylonjs/Engines/engine";
  73299. import "babylonjs/Shaders/fxaa.fragment";
  73300. import "babylonjs/Shaders/fxaa.vertex";
  73301. import { Scene } from "babylonjs/scene";
  73302. /**
  73303. * Fxaa post process
  73304. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  73305. */
  73306. export class FxaaPostProcess extends PostProcess {
  73307. /**
  73308. * Gets a string identifying the name of the class
  73309. * @returns "FxaaPostProcess" string
  73310. */
  73311. getClassName(): string;
  73312. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73313. private _getDefines;
  73314. /** @hidden */
  73315. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  73316. }
  73317. }
  73318. declare module "babylonjs/Shaders/grain.fragment" {
  73319. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73320. /** @hidden */
  73321. export var grainPixelShader: {
  73322. name: string;
  73323. shader: string;
  73324. };
  73325. }
  73326. declare module "babylonjs/PostProcesses/grainPostProcess" {
  73327. import { Nullable } from "babylonjs/types";
  73328. import { Camera } from "babylonjs/Cameras/camera";
  73329. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73330. import { Engine } from "babylonjs/Engines/engine";
  73331. import "babylonjs/Shaders/grain.fragment";
  73332. import { Scene } from "babylonjs/scene";
  73333. /**
  73334. * The GrainPostProcess adds noise to the image at mid luminance levels
  73335. */
  73336. export class GrainPostProcess extends PostProcess {
  73337. /**
  73338. * The intensity of the grain added (default: 30)
  73339. */
  73340. intensity: number;
  73341. /**
  73342. * If the grain should be randomized on every frame
  73343. */
  73344. animated: boolean;
  73345. /**
  73346. * Gets a string identifying the name of the class
  73347. * @returns "GrainPostProcess" string
  73348. */
  73349. getClassName(): string;
  73350. /**
  73351. * Creates a new instance of @see GrainPostProcess
  73352. * @param name The name of the effect.
  73353. * @param options The required width/height ratio to downsize to before computing the render pass.
  73354. * @param camera The camera to apply the render pass to.
  73355. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73356. * @param engine The engine which the post process will be applied. (default: current engine)
  73357. * @param reusable If the post process can be reused on the same frame. (default: false)
  73358. * @param textureType Type of textures used when performing the post process. (default: 0)
  73359. * @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)
  73360. */
  73361. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73362. /** @hidden */
  73363. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  73364. }
  73365. }
  73366. declare module "babylonjs/Shaders/highlights.fragment" {
  73367. /** @hidden */
  73368. export var highlightsPixelShader: {
  73369. name: string;
  73370. shader: string;
  73371. };
  73372. }
  73373. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  73374. import { Nullable } from "babylonjs/types";
  73375. import { Camera } from "babylonjs/Cameras/camera";
  73376. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73377. import { Engine } from "babylonjs/Engines/engine";
  73378. import "babylonjs/Shaders/highlights.fragment";
  73379. /**
  73380. * Extracts highlights from the image
  73381. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73382. */
  73383. export class HighlightsPostProcess extends PostProcess {
  73384. /**
  73385. * Gets a string identifying the name of the class
  73386. * @returns "HighlightsPostProcess" string
  73387. */
  73388. getClassName(): string;
  73389. /**
  73390. * Extracts highlights from the image
  73391. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73392. * @param name The name of the effect.
  73393. * @param options The required width/height ratio to downsize to before computing the render pass.
  73394. * @param camera The camera to apply the render pass to.
  73395. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73396. * @param engine The engine which the post process will be applied. (default: current engine)
  73397. * @param reusable If the post process can be reused on the same frame. (default: false)
  73398. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  73399. */
  73400. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73401. }
  73402. }
  73403. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  73404. /** @hidden */
  73405. export var mrtFragmentDeclaration: {
  73406. name: string;
  73407. shader: string;
  73408. };
  73409. }
  73410. declare module "babylonjs/Shaders/geometry.fragment" {
  73411. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  73412. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  73413. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  73414. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  73415. /** @hidden */
  73416. export var geometryPixelShader: {
  73417. name: string;
  73418. shader: string;
  73419. };
  73420. }
  73421. declare module "babylonjs/Shaders/geometry.vertex" {
  73422. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  73423. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  73424. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  73425. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  73426. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  73427. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  73428. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  73429. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  73430. /** @hidden */
  73431. export var geometryVertexShader: {
  73432. name: string;
  73433. shader: string;
  73434. };
  73435. }
  73436. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  73437. import { Matrix } from "babylonjs/Maths/math.vector";
  73438. import { SubMesh } from "babylonjs/Meshes/subMesh";
  73439. import { Mesh } from "babylonjs/Meshes/mesh";
  73440. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  73441. import { Effect } from "babylonjs/Materials/effect";
  73442. import { Scene } from "babylonjs/scene";
  73443. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73444. import "babylonjs/Shaders/geometry.fragment";
  73445. import "babylonjs/Shaders/geometry.vertex";
  73446. /** @hidden */
  73447. interface ISavedTransformationMatrix {
  73448. world: Matrix;
  73449. viewProjection: Matrix;
  73450. }
  73451. /**
  73452. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  73453. */
  73454. export class GeometryBufferRenderer {
  73455. /**
  73456. * Constant used to retrieve the position texture index in the G-Buffer textures array
  73457. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  73458. */
  73459. static readonly POSITION_TEXTURE_TYPE: number;
  73460. /**
  73461. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  73462. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  73463. */
  73464. static readonly VELOCITY_TEXTURE_TYPE: number;
  73465. /**
  73466. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  73467. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  73468. */
  73469. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  73470. /**
  73471. * Dictionary used to store the previous transformation matrices of each rendered mesh
  73472. * in order to compute objects velocities when enableVelocity is set to "true"
  73473. * @hidden
  73474. */
  73475. _previousTransformationMatrices: {
  73476. [index: number]: ISavedTransformationMatrix;
  73477. };
  73478. /**
  73479. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  73480. * in order to compute objects velocities when enableVelocity is set to "true"
  73481. * @hidden
  73482. */
  73483. _previousBonesTransformationMatrices: {
  73484. [index: number]: Float32Array;
  73485. };
  73486. /**
  73487. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  73488. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  73489. */
  73490. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  73491. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  73492. renderTransparentMeshes: boolean;
  73493. private _scene;
  73494. private _resizeObserver;
  73495. private _multiRenderTarget;
  73496. private _ratio;
  73497. private _enablePosition;
  73498. private _enableVelocity;
  73499. private _enableReflectivity;
  73500. private _positionIndex;
  73501. private _velocityIndex;
  73502. private _reflectivityIndex;
  73503. protected _effect: Effect;
  73504. protected _cachedDefines: string;
  73505. /**
  73506. * Set the render list (meshes to be rendered) used in the G buffer.
  73507. */
  73508. set renderList(meshes: Mesh[]);
  73509. /**
  73510. * Gets wether or not G buffer are supported by the running hardware.
  73511. * This requires draw buffer supports
  73512. */
  73513. get isSupported(): boolean;
  73514. /**
  73515. * Returns the index of the given texture type in the G-Buffer textures array
  73516. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  73517. * @returns the index of the given texture type in the G-Buffer textures array
  73518. */
  73519. getTextureIndex(textureType: number): number;
  73520. /**
  73521. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  73522. */
  73523. get enablePosition(): boolean;
  73524. /**
  73525. * Sets whether or not objects positions are enabled for the G buffer.
  73526. */
  73527. set enablePosition(enable: boolean);
  73528. /**
  73529. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  73530. */
  73531. get enableVelocity(): boolean;
  73532. /**
  73533. * Sets wether or not objects velocities are enabled for the G buffer.
  73534. */
  73535. set enableVelocity(enable: boolean);
  73536. /**
  73537. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  73538. */
  73539. get enableReflectivity(): boolean;
  73540. /**
  73541. * Sets wether or not objects roughness are enabled for the G buffer.
  73542. */
  73543. set enableReflectivity(enable: boolean);
  73544. /**
  73545. * Gets the scene associated with the buffer.
  73546. */
  73547. get scene(): Scene;
  73548. /**
  73549. * Gets the ratio used by the buffer during its creation.
  73550. * How big is the buffer related to the main canvas.
  73551. */
  73552. get ratio(): number;
  73553. /** @hidden */
  73554. static _SceneComponentInitialization: (scene: Scene) => void;
  73555. /**
  73556. * Creates a new G Buffer for the scene
  73557. * @param scene The scene the buffer belongs to
  73558. * @param ratio How big is the buffer related to the main canvas.
  73559. */
  73560. constructor(scene: Scene, ratio?: number);
  73561. /**
  73562. * Checks wether everything is ready to render a submesh to the G buffer.
  73563. * @param subMesh the submesh to check readiness for
  73564. * @param useInstances is the mesh drawn using instance or not
  73565. * @returns true if ready otherwise false
  73566. */
  73567. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73568. /**
  73569. * Gets the current underlying G Buffer.
  73570. * @returns the buffer
  73571. */
  73572. getGBuffer(): MultiRenderTarget;
  73573. /**
  73574. * Gets the number of samples used to render the buffer (anti aliasing).
  73575. */
  73576. get samples(): number;
  73577. /**
  73578. * Sets the number of samples used to render the buffer (anti aliasing).
  73579. */
  73580. set samples(value: number);
  73581. /**
  73582. * Disposes the renderer and frees up associated resources.
  73583. */
  73584. dispose(): void;
  73585. protected _createRenderTargets(): void;
  73586. private _copyBonesTransformationMatrices;
  73587. }
  73588. }
  73589. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73590. import { Nullable } from "babylonjs/types";
  73591. import { Scene } from "babylonjs/scene";
  73592. import { ISceneComponent } from "babylonjs/sceneComponent";
  73593. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73594. module "babylonjs/scene" {
  73595. interface Scene {
  73596. /** @hidden (Backing field) */
  73597. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73598. /**
  73599. * Gets or Sets the current geometry buffer associated to the scene.
  73600. */
  73601. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73602. /**
  73603. * Enables a GeometryBufferRender and associates it with the scene
  73604. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73605. * @returns the GeometryBufferRenderer
  73606. */
  73607. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73608. /**
  73609. * Disables the GeometryBufferRender associated with the scene
  73610. */
  73611. disableGeometryBufferRenderer(): void;
  73612. }
  73613. }
  73614. /**
  73615. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73616. * in several rendering techniques.
  73617. */
  73618. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73619. /**
  73620. * The component name helpful to identify the component in the list of scene components.
  73621. */
  73622. readonly name: string;
  73623. /**
  73624. * The scene the component belongs to.
  73625. */
  73626. scene: Scene;
  73627. /**
  73628. * Creates a new instance of the component for the given scene
  73629. * @param scene Defines the scene to register the component in
  73630. */
  73631. constructor(scene: Scene);
  73632. /**
  73633. * Registers the component in a given scene
  73634. */
  73635. register(): void;
  73636. /**
  73637. * Rebuilds the elements related to this component in case of
  73638. * context lost for instance.
  73639. */
  73640. rebuild(): void;
  73641. /**
  73642. * Disposes the component and the associated ressources
  73643. */
  73644. dispose(): void;
  73645. private _gatherRenderTargets;
  73646. }
  73647. }
  73648. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73649. /** @hidden */
  73650. export var motionBlurPixelShader: {
  73651. name: string;
  73652. shader: string;
  73653. };
  73654. }
  73655. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73656. import { Nullable } from "babylonjs/types";
  73657. import { Camera } from "babylonjs/Cameras/camera";
  73658. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73659. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73660. import "babylonjs/Animations/animatable";
  73661. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73662. import "babylonjs/Shaders/motionBlur.fragment";
  73663. import { Engine } from "babylonjs/Engines/engine";
  73664. import { Scene } from "babylonjs/scene";
  73665. /**
  73666. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73667. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73668. * As an example, all you have to do is to create the post-process:
  73669. * var mb = new BABYLON.MotionBlurPostProcess(
  73670. * 'mb', // The name of the effect.
  73671. * scene, // The scene containing the objects to blur according to their velocity.
  73672. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73673. * camera // The camera to apply the render pass to.
  73674. * );
  73675. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73676. */
  73677. export class MotionBlurPostProcess extends PostProcess {
  73678. /**
  73679. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73680. */
  73681. motionStrength: number;
  73682. /**
  73683. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73684. */
  73685. get motionBlurSamples(): number;
  73686. /**
  73687. * Sets the number of iterations to be used for motion blur quality
  73688. */
  73689. set motionBlurSamples(samples: number);
  73690. private _motionBlurSamples;
  73691. private _geometryBufferRenderer;
  73692. /**
  73693. * Gets a string identifying the name of the class
  73694. * @returns "MotionBlurPostProcess" string
  73695. */
  73696. getClassName(): string;
  73697. /**
  73698. * Creates a new instance MotionBlurPostProcess
  73699. * @param name The name of the effect.
  73700. * @param scene The scene containing the objects to blur according to their velocity.
  73701. * @param options The required width/height ratio to downsize to before computing the render pass.
  73702. * @param camera The camera to apply the render pass to.
  73703. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73704. * @param engine The engine which the post process will be applied. (default: current engine)
  73705. * @param reusable If the post process can be reused on the same frame. (default: false)
  73706. * @param textureType Type of textures used when performing the post process. (default: 0)
  73707. * @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)
  73708. */
  73709. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73710. /**
  73711. * Excludes the given skinned mesh from computing bones velocities.
  73712. * 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.
  73713. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73714. */
  73715. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73716. /**
  73717. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73718. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73719. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73720. */
  73721. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73722. /**
  73723. * Disposes the post process.
  73724. * @param camera The camera to dispose the post process on.
  73725. */
  73726. dispose(camera?: Camera): void;
  73727. /** @hidden */
  73728. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  73729. }
  73730. }
  73731. declare module "babylonjs/Shaders/refraction.fragment" {
  73732. /** @hidden */
  73733. export var refractionPixelShader: {
  73734. name: string;
  73735. shader: string;
  73736. };
  73737. }
  73738. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73739. import { Color3 } from "babylonjs/Maths/math.color";
  73740. import { Camera } from "babylonjs/Cameras/camera";
  73741. import { Texture } from "babylonjs/Materials/Textures/texture";
  73742. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73743. import { Engine } from "babylonjs/Engines/engine";
  73744. import "babylonjs/Shaders/refraction.fragment";
  73745. import { Scene } from "babylonjs/scene";
  73746. /**
  73747. * Post process which applies a refractin texture
  73748. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73749. */
  73750. export class RefractionPostProcess extends PostProcess {
  73751. private _refTexture;
  73752. private _ownRefractionTexture;
  73753. /** the base color of the refraction (used to taint the rendering) */
  73754. color: Color3;
  73755. /** simulated refraction depth */
  73756. depth: number;
  73757. /** the coefficient of the base color (0 to remove base color tainting) */
  73758. colorLevel: number;
  73759. /** Gets the url used to load the refraction texture */
  73760. refractionTextureUrl: string;
  73761. /**
  73762. * Gets or sets the refraction texture
  73763. * Please note that you are responsible for disposing the texture if you set it manually
  73764. */
  73765. get refractionTexture(): Texture;
  73766. set refractionTexture(value: Texture);
  73767. /**
  73768. * Gets a string identifying the name of the class
  73769. * @returns "RefractionPostProcess" string
  73770. */
  73771. getClassName(): string;
  73772. /**
  73773. * Initializes the RefractionPostProcess
  73774. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73775. * @param name The name of the effect.
  73776. * @param refractionTextureUrl Url of the refraction texture to use
  73777. * @param color the base color of the refraction (used to taint the rendering)
  73778. * @param depth simulated refraction depth
  73779. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  73780. * @param camera The camera to apply the render pass to.
  73781. * @param options The required width/height ratio to downsize to before computing the render pass.
  73782. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73783. * @param engine The engine which the post process will be applied. (default: current engine)
  73784. * @param reusable If the post process can be reused on the same frame. (default: false)
  73785. */
  73786. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73787. /**
  73788. * Disposes of the post process
  73789. * @param camera Camera to dispose post process on
  73790. */
  73791. dispose(camera: Camera): void;
  73792. /** @hidden */
  73793. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  73794. }
  73795. }
  73796. declare module "babylonjs/Shaders/sharpen.fragment" {
  73797. /** @hidden */
  73798. export var sharpenPixelShader: {
  73799. name: string;
  73800. shader: string;
  73801. };
  73802. }
  73803. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  73804. import { Nullable } from "babylonjs/types";
  73805. import { Camera } from "babylonjs/Cameras/camera";
  73806. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73807. import "babylonjs/Shaders/sharpen.fragment";
  73808. import { Engine } from "babylonjs/Engines/engine";
  73809. import { Scene } from "babylonjs/scene";
  73810. /**
  73811. * The SharpenPostProcess applies a sharpen kernel to every pixel
  73812. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73813. */
  73814. export class SharpenPostProcess extends PostProcess {
  73815. /**
  73816. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  73817. */
  73818. colorAmount: number;
  73819. /**
  73820. * How much sharpness should be applied (default: 0.3)
  73821. */
  73822. edgeAmount: number;
  73823. /**
  73824. * Gets a string identifying the name of the class
  73825. * @returns "SharpenPostProcess" string
  73826. */
  73827. getClassName(): string;
  73828. /**
  73829. * Creates a new instance ConvolutionPostProcess
  73830. * @param name The name of the effect.
  73831. * @param options The required width/height ratio to downsize to before computing the render pass.
  73832. * @param camera The camera to apply the render pass to.
  73833. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73834. * @param engine The engine which the post process will be applied. (default: current engine)
  73835. * @param reusable If the post process can be reused on the same frame. (default: false)
  73836. * @param textureType Type of textures used when performing the post process. (default: 0)
  73837. * @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)
  73838. */
  73839. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73840. /** @hidden */
  73841. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  73842. }
  73843. }
  73844. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  73845. import { Nullable } from "babylonjs/types";
  73846. import { Camera } from "babylonjs/Cameras/camera";
  73847. import { Engine } from "babylonjs/Engines/engine";
  73848. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73849. import { IInspectable } from "babylonjs/Misc/iInspectable";
  73850. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73851. /**
  73852. * PostProcessRenderPipeline
  73853. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73854. */
  73855. export class PostProcessRenderPipeline {
  73856. private engine;
  73857. private _renderEffects;
  73858. private _renderEffectsForIsolatedPass;
  73859. /**
  73860. * List of inspectable custom properties (used by the Inspector)
  73861. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  73862. */
  73863. inspectableCustomProperties: IInspectable[];
  73864. /**
  73865. * @hidden
  73866. */
  73867. protected _cameras: Camera[];
  73868. /** @hidden */
  73869. _name: string;
  73870. /**
  73871. * Gets pipeline name
  73872. */
  73873. get name(): string;
  73874. /** Gets the list of attached cameras */
  73875. get cameras(): Camera[];
  73876. /**
  73877. * Initializes a PostProcessRenderPipeline
  73878. * @param engine engine to add the pipeline to
  73879. * @param name name of the pipeline
  73880. */
  73881. constructor(engine: Engine, name: string);
  73882. /**
  73883. * Gets the class name
  73884. * @returns "PostProcessRenderPipeline"
  73885. */
  73886. getClassName(): string;
  73887. /**
  73888. * If all the render effects in the pipeline are supported
  73889. */
  73890. get isSupported(): boolean;
  73891. /**
  73892. * Adds an effect to the pipeline
  73893. * @param renderEffect the effect to add
  73894. */
  73895. addEffect(renderEffect: PostProcessRenderEffect): void;
  73896. /** @hidden */
  73897. _rebuild(): void;
  73898. /** @hidden */
  73899. _enableEffect(renderEffectName: string, cameras: Camera): void;
  73900. /** @hidden */
  73901. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  73902. /** @hidden */
  73903. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73904. /** @hidden */
  73905. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73906. /** @hidden */
  73907. _attachCameras(cameras: Camera, unique: boolean): void;
  73908. /** @hidden */
  73909. _attachCameras(cameras: Camera[], unique: boolean): void;
  73910. /** @hidden */
  73911. _detachCameras(cameras: Camera): void;
  73912. /** @hidden */
  73913. _detachCameras(cameras: Nullable<Camera[]>): void;
  73914. /** @hidden */
  73915. _update(): void;
  73916. /** @hidden */
  73917. _reset(): void;
  73918. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  73919. /**
  73920. * Sets the required values to the prepass renderer.
  73921. * @param prePassRenderer defines the prepass renderer to setup.
  73922. * @returns true if the pre pass is needed.
  73923. */
  73924. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  73925. /**
  73926. * Disposes of the pipeline
  73927. */
  73928. dispose(): void;
  73929. }
  73930. }
  73931. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  73932. import { Camera } from "babylonjs/Cameras/camera";
  73933. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73934. /**
  73935. * PostProcessRenderPipelineManager class
  73936. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73937. */
  73938. export class PostProcessRenderPipelineManager {
  73939. private _renderPipelines;
  73940. /**
  73941. * Initializes a PostProcessRenderPipelineManager
  73942. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73943. */
  73944. constructor();
  73945. /**
  73946. * Gets the list of supported render pipelines
  73947. */
  73948. get supportedPipelines(): PostProcessRenderPipeline[];
  73949. /**
  73950. * Adds a pipeline to the manager
  73951. * @param renderPipeline The pipeline to add
  73952. */
  73953. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  73954. /**
  73955. * Attaches a camera to the pipeline
  73956. * @param renderPipelineName The name of the pipeline to attach to
  73957. * @param cameras the camera to attach
  73958. * @param unique if the camera can be attached multiple times to the pipeline
  73959. */
  73960. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  73961. /**
  73962. * Detaches a camera from the pipeline
  73963. * @param renderPipelineName The name of the pipeline to detach from
  73964. * @param cameras the camera to detach
  73965. */
  73966. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  73967. /**
  73968. * Enables an effect by name on a pipeline
  73969. * @param renderPipelineName the name of the pipeline to enable the effect in
  73970. * @param renderEffectName the name of the effect to enable
  73971. * @param cameras the cameras that the effect should be enabled on
  73972. */
  73973. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73974. /**
  73975. * Disables an effect by name on a pipeline
  73976. * @param renderPipelineName the name of the pipeline to disable the effect in
  73977. * @param renderEffectName the name of the effect to disable
  73978. * @param cameras the cameras that the effect should be disabled on
  73979. */
  73980. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73981. /**
  73982. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  73983. */
  73984. update(): void;
  73985. /** @hidden */
  73986. _rebuild(): void;
  73987. /**
  73988. * Disposes of the manager and pipelines
  73989. */
  73990. dispose(): void;
  73991. }
  73992. }
  73993. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  73994. import { ISceneComponent } from "babylonjs/sceneComponent";
  73995. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  73996. import { Scene } from "babylonjs/scene";
  73997. module "babylonjs/scene" {
  73998. interface Scene {
  73999. /** @hidden (Backing field) */
  74000. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74001. /**
  74002. * Gets the postprocess render pipeline manager
  74003. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74004. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74005. */
  74006. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74007. }
  74008. }
  74009. /**
  74010. * Defines the Render Pipeline scene component responsible to rendering pipelines
  74011. */
  74012. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  74013. /**
  74014. * The component name helpfull to identify the component in the list of scene components.
  74015. */
  74016. readonly name: string;
  74017. /**
  74018. * The scene the component belongs to.
  74019. */
  74020. scene: Scene;
  74021. /**
  74022. * Creates a new instance of the component for the given scene
  74023. * @param scene Defines the scene to register the component in
  74024. */
  74025. constructor(scene: Scene);
  74026. /**
  74027. * Registers the component in a given scene
  74028. */
  74029. register(): void;
  74030. /**
  74031. * Rebuilds the elements related to this component in case of
  74032. * context lost for instance.
  74033. */
  74034. rebuild(): void;
  74035. /**
  74036. * Disposes the component and the associated ressources
  74037. */
  74038. dispose(): void;
  74039. private _gatherRenderTargets;
  74040. }
  74041. }
  74042. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  74043. import { Nullable } from "babylonjs/types";
  74044. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74045. import { Camera } from "babylonjs/Cameras/camera";
  74046. import { IDisposable } from "babylonjs/scene";
  74047. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  74048. import { Scene } from "babylonjs/scene";
  74049. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  74050. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74051. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74052. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  74053. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74054. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74055. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  74056. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74057. import { Animation } from "babylonjs/Animations/animation";
  74058. /**
  74059. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  74060. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74061. */
  74062. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74063. private _scene;
  74064. private _camerasToBeAttached;
  74065. /**
  74066. * ID of the sharpen post process,
  74067. */
  74068. private readonly SharpenPostProcessId;
  74069. /**
  74070. * @ignore
  74071. * ID of the image processing post process;
  74072. */
  74073. readonly ImageProcessingPostProcessId: string;
  74074. /**
  74075. * @ignore
  74076. * ID of the Fast Approximate Anti-Aliasing post process;
  74077. */
  74078. readonly FxaaPostProcessId: string;
  74079. /**
  74080. * ID of the chromatic aberration post process,
  74081. */
  74082. private readonly ChromaticAberrationPostProcessId;
  74083. /**
  74084. * ID of the grain post process
  74085. */
  74086. private readonly GrainPostProcessId;
  74087. /**
  74088. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74089. */
  74090. sharpen: SharpenPostProcess;
  74091. private _sharpenEffect;
  74092. private bloom;
  74093. /**
  74094. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74095. */
  74096. depthOfField: DepthOfFieldEffect;
  74097. /**
  74098. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74099. */
  74100. fxaa: FxaaPostProcess;
  74101. /**
  74102. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74103. */
  74104. imageProcessing: ImageProcessingPostProcess;
  74105. /**
  74106. * Chromatic aberration post process which will shift rgb colors in the image
  74107. */
  74108. chromaticAberration: ChromaticAberrationPostProcess;
  74109. private _chromaticAberrationEffect;
  74110. /**
  74111. * Grain post process which add noise to the image
  74112. */
  74113. grain: GrainPostProcess;
  74114. private _grainEffect;
  74115. /**
  74116. * Glow post process which adds a glow to emissive areas of the image
  74117. */
  74118. private _glowLayer;
  74119. /**
  74120. * Animations which can be used to tweak settings over a period of time
  74121. */
  74122. animations: Animation[];
  74123. private _imageProcessingConfigurationObserver;
  74124. private _sharpenEnabled;
  74125. private _bloomEnabled;
  74126. private _depthOfFieldEnabled;
  74127. private _depthOfFieldBlurLevel;
  74128. private _fxaaEnabled;
  74129. private _imageProcessingEnabled;
  74130. private _defaultPipelineTextureType;
  74131. private _bloomScale;
  74132. private _chromaticAberrationEnabled;
  74133. private _grainEnabled;
  74134. private _buildAllowed;
  74135. /**
  74136. * Gets active scene
  74137. */
  74138. get scene(): Scene;
  74139. /**
  74140. * Enable or disable the sharpen process from the pipeline
  74141. */
  74142. set sharpenEnabled(enabled: boolean);
  74143. get sharpenEnabled(): boolean;
  74144. private _resizeObserver;
  74145. private _hardwareScaleLevel;
  74146. private _bloomKernel;
  74147. /**
  74148. * Specifies the size of the bloom blur kernel, relative to the final output size
  74149. */
  74150. get bloomKernel(): number;
  74151. set bloomKernel(value: number);
  74152. /**
  74153. * Specifies the weight of the bloom in the final rendering
  74154. */
  74155. private _bloomWeight;
  74156. /**
  74157. * Specifies the luma threshold for the area that will be blurred by the bloom
  74158. */
  74159. private _bloomThreshold;
  74160. private _hdr;
  74161. /**
  74162. * The strength of the bloom.
  74163. */
  74164. set bloomWeight(value: number);
  74165. get bloomWeight(): number;
  74166. /**
  74167. * The strength of the bloom.
  74168. */
  74169. set bloomThreshold(value: number);
  74170. get bloomThreshold(): number;
  74171. /**
  74172. * The scale of the bloom, lower value will provide better performance.
  74173. */
  74174. set bloomScale(value: number);
  74175. get bloomScale(): number;
  74176. /**
  74177. * Enable or disable the bloom from the pipeline
  74178. */
  74179. set bloomEnabled(enabled: boolean);
  74180. get bloomEnabled(): boolean;
  74181. private _rebuildBloom;
  74182. /**
  74183. * If the depth of field is enabled.
  74184. */
  74185. get depthOfFieldEnabled(): boolean;
  74186. set depthOfFieldEnabled(enabled: boolean);
  74187. /**
  74188. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74189. */
  74190. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74191. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74192. /**
  74193. * If the anti aliasing is enabled.
  74194. */
  74195. set fxaaEnabled(enabled: boolean);
  74196. get fxaaEnabled(): boolean;
  74197. private _samples;
  74198. /**
  74199. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74200. */
  74201. set samples(sampleCount: number);
  74202. get samples(): number;
  74203. /**
  74204. * If image processing is enabled.
  74205. */
  74206. set imageProcessingEnabled(enabled: boolean);
  74207. get imageProcessingEnabled(): boolean;
  74208. /**
  74209. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74210. */
  74211. set glowLayerEnabled(enabled: boolean);
  74212. get glowLayerEnabled(): boolean;
  74213. /**
  74214. * Gets the glow layer (or null if not defined)
  74215. */
  74216. get glowLayer(): Nullable<GlowLayer>;
  74217. /**
  74218. * Enable or disable the chromaticAberration process from the pipeline
  74219. */
  74220. set chromaticAberrationEnabled(enabled: boolean);
  74221. get chromaticAberrationEnabled(): boolean;
  74222. /**
  74223. * Enable or disable the grain process from the pipeline
  74224. */
  74225. set grainEnabled(enabled: boolean);
  74226. get grainEnabled(): boolean;
  74227. /**
  74228. * @constructor
  74229. * @param name - The rendering pipeline name (default: "")
  74230. * @param hdr - If high dynamic range textures should be used (default: true)
  74231. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74232. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74233. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74234. */
  74235. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74236. /**
  74237. * Get the class name
  74238. * @returns "DefaultRenderingPipeline"
  74239. */
  74240. getClassName(): string;
  74241. /**
  74242. * Force the compilation of the entire pipeline.
  74243. */
  74244. prepare(): void;
  74245. private _hasCleared;
  74246. private _prevPostProcess;
  74247. private _prevPrevPostProcess;
  74248. private _setAutoClearAndTextureSharing;
  74249. private _depthOfFieldSceneObserver;
  74250. private _buildPipeline;
  74251. private _disposePostProcesses;
  74252. /**
  74253. * Adds a camera to the pipeline
  74254. * @param camera the camera to be added
  74255. */
  74256. addCamera(camera: Camera): void;
  74257. /**
  74258. * Removes a camera from the pipeline
  74259. * @param camera the camera to remove
  74260. */
  74261. removeCamera(camera: Camera): void;
  74262. /**
  74263. * Dispose of the pipeline and stop all post processes
  74264. */
  74265. dispose(): void;
  74266. /**
  74267. * Serialize the rendering pipeline (Used when exporting)
  74268. * @returns the serialized object
  74269. */
  74270. serialize(): any;
  74271. /**
  74272. * Parse the serialized pipeline
  74273. * @param source Source pipeline.
  74274. * @param scene The scene to load the pipeline to.
  74275. * @param rootUrl The URL of the serialized pipeline.
  74276. * @returns An instantiated pipeline from the serialized object.
  74277. */
  74278. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  74279. }
  74280. }
  74281. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  74282. /** @hidden */
  74283. export var lensHighlightsPixelShader: {
  74284. name: string;
  74285. shader: string;
  74286. };
  74287. }
  74288. declare module "babylonjs/Shaders/depthOfField.fragment" {
  74289. /** @hidden */
  74290. export var depthOfFieldPixelShader: {
  74291. name: string;
  74292. shader: string;
  74293. };
  74294. }
  74295. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  74296. import { Camera } from "babylonjs/Cameras/camera";
  74297. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74298. import { Scene } from "babylonjs/scene";
  74299. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74300. import "babylonjs/Shaders/chromaticAberration.fragment";
  74301. import "babylonjs/Shaders/lensHighlights.fragment";
  74302. import "babylonjs/Shaders/depthOfField.fragment";
  74303. /**
  74304. * BABYLON.JS Chromatic Aberration GLSL Shader
  74305. * Author: Olivier Guyot
  74306. * Separates very slightly R, G and B colors on the edges of the screen
  74307. * Inspired by Francois Tarlier & Martins Upitis
  74308. */
  74309. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  74310. /**
  74311. * @ignore
  74312. * The chromatic aberration PostProcess id in the pipeline
  74313. */
  74314. LensChromaticAberrationEffect: string;
  74315. /**
  74316. * @ignore
  74317. * The highlights enhancing PostProcess id in the pipeline
  74318. */
  74319. HighlightsEnhancingEffect: string;
  74320. /**
  74321. * @ignore
  74322. * The depth-of-field PostProcess id in the pipeline
  74323. */
  74324. LensDepthOfFieldEffect: string;
  74325. private _scene;
  74326. private _depthTexture;
  74327. private _grainTexture;
  74328. private _chromaticAberrationPostProcess;
  74329. private _highlightsPostProcess;
  74330. private _depthOfFieldPostProcess;
  74331. private _edgeBlur;
  74332. private _grainAmount;
  74333. private _chromaticAberration;
  74334. private _distortion;
  74335. private _highlightsGain;
  74336. private _highlightsThreshold;
  74337. private _dofDistance;
  74338. private _dofAperture;
  74339. private _dofDarken;
  74340. private _dofPentagon;
  74341. private _blurNoise;
  74342. /**
  74343. * @constructor
  74344. *
  74345. * Effect parameters are as follow:
  74346. * {
  74347. * chromatic_aberration: number; // from 0 to x (1 for realism)
  74348. * edge_blur: number; // from 0 to x (1 for realism)
  74349. * distortion: number; // from 0 to x (1 for realism)
  74350. * grain_amount: number; // from 0 to 1
  74351. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  74352. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  74353. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  74354. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  74355. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  74356. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  74357. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  74358. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  74359. * }
  74360. * Note: if an effect parameter is unset, effect is disabled
  74361. *
  74362. * @param name The rendering pipeline name
  74363. * @param parameters - An object containing all parameters (see above)
  74364. * @param scene The scene linked to this pipeline
  74365. * @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)
  74366. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74367. */
  74368. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  74369. /**
  74370. * Get the class name
  74371. * @returns "LensRenderingPipeline"
  74372. */
  74373. getClassName(): string;
  74374. /**
  74375. * Gets associated scene
  74376. */
  74377. get scene(): Scene;
  74378. /**
  74379. * Gets or sets the edge blur
  74380. */
  74381. get edgeBlur(): number;
  74382. set edgeBlur(value: number);
  74383. /**
  74384. * Gets or sets the grain amount
  74385. */
  74386. get grainAmount(): number;
  74387. set grainAmount(value: number);
  74388. /**
  74389. * Gets or sets the chromatic aberration amount
  74390. */
  74391. get chromaticAberration(): number;
  74392. set chromaticAberration(value: number);
  74393. /**
  74394. * Gets or sets the depth of field aperture
  74395. */
  74396. get dofAperture(): number;
  74397. set dofAperture(value: number);
  74398. /**
  74399. * Gets or sets the edge distortion
  74400. */
  74401. get edgeDistortion(): number;
  74402. set edgeDistortion(value: number);
  74403. /**
  74404. * Gets or sets the depth of field distortion
  74405. */
  74406. get dofDistortion(): number;
  74407. set dofDistortion(value: number);
  74408. /**
  74409. * Gets or sets the darken out of focus amount
  74410. */
  74411. get darkenOutOfFocus(): number;
  74412. set darkenOutOfFocus(value: number);
  74413. /**
  74414. * Gets or sets a boolean indicating if blur noise is enabled
  74415. */
  74416. get blurNoise(): boolean;
  74417. set blurNoise(value: boolean);
  74418. /**
  74419. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  74420. */
  74421. get pentagonBokeh(): boolean;
  74422. set pentagonBokeh(value: boolean);
  74423. /**
  74424. * Gets or sets the highlight grain amount
  74425. */
  74426. get highlightsGain(): number;
  74427. set highlightsGain(value: number);
  74428. /**
  74429. * Gets or sets the highlight threshold
  74430. */
  74431. get highlightsThreshold(): number;
  74432. set highlightsThreshold(value: number);
  74433. /**
  74434. * Sets the amount of blur at the edges
  74435. * @param amount blur amount
  74436. */
  74437. setEdgeBlur(amount: number): void;
  74438. /**
  74439. * Sets edge blur to 0
  74440. */
  74441. disableEdgeBlur(): void;
  74442. /**
  74443. * Sets the amout of grain
  74444. * @param amount Amount of grain
  74445. */
  74446. setGrainAmount(amount: number): void;
  74447. /**
  74448. * Set grain amount to 0
  74449. */
  74450. disableGrain(): void;
  74451. /**
  74452. * Sets the chromatic aberration amount
  74453. * @param amount amount of chromatic aberration
  74454. */
  74455. setChromaticAberration(amount: number): void;
  74456. /**
  74457. * Sets chromatic aberration amount to 0
  74458. */
  74459. disableChromaticAberration(): void;
  74460. /**
  74461. * Sets the EdgeDistortion amount
  74462. * @param amount amount of EdgeDistortion
  74463. */
  74464. setEdgeDistortion(amount: number): void;
  74465. /**
  74466. * Sets edge distortion to 0
  74467. */
  74468. disableEdgeDistortion(): void;
  74469. /**
  74470. * Sets the FocusDistance amount
  74471. * @param amount amount of FocusDistance
  74472. */
  74473. setFocusDistance(amount: number): void;
  74474. /**
  74475. * Disables depth of field
  74476. */
  74477. disableDepthOfField(): void;
  74478. /**
  74479. * Sets the Aperture amount
  74480. * @param amount amount of Aperture
  74481. */
  74482. setAperture(amount: number): void;
  74483. /**
  74484. * Sets the DarkenOutOfFocus amount
  74485. * @param amount amount of DarkenOutOfFocus
  74486. */
  74487. setDarkenOutOfFocus(amount: number): void;
  74488. private _pentagonBokehIsEnabled;
  74489. /**
  74490. * Creates a pentagon bokeh effect
  74491. */
  74492. enablePentagonBokeh(): void;
  74493. /**
  74494. * Disables the pentagon bokeh effect
  74495. */
  74496. disablePentagonBokeh(): void;
  74497. /**
  74498. * Enables noise blur
  74499. */
  74500. enableNoiseBlur(): void;
  74501. /**
  74502. * Disables noise blur
  74503. */
  74504. disableNoiseBlur(): void;
  74505. /**
  74506. * Sets the HighlightsGain amount
  74507. * @param amount amount of HighlightsGain
  74508. */
  74509. setHighlightsGain(amount: number): void;
  74510. /**
  74511. * Sets the HighlightsThreshold amount
  74512. * @param amount amount of HighlightsThreshold
  74513. */
  74514. setHighlightsThreshold(amount: number): void;
  74515. /**
  74516. * Disables highlights
  74517. */
  74518. disableHighlights(): void;
  74519. /**
  74520. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  74521. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  74522. */
  74523. dispose(disableDepthRender?: boolean): void;
  74524. private _createChromaticAberrationPostProcess;
  74525. private _createHighlightsPostProcess;
  74526. private _createDepthOfFieldPostProcess;
  74527. private _createGrainTexture;
  74528. }
  74529. }
  74530. declare module "babylonjs/Shaders/ssao2.fragment" {
  74531. /** @hidden */
  74532. export var ssao2PixelShader: {
  74533. name: string;
  74534. shader: string;
  74535. };
  74536. }
  74537. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  74538. /** @hidden */
  74539. export var ssaoCombinePixelShader: {
  74540. name: string;
  74541. shader: string;
  74542. };
  74543. }
  74544. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  74545. import { Camera } from "babylonjs/Cameras/camera";
  74546. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74547. import { Scene } from "babylonjs/scene";
  74548. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74549. import "babylonjs/Shaders/ssao2.fragment";
  74550. import "babylonjs/Shaders/ssaoCombine.fragment";
  74551. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74552. /**
  74553. * Render pipeline to produce ssao effect
  74554. */
  74555. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  74556. /**
  74557. * @ignore
  74558. * The PassPostProcess id in the pipeline that contains the original scene color
  74559. */
  74560. SSAOOriginalSceneColorEffect: string;
  74561. /**
  74562. * @ignore
  74563. * The SSAO PostProcess id in the pipeline
  74564. */
  74565. SSAORenderEffect: string;
  74566. /**
  74567. * @ignore
  74568. * The horizontal blur PostProcess id in the pipeline
  74569. */
  74570. SSAOBlurHRenderEffect: string;
  74571. /**
  74572. * @ignore
  74573. * The vertical blur PostProcess id in the pipeline
  74574. */
  74575. SSAOBlurVRenderEffect: string;
  74576. /**
  74577. * @ignore
  74578. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74579. */
  74580. SSAOCombineRenderEffect: string;
  74581. /**
  74582. * The output strength of the SSAO post-process. Default value is 1.0.
  74583. */
  74584. totalStrength: number;
  74585. /**
  74586. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74587. */
  74588. maxZ: number;
  74589. /**
  74590. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74591. */
  74592. minZAspect: number;
  74593. private _samples;
  74594. /**
  74595. * Number of samples used for the SSAO calculations. Default value is 8
  74596. */
  74597. set samples(n: number);
  74598. get samples(): number;
  74599. private _textureSamples;
  74600. /**
  74601. * Number of samples to use for antialiasing
  74602. */
  74603. set textureSamples(n: number);
  74604. get textureSamples(): number;
  74605. /**
  74606. * Force rendering the geometry through geometry buffer
  74607. */
  74608. private _forceGeometryBuffer;
  74609. /**
  74610. * Ratio object used for SSAO ratio and blur ratio
  74611. */
  74612. private _ratio;
  74613. /**
  74614. * Dynamically generated sphere sampler.
  74615. */
  74616. private _sampleSphere;
  74617. /**
  74618. * Blur filter offsets
  74619. */
  74620. private _samplerOffsets;
  74621. private _expensiveBlur;
  74622. /**
  74623. * If bilateral blur should be used
  74624. */
  74625. set expensiveBlur(b: boolean);
  74626. get expensiveBlur(): boolean;
  74627. /**
  74628. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74629. */
  74630. radius: number;
  74631. /**
  74632. * The base color of the SSAO post-process
  74633. * The final result is "base + ssao" between [0, 1]
  74634. */
  74635. base: number;
  74636. /**
  74637. * Support test.
  74638. */
  74639. static get IsSupported(): boolean;
  74640. private _scene;
  74641. private _randomTexture;
  74642. private _originalColorPostProcess;
  74643. private _ssaoPostProcess;
  74644. private _blurHPostProcess;
  74645. private _blurVPostProcess;
  74646. private _ssaoCombinePostProcess;
  74647. private _prePassRenderer;
  74648. /**
  74649. * Gets active scene
  74650. */
  74651. get scene(): Scene;
  74652. /**
  74653. * @constructor
  74654. * @param name The rendering pipeline name
  74655. * @param scene The scene linked to this pipeline
  74656. * @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 }
  74657. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74658. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74659. */
  74660. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74661. /**
  74662. * Get the class name
  74663. * @returns "SSAO2RenderingPipeline"
  74664. */
  74665. getClassName(): string;
  74666. /**
  74667. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74668. */
  74669. dispose(disableGeometryBufferRenderer?: boolean): void;
  74670. private _createBlurPostProcess;
  74671. /** @hidden */
  74672. _rebuild(): void;
  74673. private _bits;
  74674. private _radicalInverse_VdC;
  74675. private _hammersley;
  74676. private _hemisphereSample_uniform;
  74677. private _generateHemisphere;
  74678. private _getDefinesForSSAO;
  74679. private _createSSAOPostProcess;
  74680. private _createSSAOCombinePostProcess;
  74681. private _createRandomTexture;
  74682. /**
  74683. * Serialize the rendering pipeline (Used when exporting)
  74684. * @returns the serialized object
  74685. */
  74686. serialize(): any;
  74687. /**
  74688. * Parse the serialized pipeline
  74689. * @param source Source pipeline.
  74690. * @param scene The scene to load the pipeline to.
  74691. * @param rootUrl The URL of the serialized pipeline.
  74692. * @returns An instantiated pipeline from the serialized object.
  74693. */
  74694. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74695. /**
  74696. * Sets the required values to the prepass renderer.
  74697. * @param prePassRenderer defines the prepass renderer to setup
  74698. * @returns true if the pre pass is needed.
  74699. */
  74700. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74701. }
  74702. }
  74703. declare module "babylonjs/Shaders/ssao.fragment" {
  74704. /** @hidden */
  74705. export var ssaoPixelShader: {
  74706. name: string;
  74707. shader: string;
  74708. };
  74709. }
  74710. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74711. import { Camera } from "babylonjs/Cameras/camera";
  74712. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74713. import { Scene } from "babylonjs/scene";
  74714. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74715. import "babylonjs/Shaders/ssao.fragment";
  74716. import "babylonjs/Shaders/ssaoCombine.fragment";
  74717. /**
  74718. * Render pipeline to produce ssao effect
  74719. */
  74720. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74721. /**
  74722. * @ignore
  74723. * The PassPostProcess id in the pipeline that contains the original scene color
  74724. */
  74725. SSAOOriginalSceneColorEffect: string;
  74726. /**
  74727. * @ignore
  74728. * The SSAO PostProcess id in the pipeline
  74729. */
  74730. SSAORenderEffect: string;
  74731. /**
  74732. * @ignore
  74733. * The horizontal blur PostProcess id in the pipeline
  74734. */
  74735. SSAOBlurHRenderEffect: string;
  74736. /**
  74737. * @ignore
  74738. * The vertical blur PostProcess id in the pipeline
  74739. */
  74740. SSAOBlurVRenderEffect: string;
  74741. /**
  74742. * @ignore
  74743. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74744. */
  74745. SSAOCombineRenderEffect: string;
  74746. /**
  74747. * The output strength of the SSAO post-process. Default value is 1.0.
  74748. */
  74749. totalStrength: number;
  74750. /**
  74751. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  74752. */
  74753. radius: number;
  74754. /**
  74755. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  74756. * Must not be equal to fallOff and superior to fallOff.
  74757. * Default value is 0.0075
  74758. */
  74759. area: number;
  74760. /**
  74761. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  74762. * Must not be equal to area and inferior to area.
  74763. * Default value is 0.000001
  74764. */
  74765. fallOff: number;
  74766. /**
  74767. * The base color of the SSAO post-process
  74768. * The final result is "base + ssao" between [0, 1]
  74769. */
  74770. base: number;
  74771. private _scene;
  74772. private _depthTexture;
  74773. private _randomTexture;
  74774. private _originalColorPostProcess;
  74775. private _ssaoPostProcess;
  74776. private _blurHPostProcess;
  74777. private _blurVPostProcess;
  74778. private _ssaoCombinePostProcess;
  74779. private _firstUpdate;
  74780. /**
  74781. * Gets active scene
  74782. */
  74783. get scene(): Scene;
  74784. /**
  74785. * @constructor
  74786. * @param name - The rendering pipeline name
  74787. * @param scene - The scene linked to this pipeline
  74788. * @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 }
  74789. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  74790. */
  74791. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  74792. /**
  74793. * Get the class name
  74794. * @returns "SSAORenderingPipeline"
  74795. */
  74796. getClassName(): string;
  74797. /**
  74798. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74799. */
  74800. dispose(disableDepthRender?: boolean): void;
  74801. private _createBlurPostProcess;
  74802. /** @hidden */
  74803. _rebuild(): void;
  74804. private _createSSAOPostProcess;
  74805. private _createSSAOCombinePostProcess;
  74806. private _createRandomTexture;
  74807. }
  74808. }
  74809. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  74810. /** @hidden */
  74811. export var screenSpaceReflectionPixelShader: {
  74812. name: string;
  74813. shader: string;
  74814. };
  74815. }
  74816. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  74817. import { Nullable } from "babylonjs/types";
  74818. import { Camera } from "babylonjs/Cameras/camera";
  74819. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74820. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  74821. import { Engine } from "babylonjs/Engines/engine";
  74822. import { Scene } from "babylonjs/scene";
  74823. /**
  74824. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  74825. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  74826. */
  74827. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  74828. /**
  74829. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  74830. */
  74831. threshold: number;
  74832. /**
  74833. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  74834. */
  74835. strength: number;
  74836. /**
  74837. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  74838. */
  74839. reflectionSpecularFalloffExponent: number;
  74840. /**
  74841. * 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]
  74842. */
  74843. step: number;
  74844. /**
  74845. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  74846. */
  74847. roughnessFactor: number;
  74848. private _geometryBufferRenderer;
  74849. private _enableSmoothReflections;
  74850. private _reflectionSamples;
  74851. private _smoothSteps;
  74852. /**
  74853. * Gets a string identifying the name of the class
  74854. * @returns "ScreenSpaceReflectionPostProcess" string
  74855. */
  74856. getClassName(): string;
  74857. /**
  74858. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  74859. * @param name The name of the effect.
  74860. * @param scene The scene containing the objects to calculate reflections.
  74861. * @param options The required width/height ratio to downsize to before computing the render pass.
  74862. * @param camera The camera to apply the render pass to.
  74863. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74864. * @param engine The engine which the post process will be applied. (default: current engine)
  74865. * @param reusable If the post process can be reused on the same frame. (default: false)
  74866. * @param textureType Type of textures used when performing the post process. (default: 0)
  74867. * @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)
  74868. */
  74869. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74870. /**
  74871. * Gets wether or not smoothing reflections is enabled.
  74872. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74873. */
  74874. get enableSmoothReflections(): boolean;
  74875. /**
  74876. * Sets wether or not smoothing reflections is enabled.
  74877. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74878. */
  74879. set enableSmoothReflections(enabled: boolean);
  74880. /**
  74881. * Gets the number of samples taken while computing reflections. More samples count is high,
  74882. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74883. */
  74884. get reflectionSamples(): number;
  74885. /**
  74886. * Sets the number of samples taken while computing reflections. More samples count is high,
  74887. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74888. */
  74889. set reflectionSamples(samples: number);
  74890. /**
  74891. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  74892. * more the post-process will require GPU power and can generate a drop in FPS.
  74893. * Default value (5.0) work pretty well in all cases but can be adjusted.
  74894. */
  74895. get smoothSteps(): number;
  74896. set smoothSteps(steps: number);
  74897. private _updateEffectDefines;
  74898. /** @hidden */
  74899. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  74900. }
  74901. }
  74902. declare module "babylonjs/Shaders/standard.fragment" {
  74903. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  74904. /** @hidden */
  74905. export var standardPixelShader: {
  74906. name: string;
  74907. shader: string;
  74908. };
  74909. }
  74910. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  74911. import { Nullable } from "babylonjs/types";
  74912. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74913. import { Camera } from "babylonjs/Cameras/camera";
  74914. import { Texture } from "babylonjs/Materials/Textures/texture";
  74915. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74916. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74917. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  74918. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74919. import { IDisposable } from "babylonjs/scene";
  74920. import { SpotLight } from "babylonjs/Lights/spotLight";
  74921. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  74922. import { Scene } from "babylonjs/scene";
  74923. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  74924. import { Animation } from "babylonjs/Animations/animation";
  74925. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74926. import "babylonjs/Shaders/standard.fragment";
  74927. /**
  74928. * Standard rendering pipeline
  74929. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  74930. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  74931. */
  74932. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74933. /**
  74934. * Public members
  74935. */
  74936. /**
  74937. * Post-process which contains the original scene color before the pipeline applies all the effects
  74938. */
  74939. originalPostProcess: Nullable<PostProcess>;
  74940. /**
  74941. * Post-process used to down scale an image x4
  74942. */
  74943. downSampleX4PostProcess: Nullable<PostProcess>;
  74944. /**
  74945. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  74946. */
  74947. brightPassPostProcess: Nullable<PostProcess>;
  74948. /**
  74949. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  74950. */
  74951. blurHPostProcesses: PostProcess[];
  74952. /**
  74953. * Post-process array storing all the vertical blur post-processes used by the pipeline
  74954. */
  74955. blurVPostProcesses: PostProcess[];
  74956. /**
  74957. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  74958. */
  74959. textureAdderPostProcess: Nullable<PostProcess>;
  74960. /**
  74961. * Post-process used to create volumetric lighting effect
  74962. */
  74963. volumetricLightPostProcess: Nullable<PostProcess>;
  74964. /**
  74965. * Post-process used to smooth the previous volumetric light post-process on the X axis
  74966. */
  74967. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  74968. /**
  74969. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  74970. */
  74971. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  74972. /**
  74973. * Post-process used to merge the volumetric light effect and the real scene color
  74974. */
  74975. volumetricLightMergePostProces: Nullable<PostProcess>;
  74976. /**
  74977. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  74978. */
  74979. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  74980. /**
  74981. * Base post-process used to calculate the average luminance of the final image for HDR
  74982. */
  74983. luminancePostProcess: Nullable<PostProcess>;
  74984. /**
  74985. * Post-processes used to create down sample post-processes in order to get
  74986. * the average luminance of the final image for HDR
  74987. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  74988. */
  74989. luminanceDownSamplePostProcesses: PostProcess[];
  74990. /**
  74991. * Post-process used to create a HDR effect (light adaptation)
  74992. */
  74993. hdrPostProcess: Nullable<PostProcess>;
  74994. /**
  74995. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  74996. */
  74997. textureAdderFinalPostProcess: Nullable<PostProcess>;
  74998. /**
  74999. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  75000. */
  75001. lensFlareFinalPostProcess: Nullable<PostProcess>;
  75002. /**
  75003. * Post-process used to merge the final HDR post-process and the real scene color
  75004. */
  75005. hdrFinalPostProcess: Nullable<PostProcess>;
  75006. /**
  75007. * Post-process used to create a lens flare effect
  75008. */
  75009. lensFlarePostProcess: Nullable<PostProcess>;
  75010. /**
  75011. * Post-process that merges the result of the lens flare post-process and the real scene color
  75012. */
  75013. lensFlareComposePostProcess: Nullable<PostProcess>;
  75014. /**
  75015. * Post-process used to create a motion blur effect
  75016. */
  75017. motionBlurPostProcess: Nullable<PostProcess>;
  75018. /**
  75019. * Post-process used to create a depth of field effect
  75020. */
  75021. depthOfFieldPostProcess: Nullable<PostProcess>;
  75022. /**
  75023. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  75024. */
  75025. fxaaPostProcess: Nullable<FxaaPostProcess>;
  75026. /**
  75027. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  75028. */
  75029. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  75030. /**
  75031. * Represents the brightness threshold in order to configure the illuminated surfaces
  75032. */
  75033. brightThreshold: number;
  75034. /**
  75035. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  75036. */
  75037. blurWidth: number;
  75038. /**
  75039. * Sets if the blur for highlighted surfaces must be only horizontal
  75040. */
  75041. horizontalBlur: boolean;
  75042. /**
  75043. * Gets the overall exposure used by the pipeline
  75044. */
  75045. get exposure(): number;
  75046. /**
  75047. * Sets the overall exposure used by the pipeline
  75048. */
  75049. set exposure(value: number);
  75050. /**
  75051. * Texture used typically to simulate "dirty" on camera lens
  75052. */
  75053. lensTexture: Nullable<Texture>;
  75054. /**
  75055. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  75056. */
  75057. volumetricLightCoefficient: number;
  75058. /**
  75059. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  75060. */
  75061. volumetricLightPower: number;
  75062. /**
  75063. * Used the set the blur intensity to smooth the volumetric lights
  75064. */
  75065. volumetricLightBlurScale: number;
  75066. /**
  75067. * Light (spot or directional) used to generate the volumetric lights rays
  75068. * The source light must have a shadow generate so the pipeline can get its
  75069. * depth map
  75070. */
  75071. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75072. /**
  75073. * For eye adaptation, represents the minimum luminance the eye can see
  75074. */
  75075. hdrMinimumLuminance: number;
  75076. /**
  75077. * For eye adaptation, represents the decrease luminance speed
  75078. */
  75079. hdrDecreaseRate: number;
  75080. /**
  75081. * For eye adaptation, represents the increase luminance speed
  75082. */
  75083. hdrIncreaseRate: number;
  75084. /**
  75085. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75086. */
  75087. get hdrAutoExposure(): boolean;
  75088. /**
  75089. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75090. */
  75091. set hdrAutoExposure(value: boolean);
  75092. /**
  75093. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75094. */
  75095. lensColorTexture: Nullable<Texture>;
  75096. /**
  75097. * The overall strengh for the lens flare effect
  75098. */
  75099. lensFlareStrength: number;
  75100. /**
  75101. * Dispersion coefficient for lens flare ghosts
  75102. */
  75103. lensFlareGhostDispersal: number;
  75104. /**
  75105. * Main lens flare halo width
  75106. */
  75107. lensFlareHaloWidth: number;
  75108. /**
  75109. * Based on the lens distortion effect, defines how much the lens flare result
  75110. * is distorted
  75111. */
  75112. lensFlareDistortionStrength: number;
  75113. /**
  75114. * Configures the blur intensity used for for lens flare (halo)
  75115. */
  75116. lensFlareBlurWidth: number;
  75117. /**
  75118. * Lens star texture must be used to simulate rays on the flares and is available
  75119. * in the documentation
  75120. */
  75121. lensStarTexture: Nullable<Texture>;
  75122. /**
  75123. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75124. * flare effect by taking account of the dirt texture
  75125. */
  75126. lensFlareDirtTexture: Nullable<Texture>;
  75127. /**
  75128. * Represents the focal length for the depth of field effect
  75129. */
  75130. depthOfFieldDistance: number;
  75131. /**
  75132. * Represents the blur intensity for the blurred part of the depth of field effect
  75133. */
  75134. depthOfFieldBlurWidth: number;
  75135. /**
  75136. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75137. */
  75138. get motionStrength(): number;
  75139. /**
  75140. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75141. */
  75142. set motionStrength(strength: number);
  75143. /**
  75144. * Gets wether or not the motion blur post-process is object based or screen based.
  75145. */
  75146. get objectBasedMotionBlur(): boolean;
  75147. /**
  75148. * Sets wether or not the motion blur post-process should be object based or screen based
  75149. */
  75150. set objectBasedMotionBlur(value: boolean);
  75151. /**
  75152. * List of animations for the pipeline (IAnimatable implementation)
  75153. */
  75154. animations: Animation[];
  75155. /**
  75156. * Private members
  75157. */
  75158. private _scene;
  75159. private _currentDepthOfFieldSource;
  75160. private _basePostProcess;
  75161. private _fixedExposure;
  75162. private _currentExposure;
  75163. private _hdrAutoExposure;
  75164. private _hdrCurrentLuminance;
  75165. private _motionStrength;
  75166. private _isObjectBasedMotionBlur;
  75167. private _floatTextureType;
  75168. private _camerasToBeAttached;
  75169. private _ratio;
  75170. private _bloomEnabled;
  75171. private _depthOfFieldEnabled;
  75172. private _vlsEnabled;
  75173. private _lensFlareEnabled;
  75174. private _hdrEnabled;
  75175. private _motionBlurEnabled;
  75176. private _fxaaEnabled;
  75177. private _screenSpaceReflectionsEnabled;
  75178. private _motionBlurSamples;
  75179. private _volumetricLightStepsCount;
  75180. private _samples;
  75181. /**
  75182. * @ignore
  75183. * Specifies if the bloom pipeline is enabled
  75184. */
  75185. get BloomEnabled(): boolean;
  75186. set BloomEnabled(enabled: boolean);
  75187. /**
  75188. * @ignore
  75189. * Specifies if the depth of field pipeline is enabed
  75190. */
  75191. get DepthOfFieldEnabled(): boolean;
  75192. set DepthOfFieldEnabled(enabled: boolean);
  75193. /**
  75194. * @ignore
  75195. * Specifies if the lens flare pipeline is enabed
  75196. */
  75197. get LensFlareEnabled(): boolean;
  75198. set LensFlareEnabled(enabled: boolean);
  75199. /**
  75200. * @ignore
  75201. * Specifies if the HDR pipeline is enabled
  75202. */
  75203. get HDREnabled(): boolean;
  75204. set HDREnabled(enabled: boolean);
  75205. /**
  75206. * @ignore
  75207. * Specifies if the volumetric lights scattering effect is enabled
  75208. */
  75209. get VLSEnabled(): boolean;
  75210. set VLSEnabled(enabled: boolean);
  75211. /**
  75212. * @ignore
  75213. * Specifies if the motion blur effect is enabled
  75214. */
  75215. get MotionBlurEnabled(): boolean;
  75216. set MotionBlurEnabled(enabled: boolean);
  75217. /**
  75218. * Specifies if anti-aliasing is enabled
  75219. */
  75220. get fxaaEnabled(): boolean;
  75221. set fxaaEnabled(enabled: boolean);
  75222. /**
  75223. * Specifies if screen space reflections are enabled.
  75224. */
  75225. get screenSpaceReflectionsEnabled(): boolean;
  75226. set screenSpaceReflectionsEnabled(enabled: boolean);
  75227. /**
  75228. * Specifies the number of steps used to calculate the volumetric lights
  75229. * Typically in interval [50, 200]
  75230. */
  75231. get volumetricLightStepsCount(): number;
  75232. set volumetricLightStepsCount(count: number);
  75233. /**
  75234. * Specifies the number of samples used for the motion blur effect
  75235. * Typically in interval [16, 64]
  75236. */
  75237. get motionBlurSamples(): number;
  75238. set motionBlurSamples(samples: number);
  75239. /**
  75240. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  75241. */
  75242. get samples(): number;
  75243. set samples(sampleCount: number);
  75244. /**
  75245. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75246. * @constructor
  75247. * @param name The rendering pipeline name
  75248. * @param scene The scene linked to this pipeline
  75249. * @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)
  75250. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  75251. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75252. */
  75253. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  75254. private _buildPipeline;
  75255. private _createDownSampleX4PostProcess;
  75256. private _createBrightPassPostProcess;
  75257. private _createBlurPostProcesses;
  75258. private _createTextureAdderPostProcess;
  75259. private _createVolumetricLightPostProcess;
  75260. private _createLuminancePostProcesses;
  75261. private _createHdrPostProcess;
  75262. private _createLensFlarePostProcess;
  75263. private _createDepthOfFieldPostProcess;
  75264. private _createMotionBlurPostProcess;
  75265. private _getDepthTexture;
  75266. private _disposePostProcesses;
  75267. /**
  75268. * Dispose of the pipeline and stop all post processes
  75269. */
  75270. dispose(): void;
  75271. /**
  75272. * Serialize the rendering pipeline (Used when exporting)
  75273. * @returns the serialized object
  75274. */
  75275. serialize(): any;
  75276. /**
  75277. * Parse the serialized pipeline
  75278. * @param source Source pipeline.
  75279. * @param scene The scene to load the pipeline to.
  75280. * @param rootUrl The URL of the serialized pipeline.
  75281. * @returns An instantiated pipeline from the serialized object.
  75282. */
  75283. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  75284. /**
  75285. * Luminance steps
  75286. */
  75287. static LuminanceSteps: number;
  75288. }
  75289. }
  75290. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  75291. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  75292. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  75293. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  75294. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  75295. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  75296. }
  75297. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  75298. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  75299. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  75300. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75301. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  75302. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75303. }
  75304. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  75305. /** @hidden */
  75306. export var stereoscopicInterlacePixelShader: {
  75307. name: string;
  75308. shader: string;
  75309. };
  75310. }
  75311. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  75312. import { Camera } from "babylonjs/Cameras/camera";
  75313. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75314. import { Engine } from "babylonjs/Engines/engine";
  75315. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  75316. /**
  75317. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  75318. */
  75319. export class StereoscopicInterlacePostProcessI extends PostProcess {
  75320. private _stepSize;
  75321. private _passedProcess;
  75322. /**
  75323. * Gets a string identifying the name of the class
  75324. * @returns "StereoscopicInterlacePostProcessI" string
  75325. */
  75326. getClassName(): string;
  75327. /**
  75328. * Initializes a StereoscopicInterlacePostProcessI
  75329. * @param name The name of the effect.
  75330. * @param rigCameras The rig cameras to be appled to the post process
  75331. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  75332. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  75333. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75334. * @param engine The engine which the post process will be applied. (default: current engine)
  75335. * @param reusable If the post process can be reused on the same frame. (default: false)
  75336. */
  75337. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75338. }
  75339. /**
  75340. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  75341. */
  75342. export class StereoscopicInterlacePostProcess extends PostProcess {
  75343. private _stepSize;
  75344. private _passedProcess;
  75345. /**
  75346. * Gets a string identifying the name of the class
  75347. * @returns "StereoscopicInterlacePostProcess" string
  75348. */
  75349. getClassName(): string;
  75350. /**
  75351. * Initializes a StereoscopicInterlacePostProcess
  75352. * @param name The name of the effect.
  75353. * @param rigCameras The rig cameras to be appled to the post process
  75354. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  75355. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75356. * @param engine The engine which the post process will be applied. (default: current engine)
  75357. * @param reusable If the post process can be reused on the same frame. (default: false)
  75358. */
  75359. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75360. }
  75361. }
  75362. declare module "babylonjs/Shaders/tonemap.fragment" {
  75363. /** @hidden */
  75364. export var tonemapPixelShader: {
  75365. name: string;
  75366. shader: string;
  75367. };
  75368. }
  75369. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  75370. import { Camera } from "babylonjs/Cameras/camera";
  75371. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75372. import "babylonjs/Shaders/tonemap.fragment";
  75373. import { Engine } from "babylonjs/Engines/engine";
  75374. /** Defines operator used for tonemapping */
  75375. export enum TonemappingOperator {
  75376. /** Hable */
  75377. Hable = 0,
  75378. /** Reinhard */
  75379. Reinhard = 1,
  75380. /** HejiDawson */
  75381. HejiDawson = 2,
  75382. /** Photographic */
  75383. Photographic = 3
  75384. }
  75385. /**
  75386. * Defines a post process to apply tone mapping
  75387. */
  75388. export class TonemapPostProcess extends PostProcess {
  75389. private _operator;
  75390. /** Defines the required exposure adjustement */
  75391. exposureAdjustment: number;
  75392. /**
  75393. * Gets a string identifying the name of the class
  75394. * @returns "TonemapPostProcess" string
  75395. */
  75396. getClassName(): string;
  75397. /**
  75398. * Creates a new TonemapPostProcess
  75399. * @param name defines the name of the postprocess
  75400. * @param _operator defines the operator to use
  75401. * @param exposureAdjustment defines the required exposure adjustement
  75402. * @param camera defines the camera to use (can be null)
  75403. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  75404. * @param engine defines the hosting engine (can be ignore if camera is set)
  75405. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  75406. */
  75407. constructor(name: string, _operator: TonemappingOperator,
  75408. /** Defines the required exposure adjustement */
  75409. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  75410. }
  75411. }
  75412. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  75413. /** @hidden */
  75414. export var volumetricLightScatteringPixelShader: {
  75415. name: string;
  75416. shader: string;
  75417. };
  75418. }
  75419. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  75420. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75421. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75422. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75423. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75424. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75425. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75426. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75427. /** @hidden */
  75428. export var volumetricLightScatteringPassVertexShader: {
  75429. name: string;
  75430. shader: string;
  75431. };
  75432. }
  75433. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  75434. /** @hidden */
  75435. export var volumetricLightScatteringPassPixelShader: {
  75436. name: string;
  75437. shader: string;
  75438. };
  75439. }
  75440. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  75441. import { Vector3 } from "babylonjs/Maths/math.vector";
  75442. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75443. import { Mesh } from "babylonjs/Meshes/mesh";
  75444. import { Camera } from "babylonjs/Cameras/camera";
  75445. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  75446. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75447. import { Scene } from "babylonjs/scene";
  75448. import "babylonjs/Meshes/Builders/planeBuilder";
  75449. import "babylonjs/Shaders/depth.vertex";
  75450. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  75451. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  75452. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  75453. import { Engine } from "babylonjs/Engines/engine";
  75454. /**
  75455. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  75456. */
  75457. export class VolumetricLightScatteringPostProcess extends PostProcess {
  75458. private _volumetricLightScatteringPass;
  75459. private _volumetricLightScatteringRTT;
  75460. private _viewPort;
  75461. private _screenCoordinates;
  75462. private _cachedDefines;
  75463. /**
  75464. * If not undefined, the mesh position is computed from the attached node position
  75465. */
  75466. attachedNode: {
  75467. position: Vector3;
  75468. };
  75469. /**
  75470. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  75471. */
  75472. customMeshPosition: Vector3;
  75473. /**
  75474. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  75475. */
  75476. useCustomMeshPosition: boolean;
  75477. /**
  75478. * If the post-process should inverse the light scattering direction
  75479. */
  75480. invert: boolean;
  75481. /**
  75482. * The internal mesh used by the post-process
  75483. */
  75484. mesh: Mesh;
  75485. /**
  75486. * @hidden
  75487. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  75488. */
  75489. get useDiffuseColor(): boolean;
  75490. set useDiffuseColor(useDiffuseColor: boolean);
  75491. /**
  75492. * Array containing the excluded meshes not rendered in the internal pass
  75493. */
  75494. excludedMeshes: AbstractMesh[];
  75495. /**
  75496. * Controls the overall intensity of the post-process
  75497. */
  75498. exposure: number;
  75499. /**
  75500. * Dissipates each sample's contribution in range [0, 1]
  75501. */
  75502. decay: number;
  75503. /**
  75504. * Controls the overall intensity of each sample
  75505. */
  75506. weight: number;
  75507. /**
  75508. * Controls the density of each sample
  75509. */
  75510. density: number;
  75511. /**
  75512. * @constructor
  75513. * @param name The post-process name
  75514. * @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)
  75515. * @param camera The camera that the post-process will be attached to
  75516. * @param mesh The mesh used to create the light scattering
  75517. * @param samples The post-process quality, default 100
  75518. * @param samplingModeThe post-process filtering mode
  75519. * @param engine The babylon engine
  75520. * @param reusable If the post-process is reusable
  75521. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  75522. */
  75523. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  75524. /**
  75525. * Returns the string "VolumetricLightScatteringPostProcess"
  75526. * @returns "VolumetricLightScatteringPostProcess"
  75527. */
  75528. getClassName(): string;
  75529. private _isReady;
  75530. /**
  75531. * Sets the new light position for light scattering effect
  75532. * @param position The new custom light position
  75533. */
  75534. setCustomMeshPosition(position: Vector3): void;
  75535. /**
  75536. * Returns the light position for light scattering effect
  75537. * @return Vector3 The custom light position
  75538. */
  75539. getCustomMeshPosition(): Vector3;
  75540. /**
  75541. * Disposes the internal assets and detaches the post-process from the camera
  75542. */
  75543. dispose(camera: Camera): void;
  75544. /**
  75545. * Returns the render target texture used by the post-process
  75546. * @return the render target texture used by the post-process
  75547. */
  75548. getPass(): RenderTargetTexture;
  75549. private _meshExcluded;
  75550. private _createPass;
  75551. private _updateMeshScreenCoordinates;
  75552. /**
  75553. * Creates a default mesh for the Volumeric Light Scattering post-process
  75554. * @param name The mesh name
  75555. * @param scene The scene where to create the mesh
  75556. * @return the default mesh
  75557. */
  75558. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  75559. }
  75560. }
  75561. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  75562. /** @hidden */
  75563. export var screenSpaceCurvaturePixelShader: {
  75564. name: string;
  75565. shader: string;
  75566. };
  75567. }
  75568. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  75569. import { Nullable } from "babylonjs/types";
  75570. import { Camera } from "babylonjs/Cameras/camera";
  75571. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75572. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75573. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  75574. import { Engine } from "babylonjs/Engines/engine";
  75575. import { Scene } from "babylonjs/scene";
  75576. /**
  75577. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  75578. */
  75579. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  75580. /**
  75581. * Defines how much ridge the curvature effect displays.
  75582. */
  75583. ridge: number;
  75584. /**
  75585. * Defines how much valley the curvature effect displays.
  75586. */
  75587. valley: number;
  75588. private _geometryBufferRenderer;
  75589. /**
  75590. * Gets a string identifying the name of the class
  75591. * @returns "ScreenSpaceCurvaturePostProcess" string
  75592. */
  75593. getClassName(): string;
  75594. /**
  75595. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75596. * @param name The name of the effect.
  75597. * @param scene The scene containing the objects to blur according to their velocity.
  75598. * @param options The required width/height ratio to downsize to before computing the render pass.
  75599. * @param camera The camera to apply the render pass to.
  75600. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75601. * @param engine The engine which the post process will be applied. (default: current engine)
  75602. * @param reusable If the post process can be reused on the same frame. (default: false)
  75603. * @param textureType Type of textures used when performing the post process. (default: 0)
  75604. * @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)
  75605. */
  75606. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75607. /**
  75608. * Support test.
  75609. */
  75610. static get IsSupported(): boolean;
  75611. /** @hidden */
  75612. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  75613. }
  75614. }
  75615. declare module "babylonjs/PostProcesses/index" {
  75616. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75617. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75618. export * from "babylonjs/PostProcesses/bloomEffect";
  75619. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75620. export * from "babylonjs/PostProcesses/blurPostProcess";
  75621. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75622. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75623. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75624. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75625. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75626. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75627. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75628. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75629. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75630. export * from "babylonjs/PostProcesses/filterPostProcess";
  75631. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75632. export * from "babylonjs/PostProcesses/grainPostProcess";
  75633. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75634. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75635. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75636. export * from "babylonjs/PostProcesses/passPostProcess";
  75637. export * from "babylonjs/PostProcesses/postProcess";
  75638. export * from "babylonjs/PostProcesses/postProcessManager";
  75639. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75640. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75641. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75642. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75643. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75644. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75645. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75646. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75647. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75648. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75649. }
  75650. declare module "babylonjs/Probes/index" {
  75651. export * from "babylonjs/Probes/reflectionProbe";
  75652. }
  75653. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75654. import { Scene } from "babylonjs/scene";
  75655. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75656. import { SmartArray } from "babylonjs/Misc/smartArray";
  75657. import { ISceneComponent } from "babylonjs/sceneComponent";
  75658. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75659. import "babylonjs/Meshes/Builders/boxBuilder";
  75660. import "babylonjs/Shaders/color.fragment";
  75661. import "babylonjs/Shaders/color.vertex";
  75662. import { Color3 } from "babylonjs/Maths/math.color";
  75663. import { Observable } from "babylonjs/Misc/observable";
  75664. module "babylonjs/scene" {
  75665. interface Scene {
  75666. /** @hidden (Backing field) */
  75667. _boundingBoxRenderer: BoundingBoxRenderer;
  75668. /** @hidden (Backing field) */
  75669. _forceShowBoundingBoxes: boolean;
  75670. /**
  75671. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75672. */
  75673. forceShowBoundingBoxes: boolean;
  75674. /**
  75675. * Gets the bounding box renderer associated with the scene
  75676. * @returns a BoundingBoxRenderer
  75677. */
  75678. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75679. }
  75680. }
  75681. module "babylonjs/Meshes/abstractMesh" {
  75682. interface AbstractMesh {
  75683. /** @hidden (Backing field) */
  75684. _showBoundingBox: boolean;
  75685. /**
  75686. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75687. */
  75688. showBoundingBox: boolean;
  75689. }
  75690. }
  75691. /**
  75692. * Component responsible of rendering the bounding box of the meshes in a scene.
  75693. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75694. */
  75695. export class BoundingBoxRenderer implements ISceneComponent {
  75696. /**
  75697. * The component name helpfull to identify the component in the list of scene components.
  75698. */
  75699. readonly name: string;
  75700. /**
  75701. * The scene the component belongs to.
  75702. */
  75703. scene: Scene;
  75704. /**
  75705. * Color of the bounding box lines placed in front of an object
  75706. */
  75707. frontColor: Color3;
  75708. /**
  75709. * Color of the bounding box lines placed behind an object
  75710. */
  75711. backColor: Color3;
  75712. /**
  75713. * Defines if the renderer should show the back lines or not
  75714. */
  75715. showBackLines: boolean;
  75716. /**
  75717. * Observable raised before rendering a bounding box
  75718. */
  75719. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75720. /**
  75721. * Observable raised after rendering a bounding box
  75722. */
  75723. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75724. /**
  75725. * @hidden
  75726. */
  75727. renderList: SmartArray<BoundingBox>;
  75728. private _colorShader;
  75729. private _vertexBuffers;
  75730. private _indexBuffer;
  75731. private _fillIndexBuffer;
  75732. private _fillIndexData;
  75733. /**
  75734. * Instantiates a new bounding box renderer in a scene.
  75735. * @param scene the scene the renderer renders in
  75736. */
  75737. constructor(scene: Scene);
  75738. /**
  75739. * Registers the component in a given scene
  75740. */
  75741. register(): void;
  75742. private _evaluateSubMesh;
  75743. private _activeMesh;
  75744. private _prepareRessources;
  75745. private _createIndexBuffer;
  75746. /**
  75747. * Rebuilds the elements related to this component in case of
  75748. * context lost for instance.
  75749. */
  75750. rebuild(): void;
  75751. /**
  75752. * @hidden
  75753. */
  75754. reset(): void;
  75755. /**
  75756. * Render the bounding boxes of a specific rendering group
  75757. * @param renderingGroupId defines the rendering group to render
  75758. */
  75759. render(renderingGroupId: number): void;
  75760. /**
  75761. * In case of occlusion queries, we can render the occlusion bounding box through this method
  75762. * @param mesh Define the mesh to render the occlusion bounding box for
  75763. */
  75764. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  75765. /**
  75766. * Dispose and release the resources attached to this renderer.
  75767. */
  75768. dispose(): void;
  75769. }
  75770. }
  75771. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  75772. import { Nullable } from "babylonjs/types";
  75773. import { Scene } from "babylonjs/scene";
  75774. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  75775. import { Camera } from "babylonjs/Cameras/camera";
  75776. import { ISceneComponent } from "babylonjs/sceneComponent";
  75777. module "babylonjs/scene" {
  75778. interface Scene {
  75779. /** @hidden (Backing field) */
  75780. _depthRenderer: {
  75781. [id: string]: DepthRenderer;
  75782. };
  75783. /**
  75784. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  75785. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  75786. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  75787. * @returns the created depth renderer
  75788. */
  75789. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  75790. /**
  75791. * Disables a depth renderer for a given camera
  75792. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  75793. */
  75794. disableDepthRenderer(camera?: Nullable<Camera>): void;
  75795. }
  75796. }
  75797. /**
  75798. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  75799. * in several rendering techniques.
  75800. */
  75801. export class DepthRendererSceneComponent implements ISceneComponent {
  75802. /**
  75803. * The component name helpfull to identify the component in the list of scene components.
  75804. */
  75805. readonly name: string;
  75806. /**
  75807. * The scene the component belongs to.
  75808. */
  75809. scene: Scene;
  75810. /**
  75811. * Creates a new instance of the component for the given scene
  75812. * @param scene Defines the scene to register the component in
  75813. */
  75814. constructor(scene: Scene);
  75815. /**
  75816. * Registers the component in a given scene
  75817. */
  75818. register(): void;
  75819. /**
  75820. * Rebuilds the elements related to this component in case of
  75821. * context lost for instance.
  75822. */
  75823. rebuild(): void;
  75824. /**
  75825. * Disposes the component and the associated ressources
  75826. */
  75827. dispose(): void;
  75828. private _gatherRenderTargets;
  75829. private _gatherActiveCameraRenderTargets;
  75830. }
  75831. }
  75832. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  75833. import { Nullable } from "babylonjs/types";
  75834. import { Scene } from "babylonjs/scene";
  75835. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  75836. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  75837. import { AbstractScene } from "babylonjs/abstractScene";
  75838. module "babylonjs/abstractScene" {
  75839. interface AbstractScene {
  75840. /** @hidden (Backing field) */
  75841. _prePassRenderer: Nullable<PrePassRenderer>;
  75842. /**
  75843. * Gets or Sets the current prepass renderer associated to the scene.
  75844. */
  75845. prePassRenderer: Nullable<PrePassRenderer>;
  75846. /**
  75847. * Enables the prepass and associates it with the scene
  75848. * @returns the PrePassRenderer
  75849. */
  75850. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  75851. /**
  75852. * Disables the prepass associated with the scene
  75853. */
  75854. disablePrePassRenderer(): void;
  75855. }
  75856. }
  75857. /**
  75858. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  75859. * in several rendering techniques.
  75860. */
  75861. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  75862. /**
  75863. * The component name helpful to identify the component in the list of scene components.
  75864. */
  75865. readonly name: string;
  75866. /**
  75867. * The scene the component belongs to.
  75868. */
  75869. scene: Scene;
  75870. /**
  75871. * Creates a new instance of the component for the given scene
  75872. * @param scene Defines the scene to register the component in
  75873. */
  75874. constructor(scene: Scene);
  75875. /**
  75876. * Registers the component in a given scene
  75877. */
  75878. register(): void;
  75879. private _beforeCameraDraw;
  75880. private _afterCameraDraw;
  75881. private _beforeClearStage;
  75882. /**
  75883. * Serializes the component data to the specified json object
  75884. * @param serializationObject The object to serialize to
  75885. */
  75886. serialize(serializationObject: any): void;
  75887. /**
  75888. * Adds all the elements from the container to the scene
  75889. * @param container the container holding the elements
  75890. */
  75891. addFromContainer(container: AbstractScene): void;
  75892. /**
  75893. * Removes all the elements in the container from the scene
  75894. * @param container contains the elements to remove
  75895. * @param dispose if the removed element should be disposed (default: false)
  75896. */
  75897. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  75898. /**
  75899. * Rebuilds the elements related to this component in case of
  75900. * context lost for instance.
  75901. */
  75902. rebuild(): void;
  75903. /**
  75904. * Disposes the component and the associated ressources
  75905. */
  75906. dispose(): void;
  75907. }
  75908. }
  75909. declare module "babylonjs/Shaders/outline.fragment" {
  75910. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75911. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  75912. /** @hidden */
  75913. export var outlinePixelShader: {
  75914. name: string;
  75915. shader: string;
  75916. };
  75917. }
  75918. declare module "babylonjs/Shaders/outline.vertex" {
  75919. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75920. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75921. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75922. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75923. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75924. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75925. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75926. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75927. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  75928. /** @hidden */
  75929. export var outlineVertexShader: {
  75930. name: string;
  75931. shader: string;
  75932. };
  75933. }
  75934. declare module "babylonjs/Rendering/outlineRenderer" {
  75935. import { SubMesh } from "babylonjs/Meshes/subMesh";
  75936. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  75937. import { Scene } from "babylonjs/scene";
  75938. import { ISceneComponent } from "babylonjs/sceneComponent";
  75939. import "babylonjs/Shaders/outline.fragment";
  75940. import "babylonjs/Shaders/outline.vertex";
  75941. module "babylonjs/scene" {
  75942. interface Scene {
  75943. /** @hidden */
  75944. _outlineRenderer: OutlineRenderer;
  75945. /**
  75946. * Gets the outline renderer associated with the scene
  75947. * @returns a OutlineRenderer
  75948. */
  75949. getOutlineRenderer(): OutlineRenderer;
  75950. }
  75951. }
  75952. module "babylonjs/Meshes/abstractMesh" {
  75953. interface AbstractMesh {
  75954. /** @hidden (Backing field) */
  75955. _renderOutline: boolean;
  75956. /**
  75957. * Gets or sets a boolean indicating if the outline must be rendered as well
  75958. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  75959. */
  75960. renderOutline: boolean;
  75961. /** @hidden (Backing field) */
  75962. _renderOverlay: boolean;
  75963. /**
  75964. * Gets or sets a boolean indicating if the overlay must be rendered as well
  75965. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  75966. */
  75967. renderOverlay: boolean;
  75968. }
  75969. }
  75970. /**
  75971. * This class is responsible to draw bothe outline/overlay of meshes.
  75972. * It should not be used directly but through the available method on mesh.
  75973. */
  75974. export class OutlineRenderer implements ISceneComponent {
  75975. /**
  75976. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  75977. */
  75978. private static _StencilReference;
  75979. /**
  75980. * The name of the component. Each component must have a unique name.
  75981. */
  75982. name: string;
  75983. /**
  75984. * The scene the component belongs to.
  75985. */
  75986. scene: Scene;
  75987. /**
  75988. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  75989. */
  75990. zOffset: number;
  75991. private _engine;
  75992. private _effect;
  75993. private _cachedDefines;
  75994. private _savedDepthWrite;
  75995. /**
  75996. * Instantiates a new outline renderer. (There could be only one per scene).
  75997. * @param scene Defines the scene it belongs to
  75998. */
  75999. constructor(scene: Scene);
  76000. /**
  76001. * Register the component to one instance of a scene.
  76002. */
  76003. register(): void;
  76004. /**
  76005. * Rebuilds the elements related to this component in case of
  76006. * context lost for instance.
  76007. */
  76008. rebuild(): void;
  76009. /**
  76010. * Disposes the component and the associated ressources.
  76011. */
  76012. dispose(): void;
  76013. /**
  76014. * Renders the outline in the canvas.
  76015. * @param subMesh Defines the sumesh to render
  76016. * @param batch Defines the batch of meshes in case of instances
  76017. * @param useOverlay Defines if the rendering is for the overlay or the outline
  76018. */
  76019. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  76020. /**
  76021. * Returns whether or not the outline renderer is ready for a given submesh.
  76022. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  76023. * @param subMesh Defines the submesh to check readyness for
  76024. * @param useInstances Defines wheter wee are trying to render instances or not
  76025. * @returns true if ready otherwise false
  76026. */
  76027. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  76028. private _beforeRenderingMesh;
  76029. private _afterRenderingMesh;
  76030. }
  76031. }
  76032. declare module "babylonjs/Rendering/index" {
  76033. export * from "babylonjs/Rendering/boundingBoxRenderer";
  76034. export * from "babylonjs/Rendering/depthRenderer";
  76035. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  76036. export * from "babylonjs/Rendering/edgesRenderer";
  76037. export * from "babylonjs/Rendering/geometryBufferRenderer";
  76038. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  76039. export * from "babylonjs/Rendering/prePassRenderer";
  76040. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  76041. export * from "babylonjs/Rendering/outlineRenderer";
  76042. export * from "babylonjs/Rendering/renderingGroup";
  76043. export * from "babylonjs/Rendering/renderingManager";
  76044. export * from "babylonjs/Rendering/utilityLayerRenderer";
  76045. }
  76046. declare module "babylonjs/Sprites/ISprites" {
  76047. /**
  76048. * Defines the basic options interface of a Sprite Frame Source Size.
  76049. */
  76050. export interface ISpriteJSONSpriteSourceSize {
  76051. /**
  76052. * number of the original width of the Frame
  76053. */
  76054. w: number;
  76055. /**
  76056. * number of the original height of the Frame
  76057. */
  76058. h: number;
  76059. }
  76060. /**
  76061. * Defines the basic options interface of a Sprite Frame Data.
  76062. */
  76063. export interface ISpriteJSONSpriteFrameData {
  76064. /**
  76065. * number of the x offset of the Frame
  76066. */
  76067. x: number;
  76068. /**
  76069. * number of the y offset of the Frame
  76070. */
  76071. y: number;
  76072. /**
  76073. * number of the width of the Frame
  76074. */
  76075. w: number;
  76076. /**
  76077. * number of the height of the Frame
  76078. */
  76079. h: number;
  76080. }
  76081. /**
  76082. * Defines the basic options interface of a JSON Sprite.
  76083. */
  76084. export interface ISpriteJSONSprite {
  76085. /**
  76086. * string name of the Frame
  76087. */
  76088. filename: string;
  76089. /**
  76090. * ISpriteJSONSpriteFrame basic object of the frame data
  76091. */
  76092. frame: ISpriteJSONSpriteFrameData;
  76093. /**
  76094. * boolean to flag is the frame was rotated.
  76095. */
  76096. rotated: boolean;
  76097. /**
  76098. * boolean to flag is the frame was trimmed.
  76099. */
  76100. trimmed: boolean;
  76101. /**
  76102. * ISpriteJSONSpriteFrame basic object of the source data
  76103. */
  76104. spriteSourceSize: ISpriteJSONSpriteFrameData;
  76105. /**
  76106. * ISpriteJSONSpriteFrame basic object of the source data
  76107. */
  76108. sourceSize: ISpriteJSONSpriteSourceSize;
  76109. }
  76110. /**
  76111. * Defines the basic options interface of a JSON atlas.
  76112. */
  76113. export interface ISpriteJSONAtlas {
  76114. /**
  76115. * Array of objects that contain the frame data.
  76116. */
  76117. frames: Array<ISpriteJSONSprite>;
  76118. /**
  76119. * object basic object containing the sprite meta data.
  76120. */
  76121. meta?: object;
  76122. }
  76123. }
  76124. declare module "babylonjs/Shaders/spriteMap.fragment" {
  76125. /** @hidden */
  76126. export var spriteMapPixelShader: {
  76127. name: string;
  76128. shader: string;
  76129. };
  76130. }
  76131. declare module "babylonjs/Shaders/spriteMap.vertex" {
  76132. /** @hidden */
  76133. export var spriteMapVertexShader: {
  76134. name: string;
  76135. shader: string;
  76136. };
  76137. }
  76138. declare module "babylonjs/Sprites/spriteMap" {
  76139. import { IDisposable, Scene } from "babylonjs/scene";
  76140. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  76141. import { Texture } from "babylonjs/Materials/Textures/texture";
  76142. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  76143. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  76144. import "babylonjs/Meshes/Builders/planeBuilder";
  76145. import "babylonjs/Shaders/spriteMap.fragment";
  76146. import "babylonjs/Shaders/spriteMap.vertex";
  76147. /**
  76148. * Defines the basic options interface of a SpriteMap
  76149. */
  76150. export interface ISpriteMapOptions {
  76151. /**
  76152. * Vector2 of the number of cells in the grid.
  76153. */
  76154. stageSize?: Vector2;
  76155. /**
  76156. * Vector2 of the size of the output plane in World Units.
  76157. */
  76158. outputSize?: Vector2;
  76159. /**
  76160. * Vector3 of the position of the output plane in World Units.
  76161. */
  76162. outputPosition?: Vector3;
  76163. /**
  76164. * Vector3 of the rotation of the output plane.
  76165. */
  76166. outputRotation?: Vector3;
  76167. /**
  76168. * number of layers that the system will reserve in resources.
  76169. */
  76170. layerCount?: number;
  76171. /**
  76172. * number of max animation frames a single cell will reserve in resources.
  76173. */
  76174. maxAnimationFrames?: number;
  76175. /**
  76176. * number cell index of the base tile when the system compiles.
  76177. */
  76178. baseTile?: number;
  76179. /**
  76180. * boolean flip the sprite after its been repositioned by the framing data.
  76181. */
  76182. flipU?: boolean;
  76183. /**
  76184. * Vector3 scalar of the global RGB values of the SpriteMap.
  76185. */
  76186. colorMultiply?: Vector3;
  76187. }
  76188. /**
  76189. * Defines the IDisposable interface in order to be cleanable from resources.
  76190. */
  76191. export interface ISpriteMap extends IDisposable {
  76192. /**
  76193. * String name of the SpriteMap.
  76194. */
  76195. name: string;
  76196. /**
  76197. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  76198. */
  76199. atlasJSON: ISpriteJSONAtlas;
  76200. /**
  76201. * Texture of the SpriteMap.
  76202. */
  76203. spriteSheet: Texture;
  76204. /**
  76205. * The parameters to initialize the SpriteMap with.
  76206. */
  76207. options: ISpriteMapOptions;
  76208. }
  76209. /**
  76210. * Class used to manage a grid restricted sprite deployment on an Output plane.
  76211. */
  76212. export class SpriteMap implements ISpriteMap {
  76213. /** The Name of the spriteMap */
  76214. name: string;
  76215. /** The JSON file with the frame and meta data */
  76216. atlasJSON: ISpriteJSONAtlas;
  76217. /** The systems Sprite Sheet Texture */
  76218. spriteSheet: Texture;
  76219. /** Arguments passed with the Constructor */
  76220. options: ISpriteMapOptions;
  76221. /** Public Sprite Storage array, parsed from atlasJSON */
  76222. sprites: Array<ISpriteJSONSprite>;
  76223. /** Returns the Number of Sprites in the System */
  76224. get spriteCount(): number;
  76225. /** Returns the Position of Output Plane*/
  76226. get position(): Vector3;
  76227. /** Returns the Position of Output Plane*/
  76228. set position(v: Vector3);
  76229. /** Returns the Rotation of Output Plane*/
  76230. get rotation(): Vector3;
  76231. /** Returns the Rotation of Output Plane*/
  76232. set rotation(v: Vector3);
  76233. /** Sets the AnimationMap*/
  76234. get animationMap(): RawTexture;
  76235. /** Sets the AnimationMap*/
  76236. set animationMap(v: RawTexture);
  76237. /** Scene that the SpriteMap was created in */
  76238. private _scene;
  76239. /** Texture Buffer of Float32 that holds tile frame data*/
  76240. private _frameMap;
  76241. /** Texture Buffers of Float32 that holds tileMap data*/
  76242. private _tileMaps;
  76243. /** Texture Buffer of Float32 that holds Animation Data*/
  76244. private _animationMap;
  76245. /** Custom ShaderMaterial Central to the System*/
  76246. private _material;
  76247. /** Custom ShaderMaterial Central to the System*/
  76248. private _output;
  76249. /** Systems Time Ticker*/
  76250. private _time;
  76251. /**
  76252. * Creates a new SpriteMap
  76253. * @param name defines the SpriteMaps Name
  76254. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  76255. * @param spriteSheet is the Texture that the Sprites are on.
  76256. * @param options a basic deployment configuration
  76257. * @param scene The Scene that the map is deployed on
  76258. */
  76259. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  76260. /**
  76261. * Returns tileID location
  76262. * @returns Vector2 the cell position ID
  76263. */
  76264. getTileID(): Vector2;
  76265. /**
  76266. * Gets the UV location of the mouse over the SpriteMap.
  76267. * @returns Vector2 the UV position of the mouse interaction
  76268. */
  76269. getMousePosition(): Vector2;
  76270. /**
  76271. * Creates the "frame" texture Buffer
  76272. * -------------------------------------
  76273. * Structure of frames
  76274. * "filename": "Falling-Water-2.png",
  76275. * "frame": {"x":69,"y":103,"w":24,"h":32},
  76276. * "rotated": true,
  76277. * "trimmed": true,
  76278. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  76279. * "sourceSize": {"w":32,"h":32}
  76280. * @returns RawTexture of the frameMap
  76281. */
  76282. private _createFrameBuffer;
  76283. /**
  76284. * Creates the tileMap texture Buffer
  76285. * @param buffer normally and array of numbers, or a false to generate from scratch
  76286. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  76287. * @returns RawTexture of the tileMap
  76288. */
  76289. private _createTileBuffer;
  76290. /**
  76291. * Modifies the data of the tileMaps
  76292. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  76293. * @param pos is the iVector2 Coordinates of the Tile
  76294. * @param tile The SpriteIndex of the new Tile
  76295. */
  76296. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  76297. /**
  76298. * Creates the animationMap texture Buffer
  76299. * @param buffer normally and array of numbers, or a false to generate from scratch
  76300. * @returns RawTexture of the animationMap
  76301. */
  76302. private _createTileAnimationBuffer;
  76303. /**
  76304. * Modifies the data of the animationMap
  76305. * @param cellID is the Index of the Sprite
  76306. * @param _frame is the target Animation frame
  76307. * @param toCell is the Target Index of the next frame of the animation
  76308. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  76309. * @param speed is a global scalar of the time variable on the map.
  76310. */
  76311. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  76312. /**
  76313. * Exports the .tilemaps file
  76314. */
  76315. saveTileMaps(): void;
  76316. /**
  76317. * Imports the .tilemaps file
  76318. * @param url of the .tilemaps file
  76319. */
  76320. loadTileMaps(url: string): void;
  76321. /**
  76322. * Release associated resources
  76323. */
  76324. dispose(): void;
  76325. }
  76326. }
  76327. declare module "babylonjs/Sprites/spritePackedManager" {
  76328. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  76329. import { Scene } from "babylonjs/scene";
  76330. /**
  76331. * Class used to manage multiple sprites of different sizes on the same spritesheet
  76332. * @see https://doc.babylonjs.com/babylon101/sprites
  76333. */
  76334. export class SpritePackedManager extends SpriteManager {
  76335. /** defines the packed manager's name */
  76336. name: string;
  76337. /**
  76338. * Creates a new sprite manager from a packed sprite sheet
  76339. * @param name defines the manager's name
  76340. * @param imgUrl defines the sprite sheet url
  76341. * @param capacity defines the maximum allowed number of sprites
  76342. * @param scene defines the hosting scene
  76343. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  76344. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  76345. * @param samplingMode defines the smapling mode to use with spritesheet
  76346. * @param fromPacked set to true; do not alter
  76347. */
  76348. constructor(
  76349. /** defines the packed manager's name */
  76350. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  76351. }
  76352. }
  76353. declare module "babylonjs/Sprites/index" {
  76354. export * from "babylonjs/Sprites/sprite";
  76355. export * from "babylonjs/Sprites/ISprites";
  76356. export * from "babylonjs/Sprites/spriteManager";
  76357. export * from "babylonjs/Sprites/spriteMap";
  76358. export * from "babylonjs/Sprites/spritePackedManager";
  76359. export * from "babylonjs/Sprites/spriteSceneComponent";
  76360. }
  76361. declare module "babylonjs/States/index" {
  76362. export * from "babylonjs/States/alphaCullingState";
  76363. export * from "babylonjs/States/depthCullingState";
  76364. export * from "babylonjs/States/stencilState";
  76365. }
  76366. declare module "babylonjs/Misc/assetsManager" {
  76367. import { Scene } from "babylonjs/scene";
  76368. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76369. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  76370. import { Skeleton } from "babylonjs/Bones/skeleton";
  76371. import { Observable } from "babylonjs/Misc/observable";
  76372. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  76373. import { Texture } from "babylonjs/Materials/Textures/texture";
  76374. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  76375. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  76376. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  76377. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  76378. import { AssetContainer } from "babylonjs/assetContainer";
  76379. /**
  76380. * Defines the list of states available for a task inside a AssetsManager
  76381. */
  76382. export enum AssetTaskState {
  76383. /**
  76384. * Initialization
  76385. */
  76386. INIT = 0,
  76387. /**
  76388. * Running
  76389. */
  76390. RUNNING = 1,
  76391. /**
  76392. * Done
  76393. */
  76394. DONE = 2,
  76395. /**
  76396. * Error
  76397. */
  76398. ERROR = 3
  76399. }
  76400. /**
  76401. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  76402. */
  76403. export abstract class AbstractAssetTask {
  76404. /**
  76405. * Task name
  76406. */ name: string;
  76407. /**
  76408. * Callback called when the task is successful
  76409. */
  76410. onSuccess: (task: any) => void;
  76411. /**
  76412. * Callback called when the task is not successful
  76413. */
  76414. onError: (task: any, message?: string, exception?: any) => void;
  76415. /**
  76416. * Creates a new AssetsManager
  76417. * @param name defines the name of the task
  76418. */
  76419. constructor(
  76420. /**
  76421. * Task name
  76422. */ name: string);
  76423. private _isCompleted;
  76424. private _taskState;
  76425. private _errorObject;
  76426. /**
  76427. * Get if the task is completed
  76428. */
  76429. get isCompleted(): boolean;
  76430. /**
  76431. * Gets the current state of the task
  76432. */
  76433. get taskState(): AssetTaskState;
  76434. /**
  76435. * Gets the current error object (if task is in error)
  76436. */
  76437. get errorObject(): {
  76438. message?: string;
  76439. exception?: any;
  76440. };
  76441. /**
  76442. * Internal only
  76443. * @hidden
  76444. */
  76445. _setErrorObject(message?: string, exception?: any): void;
  76446. /**
  76447. * Execute the current task
  76448. * @param scene defines the scene where you want your assets to be loaded
  76449. * @param onSuccess is a callback called when the task is successfully executed
  76450. * @param onError is a callback called if an error occurs
  76451. */
  76452. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76453. /**
  76454. * Execute the current task
  76455. * @param scene defines the scene where you want your assets to be loaded
  76456. * @param onSuccess is a callback called when the task is successfully executed
  76457. * @param onError is a callback called if an error occurs
  76458. */
  76459. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76460. /**
  76461. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  76462. * This can be used with failed tasks that have the reason for failure fixed.
  76463. */
  76464. reset(): void;
  76465. private onErrorCallback;
  76466. private onDoneCallback;
  76467. }
  76468. /**
  76469. * Define the interface used by progress events raised during assets loading
  76470. */
  76471. export interface IAssetsProgressEvent {
  76472. /**
  76473. * Defines the number of remaining tasks to process
  76474. */
  76475. remainingCount: number;
  76476. /**
  76477. * Defines the total number of tasks
  76478. */
  76479. totalCount: number;
  76480. /**
  76481. * Defines the task that was just processed
  76482. */
  76483. task: AbstractAssetTask;
  76484. }
  76485. /**
  76486. * Class used to share progress information about assets loading
  76487. */
  76488. export class AssetsProgressEvent implements IAssetsProgressEvent {
  76489. /**
  76490. * Defines the number of remaining tasks to process
  76491. */
  76492. remainingCount: number;
  76493. /**
  76494. * Defines the total number of tasks
  76495. */
  76496. totalCount: number;
  76497. /**
  76498. * Defines the task that was just processed
  76499. */
  76500. task: AbstractAssetTask;
  76501. /**
  76502. * Creates a AssetsProgressEvent
  76503. * @param remainingCount defines the number of remaining tasks to process
  76504. * @param totalCount defines the total number of tasks
  76505. * @param task defines the task that was just processed
  76506. */
  76507. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  76508. }
  76509. /**
  76510. * Define a task used by AssetsManager to load assets into a container
  76511. */
  76512. export class ContainerAssetTask extends AbstractAssetTask {
  76513. /**
  76514. * Defines the name of the task
  76515. */
  76516. name: string;
  76517. /**
  76518. * Defines the list of mesh's names you want to load
  76519. */
  76520. meshesNames: any;
  76521. /**
  76522. * Defines the root url to use as a base to load your meshes and associated resources
  76523. */
  76524. rootUrl: string;
  76525. /**
  76526. * Defines the filename or File of the scene to load from
  76527. */
  76528. sceneFilename: string | File;
  76529. /**
  76530. * Get the loaded asset container
  76531. */
  76532. loadedContainer: AssetContainer;
  76533. /**
  76534. * Gets the list of loaded meshes
  76535. */
  76536. loadedMeshes: Array<AbstractMesh>;
  76537. /**
  76538. * Gets the list of loaded particle systems
  76539. */
  76540. loadedParticleSystems: Array<IParticleSystem>;
  76541. /**
  76542. * Gets the list of loaded skeletons
  76543. */
  76544. loadedSkeletons: Array<Skeleton>;
  76545. /**
  76546. * Gets the list of loaded animation groups
  76547. */
  76548. loadedAnimationGroups: Array<AnimationGroup>;
  76549. /**
  76550. * Callback called when the task is successful
  76551. */
  76552. onSuccess: (task: ContainerAssetTask) => void;
  76553. /**
  76554. * Callback called when the task is successful
  76555. */
  76556. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  76557. /**
  76558. * Creates a new ContainerAssetTask
  76559. * @param name defines the name of the task
  76560. * @param meshesNames defines the list of mesh's names you want to load
  76561. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76562. * @param sceneFilename defines the filename or File of the scene to load from
  76563. */
  76564. constructor(
  76565. /**
  76566. * Defines the name of the task
  76567. */
  76568. name: string,
  76569. /**
  76570. * Defines the list of mesh's names you want to load
  76571. */
  76572. meshesNames: any,
  76573. /**
  76574. * Defines the root url to use as a base to load your meshes and associated resources
  76575. */
  76576. rootUrl: string,
  76577. /**
  76578. * Defines the filename or File of the scene to load from
  76579. */
  76580. sceneFilename: string | File);
  76581. /**
  76582. * Execute the current task
  76583. * @param scene defines the scene where you want your assets to be loaded
  76584. * @param onSuccess is a callback called when the task is successfully executed
  76585. * @param onError is a callback called if an error occurs
  76586. */
  76587. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76588. }
  76589. /**
  76590. * Define a task used by AssetsManager to load meshes
  76591. */
  76592. export class MeshAssetTask extends AbstractAssetTask {
  76593. /**
  76594. * Defines the name of the task
  76595. */
  76596. name: string;
  76597. /**
  76598. * Defines the list of mesh's names you want to load
  76599. */
  76600. meshesNames: any;
  76601. /**
  76602. * Defines the root url to use as a base to load your meshes and associated resources
  76603. */
  76604. rootUrl: string;
  76605. /**
  76606. * Defines the filename or File of the scene to load from
  76607. */
  76608. sceneFilename: string | File;
  76609. /**
  76610. * Gets the list of loaded meshes
  76611. */
  76612. loadedMeshes: Array<AbstractMesh>;
  76613. /**
  76614. * Gets the list of loaded particle systems
  76615. */
  76616. loadedParticleSystems: Array<IParticleSystem>;
  76617. /**
  76618. * Gets the list of loaded skeletons
  76619. */
  76620. loadedSkeletons: Array<Skeleton>;
  76621. /**
  76622. * Gets the list of loaded animation groups
  76623. */
  76624. loadedAnimationGroups: Array<AnimationGroup>;
  76625. /**
  76626. * Callback called when the task is successful
  76627. */
  76628. onSuccess: (task: MeshAssetTask) => void;
  76629. /**
  76630. * Callback called when the task is successful
  76631. */
  76632. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  76633. /**
  76634. * Creates a new MeshAssetTask
  76635. * @param name defines the name of the task
  76636. * @param meshesNames defines the list of mesh's names you want to load
  76637. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76638. * @param sceneFilename defines the filename or File of the scene to load from
  76639. */
  76640. constructor(
  76641. /**
  76642. * Defines the name of the task
  76643. */
  76644. name: string,
  76645. /**
  76646. * Defines the list of mesh's names you want to load
  76647. */
  76648. meshesNames: any,
  76649. /**
  76650. * Defines the root url to use as a base to load your meshes and associated resources
  76651. */
  76652. rootUrl: string,
  76653. /**
  76654. * Defines the filename or File of the scene to load from
  76655. */
  76656. sceneFilename: string | File);
  76657. /**
  76658. * Execute the current task
  76659. * @param scene defines the scene where you want your assets to be loaded
  76660. * @param onSuccess is a callback called when the task is successfully executed
  76661. * @param onError is a callback called if an error occurs
  76662. */
  76663. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76664. }
  76665. /**
  76666. * Define a task used by AssetsManager to load text content
  76667. */
  76668. export class TextFileAssetTask extends AbstractAssetTask {
  76669. /**
  76670. * Defines the name of the task
  76671. */
  76672. name: string;
  76673. /**
  76674. * Defines the location of the file to load
  76675. */
  76676. url: string;
  76677. /**
  76678. * Gets the loaded text string
  76679. */
  76680. text: string;
  76681. /**
  76682. * Callback called when the task is successful
  76683. */
  76684. onSuccess: (task: TextFileAssetTask) => void;
  76685. /**
  76686. * Callback called when the task is successful
  76687. */
  76688. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  76689. /**
  76690. * Creates a new TextFileAssetTask object
  76691. * @param name defines the name of the task
  76692. * @param url defines the location of the file to load
  76693. */
  76694. constructor(
  76695. /**
  76696. * Defines the name of the task
  76697. */
  76698. name: string,
  76699. /**
  76700. * Defines the location of the file to load
  76701. */
  76702. url: string);
  76703. /**
  76704. * Execute the current task
  76705. * @param scene defines the scene where you want your assets to be loaded
  76706. * @param onSuccess is a callback called when the task is successfully executed
  76707. * @param onError is a callback called if an error occurs
  76708. */
  76709. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76710. }
  76711. /**
  76712. * Define a task used by AssetsManager to load binary data
  76713. */
  76714. export class BinaryFileAssetTask extends AbstractAssetTask {
  76715. /**
  76716. * Defines the name of the task
  76717. */
  76718. name: string;
  76719. /**
  76720. * Defines the location of the file to load
  76721. */
  76722. url: string;
  76723. /**
  76724. * Gets the lodaded data (as an array buffer)
  76725. */
  76726. data: ArrayBuffer;
  76727. /**
  76728. * Callback called when the task is successful
  76729. */
  76730. onSuccess: (task: BinaryFileAssetTask) => void;
  76731. /**
  76732. * Callback called when the task is successful
  76733. */
  76734. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  76735. /**
  76736. * Creates a new BinaryFileAssetTask object
  76737. * @param name defines the name of the new task
  76738. * @param url defines the location of the file to load
  76739. */
  76740. constructor(
  76741. /**
  76742. * Defines the name of the task
  76743. */
  76744. name: string,
  76745. /**
  76746. * Defines the location of the file to load
  76747. */
  76748. url: string);
  76749. /**
  76750. * Execute the current task
  76751. * @param scene defines the scene where you want your assets to be loaded
  76752. * @param onSuccess is a callback called when the task is successfully executed
  76753. * @param onError is a callback called if an error occurs
  76754. */
  76755. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76756. }
  76757. /**
  76758. * Define a task used by AssetsManager to load images
  76759. */
  76760. export class ImageAssetTask extends AbstractAssetTask {
  76761. /**
  76762. * Defines the name of the task
  76763. */
  76764. name: string;
  76765. /**
  76766. * Defines the location of the image to load
  76767. */
  76768. url: string;
  76769. /**
  76770. * Gets the loaded images
  76771. */
  76772. image: HTMLImageElement;
  76773. /**
  76774. * Callback called when the task is successful
  76775. */
  76776. onSuccess: (task: ImageAssetTask) => void;
  76777. /**
  76778. * Callback called when the task is successful
  76779. */
  76780. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  76781. /**
  76782. * Creates a new ImageAssetTask
  76783. * @param name defines the name of the task
  76784. * @param url defines the location of the image to load
  76785. */
  76786. constructor(
  76787. /**
  76788. * Defines the name of the task
  76789. */
  76790. name: string,
  76791. /**
  76792. * Defines the location of the image to load
  76793. */
  76794. url: string);
  76795. /**
  76796. * Execute the current task
  76797. * @param scene defines the scene where you want your assets to be loaded
  76798. * @param onSuccess is a callback called when the task is successfully executed
  76799. * @param onError is a callback called if an error occurs
  76800. */
  76801. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76802. }
  76803. /**
  76804. * Defines the interface used by texture loading tasks
  76805. */
  76806. export interface ITextureAssetTask<TEX extends BaseTexture> {
  76807. /**
  76808. * Gets the loaded texture
  76809. */
  76810. texture: TEX;
  76811. }
  76812. /**
  76813. * Define a task used by AssetsManager to load 2D textures
  76814. */
  76815. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  76816. /**
  76817. * Defines the name of the task
  76818. */
  76819. name: string;
  76820. /**
  76821. * Defines the location of the file to load
  76822. */
  76823. url: string;
  76824. /**
  76825. * Defines if mipmap should not be generated (default is false)
  76826. */
  76827. noMipmap?: boolean | undefined;
  76828. /**
  76829. * Defines if texture must be inverted on Y axis (default is true)
  76830. */
  76831. invertY: boolean;
  76832. /**
  76833. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76834. */
  76835. samplingMode: number;
  76836. /**
  76837. * Gets the loaded texture
  76838. */
  76839. texture: Texture;
  76840. /**
  76841. * Callback called when the task is successful
  76842. */
  76843. onSuccess: (task: TextureAssetTask) => void;
  76844. /**
  76845. * Callback called when the task is successful
  76846. */
  76847. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  76848. /**
  76849. * Creates a new TextureAssetTask object
  76850. * @param name defines the name of the task
  76851. * @param url defines the location of the file to load
  76852. * @param noMipmap defines if mipmap should not be generated (default is false)
  76853. * @param invertY defines if texture must be inverted on Y axis (default is true)
  76854. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76855. */
  76856. constructor(
  76857. /**
  76858. * Defines the name of the task
  76859. */
  76860. name: string,
  76861. /**
  76862. * Defines the location of the file to load
  76863. */
  76864. url: string,
  76865. /**
  76866. * Defines if mipmap should not be generated (default is false)
  76867. */
  76868. noMipmap?: boolean | undefined,
  76869. /**
  76870. * Defines if texture must be inverted on Y axis (default is true)
  76871. */
  76872. invertY?: boolean,
  76873. /**
  76874. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76875. */
  76876. samplingMode?: number);
  76877. /**
  76878. * Execute the current task
  76879. * @param scene defines the scene where you want your assets to be loaded
  76880. * @param onSuccess is a callback called when the task is successfully executed
  76881. * @param onError is a callback called if an error occurs
  76882. */
  76883. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76884. }
  76885. /**
  76886. * Define a task used by AssetsManager to load cube textures
  76887. */
  76888. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  76889. /**
  76890. * Defines the name of the task
  76891. */
  76892. name: string;
  76893. /**
  76894. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76895. */
  76896. url: string;
  76897. /**
  76898. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76899. */
  76900. extensions?: string[] | undefined;
  76901. /**
  76902. * Defines if mipmaps should not be generated (default is false)
  76903. */
  76904. noMipmap?: boolean | undefined;
  76905. /**
  76906. * Defines the explicit list of files (undefined by default)
  76907. */
  76908. files?: string[] | undefined;
  76909. /**
  76910. * Gets the loaded texture
  76911. */
  76912. texture: CubeTexture;
  76913. /**
  76914. * Callback called when the task is successful
  76915. */
  76916. onSuccess: (task: CubeTextureAssetTask) => void;
  76917. /**
  76918. * Callback called when the task is successful
  76919. */
  76920. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  76921. /**
  76922. * Creates a new CubeTextureAssetTask
  76923. * @param name defines the name of the task
  76924. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76925. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76926. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76927. * @param files defines the explicit list of files (undefined by default)
  76928. */
  76929. constructor(
  76930. /**
  76931. * Defines the name of the task
  76932. */
  76933. name: string,
  76934. /**
  76935. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76936. */
  76937. url: string,
  76938. /**
  76939. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76940. */
  76941. extensions?: string[] | undefined,
  76942. /**
  76943. * Defines if mipmaps should not be generated (default is false)
  76944. */
  76945. noMipmap?: boolean | undefined,
  76946. /**
  76947. * Defines the explicit list of files (undefined by default)
  76948. */
  76949. files?: string[] | undefined);
  76950. /**
  76951. * Execute the current task
  76952. * @param scene defines the scene where you want your assets to be loaded
  76953. * @param onSuccess is a callback called when the task is successfully executed
  76954. * @param onError is a callback called if an error occurs
  76955. */
  76956. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76957. }
  76958. /**
  76959. * Define a task used by AssetsManager to load HDR cube textures
  76960. */
  76961. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  76962. /**
  76963. * Defines the name of the task
  76964. */
  76965. name: string;
  76966. /**
  76967. * Defines the location of the file to load
  76968. */
  76969. url: string;
  76970. /**
  76971. * Defines the desired size (the more it increases the longer the generation will be)
  76972. */
  76973. size: number;
  76974. /**
  76975. * Defines if mipmaps should not be generated (default is false)
  76976. */
  76977. noMipmap: boolean;
  76978. /**
  76979. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76980. */
  76981. generateHarmonics: boolean;
  76982. /**
  76983. * 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)
  76984. */
  76985. gammaSpace: boolean;
  76986. /**
  76987. * Internal Use Only
  76988. */
  76989. reserved: boolean;
  76990. /**
  76991. * Gets the loaded texture
  76992. */
  76993. texture: HDRCubeTexture;
  76994. /**
  76995. * Callback called when the task is successful
  76996. */
  76997. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  76998. /**
  76999. * Callback called when the task is successful
  77000. */
  77001. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  77002. /**
  77003. * Creates a new HDRCubeTextureAssetTask object
  77004. * @param name defines the name of the task
  77005. * @param url defines the location of the file to load
  77006. * @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.
  77007. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77008. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77009. * @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)
  77010. * @param reserved Internal use only
  77011. */
  77012. constructor(
  77013. /**
  77014. * Defines the name of the task
  77015. */
  77016. name: string,
  77017. /**
  77018. * Defines the location of the file to load
  77019. */
  77020. url: string,
  77021. /**
  77022. * Defines the desired size (the more it increases the longer the generation will be)
  77023. */
  77024. size: number,
  77025. /**
  77026. * Defines if mipmaps should not be generated (default is false)
  77027. */
  77028. noMipmap?: boolean,
  77029. /**
  77030. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77031. */
  77032. generateHarmonics?: boolean,
  77033. /**
  77034. * 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)
  77035. */
  77036. gammaSpace?: boolean,
  77037. /**
  77038. * Internal Use Only
  77039. */
  77040. reserved?: boolean);
  77041. /**
  77042. * Execute the current task
  77043. * @param scene defines the scene where you want your assets to be loaded
  77044. * @param onSuccess is a callback called when the task is successfully executed
  77045. * @param onError is a callback called if an error occurs
  77046. */
  77047. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77048. }
  77049. /**
  77050. * Define a task used by AssetsManager to load Equirectangular cube textures
  77051. */
  77052. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  77053. /**
  77054. * Defines the name of the task
  77055. */
  77056. name: string;
  77057. /**
  77058. * Defines the location of the file to load
  77059. */
  77060. url: string;
  77061. /**
  77062. * Defines the desired size (the more it increases the longer the generation will be)
  77063. */
  77064. size: number;
  77065. /**
  77066. * Defines if mipmaps should not be generated (default is false)
  77067. */
  77068. noMipmap: boolean;
  77069. /**
  77070. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77071. * but the standard material would require them in Gamma space) (default is true)
  77072. */
  77073. gammaSpace: boolean;
  77074. /**
  77075. * Gets the loaded texture
  77076. */
  77077. texture: EquiRectangularCubeTexture;
  77078. /**
  77079. * Callback called when the task is successful
  77080. */
  77081. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  77082. /**
  77083. * Callback called when the task is successful
  77084. */
  77085. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  77086. /**
  77087. * Creates a new EquiRectangularCubeTextureAssetTask object
  77088. * @param name defines the name of the task
  77089. * @param url defines the location of the file to load
  77090. * @param size defines the desired size (the more it increases the longer the generation will be)
  77091. * If the size is omitted this implies you are using a preprocessed cubemap.
  77092. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77093. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  77094. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  77095. * (default is true)
  77096. */
  77097. constructor(
  77098. /**
  77099. * Defines the name of the task
  77100. */
  77101. name: string,
  77102. /**
  77103. * Defines the location of the file to load
  77104. */
  77105. url: string,
  77106. /**
  77107. * Defines the desired size (the more it increases the longer the generation will be)
  77108. */
  77109. size: number,
  77110. /**
  77111. * Defines if mipmaps should not be generated (default is false)
  77112. */
  77113. noMipmap?: boolean,
  77114. /**
  77115. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77116. * but the standard material would require them in Gamma space) (default is true)
  77117. */
  77118. gammaSpace?: boolean);
  77119. /**
  77120. * Execute the current task
  77121. * @param scene defines the scene where you want your assets to be loaded
  77122. * @param onSuccess is a callback called when the task is successfully executed
  77123. * @param onError is a callback called if an error occurs
  77124. */
  77125. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77126. }
  77127. /**
  77128. * This class can be used to easily import assets into a scene
  77129. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  77130. */
  77131. export class AssetsManager {
  77132. private _scene;
  77133. private _isLoading;
  77134. protected _tasks: AbstractAssetTask[];
  77135. protected _waitingTasksCount: number;
  77136. protected _totalTasksCount: number;
  77137. /**
  77138. * Callback called when all tasks are processed
  77139. */
  77140. onFinish: (tasks: AbstractAssetTask[]) => void;
  77141. /**
  77142. * Callback called when a task is successful
  77143. */
  77144. onTaskSuccess: (task: AbstractAssetTask) => void;
  77145. /**
  77146. * Callback called when a task had an error
  77147. */
  77148. onTaskError: (task: AbstractAssetTask) => void;
  77149. /**
  77150. * Callback called when a task is done (whatever the result is)
  77151. */
  77152. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  77153. /**
  77154. * Observable called when all tasks are processed
  77155. */
  77156. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  77157. /**
  77158. * Observable called when a task had an error
  77159. */
  77160. onTaskErrorObservable: Observable<AbstractAssetTask>;
  77161. /**
  77162. * Observable called when all tasks were executed
  77163. */
  77164. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  77165. /**
  77166. * Observable called when a task is done (whatever the result is)
  77167. */
  77168. onProgressObservable: Observable<IAssetsProgressEvent>;
  77169. /**
  77170. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  77171. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  77172. */
  77173. useDefaultLoadingScreen: boolean;
  77174. /**
  77175. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  77176. * when all assets have been downloaded.
  77177. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  77178. */
  77179. autoHideLoadingUI: boolean;
  77180. /**
  77181. * Creates a new AssetsManager
  77182. * @param scene defines the scene to work on
  77183. */
  77184. constructor(scene: Scene);
  77185. /**
  77186. * Add a ContainerAssetTask to the list of active tasks
  77187. * @param taskName defines the name of the new task
  77188. * @param meshesNames defines the name of meshes to load
  77189. * @param rootUrl defines the root url to use to locate files
  77190. * @param sceneFilename defines the filename of the scene file
  77191. * @returns a new ContainerAssetTask object
  77192. */
  77193. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  77194. /**
  77195. * Add a MeshAssetTask to the list of active tasks
  77196. * @param taskName defines the name of the new task
  77197. * @param meshesNames defines the name of meshes to load
  77198. * @param rootUrl defines the root url to use to locate files
  77199. * @param sceneFilename defines the filename of the scene file
  77200. * @returns a new MeshAssetTask object
  77201. */
  77202. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  77203. /**
  77204. * Add a TextFileAssetTask to the list of active tasks
  77205. * @param taskName defines the name of the new task
  77206. * @param url defines the url of the file to load
  77207. * @returns a new TextFileAssetTask object
  77208. */
  77209. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  77210. /**
  77211. * Add a BinaryFileAssetTask 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. * @returns a new BinaryFileAssetTask object
  77215. */
  77216. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  77217. /**
  77218. * Add a ImageAssetTask to the list of active tasks
  77219. * @param taskName defines the name of the new task
  77220. * @param url defines the url of the file to load
  77221. * @returns a new ImageAssetTask object
  77222. */
  77223. addImageTask(taskName: string, url: string): ImageAssetTask;
  77224. /**
  77225. * Add a TextureAssetTask to the list of active tasks
  77226. * @param taskName defines the name of the new task
  77227. * @param url defines the url of the file to load
  77228. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77229. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  77230. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  77231. * @returns a new TextureAssetTask object
  77232. */
  77233. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  77234. /**
  77235. * Add a CubeTextureAssetTask to the list of active tasks
  77236. * @param taskName defines the name of the new task
  77237. * @param url defines the url of the file to load
  77238. * @param extensions defines the extension to use to load the cube map (can be null)
  77239. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77240. * @param files defines the list of files to load (can be null)
  77241. * @returns a new CubeTextureAssetTask object
  77242. */
  77243. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  77244. /**
  77245. *
  77246. * Add a HDRCubeTextureAssetTask to the list of active tasks
  77247. * @param taskName defines the name of the new task
  77248. * @param url defines the url of the file to load
  77249. * @param size defines the size you want for the cubemap (can be null)
  77250. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77251. * @param generateHarmonics defines if you want to automatically generate (true by default)
  77252. * @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)
  77253. * @param reserved Internal use only
  77254. * @returns a new HDRCubeTextureAssetTask object
  77255. */
  77256. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  77257. /**
  77258. *
  77259. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  77260. * @param taskName defines the name of the new task
  77261. * @param url defines the url of the file to load
  77262. * @param size defines the size you want for the cubemap (can be null)
  77263. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77264. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  77265. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  77266. * @returns a new EquiRectangularCubeTextureAssetTask object
  77267. */
  77268. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  77269. /**
  77270. * Remove a task from the assets manager.
  77271. * @param task the task to remove
  77272. */
  77273. removeTask(task: AbstractAssetTask): void;
  77274. private _decreaseWaitingTasksCount;
  77275. private _runTask;
  77276. /**
  77277. * Reset the AssetsManager and remove all tasks
  77278. * @return the current instance of the AssetsManager
  77279. */
  77280. reset(): AssetsManager;
  77281. /**
  77282. * Start the loading process
  77283. * @return the current instance of the AssetsManager
  77284. */
  77285. load(): AssetsManager;
  77286. /**
  77287. * Start the loading process as an async operation
  77288. * @return a promise returning the list of failed tasks
  77289. */
  77290. loadAsync(): Promise<void>;
  77291. }
  77292. }
  77293. declare module "babylonjs/Misc/deferred" {
  77294. /**
  77295. * Wrapper class for promise with external resolve and reject.
  77296. */
  77297. export class Deferred<T> {
  77298. /**
  77299. * The promise associated with this deferred object.
  77300. */
  77301. readonly promise: Promise<T>;
  77302. private _resolve;
  77303. private _reject;
  77304. /**
  77305. * The resolve method of the promise associated with this deferred object.
  77306. */
  77307. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  77308. /**
  77309. * The reject method of the promise associated with this deferred object.
  77310. */
  77311. get reject(): (reason?: any) => void;
  77312. /**
  77313. * Constructor for this deferred object.
  77314. */
  77315. constructor();
  77316. }
  77317. }
  77318. declare module "babylonjs/Misc/meshExploder" {
  77319. import { Mesh } from "babylonjs/Meshes/mesh";
  77320. /**
  77321. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  77322. */
  77323. export class MeshExploder {
  77324. private _centerMesh;
  77325. private _meshes;
  77326. private _meshesOrigins;
  77327. private _toCenterVectors;
  77328. private _scaledDirection;
  77329. private _newPosition;
  77330. private _centerPosition;
  77331. /**
  77332. * Explodes meshes from a center mesh.
  77333. * @param meshes The meshes to explode.
  77334. * @param centerMesh The mesh to be center of explosion.
  77335. */
  77336. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  77337. private _setCenterMesh;
  77338. /**
  77339. * Get class name
  77340. * @returns "MeshExploder"
  77341. */
  77342. getClassName(): string;
  77343. /**
  77344. * "Exploded meshes"
  77345. * @returns Array of meshes with the centerMesh at index 0.
  77346. */
  77347. getMeshes(): Array<Mesh>;
  77348. /**
  77349. * Explodes meshes giving a specific direction
  77350. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  77351. */
  77352. explode(direction?: number): void;
  77353. }
  77354. }
  77355. declare module "babylonjs/Misc/filesInput" {
  77356. import { Engine } from "babylonjs/Engines/engine";
  77357. import { Scene } from "babylonjs/scene";
  77358. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  77359. import { Nullable } from "babylonjs/types";
  77360. /**
  77361. * Class used to help managing file picking and drag'n'drop
  77362. */
  77363. export class FilesInput {
  77364. /**
  77365. * List of files ready to be loaded
  77366. */
  77367. static get FilesToLoad(): {
  77368. [key: string]: File;
  77369. };
  77370. /**
  77371. * Callback called when a file is processed
  77372. */
  77373. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  77374. private _engine;
  77375. private _currentScene;
  77376. private _sceneLoadedCallback;
  77377. private _progressCallback;
  77378. private _additionalRenderLoopLogicCallback;
  77379. private _textureLoadingCallback;
  77380. private _startingProcessingFilesCallback;
  77381. private _onReloadCallback;
  77382. private _errorCallback;
  77383. private _elementToMonitor;
  77384. private _sceneFileToLoad;
  77385. private _filesToLoad;
  77386. /**
  77387. * Creates a new FilesInput
  77388. * @param engine defines the rendering engine
  77389. * @param scene defines the hosting scene
  77390. * @param sceneLoadedCallback callback called when scene is loaded
  77391. * @param progressCallback callback called to track progress
  77392. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  77393. * @param textureLoadingCallback callback called when a texture is loading
  77394. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  77395. * @param onReloadCallback callback called when a reload is requested
  77396. * @param errorCallback callback call if an error occurs
  77397. */
  77398. 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>);
  77399. private _dragEnterHandler;
  77400. private _dragOverHandler;
  77401. private _dropHandler;
  77402. /**
  77403. * Calls this function to listen to drag'n'drop events on a specific DOM element
  77404. * @param elementToMonitor defines the DOM element to track
  77405. */
  77406. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  77407. /** Gets the current list of files to load */
  77408. get filesToLoad(): File[];
  77409. /**
  77410. * Release all associated resources
  77411. */
  77412. dispose(): void;
  77413. private renderFunction;
  77414. private drag;
  77415. private drop;
  77416. private _traverseFolder;
  77417. private _processFiles;
  77418. /**
  77419. * Load files from a drop event
  77420. * @param event defines the drop event to use as source
  77421. */
  77422. loadFiles(event: any): void;
  77423. private _processReload;
  77424. /**
  77425. * Reload the current scene from the loaded files
  77426. */
  77427. reload(): void;
  77428. }
  77429. }
  77430. declare module "babylonjs/Misc/HighDynamicRange/index" {
  77431. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  77432. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  77433. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  77434. }
  77435. declare module "babylonjs/Misc/sceneOptimizer" {
  77436. import { Scene, IDisposable } from "babylonjs/scene";
  77437. import { Observable } from "babylonjs/Misc/observable";
  77438. /**
  77439. * Defines the root class used to create scene optimization to use with SceneOptimizer
  77440. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77441. */
  77442. export class SceneOptimization {
  77443. /**
  77444. * Defines the priority of this optimization (0 by default which means first in the list)
  77445. */
  77446. priority: number;
  77447. /**
  77448. * Gets a string describing the action executed by the current optimization
  77449. * @returns description string
  77450. */
  77451. getDescription(): string;
  77452. /**
  77453. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77454. * @param scene defines the current scene where to apply this optimization
  77455. * @param optimizer defines the current optimizer
  77456. * @returns true if everything that can be done was applied
  77457. */
  77458. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77459. /**
  77460. * Creates the SceneOptimization object
  77461. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77462. * @param desc defines the description associated with the optimization
  77463. */
  77464. constructor(
  77465. /**
  77466. * Defines the priority of this optimization (0 by default which means first in the list)
  77467. */
  77468. priority?: number);
  77469. }
  77470. /**
  77471. * Defines an optimization used to reduce the size of render target textures
  77472. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77473. */
  77474. export class TextureOptimization extends SceneOptimization {
  77475. /**
  77476. * Defines the priority of this optimization (0 by default which means first in the list)
  77477. */
  77478. priority: number;
  77479. /**
  77480. * 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
  77481. */
  77482. maximumSize: number;
  77483. /**
  77484. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77485. */
  77486. step: number;
  77487. /**
  77488. * Gets a string describing the action executed by the current optimization
  77489. * @returns description string
  77490. */
  77491. getDescription(): string;
  77492. /**
  77493. * Creates the TextureOptimization object
  77494. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77495. * @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
  77496. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77497. */
  77498. constructor(
  77499. /**
  77500. * Defines the priority of this optimization (0 by default which means first in the list)
  77501. */
  77502. priority?: number,
  77503. /**
  77504. * 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
  77505. */
  77506. maximumSize?: number,
  77507. /**
  77508. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77509. */
  77510. step?: number);
  77511. /**
  77512. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77513. * @param scene defines the current scene where to apply this optimization
  77514. * @param optimizer defines the current optimizer
  77515. * @returns true if everything that can be done was applied
  77516. */
  77517. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77518. }
  77519. /**
  77520. * Defines an optimization used to increase or decrease the rendering resolution
  77521. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77522. */
  77523. export class HardwareScalingOptimization extends SceneOptimization {
  77524. /**
  77525. * Defines the priority of this optimization (0 by default which means first in the list)
  77526. */
  77527. priority: number;
  77528. /**
  77529. * Defines the maximum scale to use (2 by default)
  77530. */
  77531. maximumScale: number;
  77532. /**
  77533. * Defines the step to use between two passes (0.5 by default)
  77534. */
  77535. step: number;
  77536. private _currentScale;
  77537. private _directionOffset;
  77538. /**
  77539. * Gets a string describing the action executed by the current optimization
  77540. * @return description string
  77541. */
  77542. getDescription(): string;
  77543. /**
  77544. * Creates the HardwareScalingOptimization object
  77545. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77546. * @param maximumScale defines the maximum scale to use (2 by default)
  77547. * @param step defines the step to use between two passes (0.5 by default)
  77548. */
  77549. constructor(
  77550. /**
  77551. * Defines the priority of this optimization (0 by default which means first in the list)
  77552. */
  77553. priority?: number,
  77554. /**
  77555. * Defines the maximum scale to use (2 by default)
  77556. */
  77557. maximumScale?: number,
  77558. /**
  77559. * Defines the step to use between two passes (0.5 by default)
  77560. */
  77561. step?: number);
  77562. /**
  77563. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77564. * @param scene defines the current scene where to apply this optimization
  77565. * @param optimizer defines the current optimizer
  77566. * @returns true if everything that can be done was applied
  77567. */
  77568. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77569. }
  77570. /**
  77571. * Defines an optimization used to remove shadows
  77572. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77573. */
  77574. export class ShadowsOptimization extends SceneOptimization {
  77575. /**
  77576. * Gets a string describing the action executed by the current optimization
  77577. * @return description string
  77578. */
  77579. getDescription(): string;
  77580. /**
  77581. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77582. * @param scene defines the current scene where to apply this optimization
  77583. * @param optimizer defines the current optimizer
  77584. * @returns true if everything that can be done was applied
  77585. */
  77586. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77587. }
  77588. /**
  77589. * Defines an optimization used to turn post-processes off
  77590. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77591. */
  77592. export class PostProcessesOptimization extends SceneOptimization {
  77593. /**
  77594. * Gets a string describing the action executed by the current optimization
  77595. * @return description string
  77596. */
  77597. getDescription(): string;
  77598. /**
  77599. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77600. * @param scene defines the current scene where to apply this optimization
  77601. * @param optimizer defines the current optimizer
  77602. * @returns true if everything that can be done was applied
  77603. */
  77604. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77605. }
  77606. /**
  77607. * Defines an optimization used to turn lens flares off
  77608. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77609. */
  77610. export class LensFlaresOptimization extends SceneOptimization {
  77611. /**
  77612. * Gets a string describing the action executed by the current optimization
  77613. * @return description string
  77614. */
  77615. getDescription(): string;
  77616. /**
  77617. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77618. * @param scene defines the current scene where to apply this optimization
  77619. * @param optimizer defines the current optimizer
  77620. * @returns true if everything that can be done was applied
  77621. */
  77622. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77623. }
  77624. /**
  77625. * Defines an optimization based on user defined callback.
  77626. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77627. */
  77628. export class CustomOptimization extends SceneOptimization {
  77629. /**
  77630. * Callback called to apply the custom optimization.
  77631. */
  77632. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  77633. /**
  77634. * Callback called to get custom description
  77635. */
  77636. onGetDescription: () => string;
  77637. /**
  77638. * Gets a string describing the action executed by the current optimization
  77639. * @returns description string
  77640. */
  77641. getDescription(): string;
  77642. /**
  77643. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77644. * @param scene defines the current scene where to apply this optimization
  77645. * @param optimizer defines the current optimizer
  77646. * @returns true if everything that can be done was applied
  77647. */
  77648. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77649. }
  77650. /**
  77651. * Defines an optimization used to turn particles off
  77652. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77653. */
  77654. export class ParticlesOptimization extends SceneOptimization {
  77655. /**
  77656. * Gets a string describing the action executed by the current optimization
  77657. * @return description string
  77658. */
  77659. getDescription(): string;
  77660. /**
  77661. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77662. * @param scene defines the current scene where to apply this optimization
  77663. * @param optimizer defines the current optimizer
  77664. * @returns true if everything that can be done was applied
  77665. */
  77666. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77667. }
  77668. /**
  77669. * Defines an optimization used to turn render targets off
  77670. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77671. */
  77672. export class RenderTargetsOptimization extends SceneOptimization {
  77673. /**
  77674. * Gets a string describing the action executed by the current optimization
  77675. * @return description string
  77676. */
  77677. getDescription(): string;
  77678. /**
  77679. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77680. * @param scene defines the current scene where to apply this optimization
  77681. * @param optimizer defines the current optimizer
  77682. * @returns true if everything that can be done was applied
  77683. */
  77684. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77685. }
  77686. /**
  77687. * Defines an optimization used to merge meshes with compatible materials
  77688. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77689. */
  77690. export class MergeMeshesOptimization extends SceneOptimization {
  77691. private static _UpdateSelectionTree;
  77692. /**
  77693. * Gets or sets a boolean which defines if optimization octree has to be updated
  77694. */
  77695. static get UpdateSelectionTree(): boolean;
  77696. /**
  77697. * Gets or sets a boolean which defines if optimization octree has to be updated
  77698. */
  77699. static set UpdateSelectionTree(value: boolean);
  77700. /**
  77701. * Gets a string describing the action executed by the current optimization
  77702. * @return description string
  77703. */
  77704. getDescription(): string;
  77705. private _canBeMerged;
  77706. /**
  77707. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77708. * @param scene defines the current scene where to apply this optimization
  77709. * @param optimizer defines the current optimizer
  77710. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  77711. * @returns true if everything that can be done was applied
  77712. */
  77713. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  77714. }
  77715. /**
  77716. * Defines a list of options used by SceneOptimizer
  77717. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77718. */
  77719. export class SceneOptimizerOptions {
  77720. /**
  77721. * Defines the target frame rate to reach (60 by default)
  77722. */
  77723. targetFrameRate: number;
  77724. /**
  77725. * Defines the interval between two checkes (2000ms by default)
  77726. */
  77727. trackerDuration: number;
  77728. /**
  77729. * Gets the list of optimizations to apply
  77730. */
  77731. optimizations: SceneOptimization[];
  77732. /**
  77733. * Creates a new list of options used by SceneOptimizer
  77734. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  77735. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  77736. */
  77737. constructor(
  77738. /**
  77739. * Defines the target frame rate to reach (60 by default)
  77740. */
  77741. targetFrameRate?: number,
  77742. /**
  77743. * Defines the interval between two checkes (2000ms by default)
  77744. */
  77745. trackerDuration?: number);
  77746. /**
  77747. * Add a new optimization
  77748. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  77749. * @returns the current SceneOptimizerOptions
  77750. */
  77751. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  77752. /**
  77753. * Add a new custom optimization
  77754. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  77755. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  77756. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77757. * @returns the current SceneOptimizerOptions
  77758. */
  77759. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  77760. /**
  77761. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  77762. * @param targetFrameRate defines the target frame rate (60 by default)
  77763. * @returns a SceneOptimizerOptions object
  77764. */
  77765. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77766. /**
  77767. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  77768. * @param targetFrameRate defines the target frame rate (60 by default)
  77769. * @returns a SceneOptimizerOptions object
  77770. */
  77771. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77772. /**
  77773. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  77774. * @param targetFrameRate defines the target frame rate (60 by default)
  77775. * @returns a SceneOptimizerOptions object
  77776. */
  77777. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77778. }
  77779. /**
  77780. * Class used to run optimizations in order to reach a target frame rate
  77781. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77782. */
  77783. export class SceneOptimizer implements IDisposable {
  77784. private _isRunning;
  77785. private _options;
  77786. private _scene;
  77787. private _currentPriorityLevel;
  77788. private _targetFrameRate;
  77789. private _trackerDuration;
  77790. private _currentFrameRate;
  77791. private _sceneDisposeObserver;
  77792. private _improvementMode;
  77793. /**
  77794. * Defines an observable called when the optimizer reaches the target frame rate
  77795. */
  77796. onSuccessObservable: Observable<SceneOptimizer>;
  77797. /**
  77798. * Defines an observable called when the optimizer enables an optimization
  77799. */
  77800. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  77801. /**
  77802. * Defines an observable called when the optimizer is not able to reach the target frame rate
  77803. */
  77804. onFailureObservable: Observable<SceneOptimizer>;
  77805. /**
  77806. * Gets a boolean indicating if the optimizer is in improvement mode
  77807. */
  77808. get isInImprovementMode(): boolean;
  77809. /**
  77810. * Gets the current priority level (0 at start)
  77811. */
  77812. get currentPriorityLevel(): number;
  77813. /**
  77814. * Gets the current frame rate checked by the SceneOptimizer
  77815. */
  77816. get currentFrameRate(): number;
  77817. /**
  77818. * Gets or sets the current target frame rate (60 by default)
  77819. */
  77820. get targetFrameRate(): number;
  77821. /**
  77822. * Gets or sets the current target frame rate (60 by default)
  77823. */
  77824. set targetFrameRate(value: number);
  77825. /**
  77826. * Gets or sets the current interval between two checks (every 2000ms by default)
  77827. */
  77828. get trackerDuration(): number;
  77829. /**
  77830. * Gets or sets the current interval between two checks (every 2000ms by default)
  77831. */
  77832. set trackerDuration(value: number);
  77833. /**
  77834. * Gets the list of active optimizations
  77835. */
  77836. get optimizations(): SceneOptimization[];
  77837. /**
  77838. * Creates a new SceneOptimizer
  77839. * @param scene defines the scene to work on
  77840. * @param options defines the options to use with the SceneOptimizer
  77841. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  77842. * @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)
  77843. */
  77844. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  77845. /**
  77846. * Stops the current optimizer
  77847. */
  77848. stop(): void;
  77849. /**
  77850. * Reset the optimizer to initial step (current priority level = 0)
  77851. */
  77852. reset(): void;
  77853. /**
  77854. * Start the optimizer. By default it will try to reach a specific framerate
  77855. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  77856. */
  77857. start(): void;
  77858. private _checkCurrentState;
  77859. /**
  77860. * Release all resources
  77861. */
  77862. dispose(): void;
  77863. /**
  77864. * Helper function to create a SceneOptimizer with one single line of code
  77865. * @param scene defines the scene to work on
  77866. * @param options defines the options to use with the SceneOptimizer
  77867. * @param onSuccess defines a callback to call on success
  77868. * @param onFailure defines a callback to call on failure
  77869. * @returns the new SceneOptimizer object
  77870. */
  77871. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  77872. }
  77873. }
  77874. declare module "babylonjs/Misc/sceneSerializer" {
  77875. import { Scene } from "babylonjs/scene";
  77876. /**
  77877. * Class used to serialize a scene into a string
  77878. */
  77879. export class SceneSerializer {
  77880. /**
  77881. * Clear cache used by a previous serialization
  77882. */
  77883. static ClearCache(): void;
  77884. /**
  77885. * Serialize a scene into a JSON compatible object
  77886. * @param scene defines the scene to serialize
  77887. * @returns a JSON compatible object
  77888. */
  77889. static Serialize(scene: Scene): any;
  77890. /**
  77891. * Serialize a mesh into a JSON compatible object
  77892. * @param toSerialize defines the mesh to serialize
  77893. * @param withParents defines if parents must be serialized as well
  77894. * @param withChildren defines if children must be serialized as well
  77895. * @returns a JSON compatible object
  77896. */
  77897. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  77898. }
  77899. }
  77900. declare module "babylonjs/Misc/textureTools" {
  77901. import { Texture } from "babylonjs/Materials/Textures/texture";
  77902. /**
  77903. * Class used to host texture specific utilities
  77904. */
  77905. export class TextureTools {
  77906. /**
  77907. * Uses the GPU to create a copy texture rescaled at a given size
  77908. * @param texture Texture to copy from
  77909. * @param width defines the desired width
  77910. * @param height defines the desired height
  77911. * @param useBilinearMode defines if bilinear mode has to be used
  77912. * @return the generated texture
  77913. */
  77914. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  77915. }
  77916. }
  77917. declare module "babylonjs/Misc/videoRecorder" {
  77918. import { Nullable } from "babylonjs/types";
  77919. import { Engine } from "babylonjs/Engines/engine";
  77920. /**
  77921. * This represents the different options available for the video capture.
  77922. */
  77923. export interface VideoRecorderOptions {
  77924. /** Defines the mime type of the video. */
  77925. mimeType: string;
  77926. /** Defines the FPS the video should be recorded at. */
  77927. fps: number;
  77928. /** Defines the chunk size for the recording data. */
  77929. recordChunckSize: number;
  77930. /** The audio tracks to attach to the recording. */
  77931. audioTracks?: MediaStreamTrack[];
  77932. }
  77933. /**
  77934. * This can help with recording videos from BabylonJS.
  77935. * This is based on the available WebRTC functionalities of the browser.
  77936. *
  77937. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  77938. */
  77939. export class VideoRecorder {
  77940. private static readonly _defaultOptions;
  77941. /**
  77942. * Returns whether or not the VideoRecorder is available in your browser.
  77943. * @param engine Defines the Babylon Engine.
  77944. * @returns true if supported otherwise false.
  77945. */
  77946. static IsSupported(engine: Engine): boolean;
  77947. private readonly _options;
  77948. private _canvas;
  77949. private _mediaRecorder;
  77950. private _recordedChunks;
  77951. private _fileName;
  77952. private _resolve;
  77953. private _reject;
  77954. /**
  77955. * True when a recording is already in progress.
  77956. */
  77957. get isRecording(): boolean;
  77958. /**
  77959. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  77960. * @param engine Defines the BabylonJS Engine you wish to record.
  77961. * @param options Defines options that can be used to customize the capture.
  77962. */
  77963. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  77964. /**
  77965. * Stops the current recording before the default capture timeout passed in the startRecording function.
  77966. */
  77967. stopRecording(): void;
  77968. /**
  77969. * Starts recording the canvas for a max duration specified in parameters.
  77970. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  77971. * If null no automatic download will start and you can rely on the promise to get the data back.
  77972. * @param maxDuration Defines the maximum recording time in seconds.
  77973. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  77974. * @return A promise callback at the end of the recording with the video data in Blob.
  77975. */
  77976. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  77977. /**
  77978. * Releases internal resources used during the recording.
  77979. */
  77980. dispose(): void;
  77981. private _handleDataAvailable;
  77982. private _handleError;
  77983. private _handleStop;
  77984. }
  77985. }
  77986. declare module "babylonjs/Misc/screenshotTools" {
  77987. import { Camera } from "babylonjs/Cameras/camera";
  77988. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  77989. import { Engine } from "babylonjs/Engines/engine";
  77990. /**
  77991. * Class containing a set of static utilities functions for screenshots
  77992. */
  77993. export class ScreenshotTools {
  77994. /**
  77995. * Captures a screenshot of the current rendering
  77996. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77997. * @param engine defines the rendering engine
  77998. * @param camera defines the source camera
  77999. * @param size This parameter can be set to a single number or to an object with the
  78000. * following (optional) properties: precision, width, height. If a single number is passed,
  78001. * it will be used for both width and height. If an object is passed, the screenshot size
  78002. * will be derived from the parameters. The precision property is a multiplier allowing
  78003. * rendering at a higher or lower resolution
  78004. * @param successCallback defines the callback receives a single parameter which contains the
  78005. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78006. * src parameter of an <img> to display it
  78007. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78008. * Check your browser for supported MIME types
  78009. */
  78010. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  78011. /**
  78012. * Captures a screenshot of the current rendering
  78013. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78014. * @param engine defines the rendering engine
  78015. * @param camera defines the source camera
  78016. * @param size This parameter can be set to a single number or to an object with the
  78017. * following (optional) properties: precision, width, height. If a single number is passed,
  78018. * it will be used for both width and height. If an object is passed, the screenshot size
  78019. * will be derived from the parameters. The precision property is a multiplier allowing
  78020. * rendering at a higher or lower resolution
  78021. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78022. * Check your browser for supported MIME types
  78023. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78024. * to the src parameter of an <img> to display it
  78025. */
  78026. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  78027. /**
  78028. * Generates an image screenshot from the specified camera.
  78029. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78030. * @param engine The engine to use for rendering
  78031. * @param camera The camera to use for rendering
  78032. * @param size This parameter can be set to a single number or to an object with the
  78033. * following (optional) properties: precision, width, height. If a single number is passed,
  78034. * it will be used for both width and height. If an object is passed, the screenshot size
  78035. * will be derived from the parameters. The precision property is a multiplier allowing
  78036. * rendering at a higher or lower resolution
  78037. * @param successCallback The callback receives a single parameter which contains the
  78038. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78039. * src parameter of an <img> to display it
  78040. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78041. * Check your browser for supported MIME types
  78042. * @param samples Texture samples (default: 1)
  78043. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78044. * @param fileName A name for for the downloaded file.
  78045. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78046. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  78047. */
  78048. 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;
  78049. /**
  78050. * Generates an image screenshot from the specified camera.
  78051. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78052. * @param engine The engine to use for rendering
  78053. * @param camera The camera to use for rendering
  78054. * @param size This parameter can be set to a single number or to an object with the
  78055. * following (optional) properties: precision, width, height. If a single number is passed,
  78056. * it will be used for both width and height. If an object is passed, the screenshot size
  78057. * will be derived from the parameters. The precision property is a multiplier allowing
  78058. * rendering at a higher or lower resolution
  78059. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78060. * Check your browser for supported MIME types
  78061. * @param samples Texture samples (default: 1)
  78062. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78063. * @param fileName A name for for the downloaded file.
  78064. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78065. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78066. * to the src parameter of an <img> to display it
  78067. */
  78068. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  78069. /**
  78070. * Gets height and width for screenshot size
  78071. * @private
  78072. */
  78073. private static _getScreenshotSize;
  78074. }
  78075. }
  78076. declare module "babylonjs/Misc/dataReader" {
  78077. /**
  78078. * Interface for a data buffer
  78079. */
  78080. export interface IDataBuffer {
  78081. /**
  78082. * Reads bytes from the data buffer.
  78083. * @param byteOffset The byte offset to read
  78084. * @param byteLength The byte length to read
  78085. * @returns A promise that resolves when the bytes are read
  78086. */
  78087. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  78088. /**
  78089. * The byte length of the buffer.
  78090. */
  78091. readonly byteLength: number;
  78092. }
  78093. /**
  78094. * Utility class for reading from a data buffer
  78095. */
  78096. export class DataReader {
  78097. /**
  78098. * The data buffer associated with this data reader.
  78099. */
  78100. readonly buffer: IDataBuffer;
  78101. /**
  78102. * The current byte offset from the beginning of the data buffer.
  78103. */
  78104. byteOffset: number;
  78105. private _dataView;
  78106. private _dataByteOffset;
  78107. /**
  78108. * Constructor
  78109. * @param buffer The buffer to read
  78110. */
  78111. constructor(buffer: IDataBuffer);
  78112. /**
  78113. * Loads the given byte length.
  78114. * @param byteLength The byte length to load
  78115. * @returns A promise that resolves when the load is complete
  78116. */
  78117. loadAsync(byteLength: number): Promise<void>;
  78118. /**
  78119. * Read a unsigned 32-bit integer from the currently loaded data range.
  78120. * @returns The 32-bit integer read
  78121. */
  78122. readUint32(): number;
  78123. /**
  78124. * Read a byte array from the currently loaded data range.
  78125. * @param byteLength The byte length to read
  78126. * @returns The byte array read
  78127. */
  78128. readUint8Array(byteLength: number): Uint8Array;
  78129. /**
  78130. * Read a string from the currently loaded data range.
  78131. * @param byteLength The byte length to read
  78132. * @returns The string read
  78133. */
  78134. readString(byteLength: number): string;
  78135. /**
  78136. * Skips the given byte length the currently loaded data range.
  78137. * @param byteLength The byte length to skip
  78138. */
  78139. skipBytes(byteLength: number): void;
  78140. }
  78141. }
  78142. declare module "babylonjs/Misc/dataStorage" {
  78143. /**
  78144. * Class for storing data to local storage if available or in-memory storage otherwise
  78145. */
  78146. export class DataStorage {
  78147. private static _Storage;
  78148. private static _GetStorage;
  78149. /**
  78150. * Reads a string from the data storage
  78151. * @param key The key to read
  78152. * @param defaultValue The value if the key doesn't exist
  78153. * @returns The string value
  78154. */
  78155. static ReadString(key: string, defaultValue: string): string;
  78156. /**
  78157. * Writes a string to the data storage
  78158. * @param key The key to write
  78159. * @param value The value to write
  78160. */
  78161. static WriteString(key: string, value: string): void;
  78162. /**
  78163. * Reads a boolean from the data storage
  78164. * @param key The key to read
  78165. * @param defaultValue The value if the key doesn't exist
  78166. * @returns The boolean value
  78167. */
  78168. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  78169. /**
  78170. * Writes a boolean to the data storage
  78171. * @param key The key to write
  78172. * @param value The value to write
  78173. */
  78174. static WriteBoolean(key: string, value: boolean): void;
  78175. /**
  78176. * Reads a number from the data storage
  78177. * @param key The key to read
  78178. * @param defaultValue The value if the key doesn't exist
  78179. * @returns The number value
  78180. */
  78181. static ReadNumber(key: string, defaultValue: number): number;
  78182. /**
  78183. * Writes a number to the data storage
  78184. * @param key The key to write
  78185. * @param value The value to write
  78186. */
  78187. static WriteNumber(key: string, value: number): void;
  78188. }
  78189. }
  78190. declare module "babylonjs/Misc/sceneRecorder" {
  78191. import { Scene } from "babylonjs/scene";
  78192. /**
  78193. * Class used to record delta files between 2 scene states
  78194. */
  78195. export class SceneRecorder {
  78196. private _trackedScene;
  78197. private _savedJSON;
  78198. /**
  78199. * Track a given scene. This means the current scene state will be considered the original state
  78200. * @param scene defines the scene to track
  78201. */
  78202. track(scene: Scene): void;
  78203. /**
  78204. * Get the delta between current state and original state
  78205. * @returns a string containing the delta
  78206. */
  78207. getDelta(): any;
  78208. private _compareArray;
  78209. private _compareObjects;
  78210. private _compareCollections;
  78211. private static GetShadowGeneratorById;
  78212. /**
  78213. * Apply a given delta to a given scene
  78214. * @param deltaJSON defines the JSON containing the delta
  78215. * @param scene defines the scene to apply the delta to
  78216. */
  78217. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  78218. private static _ApplyPropertiesToEntity;
  78219. private static _ApplyDeltaForEntity;
  78220. }
  78221. }
  78222. declare module "babylonjs/Misc/index" {
  78223. export * from "babylonjs/Misc/andOrNotEvaluator";
  78224. export * from "babylonjs/Misc/assetsManager";
  78225. export * from "babylonjs/Misc/basis";
  78226. export * from "babylonjs/Misc/dds";
  78227. export * from "babylonjs/Misc/decorators";
  78228. export * from "babylonjs/Misc/deferred";
  78229. export * from "babylonjs/Misc/environmentTextureTools";
  78230. export * from "babylonjs/Misc/meshExploder";
  78231. export * from "babylonjs/Misc/filesInput";
  78232. export * from "babylonjs/Misc/HighDynamicRange/index";
  78233. export * from "babylonjs/Misc/khronosTextureContainer";
  78234. export * from "babylonjs/Misc/observable";
  78235. export * from "babylonjs/Misc/performanceMonitor";
  78236. export * from "babylonjs/Misc/promise";
  78237. export * from "babylonjs/Misc/sceneOptimizer";
  78238. export * from "babylonjs/Misc/sceneSerializer";
  78239. export * from "babylonjs/Misc/smartArray";
  78240. export * from "babylonjs/Misc/stringDictionary";
  78241. export * from "babylonjs/Misc/tags";
  78242. export * from "babylonjs/Misc/textureTools";
  78243. export * from "babylonjs/Misc/tga";
  78244. export * from "babylonjs/Misc/tools";
  78245. export * from "babylonjs/Misc/videoRecorder";
  78246. export * from "babylonjs/Misc/virtualJoystick";
  78247. export * from "babylonjs/Misc/workerPool";
  78248. export * from "babylonjs/Misc/logger";
  78249. export * from "babylonjs/Misc/typeStore";
  78250. export * from "babylonjs/Misc/filesInputStore";
  78251. export * from "babylonjs/Misc/deepCopier";
  78252. export * from "babylonjs/Misc/pivotTools";
  78253. export * from "babylonjs/Misc/precisionDate";
  78254. export * from "babylonjs/Misc/screenshotTools";
  78255. export * from "babylonjs/Misc/typeStore";
  78256. export * from "babylonjs/Misc/webRequest";
  78257. export * from "babylonjs/Misc/iInspectable";
  78258. export * from "babylonjs/Misc/brdfTextureTools";
  78259. export * from "babylonjs/Misc/rgbdTextureTools";
  78260. export * from "babylonjs/Misc/gradients";
  78261. export * from "babylonjs/Misc/perfCounter";
  78262. export * from "babylonjs/Misc/fileRequest";
  78263. export * from "babylonjs/Misc/customAnimationFrameRequester";
  78264. export * from "babylonjs/Misc/retryStrategy";
  78265. export * from "babylonjs/Misc/interfaces/screenshotSize";
  78266. export * from "babylonjs/Misc/canvasGenerator";
  78267. export * from "babylonjs/Misc/fileTools";
  78268. export * from "babylonjs/Misc/stringTools";
  78269. export * from "babylonjs/Misc/dataReader";
  78270. export * from "babylonjs/Misc/minMaxReducer";
  78271. export * from "babylonjs/Misc/depthReducer";
  78272. export * from "babylonjs/Misc/dataStorage";
  78273. export * from "babylonjs/Misc/sceneRecorder";
  78274. }
  78275. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  78276. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  78277. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78278. import { Observable } from "babylonjs/Misc/observable";
  78279. import { Matrix } from "babylonjs/Maths/math.vector";
  78280. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78281. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78282. /**
  78283. * An interface for all Hit test features
  78284. */
  78285. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  78286. /**
  78287. * Triggered when new babylon (transformed) hit test results are available
  78288. */
  78289. onHitTestResultObservable: Observable<T[]>;
  78290. }
  78291. /**
  78292. * Options used for hit testing
  78293. */
  78294. export interface IWebXRLegacyHitTestOptions {
  78295. /**
  78296. * Only test when user interacted with the scene. Default - hit test every frame
  78297. */
  78298. testOnPointerDownOnly?: boolean;
  78299. /**
  78300. * The node to use to transform the local results to world coordinates
  78301. */
  78302. worldParentNode?: TransformNode;
  78303. }
  78304. /**
  78305. * Interface defining the babylon result of raycasting/hit-test
  78306. */
  78307. export interface IWebXRLegacyHitResult {
  78308. /**
  78309. * Transformation matrix that can be applied to a node that will put it in the hit point location
  78310. */
  78311. transformationMatrix: Matrix;
  78312. /**
  78313. * The native hit test result
  78314. */
  78315. xrHitResult: XRHitResult | XRHitTestResult;
  78316. }
  78317. /**
  78318. * The currently-working hit-test module.
  78319. * Hit test (or Ray-casting) is used to interact with the real world.
  78320. * For further information read here - https://github.com/immersive-web/hit-test
  78321. */
  78322. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  78323. /**
  78324. * options to use when constructing this feature
  78325. */
  78326. readonly options: IWebXRLegacyHitTestOptions;
  78327. private _direction;
  78328. private _mat;
  78329. private _onSelectEnabled;
  78330. private _origin;
  78331. /**
  78332. * The module's name
  78333. */
  78334. static readonly Name: string;
  78335. /**
  78336. * The (Babylon) version of this module.
  78337. * This is an integer representing the implementation version.
  78338. * This number does not correspond to the WebXR specs version
  78339. */
  78340. static readonly Version: number;
  78341. /**
  78342. * Populated with the last native XR Hit Results
  78343. */
  78344. lastNativeXRHitResults: XRHitResult[];
  78345. /**
  78346. * Triggered when new babylon (transformed) hit test results are available
  78347. */
  78348. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  78349. /**
  78350. * Creates a new instance of the (legacy version) hit test feature
  78351. * @param _xrSessionManager an instance of WebXRSessionManager
  78352. * @param options options to use when constructing this feature
  78353. */
  78354. constructor(_xrSessionManager: WebXRSessionManager,
  78355. /**
  78356. * options to use when constructing this feature
  78357. */
  78358. options?: IWebXRLegacyHitTestOptions);
  78359. /**
  78360. * execute a hit test with an XR Ray
  78361. *
  78362. * @param xrSession a native xrSession that will execute this hit test
  78363. * @param xrRay the ray (position and direction) to use for ray-casting
  78364. * @param referenceSpace native XR reference space to use for the hit-test
  78365. * @param filter filter function that will filter the results
  78366. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78367. */
  78368. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  78369. /**
  78370. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  78371. * @param event the (select) event to use to select with
  78372. * @param referenceSpace the reference space to use for this hit test
  78373. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78374. */
  78375. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  78376. /**
  78377. * attach this feature
  78378. * Will usually be called by the features manager
  78379. *
  78380. * @returns true if successful.
  78381. */
  78382. attach(): boolean;
  78383. /**
  78384. * detach this feature.
  78385. * Will usually be called by the features manager
  78386. *
  78387. * @returns true if successful.
  78388. */
  78389. detach(): boolean;
  78390. /**
  78391. * Dispose this feature and all of the resources attached
  78392. */
  78393. dispose(): void;
  78394. protected _onXRFrame(frame: XRFrame): void;
  78395. private _onHitTestResults;
  78396. private _onSelect;
  78397. }
  78398. }
  78399. declare module "babylonjs/XR/features/WebXRHitTest" {
  78400. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78401. import { Observable } from "babylonjs/Misc/observable";
  78402. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78403. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78404. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  78405. /**
  78406. * Options used for hit testing (version 2)
  78407. */
  78408. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  78409. /**
  78410. * Do not create a permanent hit test. Will usually be used when only
  78411. * transient inputs are needed.
  78412. */
  78413. disablePermanentHitTest?: boolean;
  78414. /**
  78415. * Enable transient (for example touch-based) hit test inspections
  78416. */
  78417. enableTransientHitTest?: boolean;
  78418. /**
  78419. * Offset ray for the permanent hit test
  78420. */
  78421. offsetRay?: Vector3;
  78422. /**
  78423. * Offset ray for the transient hit test
  78424. */
  78425. transientOffsetRay?: Vector3;
  78426. /**
  78427. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  78428. */
  78429. useReferenceSpace?: boolean;
  78430. /**
  78431. * Override the default entity type(s) of the hit-test result
  78432. */
  78433. entityTypes?: XRHitTestTrackableType[];
  78434. }
  78435. /**
  78436. * Interface defining the babylon result of hit-test
  78437. */
  78438. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  78439. /**
  78440. * The input source that generated this hit test (if transient)
  78441. */
  78442. inputSource?: XRInputSource;
  78443. /**
  78444. * Is this a transient hit test
  78445. */
  78446. isTransient?: boolean;
  78447. /**
  78448. * Position of the hit test result
  78449. */
  78450. position: Vector3;
  78451. /**
  78452. * Rotation of the hit test result
  78453. */
  78454. rotationQuaternion: Quaternion;
  78455. /**
  78456. * The native hit test result
  78457. */
  78458. xrHitResult: XRHitTestResult;
  78459. }
  78460. /**
  78461. * The currently-working hit-test module.
  78462. * Hit test (or Ray-casting) is used to interact with the real world.
  78463. * For further information read here - https://github.com/immersive-web/hit-test
  78464. *
  78465. * Tested on chrome (mobile) 80.
  78466. */
  78467. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  78468. /**
  78469. * options to use when constructing this feature
  78470. */
  78471. readonly options: IWebXRHitTestOptions;
  78472. private _tmpMat;
  78473. private _tmpPos;
  78474. private _tmpQuat;
  78475. private _transientXrHitTestSource;
  78476. private _xrHitTestSource;
  78477. private initHitTestSource;
  78478. /**
  78479. * The module's name
  78480. */
  78481. static readonly Name: string;
  78482. /**
  78483. * The (Babylon) version of this module.
  78484. * This is an integer representing the implementation version.
  78485. * This number does not correspond to the WebXR specs version
  78486. */
  78487. static readonly Version: number;
  78488. /**
  78489. * When set to true, each hit test will have its own position/rotation objects
  78490. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  78491. * the developers will clone them or copy them as they see fit.
  78492. */
  78493. autoCloneTransformation: boolean;
  78494. /**
  78495. * Triggered when new babylon (transformed) hit test results are available
  78496. */
  78497. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  78498. /**
  78499. * Use this to temporarily pause hit test checks.
  78500. */
  78501. paused: boolean;
  78502. /**
  78503. * Creates a new instance of the hit test feature
  78504. * @param _xrSessionManager an instance of WebXRSessionManager
  78505. * @param options options to use when constructing this feature
  78506. */
  78507. constructor(_xrSessionManager: WebXRSessionManager,
  78508. /**
  78509. * options to use when constructing this feature
  78510. */
  78511. options?: IWebXRHitTestOptions);
  78512. /**
  78513. * attach this feature
  78514. * Will usually be called by the features manager
  78515. *
  78516. * @returns true if successful.
  78517. */
  78518. attach(): boolean;
  78519. /**
  78520. * detach this feature.
  78521. * Will usually be called by the features manager
  78522. *
  78523. * @returns true if successful.
  78524. */
  78525. detach(): boolean;
  78526. /**
  78527. * Dispose this feature and all of the resources attached
  78528. */
  78529. dispose(): void;
  78530. protected _onXRFrame(frame: XRFrame): void;
  78531. private _processWebXRHitTestResult;
  78532. }
  78533. }
  78534. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  78535. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78536. import { Observable } from "babylonjs/Misc/observable";
  78537. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78538. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78539. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78540. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  78541. /**
  78542. * Configuration options of the anchor system
  78543. */
  78544. export interface IWebXRAnchorSystemOptions {
  78545. /**
  78546. * a node that will be used to convert local to world coordinates
  78547. */
  78548. worldParentNode?: TransformNode;
  78549. /**
  78550. * If set to true a reference of the created anchors will be kept until the next session starts
  78551. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  78552. */
  78553. doNotRemoveAnchorsOnSessionEnded?: boolean;
  78554. }
  78555. /**
  78556. * A babylon container for an XR Anchor
  78557. */
  78558. export interface IWebXRAnchor {
  78559. /**
  78560. * A babylon-assigned ID for this anchor
  78561. */
  78562. id: number;
  78563. /**
  78564. * Transformation matrix to apply to an object attached to this anchor
  78565. */
  78566. transformationMatrix: Matrix;
  78567. /**
  78568. * The native anchor object
  78569. */
  78570. xrAnchor: XRAnchor;
  78571. /**
  78572. * if defined, this object will be constantly updated by the anchor's position and rotation
  78573. */
  78574. attachedNode?: TransformNode;
  78575. }
  78576. /**
  78577. * An implementation of the anchor system for WebXR.
  78578. * For further information see https://github.com/immersive-web/anchors/
  78579. */
  78580. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  78581. private _options;
  78582. private _lastFrameDetected;
  78583. private _trackedAnchors;
  78584. private _referenceSpaceForFrameAnchors;
  78585. private _futureAnchors;
  78586. /**
  78587. * The module's name
  78588. */
  78589. static readonly Name: string;
  78590. /**
  78591. * The (Babylon) version of this module.
  78592. * This is an integer representing the implementation version.
  78593. * This number does not correspond to the WebXR specs version
  78594. */
  78595. static readonly Version: number;
  78596. /**
  78597. * Observers registered here will be executed when a new anchor was added to the session
  78598. */
  78599. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  78600. /**
  78601. * Observers registered here will be executed when an anchor was removed from the session
  78602. */
  78603. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  78604. /**
  78605. * Observers registered here will be executed when an existing anchor updates
  78606. * This can execute N times every frame
  78607. */
  78608. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  78609. /**
  78610. * Set the reference space to use for anchor creation, when not using a hit test.
  78611. * Will default to the session's reference space if not defined
  78612. */
  78613. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  78614. /**
  78615. * constructs a new anchor system
  78616. * @param _xrSessionManager an instance of WebXRSessionManager
  78617. * @param _options configuration object for this feature
  78618. */
  78619. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  78620. private _tmpVector;
  78621. private _tmpQuaternion;
  78622. private _populateTmpTransformation;
  78623. /**
  78624. * Create a new anchor point using a hit test result at a specific point in the scene
  78625. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78626. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78627. *
  78628. * @param hitTestResult The hit test result to use for this anchor creation
  78629. * @param position an optional position offset for this anchor
  78630. * @param rotationQuaternion an optional rotation offset for this anchor
  78631. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78632. */
  78633. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  78634. /**
  78635. * Add a new anchor at a specific position and rotation
  78636. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  78637. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  78638. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78639. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78640. *
  78641. * @param position the position in which to add an anchor
  78642. * @param rotationQuaternion an optional rotation for the anchor transformation
  78643. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  78644. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78645. */
  78646. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  78647. /**
  78648. * detach this feature.
  78649. * Will usually be called by the features manager
  78650. *
  78651. * @returns true if successful.
  78652. */
  78653. detach(): boolean;
  78654. /**
  78655. * Dispose this feature and all of the resources attached
  78656. */
  78657. dispose(): void;
  78658. protected _onXRFrame(frame: XRFrame): void;
  78659. /**
  78660. * avoiding using Array.find for global support.
  78661. * @param xrAnchor the plane to find in the array
  78662. */
  78663. private _findIndexInAnchorArray;
  78664. private _updateAnchorWithXRFrame;
  78665. private _createAnchorAtTransformation;
  78666. }
  78667. }
  78668. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  78669. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78670. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78671. import { Observable } from "babylonjs/Misc/observable";
  78672. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  78673. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78674. /**
  78675. * Options used in the plane detector module
  78676. */
  78677. export interface IWebXRPlaneDetectorOptions {
  78678. /**
  78679. * The node to use to transform the local results to world coordinates
  78680. */
  78681. worldParentNode?: TransformNode;
  78682. /**
  78683. * If set to true a reference of the created planes will be kept until the next session starts
  78684. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  78685. */
  78686. doNotRemovePlanesOnSessionEnded?: boolean;
  78687. }
  78688. /**
  78689. * A babylon interface for a WebXR plane.
  78690. * A Plane is actually a polygon, built from N points in space
  78691. *
  78692. * Supported in chrome 79, not supported in canary 81 ATM
  78693. */
  78694. export interface IWebXRPlane {
  78695. /**
  78696. * a babylon-assigned ID for this polygon
  78697. */
  78698. id: number;
  78699. /**
  78700. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  78701. */
  78702. polygonDefinition: Array<Vector3>;
  78703. /**
  78704. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  78705. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  78706. */
  78707. transformationMatrix: Matrix;
  78708. /**
  78709. * the native xr-plane object
  78710. */
  78711. xrPlane: XRPlane;
  78712. }
  78713. /**
  78714. * The plane detector is used to detect planes in the real world when in AR
  78715. * For more information see https://github.com/immersive-web/real-world-geometry/
  78716. */
  78717. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  78718. private _options;
  78719. private _detectedPlanes;
  78720. private _enabled;
  78721. private _lastFrameDetected;
  78722. /**
  78723. * The module's name
  78724. */
  78725. static readonly Name: string;
  78726. /**
  78727. * The (Babylon) version of this module.
  78728. * This is an integer representing the implementation version.
  78729. * This number does not correspond to the WebXR specs version
  78730. */
  78731. static readonly Version: number;
  78732. /**
  78733. * Observers registered here will be executed when a new plane was added to the session
  78734. */
  78735. onPlaneAddedObservable: Observable<IWebXRPlane>;
  78736. /**
  78737. * Observers registered here will be executed when a plane is no longer detected in the session
  78738. */
  78739. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  78740. /**
  78741. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  78742. * This can execute N times every frame
  78743. */
  78744. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  78745. /**
  78746. * construct a new Plane Detector
  78747. * @param _xrSessionManager an instance of xr Session manager
  78748. * @param _options configuration to use when constructing this feature
  78749. */
  78750. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  78751. /**
  78752. * detach this feature.
  78753. * Will usually be called by the features manager
  78754. *
  78755. * @returns true if successful.
  78756. */
  78757. detach(): boolean;
  78758. /**
  78759. * Dispose this feature and all of the resources attached
  78760. */
  78761. dispose(): void;
  78762. protected _onXRFrame(frame: XRFrame): void;
  78763. private _init;
  78764. private _updatePlaneWithXRPlane;
  78765. /**
  78766. * avoiding using Array.find for global support.
  78767. * @param xrPlane the plane to find in the array
  78768. */
  78769. private findIndexInPlaneArray;
  78770. }
  78771. }
  78772. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  78773. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78774. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78775. import { Observable } from "babylonjs/Misc/observable";
  78776. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78777. /**
  78778. * Options interface for the background remover plugin
  78779. */
  78780. export interface IWebXRBackgroundRemoverOptions {
  78781. /**
  78782. * Further background meshes to disable when entering AR
  78783. */
  78784. backgroundMeshes?: AbstractMesh[];
  78785. /**
  78786. * flags to configure the removal of the environment helper.
  78787. * If not set, the entire background will be removed. If set, flags should be set as well.
  78788. */
  78789. environmentHelperRemovalFlags?: {
  78790. /**
  78791. * Should the skybox be removed (default false)
  78792. */
  78793. skyBox?: boolean;
  78794. /**
  78795. * Should the ground be removed (default false)
  78796. */
  78797. ground?: boolean;
  78798. };
  78799. /**
  78800. * don't disable the environment helper
  78801. */
  78802. ignoreEnvironmentHelper?: boolean;
  78803. }
  78804. /**
  78805. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  78806. */
  78807. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  78808. /**
  78809. * read-only options to be used in this module
  78810. */
  78811. readonly options: IWebXRBackgroundRemoverOptions;
  78812. /**
  78813. * The module's name
  78814. */
  78815. static readonly Name: string;
  78816. /**
  78817. * The (Babylon) version of this module.
  78818. * This is an integer representing the implementation version.
  78819. * This number does not correspond to the WebXR specs version
  78820. */
  78821. static readonly Version: number;
  78822. /**
  78823. * registered observers will be triggered when the background state changes
  78824. */
  78825. onBackgroundStateChangedObservable: Observable<boolean>;
  78826. /**
  78827. * constructs a new background remover module
  78828. * @param _xrSessionManager the session manager for this module
  78829. * @param options read-only options to be used in this module
  78830. */
  78831. constructor(_xrSessionManager: WebXRSessionManager,
  78832. /**
  78833. * read-only options to be used in this module
  78834. */
  78835. options?: IWebXRBackgroundRemoverOptions);
  78836. /**
  78837. * attach this feature
  78838. * Will usually be called by the features manager
  78839. *
  78840. * @returns true if successful.
  78841. */
  78842. attach(): boolean;
  78843. /**
  78844. * detach this feature.
  78845. * Will usually be called by the features manager
  78846. *
  78847. * @returns true if successful.
  78848. */
  78849. detach(): boolean;
  78850. /**
  78851. * Dispose this feature and all of the resources attached
  78852. */
  78853. dispose(): void;
  78854. protected _onXRFrame(_xrFrame: XRFrame): void;
  78855. private _setBackgroundState;
  78856. }
  78857. }
  78858. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  78859. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78860. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  78861. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  78862. import { WebXRInput } from "babylonjs/XR/webXRInput";
  78863. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78864. import { Nullable } from "babylonjs/types";
  78865. /**
  78866. * Options for the controller physics feature
  78867. */
  78868. export class IWebXRControllerPhysicsOptions {
  78869. /**
  78870. * Should the headset get its own impostor
  78871. */
  78872. enableHeadsetImpostor?: boolean;
  78873. /**
  78874. * Optional parameters for the headset impostor
  78875. */
  78876. headsetImpostorParams?: {
  78877. /**
  78878. * The type of impostor to create. Default is sphere
  78879. */
  78880. impostorType: number;
  78881. /**
  78882. * the size of the impostor. Defaults to 10cm
  78883. */
  78884. impostorSize?: number | {
  78885. width: number;
  78886. height: number;
  78887. depth: number;
  78888. };
  78889. /**
  78890. * Friction definitions
  78891. */
  78892. friction?: number;
  78893. /**
  78894. * Restitution
  78895. */
  78896. restitution?: number;
  78897. };
  78898. /**
  78899. * The physics properties of the future impostors
  78900. */
  78901. physicsProperties?: {
  78902. /**
  78903. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  78904. * Note that this requires a physics engine that supports mesh impostors!
  78905. */
  78906. useControllerMesh?: boolean;
  78907. /**
  78908. * The type of impostor to create. Default is sphere
  78909. */
  78910. impostorType?: number;
  78911. /**
  78912. * the size of the impostor. Defaults to 10cm
  78913. */
  78914. impostorSize?: number | {
  78915. width: number;
  78916. height: number;
  78917. depth: number;
  78918. };
  78919. /**
  78920. * Friction definitions
  78921. */
  78922. friction?: number;
  78923. /**
  78924. * Restitution
  78925. */
  78926. restitution?: number;
  78927. };
  78928. /**
  78929. * the xr input to use with this pointer selection
  78930. */
  78931. xrInput: WebXRInput;
  78932. }
  78933. /**
  78934. * Add physics impostor to your webxr controllers,
  78935. * including naive calculation of their linear and angular velocity
  78936. */
  78937. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  78938. private readonly _options;
  78939. private _attachController;
  78940. private _controllers;
  78941. private _debugMode;
  78942. private _delta;
  78943. private _headsetImpostor?;
  78944. private _headsetMesh?;
  78945. private _lastTimestamp;
  78946. private _tmpQuaternion;
  78947. private _tmpVector;
  78948. /**
  78949. * The module's name
  78950. */
  78951. static readonly Name: string;
  78952. /**
  78953. * The (Babylon) version of this module.
  78954. * This is an integer representing the implementation version.
  78955. * This number does not correspond to the webxr specs version
  78956. */
  78957. static readonly Version: number;
  78958. /**
  78959. * Construct a new Controller Physics Feature
  78960. * @param _xrSessionManager the corresponding xr session manager
  78961. * @param _options options to create this feature with
  78962. */
  78963. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  78964. /**
  78965. * @hidden
  78966. * enable debugging - will show console outputs and the impostor mesh
  78967. */
  78968. _enablePhysicsDebug(): void;
  78969. /**
  78970. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  78971. * @param xrController the controller to add
  78972. */
  78973. addController(xrController: WebXRInputSource): void;
  78974. /**
  78975. * attach this feature
  78976. * Will usually be called by the features manager
  78977. *
  78978. * @returns true if successful.
  78979. */
  78980. attach(): boolean;
  78981. /**
  78982. * detach this feature.
  78983. * Will usually be called by the features manager
  78984. *
  78985. * @returns true if successful.
  78986. */
  78987. detach(): boolean;
  78988. /**
  78989. * Get the headset impostor, if enabled
  78990. * @returns the impostor
  78991. */
  78992. getHeadsetImpostor(): PhysicsImpostor | undefined;
  78993. /**
  78994. * Get the physics impostor of a specific controller.
  78995. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  78996. * @param controller the controller or the controller id of which to get the impostor
  78997. * @returns the impostor or null
  78998. */
  78999. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  79000. /**
  79001. * Update the physics properties provided in the constructor
  79002. * @param newProperties the new properties object
  79003. */
  79004. setPhysicsProperties(newProperties: {
  79005. impostorType?: number;
  79006. impostorSize?: number | {
  79007. width: number;
  79008. height: number;
  79009. depth: number;
  79010. };
  79011. friction?: number;
  79012. restitution?: number;
  79013. }): void;
  79014. protected _onXRFrame(_xrFrame: any): void;
  79015. private _detachController;
  79016. }
  79017. }
  79018. declare module "babylonjs/XR/features/WebXRFeaturePointSystem" {
  79019. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79020. import { Observable } from "babylonjs/Misc/observable";
  79021. import { Vector3 } from "babylonjs/Maths/math.vector";
  79022. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79023. /**
  79024. * A babylon interface for a "WebXR" feature point.
  79025. * Represents the position and confidence value of a given feature point.
  79026. */
  79027. export interface IWebXRFeaturePoint {
  79028. /**
  79029. * Represents the position of the feature point in world space.
  79030. */
  79031. position: Vector3;
  79032. /**
  79033. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  79034. */
  79035. confidenceValue: number;
  79036. }
  79037. /**
  79038. * The feature point system is used to detect feature points from real world geometry.
  79039. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  79040. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  79041. */
  79042. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  79043. private _enabled;
  79044. private _featurePointCloud;
  79045. /**
  79046. * The module's name
  79047. */
  79048. static readonly Name: string;
  79049. /**
  79050. * The (Babylon) version of this module.
  79051. * This is an integer representing the implementation version.
  79052. * This number does not correspond to the WebXR specs version
  79053. */
  79054. static readonly Version: number;
  79055. /**
  79056. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  79057. * Will notify the observers about which feature points have been added.
  79058. */
  79059. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  79060. /**
  79061. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  79062. * Will notify the observers about which feature points have been updated.
  79063. */
  79064. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  79065. /**
  79066. * The current feature point cloud maintained across frames.
  79067. */
  79068. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  79069. /**
  79070. * construct the feature point system
  79071. * @param _xrSessionManager an instance of xr Session manager
  79072. */
  79073. constructor(_xrSessionManager: WebXRSessionManager);
  79074. /**
  79075. * Detach this feature.
  79076. * Will usually be called by the features manager
  79077. *
  79078. * @returns true if successful.
  79079. */
  79080. detach(): boolean;
  79081. /**
  79082. * Dispose this feature and all of the resources attached
  79083. */
  79084. dispose(): void;
  79085. /**
  79086. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  79087. */
  79088. protected _onXRFrame(frame: XRFrame): void;
  79089. /**
  79090. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  79091. */
  79092. private _init;
  79093. }
  79094. }
  79095. declare module "babylonjs/XR/features/WebXRHandTracking" {
  79096. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79097. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79098. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79099. import { Mesh } from "babylonjs/Meshes/mesh";
  79100. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79101. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79102. import { Nullable } from "babylonjs/types";
  79103. import { IDisposable } from "babylonjs/scene";
  79104. import { Observable } from "babylonjs/Misc/observable";
  79105. /**
  79106. * Configuration interface for the hand tracking feature
  79107. */
  79108. export interface IWebXRHandTrackingOptions {
  79109. /**
  79110. * The xrInput that will be used as source for new hands
  79111. */
  79112. xrInput: WebXRInput;
  79113. /**
  79114. * Configuration object for the joint meshes
  79115. */
  79116. jointMeshes?: {
  79117. /**
  79118. * Should the meshes created be invisible (defaults to false)
  79119. */
  79120. invisible?: boolean;
  79121. /**
  79122. * A source mesh to be used to create instances. Defaults to a sphere.
  79123. * This mesh will be the source for all other (25) meshes.
  79124. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  79125. */
  79126. sourceMesh?: Mesh;
  79127. /**
  79128. * Should the source mesh stay visible. Defaults to false
  79129. */
  79130. keepOriginalVisible?: boolean;
  79131. /**
  79132. * Scale factor for all instances (defaults to 2)
  79133. */
  79134. scaleFactor?: number;
  79135. /**
  79136. * Should each instance have its own physics impostor
  79137. */
  79138. enablePhysics?: boolean;
  79139. /**
  79140. * If enabled, override default physics properties
  79141. */
  79142. physicsProps?: {
  79143. friction?: number;
  79144. restitution?: number;
  79145. impostorType?: number;
  79146. };
  79147. /**
  79148. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  79149. */
  79150. handMesh?: AbstractMesh;
  79151. };
  79152. }
  79153. /**
  79154. * Parts of the hands divided to writs and finger names
  79155. */
  79156. export const enum HandPart {
  79157. /**
  79158. * HandPart - Wrist
  79159. */
  79160. WRIST = "wrist",
  79161. /**
  79162. * HandPart - The THumb
  79163. */
  79164. THUMB = "thumb",
  79165. /**
  79166. * HandPart - Index finger
  79167. */
  79168. INDEX = "index",
  79169. /**
  79170. * HandPart - Middle finger
  79171. */
  79172. MIDDLE = "middle",
  79173. /**
  79174. * HandPart - Ring finger
  79175. */
  79176. RING = "ring",
  79177. /**
  79178. * HandPart - Little finger
  79179. */
  79180. LITTLE = "little"
  79181. }
  79182. /**
  79183. * Representing a single hand (with its corresponding native XRHand object)
  79184. */
  79185. export class WebXRHand implements IDisposable {
  79186. /** the controller to which the hand correlates */
  79187. readonly xrController: WebXRInputSource;
  79188. /** the meshes to be used to track the hand joints */
  79189. readonly trackedMeshes: AbstractMesh[];
  79190. /**
  79191. * Hand-parts definition (key is HandPart)
  79192. */
  79193. static HandPartsDefinition: {
  79194. [key: string]: number[];
  79195. };
  79196. /**
  79197. * Populate the HandPartsDefinition object.
  79198. * This is called as a side effect since certain browsers don't have XRHand defined.
  79199. */
  79200. static _PopulateHandPartsDefinition(): void;
  79201. /**
  79202. * Construct a new hand object
  79203. * @param xrController the controller to which the hand correlates
  79204. * @param trackedMeshes the meshes to be used to track the hand joints
  79205. */
  79206. constructor(
  79207. /** the controller to which the hand correlates */
  79208. xrController: WebXRInputSource,
  79209. /** the meshes to be used to track the hand joints */
  79210. trackedMeshes: AbstractMesh[]);
  79211. /**
  79212. * Update this hand from the latest xr frame
  79213. * @param xrFrame xrFrame to update from
  79214. * @param referenceSpace The current viewer reference space
  79215. * @param scaleFactor optional scale factor for the meshes
  79216. */
  79217. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  79218. /**
  79219. * Get meshes of part of the hand
  79220. * @param part the part of hand to get
  79221. * @returns An array of meshes that correlate to the hand part requested
  79222. */
  79223. getHandPartMeshes(part: HandPart): AbstractMesh[];
  79224. /**
  79225. * Dispose this Hand object
  79226. */
  79227. dispose(): void;
  79228. }
  79229. /**
  79230. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  79231. */
  79232. export class WebXRHandTracking extends WebXRAbstractFeature {
  79233. /**
  79234. * options to use when constructing this feature
  79235. */
  79236. readonly options: IWebXRHandTrackingOptions;
  79237. private static _idCounter;
  79238. /**
  79239. * The module's name
  79240. */
  79241. static readonly Name: string;
  79242. /**
  79243. * The (Babylon) version of this module.
  79244. * This is an integer representing the implementation version.
  79245. * This number does not correspond to the WebXR specs version
  79246. */
  79247. static readonly Version: number;
  79248. /**
  79249. * This observable will notify registered observers when a new hand object was added and initialized
  79250. */
  79251. onHandAddedObservable: Observable<WebXRHand>;
  79252. /**
  79253. * This observable will notify its observers right before the hand object is disposed
  79254. */
  79255. onHandRemovedObservable: Observable<WebXRHand>;
  79256. private _hands;
  79257. /**
  79258. * Creates a new instance of the hit test feature
  79259. * @param _xrSessionManager an instance of WebXRSessionManager
  79260. * @param options options to use when constructing this feature
  79261. */
  79262. constructor(_xrSessionManager: WebXRSessionManager,
  79263. /**
  79264. * options to use when constructing this feature
  79265. */
  79266. options: IWebXRHandTrackingOptions);
  79267. /**
  79268. * Check if the needed objects are defined.
  79269. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  79270. */
  79271. isCompatible(): boolean;
  79272. /**
  79273. * attach this feature
  79274. * Will usually be called by the features manager
  79275. *
  79276. * @returns true if successful.
  79277. */
  79278. attach(): boolean;
  79279. /**
  79280. * detach this feature.
  79281. * Will usually be called by the features manager
  79282. *
  79283. * @returns true if successful.
  79284. */
  79285. detach(): boolean;
  79286. /**
  79287. * Dispose this feature and all of the resources attached
  79288. */
  79289. dispose(): void;
  79290. /**
  79291. * Get the hand object according to the controller id
  79292. * @param controllerId the controller id to which we want to get the hand
  79293. * @returns null if not found or the WebXRHand object if found
  79294. */
  79295. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  79296. /**
  79297. * Get a hand object according to the requested handedness
  79298. * @param handedness the handedness to request
  79299. * @returns null if not found or the WebXRHand object if found
  79300. */
  79301. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  79302. protected _onXRFrame(_xrFrame: XRFrame): void;
  79303. private _attachHand;
  79304. private _detachHand;
  79305. }
  79306. }
  79307. declare module "babylonjs/XR/features/index" {
  79308. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  79309. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  79310. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  79311. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  79312. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  79313. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  79314. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  79315. export * from "babylonjs/XR/features/WebXRHitTest";
  79316. export * from "babylonjs/XR/features/WebXRFeaturePointSystem";
  79317. export * from "babylonjs/XR/features/WebXRHandTracking";
  79318. }
  79319. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  79320. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79321. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79322. import { Scene } from "babylonjs/scene";
  79323. /**
  79324. * The motion controller class for all microsoft mixed reality controllers
  79325. */
  79326. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  79327. protected readonly _mapping: {
  79328. defaultButton: {
  79329. valueNodeName: string;
  79330. unpressedNodeName: string;
  79331. pressedNodeName: string;
  79332. };
  79333. defaultAxis: {
  79334. valueNodeName: string;
  79335. minNodeName: string;
  79336. maxNodeName: string;
  79337. };
  79338. buttons: {
  79339. "xr-standard-trigger": {
  79340. rootNodeName: string;
  79341. componentProperty: string;
  79342. states: string[];
  79343. };
  79344. "xr-standard-squeeze": {
  79345. rootNodeName: string;
  79346. componentProperty: string;
  79347. states: string[];
  79348. };
  79349. "xr-standard-touchpad": {
  79350. rootNodeName: string;
  79351. labelAnchorNodeName: string;
  79352. touchPointNodeName: string;
  79353. };
  79354. "xr-standard-thumbstick": {
  79355. rootNodeName: string;
  79356. componentProperty: string;
  79357. states: string[];
  79358. };
  79359. };
  79360. axes: {
  79361. "xr-standard-touchpad": {
  79362. "x-axis": {
  79363. rootNodeName: string;
  79364. };
  79365. "y-axis": {
  79366. rootNodeName: string;
  79367. };
  79368. };
  79369. "xr-standard-thumbstick": {
  79370. "x-axis": {
  79371. rootNodeName: string;
  79372. };
  79373. "y-axis": {
  79374. rootNodeName: string;
  79375. };
  79376. };
  79377. };
  79378. };
  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. profileId: string;
  79392. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79393. protected _getFilenameAndPath(): {
  79394. filename: string;
  79395. path: string;
  79396. };
  79397. protected _getModelLoadingConstraints(): boolean;
  79398. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79399. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79400. protected _updateModel(): void;
  79401. }
  79402. }
  79403. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  79404. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79405. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79406. import { Scene } from "babylonjs/scene";
  79407. /**
  79408. * The motion controller class for oculus touch (quest, rift).
  79409. * This class supports legacy mapping as well the standard xr mapping
  79410. */
  79411. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  79412. private _forceLegacyControllers;
  79413. private _modelRootNode;
  79414. /**
  79415. * The base url used to load the left and right controller models
  79416. */
  79417. static MODEL_BASE_URL: string;
  79418. /**
  79419. * The name of the left controller model file
  79420. */
  79421. static MODEL_LEFT_FILENAME: string;
  79422. /**
  79423. * The name of the right controller model file
  79424. */
  79425. static MODEL_RIGHT_FILENAME: string;
  79426. /**
  79427. * Base Url for the Quest controller model.
  79428. */
  79429. static QUEST_MODEL_BASE_URL: string;
  79430. profileId: string;
  79431. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  79432. protected _getFilenameAndPath(): {
  79433. filename: string;
  79434. path: string;
  79435. };
  79436. protected _getModelLoadingConstraints(): boolean;
  79437. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79438. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79439. protected _updateModel(): void;
  79440. /**
  79441. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  79442. * between the touch and touch 2.
  79443. */
  79444. private _isQuest;
  79445. }
  79446. }
  79447. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  79448. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79449. import { Scene } from "babylonjs/scene";
  79450. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79451. /**
  79452. * The motion controller class for the standard HTC-Vive controllers
  79453. */
  79454. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  79455. private _modelRootNode;
  79456. /**
  79457. * The base url used to load the left and right controller models
  79458. */
  79459. static MODEL_BASE_URL: string;
  79460. /**
  79461. * File name for the controller model.
  79462. */
  79463. static MODEL_FILENAME: string;
  79464. profileId: string;
  79465. /**
  79466. * Create a new Vive motion controller object
  79467. * @param scene the scene to use to create this controller
  79468. * @param gamepadObject the corresponding gamepad object
  79469. * @param handedness the handedness of the controller
  79470. */
  79471. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79472. protected _getFilenameAndPath(): {
  79473. filename: string;
  79474. path: string;
  79475. };
  79476. protected _getModelLoadingConstraints(): boolean;
  79477. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79478. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79479. protected _updateModel(): void;
  79480. }
  79481. }
  79482. declare module "babylonjs/XR/motionController/index" {
  79483. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79484. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  79485. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  79486. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  79487. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  79488. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  79489. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  79490. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  79491. }
  79492. declare module "babylonjs/XR/index" {
  79493. export * from "babylonjs/XR/webXRCamera";
  79494. export * from "babylonjs/XR/webXREnterExitUI";
  79495. export * from "babylonjs/XR/webXRExperienceHelper";
  79496. export * from "babylonjs/XR/webXRInput";
  79497. export * from "babylonjs/XR/webXRInputSource";
  79498. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  79499. export * from "babylonjs/XR/webXRTypes";
  79500. export * from "babylonjs/XR/webXRSessionManager";
  79501. export * from "babylonjs/XR/webXRDefaultExperience";
  79502. export * from "babylonjs/XR/webXRFeaturesManager";
  79503. export * from "babylonjs/XR/features/index";
  79504. export * from "babylonjs/XR/motionController/index";
  79505. }
  79506. declare module "babylonjs/index" {
  79507. export * from "babylonjs/abstractScene";
  79508. export * from "babylonjs/Actions/index";
  79509. export * from "babylonjs/Animations/index";
  79510. export * from "babylonjs/assetContainer";
  79511. export * from "babylonjs/Audio/index";
  79512. export * from "babylonjs/Behaviors/index";
  79513. export * from "babylonjs/Bones/index";
  79514. export * from "babylonjs/Cameras/index";
  79515. export * from "babylonjs/Collisions/index";
  79516. export * from "babylonjs/Culling/index";
  79517. export * from "babylonjs/Debug/index";
  79518. export * from "babylonjs/DeviceInput/index";
  79519. export * from "babylonjs/Engines/index";
  79520. export * from "babylonjs/Events/index";
  79521. export * from "babylonjs/Gamepads/index";
  79522. export * from "babylonjs/Gizmos/index";
  79523. export * from "babylonjs/Helpers/index";
  79524. export * from "babylonjs/Instrumentation/index";
  79525. export * from "babylonjs/Layers/index";
  79526. export * from "babylonjs/LensFlares/index";
  79527. export * from "babylonjs/Lights/index";
  79528. export * from "babylonjs/Loading/index";
  79529. export * from "babylonjs/Materials/index";
  79530. export * from "babylonjs/Maths/index";
  79531. export * from "babylonjs/Meshes/index";
  79532. export * from "babylonjs/Morph/index";
  79533. export * from "babylonjs/Navigation/index";
  79534. export * from "babylonjs/node";
  79535. export * from "babylonjs/Offline/index";
  79536. export * from "babylonjs/Particles/index";
  79537. export * from "babylonjs/Physics/index";
  79538. export * from "babylonjs/PostProcesses/index";
  79539. export * from "babylonjs/Probes/index";
  79540. export * from "babylonjs/Rendering/index";
  79541. export * from "babylonjs/scene";
  79542. export * from "babylonjs/sceneComponent";
  79543. export * from "babylonjs/Sprites/index";
  79544. export * from "babylonjs/States/index";
  79545. export * from "babylonjs/Misc/index";
  79546. export * from "babylonjs/XR/index";
  79547. export * from "babylonjs/types";
  79548. }
  79549. declare module "babylonjs/Animations/pathCursor" {
  79550. import { Vector3 } from "babylonjs/Maths/math.vector";
  79551. import { Path2 } from "babylonjs/Maths/math.path";
  79552. /**
  79553. * A cursor which tracks a point on a path
  79554. */
  79555. export class PathCursor {
  79556. private path;
  79557. /**
  79558. * Stores path cursor callbacks for when an onchange event is triggered
  79559. */
  79560. private _onchange;
  79561. /**
  79562. * The value of the path cursor
  79563. */
  79564. value: number;
  79565. /**
  79566. * The animation array of the path cursor
  79567. */
  79568. animations: Animation[];
  79569. /**
  79570. * Initializes the path cursor
  79571. * @param path The path to track
  79572. */
  79573. constructor(path: Path2);
  79574. /**
  79575. * Gets the cursor point on the path
  79576. * @returns A point on the path cursor at the cursor location
  79577. */
  79578. getPoint(): Vector3;
  79579. /**
  79580. * Moves the cursor ahead by the step amount
  79581. * @param step The amount to move the cursor forward
  79582. * @returns This path cursor
  79583. */
  79584. moveAhead(step?: number): PathCursor;
  79585. /**
  79586. * Moves the cursor behind by the step amount
  79587. * @param step The amount to move the cursor back
  79588. * @returns This path cursor
  79589. */
  79590. moveBack(step?: number): PathCursor;
  79591. /**
  79592. * Moves the cursor by the step amount
  79593. * If the step amount is greater than one, an exception is thrown
  79594. * @param step The amount to move the cursor
  79595. * @returns This path cursor
  79596. */
  79597. move(step: number): PathCursor;
  79598. /**
  79599. * Ensures that the value is limited between zero and one
  79600. * @returns This path cursor
  79601. */
  79602. private ensureLimits;
  79603. /**
  79604. * Runs onchange callbacks on change (used by the animation engine)
  79605. * @returns This path cursor
  79606. */
  79607. private raiseOnChange;
  79608. /**
  79609. * Executes a function on change
  79610. * @param f A path cursor onchange callback
  79611. * @returns This path cursor
  79612. */
  79613. onchange(f: (cursor: PathCursor) => void): PathCursor;
  79614. }
  79615. }
  79616. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  79617. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  79618. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  79619. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  79620. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  79621. }
  79622. declare module "babylonjs/Engines/Processors/Expressions/index" {
  79623. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  79624. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  79625. }
  79626. declare module "babylonjs/Engines/Processors/index" {
  79627. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  79628. export * from "babylonjs/Engines/Processors/Expressions/index";
  79629. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  79630. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  79631. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  79632. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  79633. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  79634. export * from "babylonjs/Engines/Processors/shaderProcessor";
  79635. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  79636. }
  79637. declare module "babylonjs/Legacy/legacy" {
  79638. import * as Babylon from "babylonjs/index";
  79639. export * from "babylonjs/index";
  79640. }
  79641. declare module "babylonjs/Shaders/blur.fragment" {
  79642. /** @hidden */
  79643. export var blurPixelShader: {
  79644. name: string;
  79645. shader: string;
  79646. };
  79647. }
  79648. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  79649. /** @hidden */
  79650. export var pointCloudVertexDeclaration: {
  79651. name: string;
  79652. shader: string;
  79653. };
  79654. }
  79655. declare module "babylonjs" {
  79656. export * from "babylonjs/Legacy/legacy";
  79657. }
  79658. declare module BABYLON {
  79659. /** Alias type for value that can be null */
  79660. export type Nullable<T> = T | null;
  79661. /**
  79662. * Alias type for number that are floats
  79663. * @ignorenaming
  79664. */
  79665. export type float = number;
  79666. /**
  79667. * Alias type for number that are doubles.
  79668. * @ignorenaming
  79669. */
  79670. export type double = number;
  79671. /**
  79672. * Alias type for number that are integer
  79673. * @ignorenaming
  79674. */
  79675. export type int = number;
  79676. /** Alias type for number array or Float32Array */
  79677. export type FloatArray = number[] | Float32Array;
  79678. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  79679. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  79680. /**
  79681. * Alias for types that can be used by a Buffer or VertexBuffer.
  79682. */
  79683. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  79684. /**
  79685. * Alias type for primitive types
  79686. * @ignorenaming
  79687. */
  79688. type Primitive = undefined | null | boolean | string | number | Function;
  79689. /**
  79690. * Type modifier to make all the properties of an object Readonly
  79691. */
  79692. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  79693. /**
  79694. * Type modifier to make all the properties of an object Readonly recursively
  79695. */
  79696. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  79697. /**
  79698. * Type modifier to make object properties readonly.
  79699. */
  79700. export type DeepImmutableObject<T> = {
  79701. readonly [K in keyof T]: DeepImmutable<T[K]>;
  79702. };
  79703. /** @hidden */
  79704. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  79705. }
  79706. }
  79707. declare module BABYLON {
  79708. /**
  79709. * A class serves as a medium between the observable and its observers
  79710. */
  79711. export class EventState {
  79712. /**
  79713. * Create a new EventState
  79714. * @param mask defines the mask associated with this state
  79715. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79716. * @param target defines the original target of the state
  79717. * @param currentTarget defines the current target of the state
  79718. */
  79719. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  79720. /**
  79721. * Initialize the current event state
  79722. * @param mask defines the mask associated with this state
  79723. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79724. * @param target defines the original target of the state
  79725. * @param currentTarget defines the current target of the state
  79726. * @returns the current event state
  79727. */
  79728. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  79729. /**
  79730. * An Observer can set this property to true to prevent subsequent observers of being notified
  79731. */
  79732. skipNextObservers: boolean;
  79733. /**
  79734. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79735. */
  79736. mask: number;
  79737. /**
  79738. * The object that originally notified the event
  79739. */
  79740. target?: any;
  79741. /**
  79742. * The current object in the bubbling phase
  79743. */
  79744. currentTarget?: any;
  79745. /**
  79746. * This will be populated with the return value of the last function that was executed.
  79747. * If it is the first function in the callback chain it will be the event data.
  79748. */
  79749. lastReturnValue?: any;
  79750. }
  79751. /**
  79752. * Represent an Observer registered to a given Observable object.
  79753. */
  79754. export class Observer<T> {
  79755. /**
  79756. * Defines the callback to call when the observer is notified
  79757. */
  79758. callback: (eventData: T, eventState: EventState) => void;
  79759. /**
  79760. * Defines the mask of the observer (used to filter notifications)
  79761. */
  79762. mask: number;
  79763. /**
  79764. * Defines the current scope used to restore the JS context
  79765. */
  79766. scope: any;
  79767. /** @hidden */
  79768. _willBeUnregistered: boolean;
  79769. /**
  79770. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  79771. */
  79772. unregisterOnNextCall: boolean;
  79773. /**
  79774. * Creates a new observer
  79775. * @param callback defines the callback to call when the observer is notified
  79776. * @param mask defines the mask of the observer (used to filter notifications)
  79777. * @param scope defines the current scope used to restore the JS context
  79778. */
  79779. constructor(
  79780. /**
  79781. * Defines the callback to call when the observer is notified
  79782. */
  79783. callback: (eventData: T, eventState: EventState) => void,
  79784. /**
  79785. * Defines the mask of the observer (used to filter notifications)
  79786. */
  79787. mask: number,
  79788. /**
  79789. * Defines the current scope used to restore the JS context
  79790. */
  79791. scope?: any);
  79792. }
  79793. /**
  79794. * Represent a list of observers registered to multiple Observables object.
  79795. */
  79796. export class MultiObserver<T> {
  79797. private _observers;
  79798. private _observables;
  79799. /**
  79800. * Release associated resources
  79801. */
  79802. dispose(): void;
  79803. /**
  79804. * Raise a callback when one of the observable will notify
  79805. * @param observables defines a list of observables to watch
  79806. * @param callback defines the callback to call on notification
  79807. * @param mask defines the mask used to filter notifications
  79808. * @param scope defines the current scope used to restore the JS context
  79809. * @returns the new MultiObserver
  79810. */
  79811. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  79812. }
  79813. /**
  79814. * The Observable class is a simple implementation of the Observable pattern.
  79815. *
  79816. * 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.
  79817. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  79818. * 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).
  79819. * 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.
  79820. */
  79821. export class Observable<T> {
  79822. private _observers;
  79823. private _eventState;
  79824. private _onObserverAdded;
  79825. /**
  79826. * Gets the list of observers
  79827. */
  79828. get observers(): Array<Observer<T>>;
  79829. /**
  79830. * Creates a new observable
  79831. * @param onObserverAdded defines a callback to call when a new observer is added
  79832. */
  79833. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  79834. /**
  79835. * Create a new Observer with the specified callback
  79836. * @param callback the callback that will be executed for that Observer
  79837. * @param mask the mask used to filter observers
  79838. * @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.
  79839. * @param scope optional scope for the callback to be called from
  79840. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  79841. * @returns the new observer created for the callback
  79842. */
  79843. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  79844. /**
  79845. * Create a new Observer with the specified callback and unregisters after the next notification
  79846. * @param callback the callback that will be executed for that Observer
  79847. * @returns the new observer created for the callback
  79848. */
  79849. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  79850. /**
  79851. * Remove an Observer from the Observable object
  79852. * @param observer the instance of the Observer to remove
  79853. * @returns false if it doesn't belong to this Observable
  79854. */
  79855. remove(observer: Nullable<Observer<T>>): boolean;
  79856. /**
  79857. * Remove a callback from the Observable object
  79858. * @param callback the callback to remove
  79859. * @param scope optional scope. If used only the callbacks with this scope will be removed
  79860. * @returns false if it doesn't belong to this Observable
  79861. */
  79862. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  79863. private _deferUnregister;
  79864. private _remove;
  79865. /**
  79866. * Moves the observable to the top of the observer list making it get called first when notified
  79867. * @param observer the observer to move
  79868. */
  79869. makeObserverTopPriority(observer: Observer<T>): void;
  79870. /**
  79871. * Moves the observable to the bottom of the observer list making it get called last when notified
  79872. * @param observer the observer to move
  79873. */
  79874. makeObserverBottomPriority(observer: Observer<T>): void;
  79875. /**
  79876. * Notify all Observers by calling their respective callback with the given data
  79877. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  79878. * @param eventData defines the data to send to all observers
  79879. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  79880. * @param target defines the original target of the state
  79881. * @param currentTarget defines the current target of the state
  79882. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  79883. */
  79884. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  79885. /**
  79886. * Calling this will execute each callback, expecting it to be a promise or return a value.
  79887. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  79888. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  79889. * and it is crucial that all callbacks will be executed.
  79890. * The order of the callbacks is kept, callbacks are not executed parallel.
  79891. *
  79892. * @param eventData The data to be sent to each callback
  79893. * @param mask is used to filter observers defaults to -1
  79894. * @param target defines the callback target (see EventState)
  79895. * @param currentTarget defines he current object in the bubbling phase
  79896. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  79897. */
  79898. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  79899. /**
  79900. * Notify a specific observer
  79901. * @param observer defines the observer to notify
  79902. * @param eventData defines the data to be sent to each callback
  79903. * @param mask is used to filter observers defaults to -1
  79904. */
  79905. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  79906. /**
  79907. * Gets a boolean indicating if the observable has at least one observer
  79908. * @returns true is the Observable has at least one Observer registered
  79909. */
  79910. hasObservers(): boolean;
  79911. /**
  79912. * Clear the list of observers
  79913. */
  79914. clear(): void;
  79915. /**
  79916. * Clone the current observable
  79917. * @returns a new observable
  79918. */
  79919. clone(): Observable<T>;
  79920. /**
  79921. * Does this observable handles observer registered with a given mask
  79922. * @param mask defines the mask to be tested
  79923. * @return whether or not one observer registered with the given mask is handeled
  79924. **/
  79925. hasSpecificMask(mask?: number): boolean;
  79926. }
  79927. }
  79928. declare module BABYLON {
  79929. /**
  79930. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  79931. * Babylon.js
  79932. */
  79933. export class DomManagement {
  79934. /**
  79935. * Checks if the window object exists
  79936. * @returns true if the window object exists
  79937. */
  79938. static IsWindowObjectExist(): boolean;
  79939. /**
  79940. * Checks if the navigator object exists
  79941. * @returns true if the navigator object exists
  79942. */
  79943. static IsNavigatorAvailable(): boolean;
  79944. /**
  79945. * Check if the document object exists
  79946. * @returns true if the document object exists
  79947. */
  79948. static IsDocumentAvailable(): boolean;
  79949. /**
  79950. * Extracts text content from a DOM element hierarchy
  79951. * @param element defines the root element
  79952. * @returns a string
  79953. */
  79954. static GetDOMTextContent(element: HTMLElement): string;
  79955. }
  79956. }
  79957. declare module BABYLON {
  79958. /**
  79959. * Logger used througouht the application to allow configuration of
  79960. * the log level required for the messages.
  79961. */
  79962. export class Logger {
  79963. /**
  79964. * No log
  79965. */
  79966. static readonly NoneLogLevel: number;
  79967. /**
  79968. * Only message logs
  79969. */
  79970. static readonly MessageLogLevel: number;
  79971. /**
  79972. * Only warning logs
  79973. */
  79974. static readonly WarningLogLevel: number;
  79975. /**
  79976. * Only error logs
  79977. */
  79978. static readonly ErrorLogLevel: number;
  79979. /**
  79980. * All logs
  79981. */
  79982. static readonly AllLogLevel: number;
  79983. private static _LogCache;
  79984. /**
  79985. * Gets a value indicating the number of loading errors
  79986. * @ignorenaming
  79987. */
  79988. static errorsCount: number;
  79989. /**
  79990. * Callback called when a new log is added
  79991. */
  79992. static OnNewCacheEntry: (entry: string) => void;
  79993. private static _AddLogEntry;
  79994. private static _FormatMessage;
  79995. private static _LogDisabled;
  79996. private static _LogEnabled;
  79997. private static _WarnDisabled;
  79998. private static _WarnEnabled;
  79999. private static _ErrorDisabled;
  80000. private static _ErrorEnabled;
  80001. /**
  80002. * Log a message to the console
  80003. */
  80004. static Log: (message: string) => void;
  80005. /**
  80006. * Write a warning message to the console
  80007. */
  80008. static Warn: (message: string) => void;
  80009. /**
  80010. * Write an error message to the console
  80011. */
  80012. static Error: (message: string) => void;
  80013. /**
  80014. * Gets current log cache (list of logs)
  80015. */
  80016. static get LogCache(): string;
  80017. /**
  80018. * Clears the log cache
  80019. */
  80020. static ClearLogCache(): void;
  80021. /**
  80022. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  80023. */
  80024. static set LogLevels(level: number);
  80025. }
  80026. }
  80027. declare module BABYLON {
  80028. /** @hidden */
  80029. export class _TypeStore {
  80030. /** @hidden */
  80031. static RegisteredTypes: {
  80032. [key: string]: Object;
  80033. };
  80034. /** @hidden */
  80035. static GetClass(fqdn: string): any;
  80036. }
  80037. }
  80038. declare module BABYLON {
  80039. /**
  80040. * Helper to manipulate strings
  80041. */
  80042. export class StringTools {
  80043. /**
  80044. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  80045. * @param str Source string
  80046. * @param suffix Suffix to search for in the source string
  80047. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80048. */
  80049. static EndsWith(str: string, suffix: string): boolean;
  80050. /**
  80051. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  80052. * @param str Source string
  80053. * @param suffix Suffix to search for in the source string
  80054. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80055. */
  80056. static StartsWith(str: string, suffix: string): boolean;
  80057. /**
  80058. * Decodes a buffer into a string
  80059. * @param buffer The buffer to decode
  80060. * @returns The decoded string
  80061. */
  80062. static Decode(buffer: Uint8Array | Uint16Array): string;
  80063. /**
  80064. * Encode a buffer to a base64 string
  80065. * @param buffer defines the buffer to encode
  80066. * @returns the encoded string
  80067. */
  80068. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  80069. /**
  80070. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  80071. * @param num the number to convert and pad
  80072. * @param length the expected length of the string
  80073. * @returns the padded string
  80074. */
  80075. static PadNumber(num: number, length: number): string;
  80076. }
  80077. }
  80078. declare module BABYLON {
  80079. /**
  80080. * Class containing a set of static utilities functions for deep copy.
  80081. */
  80082. export class DeepCopier {
  80083. /**
  80084. * Tries to copy an object by duplicating every property
  80085. * @param source defines the source object
  80086. * @param destination defines the target object
  80087. * @param doNotCopyList defines a list of properties to avoid
  80088. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  80089. */
  80090. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  80091. }
  80092. }
  80093. declare module BABYLON {
  80094. /**
  80095. * Class containing a set of static utilities functions for precision date
  80096. */
  80097. export class PrecisionDate {
  80098. /**
  80099. * Gets either window.performance.now() if supported or Date.now() else
  80100. */
  80101. static get Now(): number;
  80102. }
  80103. }
  80104. declare module BABYLON {
  80105. /** @hidden */
  80106. export class _DevTools {
  80107. static WarnImport(name: string): string;
  80108. }
  80109. }
  80110. declare module BABYLON {
  80111. /**
  80112. * Interface used to define the mechanism to get data from the network
  80113. */
  80114. export interface IWebRequest {
  80115. /**
  80116. * Returns client's response url
  80117. */
  80118. responseURL: string;
  80119. /**
  80120. * Returns client's status
  80121. */
  80122. status: number;
  80123. /**
  80124. * Returns client's status as a text
  80125. */
  80126. statusText: string;
  80127. }
  80128. }
  80129. declare module BABYLON {
  80130. /**
  80131. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  80132. */
  80133. export class WebRequest implements IWebRequest {
  80134. private _xhr;
  80135. /**
  80136. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  80137. * i.e. when loading files, where the server/service expects an Authorization header
  80138. */
  80139. static CustomRequestHeaders: {
  80140. [key: string]: string;
  80141. };
  80142. /**
  80143. * Add callback functions in this array to update all the requests before they get sent to the network
  80144. */
  80145. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  80146. private _injectCustomRequestHeaders;
  80147. /**
  80148. * Gets or sets a function to be called when loading progress changes
  80149. */
  80150. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  80151. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  80152. /**
  80153. * Returns client's state
  80154. */
  80155. get readyState(): number;
  80156. /**
  80157. * Returns client's status
  80158. */
  80159. get status(): number;
  80160. /**
  80161. * Returns client's status as a text
  80162. */
  80163. get statusText(): string;
  80164. /**
  80165. * Returns client's response
  80166. */
  80167. get response(): any;
  80168. /**
  80169. * Returns client's response url
  80170. */
  80171. get responseURL(): string;
  80172. /**
  80173. * Returns client's response as text
  80174. */
  80175. get responseText(): string;
  80176. /**
  80177. * Gets or sets the expected response type
  80178. */
  80179. get responseType(): XMLHttpRequestResponseType;
  80180. set responseType(value: XMLHttpRequestResponseType);
  80181. /** @hidden */
  80182. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  80183. /** @hidden */
  80184. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  80185. /**
  80186. * Cancels any network activity
  80187. */
  80188. abort(): void;
  80189. /**
  80190. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  80191. * @param body defines an optional request body
  80192. */
  80193. send(body?: Document | BodyInit | null): void;
  80194. /**
  80195. * Sets the request method, request URL
  80196. * @param method defines the method to use (GET, POST, etc..)
  80197. * @param url defines the url to connect with
  80198. */
  80199. open(method: string, url: string): void;
  80200. /**
  80201. * Sets the value of a request header.
  80202. * @param name The name of the header whose value is to be set
  80203. * @param value The value to set as the body of the header
  80204. */
  80205. setRequestHeader(name: string, value: string): void;
  80206. /**
  80207. * Get the string containing the text of a particular header's value.
  80208. * @param name The name of the header
  80209. * @returns The string containing the text of the given header name
  80210. */
  80211. getResponseHeader(name: string): Nullable<string>;
  80212. }
  80213. }
  80214. declare module BABYLON {
  80215. /**
  80216. * File request interface
  80217. */
  80218. export interface IFileRequest {
  80219. /**
  80220. * Raised when the request is complete (success or error).
  80221. */
  80222. onCompleteObservable: Observable<IFileRequest>;
  80223. /**
  80224. * Aborts the request for a file.
  80225. */
  80226. abort: () => void;
  80227. }
  80228. }
  80229. declare module BABYLON {
  80230. /**
  80231. * Define options used to create a render target texture
  80232. */
  80233. export class RenderTargetCreationOptions {
  80234. /**
  80235. * Specifies is mipmaps must be generated
  80236. */
  80237. generateMipMaps?: boolean;
  80238. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  80239. generateDepthBuffer?: boolean;
  80240. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  80241. generateStencilBuffer?: boolean;
  80242. /** Defines texture type (int by default) */
  80243. type?: number;
  80244. /** Defines sampling mode (trilinear by default) */
  80245. samplingMode?: number;
  80246. /** Defines format (RGBA by default) */
  80247. format?: number;
  80248. }
  80249. }
  80250. declare module BABYLON {
  80251. /** Defines the cross module used constants to avoid circular dependncies */
  80252. export class Constants {
  80253. /** Defines that alpha blending is disabled */
  80254. static readonly ALPHA_DISABLE: number;
  80255. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  80256. static readonly ALPHA_ADD: number;
  80257. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  80258. static readonly ALPHA_COMBINE: number;
  80259. /** Defines that alpha blending is DEST - SRC * DEST */
  80260. static readonly ALPHA_SUBTRACT: number;
  80261. /** Defines that alpha blending is SRC * DEST */
  80262. static readonly ALPHA_MULTIPLY: number;
  80263. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  80264. static readonly ALPHA_MAXIMIZED: number;
  80265. /** Defines that alpha blending is SRC + DEST */
  80266. static readonly ALPHA_ONEONE: number;
  80267. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  80268. static readonly ALPHA_PREMULTIPLIED: number;
  80269. /**
  80270. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  80271. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  80272. */
  80273. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  80274. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  80275. static readonly ALPHA_INTERPOLATE: number;
  80276. /**
  80277. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  80278. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  80279. */
  80280. static readonly ALPHA_SCREENMODE: number;
  80281. /**
  80282. * Defines that alpha blending is SRC + DST
  80283. * Alpha will be set to SRC ALPHA + DST ALPHA
  80284. */
  80285. static readonly ALPHA_ONEONE_ONEONE: number;
  80286. /**
  80287. * Defines that alpha blending is SRC * DST ALPHA + DST
  80288. * Alpha will be set to 0
  80289. */
  80290. static readonly ALPHA_ALPHATOCOLOR: number;
  80291. /**
  80292. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80293. */
  80294. static readonly ALPHA_REVERSEONEMINUS: number;
  80295. /**
  80296. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  80297. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  80298. */
  80299. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  80300. /**
  80301. * Defines that alpha blending is SRC + DST
  80302. * Alpha will be set to SRC ALPHA
  80303. */
  80304. static readonly ALPHA_ONEONE_ONEZERO: number;
  80305. /**
  80306. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80307. * Alpha will be set to DST ALPHA
  80308. */
  80309. static readonly ALPHA_EXCLUSION: number;
  80310. /** Defines that alpha blending equation a SUM */
  80311. static readonly ALPHA_EQUATION_ADD: number;
  80312. /** Defines that alpha blending equation a SUBSTRACTION */
  80313. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  80314. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  80315. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  80316. /** Defines that alpha blending equation a MAX operation */
  80317. static readonly ALPHA_EQUATION_MAX: number;
  80318. /** Defines that alpha blending equation a MIN operation */
  80319. static readonly ALPHA_EQUATION_MIN: number;
  80320. /**
  80321. * Defines that alpha blending equation a DARKEN operation:
  80322. * It takes the min of the src and sums the alpha channels.
  80323. */
  80324. static readonly ALPHA_EQUATION_DARKEN: number;
  80325. /** Defines that the ressource is not delayed*/
  80326. static readonly DELAYLOADSTATE_NONE: number;
  80327. /** Defines that the ressource was successfully delay loaded */
  80328. static readonly DELAYLOADSTATE_LOADED: number;
  80329. /** Defines that the ressource is currently delay loading */
  80330. static readonly DELAYLOADSTATE_LOADING: number;
  80331. /** Defines that the ressource is delayed and has not started loading */
  80332. static readonly DELAYLOADSTATE_NOTLOADED: number;
  80333. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  80334. static readonly NEVER: number;
  80335. /** 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 */
  80336. static readonly ALWAYS: number;
  80337. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  80338. static readonly LESS: number;
  80339. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  80340. static readonly EQUAL: number;
  80341. /** 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 */
  80342. static readonly LEQUAL: number;
  80343. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  80344. static readonly GREATER: number;
  80345. /** 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 */
  80346. static readonly GEQUAL: number;
  80347. /** 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 */
  80348. static readonly NOTEQUAL: number;
  80349. /** Passed to stencilOperation to specify that stencil value must be kept */
  80350. static readonly KEEP: number;
  80351. /** Passed to stencilOperation to specify that stencil value must be replaced */
  80352. static readonly REPLACE: number;
  80353. /** Passed to stencilOperation to specify that stencil value must be incremented */
  80354. static readonly INCR: number;
  80355. /** Passed to stencilOperation to specify that stencil value must be decremented */
  80356. static readonly DECR: number;
  80357. /** Passed to stencilOperation to specify that stencil value must be inverted */
  80358. static readonly INVERT: number;
  80359. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  80360. static readonly INCR_WRAP: number;
  80361. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  80362. static readonly DECR_WRAP: number;
  80363. /** Texture is not repeating outside of 0..1 UVs */
  80364. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  80365. /** Texture is repeating outside of 0..1 UVs */
  80366. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  80367. /** Texture is repeating and mirrored */
  80368. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  80369. /** ALPHA */
  80370. static readonly TEXTUREFORMAT_ALPHA: number;
  80371. /** LUMINANCE */
  80372. static readonly TEXTUREFORMAT_LUMINANCE: number;
  80373. /** LUMINANCE_ALPHA */
  80374. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  80375. /** RGB */
  80376. static readonly TEXTUREFORMAT_RGB: number;
  80377. /** RGBA */
  80378. static readonly TEXTUREFORMAT_RGBA: number;
  80379. /** RED */
  80380. static readonly TEXTUREFORMAT_RED: number;
  80381. /** RED (2nd reference) */
  80382. static readonly TEXTUREFORMAT_R: number;
  80383. /** RG */
  80384. static readonly TEXTUREFORMAT_RG: number;
  80385. /** RED_INTEGER */
  80386. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  80387. /** RED_INTEGER (2nd reference) */
  80388. static readonly TEXTUREFORMAT_R_INTEGER: number;
  80389. /** RG_INTEGER */
  80390. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  80391. /** RGB_INTEGER */
  80392. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  80393. /** RGBA_INTEGER */
  80394. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  80395. /** UNSIGNED_BYTE */
  80396. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  80397. /** UNSIGNED_BYTE (2nd reference) */
  80398. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  80399. /** FLOAT */
  80400. static readonly TEXTURETYPE_FLOAT: number;
  80401. /** HALF_FLOAT */
  80402. static readonly TEXTURETYPE_HALF_FLOAT: number;
  80403. /** BYTE */
  80404. static readonly TEXTURETYPE_BYTE: number;
  80405. /** SHORT */
  80406. static readonly TEXTURETYPE_SHORT: number;
  80407. /** UNSIGNED_SHORT */
  80408. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  80409. /** INT */
  80410. static readonly TEXTURETYPE_INT: number;
  80411. /** UNSIGNED_INT */
  80412. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  80413. /** UNSIGNED_SHORT_4_4_4_4 */
  80414. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  80415. /** UNSIGNED_SHORT_5_5_5_1 */
  80416. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  80417. /** UNSIGNED_SHORT_5_6_5 */
  80418. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  80419. /** UNSIGNED_INT_2_10_10_10_REV */
  80420. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  80421. /** UNSIGNED_INT_24_8 */
  80422. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  80423. /** UNSIGNED_INT_10F_11F_11F_REV */
  80424. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  80425. /** UNSIGNED_INT_5_9_9_9_REV */
  80426. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  80427. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  80428. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  80429. /** nearest is mag = nearest and min = nearest and no mip */
  80430. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  80431. /** mag = nearest and min = nearest and mip = none */
  80432. static readonly TEXTURE_NEAREST_NEAREST: number;
  80433. /** Bilinear is mag = linear and min = linear and no mip */
  80434. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  80435. /** mag = linear and min = linear and mip = none */
  80436. static readonly TEXTURE_LINEAR_LINEAR: number;
  80437. /** Trilinear is mag = linear and min = linear and mip = linear */
  80438. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  80439. /** Trilinear is mag = linear and min = linear and mip = linear */
  80440. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  80441. /** mag = nearest and min = nearest and mip = nearest */
  80442. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  80443. /** mag = nearest and min = linear and mip = nearest */
  80444. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  80445. /** mag = nearest and min = linear and mip = linear */
  80446. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  80447. /** mag = nearest and min = linear and mip = none */
  80448. static readonly TEXTURE_NEAREST_LINEAR: number;
  80449. /** nearest is mag = nearest and min = nearest and mip = linear */
  80450. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  80451. /** mag = linear and min = nearest and mip = nearest */
  80452. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  80453. /** mag = linear and min = nearest and mip = linear */
  80454. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  80455. /** Bilinear is mag = linear and min = linear and mip = nearest */
  80456. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  80457. /** mag = linear and min = nearest and mip = none */
  80458. static readonly TEXTURE_LINEAR_NEAREST: number;
  80459. /** Explicit coordinates mode */
  80460. static readonly TEXTURE_EXPLICIT_MODE: number;
  80461. /** Spherical coordinates mode */
  80462. static readonly TEXTURE_SPHERICAL_MODE: number;
  80463. /** Planar coordinates mode */
  80464. static readonly TEXTURE_PLANAR_MODE: number;
  80465. /** Cubic coordinates mode */
  80466. static readonly TEXTURE_CUBIC_MODE: number;
  80467. /** Projection coordinates mode */
  80468. static readonly TEXTURE_PROJECTION_MODE: number;
  80469. /** Skybox coordinates mode */
  80470. static readonly TEXTURE_SKYBOX_MODE: number;
  80471. /** Inverse Cubic coordinates mode */
  80472. static readonly TEXTURE_INVCUBIC_MODE: number;
  80473. /** Equirectangular coordinates mode */
  80474. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  80475. /** Equirectangular Fixed coordinates mode */
  80476. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  80477. /** Equirectangular Fixed Mirrored coordinates mode */
  80478. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  80479. /** Offline (baking) quality for texture filtering */
  80480. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  80481. /** High quality for texture filtering */
  80482. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  80483. /** Medium quality for texture filtering */
  80484. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  80485. /** Low quality for texture filtering */
  80486. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  80487. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  80488. static readonly SCALEMODE_FLOOR: number;
  80489. /** Defines that texture rescaling will look for the nearest power of 2 size */
  80490. static readonly SCALEMODE_NEAREST: number;
  80491. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  80492. static readonly SCALEMODE_CEILING: number;
  80493. /**
  80494. * The dirty texture flag value
  80495. */
  80496. static readonly MATERIAL_TextureDirtyFlag: number;
  80497. /**
  80498. * The dirty light flag value
  80499. */
  80500. static readonly MATERIAL_LightDirtyFlag: number;
  80501. /**
  80502. * The dirty fresnel flag value
  80503. */
  80504. static readonly MATERIAL_FresnelDirtyFlag: number;
  80505. /**
  80506. * The dirty attribute flag value
  80507. */
  80508. static readonly MATERIAL_AttributesDirtyFlag: number;
  80509. /**
  80510. * The dirty misc flag value
  80511. */
  80512. static readonly MATERIAL_MiscDirtyFlag: number;
  80513. /**
  80514. * The all dirty flag value
  80515. */
  80516. static readonly MATERIAL_AllDirtyFlag: number;
  80517. /**
  80518. * Returns the triangle fill mode
  80519. */
  80520. static readonly MATERIAL_TriangleFillMode: number;
  80521. /**
  80522. * Returns the wireframe mode
  80523. */
  80524. static readonly MATERIAL_WireFrameFillMode: number;
  80525. /**
  80526. * Returns the point fill mode
  80527. */
  80528. static readonly MATERIAL_PointFillMode: number;
  80529. /**
  80530. * Returns the point list draw mode
  80531. */
  80532. static readonly MATERIAL_PointListDrawMode: number;
  80533. /**
  80534. * Returns the line list draw mode
  80535. */
  80536. static readonly MATERIAL_LineListDrawMode: number;
  80537. /**
  80538. * Returns the line loop draw mode
  80539. */
  80540. static readonly MATERIAL_LineLoopDrawMode: number;
  80541. /**
  80542. * Returns the line strip draw mode
  80543. */
  80544. static readonly MATERIAL_LineStripDrawMode: number;
  80545. /**
  80546. * Returns the triangle strip draw mode
  80547. */
  80548. static readonly MATERIAL_TriangleStripDrawMode: number;
  80549. /**
  80550. * Returns the triangle fan draw mode
  80551. */
  80552. static readonly MATERIAL_TriangleFanDrawMode: number;
  80553. /**
  80554. * Stores the clock-wise side orientation
  80555. */
  80556. static readonly MATERIAL_ClockWiseSideOrientation: number;
  80557. /**
  80558. * Stores the counter clock-wise side orientation
  80559. */
  80560. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  80561. /**
  80562. * Nothing
  80563. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80564. */
  80565. static readonly ACTION_NothingTrigger: number;
  80566. /**
  80567. * On pick
  80568. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80569. */
  80570. static readonly ACTION_OnPickTrigger: number;
  80571. /**
  80572. * On left pick
  80573. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80574. */
  80575. static readonly ACTION_OnLeftPickTrigger: number;
  80576. /**
  80577. * On right pick
  80578. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80579. */
  80580. static readonly ACTION_OnRightPickTrigger: number;
  80581. /**
  80582. * On center pick
  80583. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80584. */
  80585. static readonly ACTION_OnCenterPickTrigger: number;
  80586. /**
  80587. * On pick down
  80588. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80589. */
  80590. static readonly ACTION_OnPickDownTrigger: number;
  80591. /**
  80592. * On double pick
  80593. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80594. */
  80595. static readonly ACTION_OnDoublePickTrigger: number;
  80596. /**
  80597. * On pick up
  80598. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80599. */
  80600. static readonly ACTION_OnPickUpTrigger: number;
  80601. /**
  80602. * On pick out.
  80603. * This trigger will only be raised if you also declared a OnPickDown
  80604. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80605. */
  80606. static readonly ACTION_OnPickOutTrigger: number;
  80607. /**
  80608. * On long press
  80609. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80610. */
  80611. static readonly ACTION_OnLongPressTrigger: number;
  80612. /**
  80613. * On pointer over
  80614. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80615. */
  80616. static readonly ACTION_OnPointerOverTrigger: number;
  80617. /**
  80618. * On pointer out
  80619. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80620. */
  80621. static readonly ACTION_OnPointerOutTrigger: number;
  80622. /**
  80623. * On every frame
  80624. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80625. */
  80626. static readonly ACTION_OnEveryFrameTrigger: number;
  80627. /**
  80628. * On intersection enter
  80629. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80630. */
  80631. static readonly ACTION_OnIntersectionEnterTrigger: number;
  80632. /**
  80633. * On intersection exit
  80634. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80635. */
  80636. static readonly ACTION_OnIntersectionExitTrigger: number;
  80637. /**
  80638. * On key down
  80639. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80640. */
  80641. static readonly ACTION_OnKeyDownTrigger: number;
  80642. /**
  80643. * On key up
  80644. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80645. */
  80646. static readonly ACTION_OnKeyUpTrigger: number;
  80647. /**
  80648. * Billboard mode will only apply to Y axis
  80649. */
  80650. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  80651. /**
  80652. * Billboard mode will apply to all axes
  80653. */
  80654. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  80655. /**
  80656. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  80657. */
  80658. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  80659. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  80660. * Test order :
  80661. * Is the bounding sphere outside the frustum ?
  80662. * If not, are the bounding box vertices outside the frustum ?
  80663. * It not, then the cullable object is in the frustum.
  80664. */
  80665. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  80666. /** Culling strategy : Bounding Sphere Only.
  80667. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  80668. * It's also less accurate than the standard because some not visible objects can still be selected.
  80669. * Test : is the bounding sphere outside the frustum ?
  80670. * If not, then the cullable object is in the frustum.
  80671. */
  80672. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  80673. /** Culling strategy : Optimistic Inclusion.
  80674. * This in an inclusion test first, then the standard exclusion test.
  80675. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  80676. * 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.
  80677. * Anyway, it's as accurate as the standard strategy.
  80678. * Test :
  80679. * Is the cullable object bounding sphere center in the frustum ?
  80680. * If not, apply the default culling strategy.
  80681. */
  80682. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  80683. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  80684. * This in an inclusion test first, then the bounding sphere only exclusion test.
  80685. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  80686. * 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.
  80687. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  80688. * Test :
  80689. * Is the cullable object bounding sphere center in the frustum ?
  80690. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  80691. */
  80692. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  80693. /**
  80694. * No logging while loading
  80695. */
  80696. static readonly SCENELOADER_NO_LOGGING: number;
  80697. /**
  80698. * Minimal logging while loading
  80699. */
  80700. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  80701. /**
  80702. * Summary logging while loading
  80703. */
  80704. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  80705. /**
  80706. * Detailled logging while loading
  80707. */
  80708. static readonly SCENELOADER_DETAILED_LOGGING: number;
  80709. /**
  80710. * Prepass texture index for color
  80711. */
  80712. static readonly PREPASS_COLOR_INDEX: number;
  80713. /**
  80714. * Prepass texture index for irradiance
  80715. */
  80716. static readonly PREPASS_IRRADIANCE_INDEX: number;
  80717. /**
  80718. * Prepass texture index for depth + normal
  80719. */
  80720. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  80721. /**
  80722. * Prepass texture index for albedo
  80723. */
  80724. static readonly PREPASS_ALBEDO_INDEX: number;
  80725. }
  80726. }
  80727. declare module BABYLON {
  80728. /**
  80729. * This represents the required contract to create a new type of texture loader.
  80730. */
  80731. export interface IInternalTextureLoader {
  80732. /**
  80733. * Defines wether the loader supports cascade loading the different faces.
  80734. */
  80735. supportCascades: boolean;
  80736. /**
  80737. * This returns if the loader support the current file information.
  80738. * @param extension defines the file extension of the file being loaded
  80739. * @param mimeType defines the optional mime type of the file being loaded
  80740. * @returns true if the loader can load the specified file
  80741. */
  80742. canLoad(extension: string, mimeType?: string): boolean;
  80743. /**
  80744. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  80745. * @param data contains the texture data
  80746. * @param texture defines the BabylonJS internal texture
  80747. * @param createPolynomials will be true if polynomials have been requested
  80748. * @param onLoad defines the callback to trigger once the texture is ready
  80749. * @param onError defines the callback to trigger in case of error
  80750. */
  80751. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  80752. /**
  80753. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  80754. * @param data contains the texture data
  80755. * @param texture defines the BabylonJS internal texture
  80756. * @param callback defines the method to call once ready to upload
  80757. */
  80758. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  80759. }
  80760. }
  80761. declare module BABYLON {
  80762. /**
  80763. * Class used to store and describe the pipeline context associated with an effect
  80764. */
  80765. export interface IPipelineContext {
  80766. /**
  80767. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  80768. */
  80769. isAsync: boolean;
  80770. /**
  80771. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  80772. */
  80773. isReady: boolean;
  80774. /** @hidden */
  80775. _getVertexShaderCode(): string | null;
  80776. /** @hidden */
  80777. _getFragmentShaderCode(): string | null;
  80778. /** @hidden */
  80779. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  80780. }
  80781. }
  80782. declare module BABYLON {
  80783. /**
  80784. * Class used to store gfx data (like WebGLBuffer)
  80785. */
  80786. export class DataBuffer {
  80787. /**
  80788. * Gets or sets the number of objects referencing this buffer
  80789. */
  80790. references: number;
  80791. /** Gets or sets the size of the underlying buffer */
  80792. capacity: number;
  80793. /**
  80794. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  80795. */
  80796. is32Bits: boolean;
  80797. /**
  80798. * Gets the underlying buffer
  80799. */
  80800. get underlyingResource(): any;
  80801. }
  80802. }
  80803. declare module BABYLON {
  80804. /** @hidden */
  80805. export interface IShaderProcessor {
  80806. attributeProcessor?: (attribute: string) => string;
  80807. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  80808. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  80809. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  80810. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  80811. lineProcessor?: (line: string, isFragment: boolean) => string;
  80812. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80813. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80814. }
  80815. }
  80816. declare module BABYLON {
  80817. /** @hidden */
  80818. export interface ProcessingOptions {
  80819. defines: string[];
  80820. indexParameters: any;
  80821. isFragment: boolean;
  80822. shouldUseHighPrecisionShader: boolean;
  80823. supportsUniformBuffers: boolean;
  80824. shadersRepository: string;
  80825. includesShadersStore: {
  80826. [key: string]: string;
  80827. };
  80828. processor?: IShaderProcessor;
  80829. version: string;
  80830. platformName: string;
  80831. lookForClosingBracketForUniformBuffer?: boolean;
  80832. }
  80833. }
  80834. declare module BABYLON {
  80835. /** @hidden */
  80836. export class ShaderCodeNode {
  80837. line: string;
  80838. children: ShaderCodeNode[];
  80839. additionalDefineKey?: string;
  80840. additionalDefineValue?: string;
  80841. isValid(preprocessors: {
  80842. [key: string]: string;
  80843. }): boolean;
  80844. process(preprocessors: {
  80845. [key: string]: string;
  80846. }, options: ProcessingOptions): string;
  80847. }
  80848. }
  80849. declare module BABYLON {
  80850. /** @hidden */
  80851. export class ShaderCodeCursor {
  80852. private _lines;
  80853. lineIndex: number;
  80854. get currentLine(): string;
  80855. get canRead(): boolean;
  80856. set lines(value: string[]);
  80857. }
  80858. }
  80859. declare module BABYLON {
  80860. /** @hidden */
  80861. export class ShaderCodeConditionNode extends ShaderCodeNode {
  80862. process(preprocessors: {
  80863. [key: string]: string;
  80864. }, options: ProcessingOptions): string;
  80865. }
  80866. }
  80867. declare module BABYLON {
  80868. /** @hidden */
  80869. export class ShaderDefineExpression {
  80870. isTrue(preprocessors: {
  80871. [key: string]: string;
  80872. }): boolean;
  80873. private static _OperatorPriority;
  80874. private static _Stack;
  80875. static postfixToInfix(postfix: string[]): string;
  80876. static infixToPostfix(infix: string): string[];
  80877. }
  80878. }
  80879. declare module BABYLON {
  80880. /** @hidden */
  80881. export class ShaderCodeTestNode extends ShaderCodeNode {
  80882. testExpression: ShaderDefineExpression;
  80883. isValid(preprocessors: {
  80884. [key: string]: string;
  80885. }): boolean;
  80886. }
  80887. }
  80888. declare module BABYLON {
  80889. /** @hidden */
  80890. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  80891. define: string;
  80892. not: boolean;
  80893. constructor(define: string, not?: boolean);
  80894. isTrue(preprocessors: {
  80895. [key: string]: string;
  80896. }): boolean;
  80897. }
  80898. }
  80899. declare module BABYLON {
  80900. /** @hidden */
  80901. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  80902. leftOperand: ShaderDefineExpression;
  80903. rightOperand: ShaderDefineExpression;
  80904. isTrue(preprocessors: {
  80905. [key: string]: string;
  80906. }): boolean;
  80907. }
  80908. }
  80909. declare module BABYLON {
  80910. /** @hidden */
  80911. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  80912. leftOperand: ShaderDefineExpression;
  80913. rightOperand: ShaderDefineExpression;
  80914. isTrue(preprocessors: {
  80915. [key: string]: string;
  80916. }): boolean;
  80917. }
  80918. }
  80919. declare module BABYLON {
  80920. /** @hidden */
  80921. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  80922. define: string;
  80923. operand: string;
  80924. testValue: string;
  80925. constructor(define: string, operand: string, testValue: string);
  80926. isTrue(preprocessors: {
  80927. [key: string]: string;
  80928. }): boolean;
  80929. }
  80930. }
  80931. declare module BABYLON {
  80932. /**
  80933. * Class used to enable access to offline support
  80934. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  80935. */
  80936. export interface IOfflineProvider {
  80937. /**
  80938. * Gets a boolean indicating if scene must be saved in the database
  80939. */
  80940. enableSceneOffline: boolean;
  80941. /**
  80942. * Gets a boolean indicating if textures must be saved in the database
  80943. */
  80944. enableTexturesOffline: boolean;
  80945. /**
  80946. * Open the offline support and make it available
  80947. * @param successCallback defines the callback to call on success
  80948. * @param errorCallback defines the callback to call on error
  80949. */
  80950. open(successCallback: () => void, errorCallback: () => void): void;
  80951. /**
  80952. * Loads an image from the offline support
  80953. * @param url defines the url to load from
  80954. * @param image defines the target DOM image
  80955. */
  80956. loadImage(url: string, image: HTMLImageElement): void;
  80957. /**
  80958. * Loads a file from offline support
  80959. * @param url defines the URL to load from
  80960. * @param sceneLoaded defines a callback to call on success
  80961. * @param progressCallBack defines a callback to call when progress changed
  80962. * @param errorCallback defines a callback to call on error
  80963. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  80964. */
  80965. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  80966. }
  80967. }
  80968. declare module BABYLON {
  80969. /**
  80970. * Class used to help managing file picking and drag'n'drop
  80971. * File Storage
  80972. */
  80973. export class FilesInputStore {
  80974. /**
  80975. * List of files ready to be loaded
  80976. */
  80977. static FilesToLoad: {
  80978. [key: string]: File;
  80979. };
  80980. }
  80981. }
  80982. declare module BABYLON {
  80983. /**
  80984. * Class used to define a retry strategy when error happens while loading assets
  80985. */
  80986. export class RetryStrategy {
  80987. /**
  80988. * Function used to defines an exponential back off strategy
  80989. * @param maxRetries defines the maximum number of retries (3 by default)
  80990. * @param baseInterval defines the interval between retries
  80991. * @returns the strategy function to use
  80992. */
  80993. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  80994. }
  80995. }
  80996. declare module BABYLON {
  80997. /**
  80998. * @ignore
  80999. * Application error to support additional information when loading a file
  81000. */
  81001. export abstract class BaseError extends Error {
  81002. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  81003. }
  81004. }
  81005. declare module BABYLON {
  81006. /** @ignore */
  81007. export class LoadFileError extends BaseError {
  81008. request?: WebRequest;
  81009. file?: File;
  81010. /**
  81011. * Creates a new LoadFileError
  81012. * @param message defines the message of the error
  81013. * @param request defines the optional web request
  81014. * @param file defines the optional file
  81015. */
  81016. constructor(message: string, object?: WebRequest | File);
  81017. }
  81018. /** @ignore */
  81019. export class RequestFileError extends BaseError {
  81020. request: WebRequest;
  81021. /**
  81022. * Creates a new LoadFileError
  81023. * @param message defines the message of the error
  81024. * @param request defines the optional web request
  81025. */
  81026. constructor(message: string, request: WebRequest);
  81027. }
  81028. /** @ignore */
  81029. export class ReadFileError extends BaseError {
  81030. file: File;
  81031. /**
  81032. * Creates a new ReadFileError
  81033. * @param message defines the message of the error
  81034. * @param file defines the optional file
  81035. */
  81036. constructor(message: string, file: File);
  81037. }
  81038. /**
  81039. * @hidden
  81040. */
  81041. export class FileTools {
  81042. /**
  81043. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  81044. */
  81045. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  81046. /**
  81047. * Gets or sets the base URL to use to load assets
  81048. */
  81049. static BaseUrl: string;
  81050. /**
  81051. * Default behaviour for cors in the application.
  81052. * It can be a string if the expected behavior is identical in the entire app.
  81053. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  81054. */
  81055. static CorsBehavior: string | ((url: string | string[]) => string);
  81056. /**
  81057. * Gets or sets a function used to pre-process url before using them to load assets
  81058. */
  81059. static PreprocessUrl: (url: string) => string;
  81060. /**
  81061. * Removes unwanted characters from an url
  81062. * @param url defines the url to clean
  81063. * @returns the cleaned url
  81064. */
  81065. private static _CleanUrl;
  81066. /**
  81067. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  81068. * @param url define the url we are trying
  81069. * @param element define the dom element where to configure the cors policy
  81070. */
  81071. static SetCorsBehavior(url: string | string[], element: {
  81072. crossOrigin: string | null;
  81073. }): void;
  81074. /**
  81075. * Loads an image as an HTMLImageElement.
  81076. * @param input url string, ArrayBuffer, or Blob to load
  81077. * @param onLoad callback called when the image successfully loads
  81078. * @param onError callback called when the image fails to load
  81079. * @param offlineProvider offline provider for caching
  81080. * @param mimeType optional mime type
  81081. * @returns the HTMLImageElement of the loaded image
  81082. */
  81083. 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>;
  81084. /**
  81085. * Reads a file from a File object
  81086. * @param file defines the file to load
  81087. * @param onSuccess defines the callback to call when data is loaded
  81088. * @param onProgress defines the callback to call during loading process
  81089. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  81090. * @param onError defines the callback to call when an error occurs
  81091. * @returns a file request object
  81092. */
  81093. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  81094. /**
  81095. * Loads a file from a url
  81096. * @param url url to load
  81097. * @param onSuccess callback called when the file successfully loads
  81098. * @param onProgress callback called while file is loading (if the server supports this mode)
  81099. * @param offlineProvider defines the offline provider for caching
  81100. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81101. * @param onError callback called when the file fails to load
  81102. * @returns a file request object
  81103. */
  81104. 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;
  81105. /**
  81106. * Loads a file
  81107. * @param url url to load
  81108. * @param onSuccess callback called when the file successfully loads
  81109. * @param onProgress callback called while file is loading (if the server supports this mode)
  81110. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81111. * @param onError callback called when the file fails to load
  81112. * @param onOpened callback called when the web request is opened
  81113. * @returns a file request object
  81114. */
  81115. 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;
  81116. /**
  81117. * Checks if the loaded document was accessed via `file:`-Protocol.
  81118. * @returns boolean
  81119. */
  81120. static IsFileURL(): boolean;
  81121. }
  81122. }
  81123. declare module BABYLON {
  81124. /** @hidden */
  81125. export class ShaderProcessor {
  81126. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  81127. private static _ProcessPrecision;
  81128. private static _ExtractOperation;
  81129. private static _BuildSubExpression;
  81130. private static _BuildExpression;
  81131. private static _MoveCursorWithinIf;
  81132. private static _MoveCursor;
  81133. private static _EvaluatePreProcessors;
  81134. private static _PreparePreProcessors;
  81135. private static _ProcessShaderConversion;
  81136. private static _ProcessIncludes;
  81137. /**
  81138. * Loads a file from a url
  81139. * @param url url to load
  81140. * @param onSuccess callback called when the file successfully loads
  81141. * @param onProgress callback called while file is loading (if the server supports this mode)
  81142. * @param offlineProvider defines the offline provider for caching
  81143. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81144. * @param onError callback called when the file fails to load
  81145. * @returns a file request object
  81146. * @hidden
  81147. */
  81148. 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;
  81149. }
  81150. }
  81151. declare module BABYLON {
  81152. /**
  81153. * @hidden
  81154. */
  81155. export interface IColor4Like {
  81156. r: float;
  81157. g: float;
  81158. b: float;
  81159. a: float;
  81160. }
  81161. /**
  81162. * @hidden
  81163. */
  81164. export interface IColor3Like {
  81165. r: float;
  81166. g: float;
  81167. b: float;
  81168. }
  81169. /**
  81170. * @hidden
  81171. */
  81172. export interface IVector4Like {
  81173. x: float;
  81174. y: float;
  81175. z: float;
  81176. w: float;
  81177. }
  81178. /**
  81179. * @hidden
  81180. */
  81181. export interface IVector3Like {
  81182. x: float;
  81183. y: float;
  81184. z: float;
  81185. }
  81186. /**
  81187. * @hidden
  81188. */
  81189. export interface IVector2Like {
  81190. x: float;
  81191. y: float;
  81192. }
  81193. /**
  81194. * @hidden
  81195. */
  81196. export interface IMatrixLike {
  81197. toArray(): DeepImmutable<Float32Array | Array<number>>;
  81198. updateFlag: int;
  81199. }
  81200. /**
  81201. * @hidden
  81202. */
  81203. export interface IViewportLike {
  81204. x: float;
  81205. y: float;
  81206. width: float;
  81207. height: float;
  81208. }
  81209. /**
  81210. * @hidden
  81211. */
  81212. export interface IPlaneLike {
  81213. normal: IVector3Like;
  81214. d: float;
  81215. normalize(): void;
  81216. }
  81217. }
  81218. declare module BABYLON {
  81219. /**
  81220. * Interface used to define common properties for effect fallbacks
  81221. */
  81222. export interface IEffectFallbacks {
  81223. /**
  81224. * Removes the defines that should be removed when falling back.
  81225. * @param currentDefines defines the current define statements for the shader.
  81226. * @param effect defines the current effect we try to compile
  81227. * @returns The resulting defines with defines of the current rank removed.
  81228. */
  81229. reduce(currentDefines: string, effect: Effect): string;
  81230. /**
  81231. * Removes the fallback from the bound mesh.
  81232. */
  81233. unBindMesh(): void;
  81234. /**
  81235. * Checks to see if more fallbacks are still availible.
  81236. */
  81237. hasMoreFallbacks: boolean;
  81238. }
  81239. }
  81240. declare module BABYLON {
  81241. /**
  81242. * Class used to evalaute queries containing `and` and `or` operators
  81243. */
  81244. export class AndOrNotEvaluator {
  81245. /**
  81246. * Evaluate a query
  81247. * @param query defines the query to evaluate
  81248. * @param evaluateCallback defines the callback used to filter result
  81249. * @returns true if the query matches
  81250. */
  81251. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  81252. private static _HandleParenthesisContent;
  81253. private static _SimplifyNegation;
  81254. }
  81255. }
  81256. declare module BABYLON {
  81257. /**
  81258. * Class used to store custom tags
  81259. */
  81260. export class Tags {
  81261. /**
  81262. * Adds support for tags on the given object
  81263. * @param obj defines the object to use
  81264. */
  81265. static EnableFor(obj: any): void;
  81266. /**
  81267. * Removes tags support
  81268. * @param obj defines the object to use
  81269. */
  81270. static DisableFor(obj: any): void;
  81271. /**
  81272. * Gets a boolean indicating if the given object has tags
  81273. * @param obj defines the object to use
  81274. * @returns a boolean
  81275. */
  81276. static HasTags(obj: any): boolean;
  81277. /**
  81278. * Gets the tags available on a given object
  81279. * @param obj defines the object to use
  81280. * @param asString defines if the tags must be returned as a string instead of an array of strings
  81281. * @returns the tags
  81282. */
  81283. static GetTags(obj: any, asString?: boolean): any;
  81284. /**
  81285. * Adds tags to an object
  81286. * @param obj defines the object to use
  81287. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  81288. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  81289. */
  81290. static AddTagsTo(obj: any, tagsString: string): void;
  81291. /**
  81292. * @hidden
  81293. */
  81294. static _AddTagTo(obj: any, tag: string): void;
  81295. /**
  81296. * Removes specific tags from a specific object
  81297. * @param obj defines the object to use
  81298. * @param tagsString defines the tags to remove
  81299. */
  81300. static RemoveTagsFrom(obj: any, tagsString: string): void;
  81301. /**
  81302. * @hidden
  81303. */
  81304. static _RemoveTagFrom(obj: any, tag: string): void;
  81305. /**
  81306. * Defines if tags hosted on an object match a given query
  81307. * @param obj defines the object to use
  81308. * @param tagsQuery defines the tag query
  81309. * @returns a boolean
  81310. */
  81311. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  81312. }
  81313. }
  81314. declare module BABYLON {
  81315. /**
  81316. * Scalar computation library
  81317. */
  81318. export class Scalar {
  81319. /**
  81320. * Two pi constants convenient for computation.
  81321. */
  81322. static TwoPi: number;
  81323. /**
  81324. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81325. * @param a number
  81326. * @param b number
  81327. * @param epsilon (default = 1.401298E-45)
  81328. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81329. */
  81330. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  81331. /**
  81332. * Returns a string : the upper case translation of the number i to hexadecimal.
  81333. * @param i number
  81334. * @returns the upper case translation of the number i to hexadecimal.
  81335. */
  81336. static ToHex(i: number): string;
  81337. /**
  81338. * Returns -1 if value is negative and +1 is value is positive.
  81339. * @param value the value
  81340. * @returns the value itself if it's equal to zero.
  81341. */
  81342. static Sign(value: number): number;
  81343. /**
  81344. * Returns the value itself if it's between min and max.
  81345. * Returns min if the value is lower than min.
  81346. * Returns max if the value is greater than max.
  81347. * @param value the value to clmap
  81348. * @param min the min value to clamp to (default: 0)
  81349. * @param max the max value to clamp to (default: 1)
  81350. * @returns the clamped value
  81351. */
  81352. static Clamp(value: number, min?: number, max?: number): number;
  81353. /**
  81354. * the log2 of value.
  81355. * @param value the value to compute log2 of
  81356. * @returns the log2 of value.
  81357. */
  81358. static Log2(value: number): number;
  81359. /**
  81360. * Loops the value, so that it is never larger than length and never smaller than 0.
  81361. *
  81362. * This is similar to the modulo operator but it works with floating point numbers.
  81363. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  81364. * With t = 5 and length = 2.5, the result would be 0.0.
  81365. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  81366. * @param value the value
  81367. * @param length the length
  81368. * @returns the looped value
  81369. */
  81370. static Repeat(value: number, length: number): number;
  81371. /**
  81372. * Normalize the value between 0.0 and 1.0 using min and max values
  81373. * @param value value to normalize
  81374. * @param min max to normalize between
  81375. * @param max min to normalize between
  81376. * @returns the normalized value
  81377. */
  81378. static Normalize(value: number, min: number, max: number): number;
  81379. /**
  81380. * Denormalize the value from 0.0 and 1.0 using min and max values
  81381. * @param normalized value to denormalize
  81382. * @param min max to denormalize between
  81383. * @param max min to denormalize between
  81384. * @returns the denormalized value
  81385. */
  81386. static Denormalize(normalized: number, min: number, max: number): number;
  81387. /**
  81388. * Calculates the shortest difference between two given angles given in degrees.
  81389. * @param current current angle in degrees
  81390. * @param target target angle in degrees
  81391. * @returns the delta
  81392. */
  81393. static DeltaAngle(current: number, target: number): number;
  81394. /**
  81395. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  81396. * @param tx value
  81397. * @param length length
  81398. * @returns The returned value will move back and forth between 0 and length
  81399. */
  81400. static PingPong(tx: number, length: number): number;
  81401. /**
  81402. * Interpolates between min and max with smoothing at the limits.
  81403. *
  81404. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  81405. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  81406. * @param from from
  81407. * @param to to
  81408. * @param tx value
  81409. * @returns the smooth stepped value
  81410. */
  81411. static SmoothStep(from: number, to: number, tx: number): number;
  81412. /**
  81413. * Moves a value current towards target.
  81414. *
  81415. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  81416. * Negative values of maxDelta pushes the value away from target.
  81417. * @param current current value
  81418. * @param target target value
  81419. * @param maxDelta max distance to move
  81420. * @returns resulting value
  81421. */
  81422. static MoveTowards(current: number, target: number, maxDelta: number): number;
  81423. /**
  81424. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81425. *
  81426. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  81427. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  81428. * @param current current value
  81429. * @param target target value
  81430. * @param maxDelta max distance to move
  81431. * @returns resulting angle
  81432. */
  81433. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  81434. /**
  81435. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  81436. * @param start start value
  81437. * @param end target value
  81438. * @param amount amount to lerp between
  81439. * @returns the lerped value
  81440. */
  81441. static Lerp(start: number, end: number, amount: number): number;
  81442. /**
  81443. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81444. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  81445. * @param start start value
  81446. * @param end target value
  81447. * @param amount amount to lerp between
  81448. * @returns the lerped value
  81449. */
  81450. static LerpAngle(start: number, end: number, amount: number): number;
  81451. /**
  81452. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  81453. * @param a start value
  81454. * @param b target value
  81455. * @param value value between a and b
  81456. * @returns the inverseLerp value
  81457. */
  81458. static InverseLerp(a: number, b: number, value: number): number;
  81459. /**
  81460. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  81461. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  81462. * @param value1 spline value
  81463. * @param tangent1 spline value
  81464. * @param value2 spline value
  81465. * @param tangent2 spline value
  81466. * @param amount input value
  81467. * @returns hermite result
  81468. */
  81469. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  81470. /**
  81471. * Returns a random float number between and min and max values
  81472. * @param min min value of random
  81473. * @param max max value of random
  81474. * @returns random value
  81475. */
  81476. static RandomRange(min: number, max: number): number;
  81477. /**
  81478. * This function returns percentage of a number in a given range.
  81479. *
  81480. * RangeToPercent(40,20,60) will return 0.5 (50%)
  81481. * RangeToPercent(34,0,100) will return 0.34 (34%)
  81482. * @param number to convert to percentage
  81483. * @param min min range
  81484. * @param max max range
  81485. * @returns the percentage
  81486. */
  81487. static RangeToPercent(number: number, min: number, max: number): number;
  81488. /**
  81489. * This function returns number that corresponds to the percentage in a given range.
  81490. *
  81491. * PercentToRange(0.34,0,100) will return 34.
  81492. * @param percent to convert to number
  81493. * @param min min range
  81494. * @param max max range
  81495. * @returns the number
  81496. */
  81497. static PercentToRange(percent: number, min: number, max: number): number;
  81498. /**
  81499. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  81500. * @param angle The angle to normalize in radian.
  81501. * @return The converted angle.
  81502. */
  81503. static NormalizeRadians(angle: number): number;
  81504. }
  81505. }
  81506. declare module BABYLON {
  81507. /**
  81508. * Constant used to convert a value to gamma space
  81509. * @ignorenaming
  81510. */
  81511. export const ToGammaSpace: number;
  81512. /**
  81513. * Constant used to convert a value to linear space
  81514. * @ignorenaming
  81515. */
  81516. export const ToLinearSpace = 2.2;
  81517. /**
  81518. * Constant used to define the minimal number value in Babylon.js
  81519. * @ignorenaming
  81520. */
  81521. let Epsilon: number;
  81522. }
  81523. declare module BABYLON {
  81524. /**
  81525. * Class used to represent a viewport on screen
  81526. */
  81527. export class Viewport {
  81528. /** viewport left coordinate */
  81529. x: number;
  81530. /** viewport top coordinate */
  81531. y: number;
  81532. /**viewport width */
  81533. width: number;
  81534. /** viewport height */
  81535. height: number;
  81536. /**
  81537. * Creates a Viewport object located at (x, y) and sized (width, height)
  81538. * @param x defines viewport left coordinate
  81539. * @param y defines viewport top coordinate
  81540. * @param width defines the viewport width
  81541. * @param height defines the viewport height
  81542. */
  81543. constructor(
  81544. /** viewport left coordinate */
  81545. x: number,
  81546. /** viewport top coordinate */
  81547. y: number,
  81548. /**viewport width */
  81549. width: number,
  81550. /** viewport height */
  81551. height: number);
  81552. /**
  81553. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  81554. * @param renderWidth defines the rendering width
  81555. * @param renderHeight defines the rendering height
  81556. * @returns a new Viewport
  81557. */
  81558. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  81559. /**
  81560. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  81561. * @param renderWidth defines the rendering width
  81562. * @param renderHeight defines the rendering height
  81563. * @param ref defines the target viewport
  81564. * @returns the current viewport
  81565. */
  81566. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  81567. /**
  81568. * Returns a new Viewport copied from the current one
  81569. * @returns a new Viewport
  81570. */
  81571. clone(): Viewport;
  81572. }
  81573. }
  81574. declare module BABYLON {
  81575. /**
  81576. * Class containing a set of static utilities functions for arrays.
  81577. */
  81578. export class ArrayTools {
  81579. /**
  81580. * Returns an array of the given size filled with element built from the given constructor and the paramters
  81581. * @param size the number of element to construct and put in the array
  81582. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  81583. * @returns a new array filled with new objects
  81584. */
  81585. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  81586. }
  81587. }
  81588. declare module BABYLON {
  81589. /**
  81590. * Represents a plane by the equation ax + by + cz + d = 0
  81591. */
  81592. export class Plane {
  81593. private static _TmpMatrix;
  81594. /**
  81595. * Normal of the plane (a,b,c)
  81596. */
  81597. normal: Vector3;
  81598. /**
  81599. * d component of the plane
  81600. */
  81601. d: number;
  81602. /**
  81603. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  81604. * @param a a component of the plane
  81605. * @param b b component of the plane
  81606. * @param c c component of the plane
  81607. * @param d d component of the plane
  81608. */
  81609. constructor(a: number, b: number, c: number, d: number);
  81610. /**
  81611. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  81612. */
  81613. asArray(): number[];
  81614. /**
  81615. * @returns a new plane copied from the current Plane.
  81616. */
  81617. clone(): Plane;
  81618. /**
  81619. * @returns the string "Plane".
  81620. */
  81621. getClassName(): string;
  81622. /**
  81623. * @returns the Plane hash code.
  81624. */
  81625. getHashCode(): number;
  81626. /**
  81627. * Normalize the current Plane in place.
  81628. * @returns the updated Plane.
  81629. */
  81630. normalize(): Plane;
  81631. /**
  81632. * Applies a transformation the plane and returns the result
  81633. * @param transformation the transformation matrix to be applied to the plane
  81634. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  81635. */
  81636. transform(transformation: DeepImmutable<Matrix>): Plane;
  81637. /**
  81638. * Compute the dot product between the point and the plane normal
  81639. * @param point point to calculate the dot product with
  81640. * @returns the dot product (float) of the point coordinates and the plane normal.
  81641. */
  81642. dotCoordinate(point: DeepImmutable<Vector3>): number;
  81643. /**
  81644. * Updates the current Plane from the plane defined by the three given points.
  81645. * @param point1 one of the points used to contruct the plane
  81646. * @param point2 one of the points used to contruct the plane
  81647. * @param point3 one of the points used to contruct the plane
  81648. * @returns the updated Plane.
  81649. */
  81650. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81651. /**
  81652. * Checks if the plane is facing a given direction
  81653. * @param direction the direction to check if the plane is facing
  81654. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  81655. * @returns True is the vector "direction" is the same side than the plane normal.
  81656. */
  81657. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  81658. /**
  81659. * Calculates the distance to a point
  81660. * @param point point to calculate distance to
  81661. * @returns the signed distance (float) from the given point to the Plane.
  81662. */
  81663. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  81664. /**
  81665. * Creates a plane from an array
  81666. * @param array the array to create a plane from
  81667. * @returns a new Plane from the given array.
  81668. */
  81669. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  81670. /**
  81671. * Creates a plane from three points
  81672. * @param point1 point used to create the plane
  81673. * @param point2 point used to create the plane
  81674. * @param point3 point used to create the plane
  81675. * @returns a new Plane defined by the three given points.
  81676. */
  81677. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81678. /**
  81679. * Creates a plane from an origin point and a normal
  81680. * @param origin origin of the plane to be constructed
  81681. * @param normal normal of the plane to be constructed
  81682. * @returns a new Plane the normal vector to this plane at the given origin point.
  81683. * Note : the vector "normal" is updated because normalized.
  81684. */
  81685. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  81686. /**
  81687. * Calculates the distance from a plane and a point
  81688. * @param origin origin of the plane to be constructed
  81689. * @param normal normal of the plane to be constructed
  81690. * @param point point to calculate distance to
  81691. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  81692. */
  81693. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  81694. }
  81695. }
  81696. declare module BABYLON {
  81697. /** @hidden */
  81698. export class PerformanceConfigurator {
  81699. /** @hidden */
  81700. static MatrixUse64Bits: boolean;
  81701. /** @hidden */
  81702. static MatrixTrackPrecisionChange: boolean;
  81703. /** @hidden */
  81704. static MatrixCurrentType: any;
  81705. /** @hidden */
  81706. static MatrixTrackedMatrices: Array<any> | null;
  81707. /** @hidden */
  81708. static SetMatrixPrecision(use64bits: boolean): void;
  81709. }
  81710. }
  81711. declare module BABYLON {
  81712. /**
  81713. * Class representing a vector containing 2 coordinates
  81714. */
  81715. export class Vector2 {
  81716. /** defines the first coordinate */
  81717. x: number;
  81718. /** defines the second coordinate */
  81719. y: number;
  81720. /**
  81721. * Creates a new Vector2 from the given x and y coordinates
  81722. * @param x defines the first coordinate
  81723. * @param y defines the second coordinate
  81724. */
  81725. constructor(
  81726. /** defines the first coordinate */
  81727. x?: number,
  81728. /** defines the second coordinate */
  81729. y?: number);
  81730. /**
  81731. * Gets a string with the Vector2 coordinates
  81732. * @returns a string with the Vector2 coordinates
  81733. */
  81734. toString(): string;
  81735. /**
  81736. * Gets class name
  81737. * @returns the string "Vector2"
  81738. */
  81739. getClassName(): string;
  81740. /**
  81741. * Gets current vector hash code
  81742. * @returns the Vector2 hash code as a number
  81743. */
  81744. getHashCode(): number;
  81745. /**
  81746. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  81747. * @param array defines the source array
  81748. * @param index defines the offset in source array
  81749. * @returns the current Vector2
  81750. */
  81751. toArray(array: FloatArray, index?: number): Vector2;
  81752. /**
  81753. * Update the current vector from an array
  81754. * @param array defines the destination array
  81755. * @param index defines the offset in the destination array
  81756. * @returns the current Vector3
  81757. */
  81758. fromArray(array: FloatArray, index?: number): Vector2;
  81759. /**
  81760. * Copy the current vector to an array
  81761. * @returns a new array with 2 elements: the Vector2 coordinates.
  81762. */
  81763. asArray(): number[];
  81764. /**
  81765. * Sets the Vector2 coordinates with the given Vector2 coordinates
  81766. * @param source defines the source Vector2
  81767. * @returns the current updated Vector2
  81768. */
  81769. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  81770. /**
  81771. * Sets the Vector2 coordinates with the given floats
  81772. * @param x defines the first coordinate
  81773. * @param y defines the second coordinate
  81774. * @returns the current updated Vector2
  81775. */
  81776. copyFromFloats(x: number, y: number): Vector2;
  81777. /**
  81778. * Sets the Vector2 coordinates with the given floats
  81779. * @param x defines the first coordinate
  81780. * @param y defines the second coordinate
  81781. * @returns the current updated Vector2
  81782. */
  81783. set(x: number, y: number): Vector2;
  81784. /**
  81785. * Add another vector with the current one
  81786. * @param otherVector defines the other vector
  81787. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  81788. */
  81789. add(otherVector: DeepImmutable<Vector2>): Vector2;
  81790. /**
  81791. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  81792. * @param otherVector defines the other vector
  81793. * @param result defines the target vector
  81794. * @returns the unmodified current Vector2
  81795. */
  81796. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81797. /**
  81798. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  81799. * @param otherVector defines the other vector
  81800. * @returns the current updated Vector2
  81801. */
  81802. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81803. /**
  81804. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  81805. * @param otherVector defines the other vector
  81806. * @returns a new Vector2
  81807. */
  81808. addVector3(otherVector: Vector3): Vector2;
  81809. /**
  81810. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  81811. * @param otherVector defines the other vector
  81812. * @returns a new Vector2
  81813. */
  81814. subtract(otherVector: Vector2): Vector2;
  81815. /**
  81816. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  81817. * @param otherVector defines the other vector
  81818. * @param result defines the target vector
  81819. * @returns the unmodified current Vector2
  81820. */
  81821. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81822. /**
  81823. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  81824. * @param otherVector defines the other vector
  81825. * @returns the current updated Vector2
  81826. */
  81827. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81828. /**
  81829. * Multiplies in place the current Vector2 coordinates by the given ones
  81830. * @param otherVector defines the other vector
  81831. * @returns the current updated Vector2
  81832. */
  81833. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81834. /**
  81835. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  81836. * @param otherVector defines the other vector
  81837. * @returns a new Vector2
  81838. */
  81839. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  81840. /**
  81841. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  81842. * @param otherVector defines the other vector
  81843. * @param result defines the target vector
  81844. * @returns the unmodified current Vector2
  81845. */
  81846. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81847. /**
  81848. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  81849. * @param x defines the first coordinate
  81850. * @param y defines the second coordinate
  81851. * @returns a new Vector2
  81852. */
  81853. multiplyByFloats(x: number, y: number): Vector2;
  81854. /**
  81855. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  81856. * @param otherVector defines the other vector
  81857. * @returns a new Vector2
  81858. */
  81859. divide(otherVector: Vector2): Vector2;
  81860. /**
  81861. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  81862. * @param otherVector defines the other vector
  81863. * @param result defines the target vector
  81864. * @returns the unmodified current Vector2
  81865. */
  81866. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81867. /**
  81868. * Divides the current Vector2 coordinates by the given ones
  81869. * @param otherVector defines the other vector
  81870. * @returns the current updated Vector2
  81871. */
  81872. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81873. /**
  81874. * Gets a new Vector2 with current Vector2 negated coordinates
  81875. * @returns a new Vector2
  81876. */
  81877. negate(): Vector2;
  81878. /**
  81879. * Negate this vector in place
  81880. * @returns this
  81881. */
  81882. negateInPlace(): Vector2;
  81883. /**
  81884. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  81885. * @param result defines the Vector3 object where to store the result
  81886. * @returns the current Vector2
  81887. */
  81888. negateToRef(result: Vector2): Vector2;
  81889. /**
  81890. * Multiply the Vector2 coordinates by scale
  81891. * @param scale defines the scaling factor
  81892. * @returns the current updated Vector2
  81893. */
  81894. scaleInPlace(scale: number): Vector2;
  81895. /**
  81896. * Returns a new Vector2 scaled by "scale" from the current Vector2
  81897. * @param scale defines the scaling factor
  81898. * @returns a new Vector2
  81899. */
  81900. scale(scale: number): Vector2;
  81901. /**
  81902. * Scale the current Vector2 values by a factor to a given Vector2
  81903. * @param scale defines the scale factor
  81904. * @param result defines the Vector2 object where to store the result
  81905. * @returns the unmodified current Vector2
  81906. */
  81907. scaleToRef(scale: number, result: Vector2): Vector2;
  81908. /**
  81909. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  81910. * @param scale defines the scale factor
  81911. * @param result defines the Vector2 object where to store the result
  81912. * @returns the unmodified current Vector2
  81913. */
  81914. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  81915. /**
  81916. * Gets a boolean if two vectors are equals
  81917. * @param otherVector defines the other vector
  81918. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  81919. */
  81920. equals(otherVector: DeepImmutable<Vector2>): boolean;
  81921. /**
  81922. * Gets a boolean if two vectors are equals (using an epsilon value)
  81923. * @param otherVector defines the other vector
  81924. * @param epsilon defines the minimal distance to consider equality
  81925. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  81926. */
  81927. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  81928. /**
  81929. * Gets a new Vector2 from current Vector2 floored values
  81930. * @returns a new Vector2
  81931. */
  81932. floor(): Vector2;
  81933. /**
  81934. * Gets a new Vector2 from current Vector2 floored values
  81935. * @returns a new Vector2
  81936. */
  81937. fract(): Vector2;
  81938. /**
  81939. * Gets the length of the vector
  81940. * @returns the vector length (float)
  81941. */
  81942. length(): number;
  81943. /**
  81944. * Gets the vector squared length
  81945. * @returns the vector squared length (float)
  81946. */
  81947. lengthSquared(): number;
  81948. /**
  81949. * Normalize the vector
  81950. * @returns the current updated Vector2
  81951. */
  81952. normalize(): Vector2;
  81953. /**
  81954. * Gets a new Vector2 copied from the Vector2
  81955. * @returns a new Vector2
  81956. */
  81957. clone(): Vector2;
  81958. /**
  81959. * Gets a new Vector2(0, 0)
  81960. * @returns a new Vector2
  81961. */
  81962. static Zero(): Vector2;
  81963. /**
  81964. * Gets a new Vector2(1, 1)
  81965. * @returns a new Vector2
  81966. */
  81967. static One(): Vector2;
  81968. /**
  81969. * Gets a new Vector2 set from the given index element of the given array
  81970. * @param array defines the data source
  81971. * @param offset defines the offset in the data source
  81972. * @returns a new Vector2
  81973. */
  81974. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  81975. /**
  81976. * Sets "result" from the given index element of the given array
  81977. * @param array defines the data source
  81978. * @param offset defines the offset in the data source
  81979. * @param result defines the target vector
  81980. */
  81981. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  81982. /**
  81983. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  81984. * @param value1 defines 1st point of control
  81985. * @param value2 defines 2nd point of control
  81986. * @param value3 defines 3rd point of control
  81987. * @param value4 defines 4th point of control
  81988. * @param amount defines the interpolation factor
  81989. * @returns a new Vector2
  81990. */
  81991. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  81992. /**
  81993. * 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".
  81994. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  81995. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  81996. * @param value defines the value to clamp
  81997. * @param min defines the lower limit
  81998. * @param max defines the upper limit
  81999. * @returns a new Vector2
  82000. */
  82001. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  82002. /**
  82003. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  82004. * @param value1 defines the 1st control point
  82005. * @param tangent1 defines the outgoing tangent
  82006. * @param value2 defines the 2nd control point
  82007. * @param tangent2 defines the incoming tangent
  82008. * @param amount defines the interpolation factor
  82009. * @returns a new Vector2
  82010. */
  82011. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  82012. /**
  82013. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  82014. * @param start defines the start vector
  82015. * @param end defines the end vector
  82016. * @param amount defines the interpolation factor
  82017. * @returns a new Vector2
  82018. */
  82019. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  82020. /**
  82021. * Gets the dot product of the vector "left" and the vector "right"
  82022. * @param left defines first vector
  82023. * @param right defines second vector
  82024. * @returns the dot product (float)
  82025. */
  82026. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  82027. /**
  82028. * Returns a new Vector2 equal to the normalized given vector
  82029. * @param vector defines the vector to normalize
  82030. * @returns a new Vector2
  82031. */
  82032. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  82033. /**
  82034. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  82035. * @param left defines 1st vector
  82036. * @param right defines 2nd vector
  82037. * @returns a new Vector2
  82038. */
  82039. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82040. /**
  82041. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  82042. * @param left defines 1st vector
  82043. * @param right defines 2nd vector
  82044. * @returns a new Vector2
  82045. */
  82046. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82047. /**
  82048. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  82049. * @param vector defines the vector to transform
  82050. * @param transformation defines the matrix to apply
  82051. * @returns a new Vector2
  82052. */
  82053. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  82054. /**
  82055. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  82056. * @param vector defines the vector to transform
  82057. * @param transformation defines the matrix to apply
  82058. * @param result defines the target vector
  82059. */
  82060. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  82061. /**
  82062. * Determines if a given vector is included in a triangle
  82063. * @param p defines the vector to test
  82064. * @param p0 defines 1st triangle point
  82065. * @param p1 defines 2nd triangle point
  82066. * @param p2 defines 3rd triangle point
  82067. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  82068. */
  82069. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  82070. /**
  82071. * Gets the distance between the vectors "value1" and "value2"
  82072. * @param value1 defines first vector
  82073. * @param value2 defines second vector
  82074. * @returns the distance between vectors
  82075. */
  82076. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82077. /**
  82078. * Returns the squared distance between the vectors "value1" and "value2"
  82079. * @param value1 defines first vector
  82080. * @param value2 defines second vector
  82081. * @returns the squared distance between vectors
  82082. */
  82083. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82084. /**
  82085. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  82086. * @param value1 defines first vector
  82087. * @param value2 defines second vector
  82088. * @returns a new Vector2
  82089. */
  82090. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  82091. /**
  82092. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  82093. * @param p defines the middle point
  82094. * @param segA defines one point of the segment
  82095. * @param segB defines the other point of the segment
  82096. * @returns the shortest distance
  82097. */
  82098. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  82099. }
  82100. /**
  82101. * Class used to store (x,y,z) vector representation
  82102. * A Vector3 is the main object used in 3D geometry
  82103. * It can represent etiher the coordinates of a point the space, either a direction
  82104. * Reminder: js uses a left handed forward facing system
  82105. */
  82106. export class Vector3 {
  82107. private static _UpReadOnly;
  82108. private static _ZeroReadOnly;
  82109. /** @hidden */
  82110. _x: number;
  82111. /** @hidden */
  82112. _y: number;
  82113. /** @hidden */
  82114. _z: number;
  82115. /** @hidden */
  82116. _isDirty: boolean;
  82117. /** Gets or sets the x coordinate */
  82118. get x(): number;
  82119. set x(value: number);
  82120. /** Gets or sets the y coordinate */
  82121. get y(): number;
  82122. set y(value: number);
  82123. /** Gets or sets the z coordinate */
  82124. get z(): number;
  82125. set z(value: number);
  82126. /**
  82127. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  82128. * @param x defines the first coordinates (on X axis)
  82129. * @param y defines the second coordinates (on Y axis)
  82130. * @param z defines the third coordinates (on Z axis)
  82131. */
  82132. constructor(x?: number, y?: number, z?: number);
  82133. /**
  82134. * Creates a string representation of the Vector3
  82135. * @returns a string with the Vector3 coordinates.
  82136. */
  82137. toString(): string;
  82138. /**
  82139. * Gets the class name
  82140. * @returns the string "Vector3"
  82141. */
  82142. getClassName(): string;
  82143. /**
  82144. * Creates the Vector3 hash code
  82145. * @returns a number which tends to be unique between Vector3 instances
  82146. */
  82147. getHashCode(): number;
  82148. /**
  82149. * Creates an array containing three elements : the coordinates of the Vector3
  82150. * @returns a new array of numbers
  82151. */
  82152. asArray(): number[];
  82153. /**
  82154. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  82155. * @param array defines the destination array
  82156. * @param index defines the offset in the destination array
  82157. * @returns the current Vector3
  82158. */
  82159. toArray(array: FloatArray, index?: number): Vector3;
  82160. /**
  82161. * Update the current vector from an array
  82162. * @param array defines the destination array
  82163. * @param index defines the offset in the destination array
  82164. * @returns the current Vector3
  82165. */
  82166. fromArray(array: FloatArray, index?: number): Vector3;
  82167. /**
  82168. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  82169. * @returns a new Quaternion object, computed from the Vector3 coordinates
  82170. */
  82171. toQuaternion(): Quaternion;
  82172. /**
  82173. * Adds the given vector to the current Vector3
  82174. * @param otherVector defines the second operand
  82175. * @returns the current updated Vector3
  82176. */
  82177. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82178. /**
  82179. * Adds the given coordinates to the current Vector3
  82180. * @param x defines the x coordinate of the operand
  82181. * @param y defines the y coordinate of the operand
  82182. * @param z defines the z coordinate of the operand
  82183. * @returns the current updated Vector3
  82184. */
  82185. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82186. /**
  82187. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  82188. * @param otherVector defines the second operand
  82189. * @returns the resulting Vector3
  82190. */
  82191. add(otherVector: DeepImmutable<Vector3>): Vector3;
  82192. /**
  82193. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  82194. * @param otherVector defines the second operand
  82195. * @param result defines the Vector3 object where to store the result
  82196. * @returns the current Vector3
  82197. */
  82198. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82199. /**
  82200. * Subtract the given vector from the current Vector3
  82201. * @param otherVector defines the second operand
  82202. * @returns the current updated Vector3
  82203. */
  82204. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82205. /**
  82206. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  82207. * @param otherVector defines the second operand
  82208. * @returns the resulting Vector3
  82209. */
  82210. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  82211. /**
  82212. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  82213. * @param otherVector defines the second operand
  82214. * @param result defines the Vector3 object where to store the result
  82215. * @returns the current Vector3
  82216. */
  82217. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82218. /**
  82219. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  82220. * @param x defines the x coordinate of the operand
  82221. * @param y defines the y coordinate of the operand
  82222. * @param z defines the z coordinate of the operand
  82223. * @returns the resulting Vector3
  82224. */
  82225. subtractFromFloats(x: number, y: number, z: number): Vector3;
  82226. /**
  82227. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  82228. * @param x defines the x coordinate of the operand
  82229. * @param y defines the y coordinate of the operand
  82230. * @param z defines the z coordinate of the operand
  82231. * @param result defines the Vector3 object where to store the result
  82232. * @returns the current Vector3
  82233. */
  82234. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  82235. /**
  82236. * Gets a new Vector3 set with the current Vector3 negated coordinates
  82237. * @returns a new Vector3
  82238. */
  82239. negate(): Vector3;
  82240. /**
  82241. * Negate this vector in place
  82242. * @returns this
  82243. */
  82244. negateInPlace(): Vector3;
  82245. /**
  82246. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  82247. * @param result defines the Vector3 object where to store the result
  82248. * @returns the current Vector3
  82249. */
  82250. negateToRef(result: Vector3): Vector3;
  82251. /**
  82252. * Multiplies the Vector3 coordinates by the float "scale"
  82253. * @param scale defines the multiplier factor
  82254. * @returns the current updated Vector3
  82255. */
  82256. scaleInPlace(scale: number): Vector3;
  82257. /**
  82258. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  82259. * @param scale defines the multiplier factor
  82260. * @returns a new Vector3
  82261. */
  82262. scale(scale: number): Vector3;
  82263. /**
  82264. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  82265. * @param scale defines the multiplier factor
  82266. * @param result defines the Vector3 object where to store the result
  82267. * @returns the current Vector3
  82268. */
  82269. scaleToRef(scale: number, result: Vector3): Vector3;
  82270. /**
  82271. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  82272. * @param scale defines the scale factor
  82273. * @param result defines the Vector3 object where to store the result
  82274. * @returns the unmodified current Vector3
  82275. */
  82276. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  82277. /**
  82278. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82279. * @param origin defines the origin of the projection ray
  82280. * @param plane defines the plane to project to
  82281. * @returns the projected vector3
  82282. */
  82283. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  82284. /**
  82285. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82286. * @param origin defines the origin of the projection ray
  82287. * @param plane defines the plane to project to
  82288. * @param result defines the Vector3 where to store the result
  82289. */
  82290. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  82291. /**
  82292. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  82293. * @param otherVector defines the second operand
  82294. * @returns true if both vectors are equals
  82295. */
  82296. equals(otherVector: DeepImmutable<Vector3>): boolean;
  82297. /**
  82298. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  82299. * @param otherVector defines the second operand
  82300. * @param epsilon defines the minimal distance to define values as equals
  82301. * @returns true if both vectors are distant less than epsilon
  82302. */
  82303. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  82304. /**
  82305. * Returns true if the current Vector3 coordinates equals the given floats
  82306. * @param x defines the x coordinate of the operand
  82307. * @param y defines the y coordinate of the operand
  82308. * @param z defines the z coordinate of the operand
  82309. * @returns true if both vectors are equals
  82310. */
  82311. equalsToFloats(x: number, y: number, z: number): boolean;
  82312. /**
  82313. * Multiplies the current Vector3 coordinates by the given ones
  82314. * @param otherVector defines the second operand
  82315. * @returns the current updated Vector3
  82316. */
  82317. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82318. /**
  82319. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  82320. * @param otherVector defines the second operand
  82321. * @returns the new Vector3
  82322. */
  82323. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  82324. /**
  82325. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  82326. * @param otherVector defines the second operand
  82327. * @param result defines the Vector3 object where to store the result
  82328. * @returns the current Vector3
  82329. */
  82330. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82331. /**
  82332. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  82333. * @param x defines the x coordinate of the operand
  82334. * @param y defines the y coordinate of the operand
  82335. * @param z defines the z coordinate of the operand
  82336. * @returns the new Vector3
  82337. */
  82338. multiplyByFloats(x: number, y: number, z: number): Vector3;
  82339. /**
  82340. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  82341. * @param otherVector defines the second operand
  82342. * @returns the new Vector3
  82343. */
  82344. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  82345. /**
  82346. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  82347. * @param otherVector defines the second operand
  82348. * @param result defines the Vector3 object where to store the result
  82349. * @returns the current Vector3
  82350. */
  82351. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82352. /**
  82353. * Divides the current Vector3 coordinates by the given ones.
  82354. * @param otherVector defines the second operand
  82355. * @returns the current updated Vector3
  82356. */
  82357. divideInPlace(otherVector: Vector3): Vector3;
  82358. /**
  82359. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  82360. * @param other defines the second operand
  82361. * @returns the current updated Vector3
  82362. */
  82363. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82364. /**
  82365. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  82366. * @param other defines the second operand
  82367. * @returns the current updated Vector3
  82368. */
  82369. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82370. /**
  82371. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  82372. * @param x defines the x coordinate of the operand
  82373. * @param y defines the y coordinate of the operand
  82374. * @param z defines the z coordinate of the operand
  82375. * @returns the current updated Vector3
  82376. */
  82377. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82378. /**
  82379. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  82380. * @param x defines the x coordinate of the operand
  82381. * @param y defines the y coordinate of the operand
  82382. * @param z defines the z coordinate of the operand
  82383. * @returns the current updated Vector3
  82384. */
  82385. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82386. /**
  82387. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  82388. * Check if is non uniform within a certain amount of decimal places to account for this
  82389. * @param epsilon the amount the values can differ
  82390. * @returns if the the vector is non uniform to a certain number of decimal places
  82391. */
  82392. isNonUniformWithinEpsilon(epsilon: number): boolean;
  82393. /**
  82394. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  82395. */
  82396. get isNonUniform(): boolean;
  82397. /**
  82398. * Gets a new Vector3 from current Vector3 floored values
  82399. * @returns a new Vector3
  82400. */
  82401. floor(): Vector3;
  82402. /**
  82403. * Gets a new Vector3 from current Vector3 floored values
  82404. * @returns a new Vector3
  82405. */
  82406. fract(): Vector3;
  82407. /**
  82408. * Gets the length of the Vector3
  82409. * @returns the length of the Vector3
  82410. */
  82411. length(): number;
  82412. /**
  82413. * Gets the squared length of the Vector3
  82414. * @returns squared length of the Vector3
  82415. */
  82416. lengthSquared(): number;
  82417. /**
  82418. * Normalize the current Vector3.
  82419. * Please note that this is an in place operation.
  82420. * @returns the current updated Vector3
  82421. */
  82422. normalize(): Vector3;
  82423. /**
  82424. * Reorders the x y z properties of the vector in place
  82425. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  82426. * @returns the current updated vector
  82427. */
  82428. reorderInPlace(order: string): this;
  82429. /**
  82430. * Rotates the vector around 0,0,0 by a quaternion
  82431. * @param quaternion the rotation quaternion
  82432. * @param result vector to store the result
  82433. * @returns the resulting vector
  82434. */
  82435. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  82436. /**
  82437. * Rotates a vector around a given point
  82438. * @param quaternion the rotation quaternion
  82439. * @param point the point to rotate around
  82440. * @param result vector to store the result
  82441. * @returns the resulting vector
  82442. */
  82443. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  82444. /**
  82445. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  82446. * The cross product is then orthogonal to both current and "other"
  82447. * @param other defines the right operand
  82448. * @returns the cross product
  82449. */
  82450. cross(other: Vector3): Vector3;
  82451. /**
  82452. * Normalize the current Vector3 with the given input length.
  82453. * Please note that this is an in place operation.
  82454. * @param len the length of the vector
  82455. * @returns the current updated Vector3
  82456. */
  82457. normalizeFromLength(len: number): Vector3;
  82458. /**
  82459. * Normalize the current Vector3 to a new vector
  82460. * @returns the new Vector3
  82461. */
  82462. normalizeToNew(): Vector3;
  82463. /**
  82464. * Normalize the current Vector3 to the reference
  82465. * @param reference define the Vector3 to update
  82466. * @returns the updated Vector3
  82467. */
  82468. normalizeToRef(reference: Vector3): Vector3;
  82469. /**
  82470. * Creates a new Vector3 copied from the current Vector3
  82471. * @returns the new Vector3
  82472. */
  82473. clone(): Vector3;
  82474. /**
  82475. * Copies the given vector coordinates to the current Vector3 ones
  82476. * @param source defines the source Vector3
  82477. * @returns the current updated Vector3
  82478. */
  82479. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  82480. /**
  82481. * Copies the given floats to the current Vector3 coordinates
  82482. * @param x defines the x coordinate of the operand
  82483. * @param y defines the y coordinate of the operand
  82484. * @param z defines the z coordinate of the operand
  82485. * @returns the current updated Vector3
  82486. */
  82487. copyFromFloats(x: number, y: number, z: number): Vector3;
  82488. /**
  82489. * Copies the given floats to the current Vector3 coordinates
  82490. * @param x defines the x coordinate of the operand
  82491. * @param y defines the y coordinate of the operand
  82492. * @param z defines the z coordinate of the operand
  82493. * @returns the current updated Vector3
  82494. */
  82495. set(x: number, y: number, z: number): Vector3;
  82496. /**
  82497. * Copies the given float to the current Vector3 coordinates
  82498. * @param v defines the x, y and z coordinates of the operand
  82499. * @returns the current updated Vector3
  82500. */
  82501. setAll(v: number): Vector3;
  82502. /**
  82503. * Get the clip factor between two vectors
  82504. * @param vector0 defines the first operand
  82505. * @param vector1 defines the second operand
  82506. * @param axis defines the axis to use
  82507. * @param size defines the size along the axis
  82508. * @returns the clip factor
  82509. */
  82510. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  82511. /**
  82512. * Get angle between two vectors
  82513. * @param vector0 angle between vector0 and vector1
  82514. * @param vector1 angle between vector0 and vector1
  82515. * @param normal direction of the normal
  82516. * @return the angle between vector0 and vector1
  82517. */
  82518. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  82519. /**
  82520. * Returns a new Vector3 set from the index "offset" of the given array
  82521. * @param array defines the source array
  82522. * @param offset defines the offset in the source array
  82523. * @returns the new Vector3
  82524. */
  82525. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  82526. /**
  82527. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  82528. * @param array defines the source array
  82529. * @param offset defines the offset in the source array
  82530. * @returns the new Vector3
  82531. * @deprecated Please use FromArray instead.
  82532. */
  82533. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  82534. /**
  82535. * Sets the given vector "result" with the element values from the index "offset" of the given array
  82536. * @param array defines the source array
  82537. * @param offset defines the offset in the source array
  82538. * @param result defines the Vector3 where to store the result
  82539. */
  82540. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  82541. /**
  82542. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  82543. * @param array defines the source array
  82544. * @param offset defines the offset in the source array
  82545. * @param result defines the Vector3 where to store the result
  82546. * @deprecated Please use FromArrayToRef instead.
  82547. */
  82548. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  82549. /**
  82550. * Sets the given vector "result" with the given floats.
  82551. * @param x defines the x coordinate of the source
  82552. * @param y defines the y coordinate of the source
  82553. * @param z defines the z coordinate of the source
  82554. * @param result defines the Vector3 where to store the result
  82555. */
  82556. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  82557. /**
  82558. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  82559. * @returns a new empty Vector3
  82560. */
  82561. static Zero(): Vector3;
  82562. /**
  82563. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  82564. * @returns a new unit Vector3
  82565. */
  82566. static One(): Vector3;
  82567. /**
  82568. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  82569. * @returns a new up Vector3
  82570. */
  82571. static Up(): Vector3;
  82572. /**
  82573. * Gets a up Vector3 that must not be updated
  82574. */
  82575. static get UpReadOnly(): DeepImmutable<Vector3>;
  82576. /**
  82577. * Gets a zero Vector3 that must not be updated
  82578. */
  82579. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  82580. /**
  82581. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  82582. * @returns a new down Vector3
  82583. */
  82584. static Down(): Vector3;
  82585. /**
  82586. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  82587. * @param rightHandedSystem is the scene right-handed (negative z)
  82588. * @returns a new forward Vector3
  82589. */
  82590. static Forward(rightHandedSystem?: boolean): Vector3;
  82591. /**
  82592. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  82593. * @param rightHandedSystem is the scene right-handed (negative-z)
  82594. * @returns a new forward Vector3
  82595. */
  82596. static Backward(rightHandedSystem?: boolean): Vector3;
  82597. /**
  82598. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  82599. * @returns a new right Vector3
  82600. */
  82601. static Right(): Vector3;
  82602. /**
  82603. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  82604. * @returns a new left Vector3
  82605. */
  82606. static Left(): Vector3;
  82607. /**
  82608. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  82609. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82610. * @param vector defines the Vector3 to transform
  82611. * @param transformation defines the transformation matrix
  82612. * @returns the transformed Vector3
  82613. */
  82614. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82615. /**
  82616. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  82617. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82618. * @param vector defines the Vector3 to transform
  82619. * @param transformation defines the transformation matrix
  82620. * @param result defines the Vector3 where to store the result
  82621. */
  82622. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82623. /**
  82624. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  82625. * This method computes tranformed coordinates only, not transformed direction vectors
  82626. * @param x define the x coordinate of the source vector
  82627. * @param y define the y coordinate of the source vector
  82628. * @param z define the z coordinate of the source vector
  82629. * @param transformation defines the transformation matrix
  82630. * @param result defines the Vector3 where to store the result
  82631. */
  82632. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82633. /**
  82634. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  82635. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82636. * @param vector defines the Vector3 to transform
  82637. * @param transformation defines the transformation matrix
  82638. * @returns the new Vector3
  82639. */
  82640. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82641. /**
  82642. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  82643. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82644. * @param vector defines the Vector3 to transform
  82645. * @param transformation defines the transformation matrix
  82646. * @param result defines the Vector3 where to store the result
  82647. */
  82648. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82649. /**
  82650. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  82651. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82652. * @param x define the x coordinate of the source vector
  82653. * @param y define the y coordinate of the source vector
  82654. * @param z define the z coordinate of the source vector
  82655. * @param transformation defines the transformation matrix
  82656. * @param result defines the Vector3 where to store the result
  82657. */
  82658. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82659. /**
  82660. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  82661. * @param value1 defines the first control point
  82662. * @param value2 defines the second control point
  82663. * @param value3 defines the third control point
  82664. * @param value4 defines the fourth control point
  82665. * @param amount defines the amount on the spline to use
  82666. * @returns the new Vector3
  82667. */
  82668. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  82669. /**
  82670. * 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"
  82671. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82672. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82673. * @param value defines the current value
  82674. * @param min defines the lower range value
  82675. * @param max defines the upper range value
  82676. * @returns the new Vector3
  82677. */
  82678. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  82679. /**
  82680. * 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"
  82681. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82682. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82683. * @param value defines the current value
  82684. * @param min defines the lower range value
  82685. * @param max defines the upper range value
  82686. * @param result defines the Vector3 where to store the result
  82687. */
  82688. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  82689. /**
  82690. * Checks if a given vector is inside a specific range
  82691. * @param v defines the vector to test
  82692. * @param min defines the minimum range
  82693. * @param max defines the maximum range
  82694. */
  82695. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  82696. /**
  82697. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  82698. * @param value1 defines the first control point
  82699. * @param tangent1 defines the first tangent vector
  82700. * @param value2 defines the second control point
  82701. * @param tangent2 defines the second tangent vector
  82702. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  82703. * @returns the new Vector3
  82704. */
  82705. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  82706. /**
  82707. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  82708. * @param start defines the start value
  82709. * @param end defines the end value
  82710. * @param amount max defines amount between both (between 0 and 1)
  82711. * @returns the new Vector3
  82712. */
  82713. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  82714. /**
  82715. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  82716. * @param start defines the start value
  82717. * @param end defines the end value
  82718. * @param amount max defines amount between both (between 0 and 1)
  82719. * @param result defines the Vector3 where to store the result
  82720. */
  82721. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  82722. /**
  82723. * Returns the dot product (float) between the vectors "left" and "right"
  82724. * @param left defines the left operand
  82725. * @param right defines the right operand
  82726. * @returns the dot product
  82727. */
  82728. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  82729. /**
  82730. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  82731. * The cross product is then orthogonal to both "left" and "right"
  82732. * @param left defines the left operand
  82733. * @param right defines the right operand
  82734. * @returns the cross product
  82735. */
  82736. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82737. /**
  82738. * Sets the given vector "result" with the cross product of "left" and "right"
  82739. * The cross product is then orthogonal to both "left" and "right"
  82740. * @param left defines the left operand
  82741. * @param right defines the right operand
  82742. * @param result defines the Vector3 where to store the result
  82743. */
  82744. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  82745. /**
  82746. * Returns a new Vector3 as the normalization of the given vector
  82747. * @param vector defines the Vector3 to normalize
  82748. * @returns the new Vector3
  82749. */
  82750. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  82751. /**
  82752. * Sets the given vector "result" with the normalization of the given first vector
  82753. * @param vector defines the Vector3 to normalize
  82754. * @param result defines the Vector3 where to store the result
  82755. */
  82756. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  82757. /**
  82758. * Project a Vector3 onto screen space
  82759. * @param vector defines the Vector3 to project
  82760. * @param world defines the world matrix to use
  82761. * @param transform defines the transform (view x projection) matrix to use
  82762. * @param viewport defines the screen viewport to use
  82763. * @returns the new Vector3
  82764. */
  82765. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  82766. /** @hidden */
  82767. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  82768. /**
  82769. * Unproject from screen space to object space
  82770. * @param source defines the screen space Vector3 to use
  82771. * @param viewportWidth defines the current width of the viewport
  82772. * @param viewportHeight defines the current height of the viewport
  82773. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82774. * @param transform defines the transform (view x projection) matrix to use
  82775. * @returns the new Vector3
  82776. */
  82777. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  82778. /**
  82779. * Unproject from screen space to object space
  82780. * @param source defines the screen space Vector3 to use
  82781. * @param viewportWidth defines the current width of the viewport
  82782. * @param viewportHeight defines the current height of the viewport
  82783. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82784. * @param view defines the view matrix to use
  82785. * @param projection defines the projection matrix to use
  82786. * @returns the new Vector3
  82787. */
  82788. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  82789. /**
  82790. * Unproject from screen space to object space
  82791. * @param source defines the screen space Vector3 to use
  82792. * @param viewportWidth defines the current width of the viewport
  82793. * @param viewportHeight defines the current height of the viewport
  82794. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82795. * @param view defines the view matrix to use
  82796. * @param projection defines the projection matrix to use
  82797. * @param result defines the Vector3 where to store the result
  82798. */
  82799. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82800. /**
  82801. * Unproject from screen space to object space
  82802. * @param sourceX defines the screen space x coordinate to use
  82803. * @param sourceY defines the screen space y coordinate to use
  82804. * @param sourceZ defines the screen space z coordinate to use
  82805. * @param viewportWidth defines the current width of the viewport
  82806. * @param viewportHeight defines the current height of the viewport
  82807. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82808. * @param view defines the view matrix to use
  82809. * @param projection defines the projection matrix to use
  82810. * @param result defines the Vector3 where to store the result
  82811. */
  82812. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82813. /**
  82814. * Gets the minimal coordinate values between two Vector3
  82815. * @param left defines the first operand
  82816. * @param right defines the second operand
  82817. * @returns the new Vector3
  82818. */
  82819. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82820. /**
  82821. * Gets the maximal coordinate values between two Vector3
  82822. * @param left defines the first operand
  82823. * @param right defines the second operand
  82824. * @returns the new Vector3
  82825. */
  82826. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82827. /**
  82828. * Returns the distance between the vectors "value1" and "value2"
  82829. * @param value1 defines the first operand
  82830. * @param value2 defines the second operand
  82831. * @returns the distance
  82832. */
  82833. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82834. /**
  82835. * Returns the squared distance between the vectors "value1" and "value2"
  82836. * @param value1 defines the first operand
  82837. * @param value2 defines the second operand
  82838. * @returns the squared distance
  82839. */
  82840. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82841. /**
  82842. * Returns a new Vector3 located at the center between "value1" and "value2"
  82843. * @param value1 defines the first operand
  82844. * @param value2 defines the second operand
  82845. * @returns the new Vector3
  82846. */
  82847. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  82848. /**
  82849. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  82850. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  82851. * to something in order to rotate it from its local system to the given target system
  82852. * Note: axis1, axis2 and axis3 are normalized during this operation
  82853. * @param axis1 defines the first axis
  82854. * @param axis2 defines the second axis
  82855. * @param axis3 defines the third axis
  82856. * @returns a new Vector3
  82857. */
  82858. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  82859. /**
  82860. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  82861. * @param axis1 defines the first axis
  82862. * @param axis2 defines the second axis
  82863. * @param axis3 defines the third axis
  82864. * @param ref defines the Vector3 where to store the result
  82865. */
  82866. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  82867. }
  82868. /**
  82869. * Vector4 class created for EulerAngle class conversion to Quaternion
  82870. */
  82871. export class Vector4 {
  82872. /** x value of the vector */
  82873. x: number;
  82874. /** y value of the vector */
  82875. y: number;
  82876. /** z value of the vector */
  82877. z: number;
  82878. /** w value of the vector */
  82879. w: number;
  82880. /**
  82881. * Creates a Vector4 object from the given floats.
  82882. * @param x x value of the vector
  82883. * @param y y value of the vector
  82884. * @param z z value of the vector
  82885. * @param w w value of the vector
  82886. */
  82887. constructor(
  82888. /** x value of the vector */
  82889. x: number,
  82890. /** y value of the vector */
  82891. y: number,
  82892. /** z value of the vector */
  82893. z: number,
  82894. /** w value of the vector */
  82895. w: number);
  82896. /**
  82897. * Returns the string with the Vector4 coordinates.
  82898. * @returns a string containing all the vector values
  82899. */
  82900. toString(): string;
  82901. /**
  82902. * Returns the string "Vector4".
  82903. * @returns "Vector4"
  82904. */
  82905. getClassName(): string;
  82906. /**
  82907. * Returns the Vector4 hash code.
  82908. * @returns a unique hash code
  82909. */
  82910. getHashCode(): number;
  82911. /**
  82912. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  82913. * @returns the resulting array
  82914. */
  82915. asArray(): number[];
  82916. /**
  82917. * Populates the given array from the given index with the Vector4 coordinates.
  82918. * @param array array to populate
  82919. * @param index index of the array to start at (default: 0)
  82920. * @returns the Vector4.
  82921. */
  82922. toArray(array: FloatArray, index?: number): Vector4;
  82923. /**
  82924. * Update the current vector from an array
  82925. * @param array defines the destination array
  82926. * @param index defines the offset in the destination array
  82927. * @returns the current Vector3
  82928. */
  82929. fromArray(array: FloatArray, index?: number): Vector4;
  82930. /**
  82931. * Adds the given vector to the current Vector4.
  82932. * @param otherVector the vector to add
  82933. * @returns the updated Vector4.
  82934. */
  82935. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82936. /**
  82937. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  82938. * @param otherVector the vector to add
  82939. * @returns the resulting vector
  82940. */
  82941. add(otherVector: DeepImmutable<Vector4>): Vector4;
  82942. /**
  82943. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  82944. * @param otherVector the vector to add
  82945. * @param result the vector to store the result
  82946. * @returns the current Vector4.
  82947. */
  82948. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82949. /**
  82950. * Subtract in place the given vector from the current Vector4.
  82951. * @param otherVector the vector to subtract
  82952. * @returns the updated Vector4.
  82953. */
  82954. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82955. /**
  82956. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  82957. * @param otherVector the vector to add
  82958. * @returns the new vector with the result
  82959. */
  82960. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  82961. /**
  82962. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  82963. * @param otherVector the vector to subtract
  82964. * @param result the vector to store the result
  82965. * @returns the current Vector4.
  82966. */
  82967. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82968. /**
  82969. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82970. */
  82971. /**
  82972. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82973. * @param x value to subtract
  82974. * @param y value to subtract
  82975. * @param z value to subtract
  82976. * @param w value to subtract
  82977. * @returns new vector containing the result
  82978. */
  82979. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  82980. /**
  82981. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82982. * @param x value to subtract
  82983. * @param y value to subtract
  82984. * @param z value to subtract
  82985. * @param w value to subtract
  82986. * @param result the vector to store the result in
  82987. * @returns the current Vector4.
  82988. */
  82989. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  82990. /**
  82991. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  82992. * @returns a new vector with the negated values
  82993. */
  82994. negate(): Vector4;
  82995. /**
  82996. * Negate this vector in place
  82997. * @returns this
  82998. */
  82999. negateInPlace(): Vector4;
  83000. /**
  83001. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  83002. * @param result defines the Vector3 object where to store the result
  83003. * @returns the current Vector4
  83004. */
  83005. negateToRef(result: Vector4): Vector4;
  83006. /**
  83007. * Multiplies the current Vector4 coordinates by scale (float).
  83008. * @param scale the number to scale with
  83009. * @returns the updated Vector4.
  83010. */
  83011. scaleInPlace(scale: number): Vector4;
  83012. /**
  83013. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  83014. * @param scale the number to scale with
  83015. * @returns a new vector with the result
  83016. */
  83017. scale(scale: number): Vector4;
  83018. /**
  83019. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  83020. * @param scale the number to scale with
  83021. * @param result a vector to store the result in
  83022. * @returns the current Vector4.
  83023. */
  83024. scaleToRef(scale: number, result: Vector4): Vector4;
  83025. /**
  83026. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  83027. * @param scale defines the scale factor
  83028. * @param result defines the Vector4 object where to store the result
  83029. * @returns the unmodified current Vector4
  83030. */
  83031. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  83032. /**
  83033. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  83034. * @param otherVector the vector to compare against
  83035. * @returns true if they are equal
  83036. */
  83037. equals(otherVector: DeepImmutable<Vector4>): boolean;
  83038. /**
  83039. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  83040. * @param otherVector vector to compare against
  83041. * @param epsilon (Default: very small number)
  83042. * @returns true if they are equal
  83043. */
  83044. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  83045. /**
  83046. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  83047. * @param x x value to compare against
  83048. * @param y y value to compare against
  83049. * @param z z value to compare against
  83050. * @param w w value to compare against
  83051. * @returns true if equal
  83052. */
  83053. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  83054. /**
  83055. * Multiplies in place the current Vector4 by the given one.
  83056. * @param otherVector vector to multiple with
  83057. * @returns the updated Vector4.
  83058. */
  83059. multiplyInPlace(otherVector: Vector4): Vector4;
  83060. /**
  83061. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  83062. * @param otherVector vector to multiple with
  83063. * @returns resulting new vector
  83064. */
  83065. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  83066. /**
  83067. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  83068. * @param otherVector vector to multiple with
  83069. * @param result vector to store the result
  83070. * @returns the current Vector4.
  83071. */
  83072. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83073. /**
  83074. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  83075. * @param x x value multiply with
  83076. * @param y y value multiply with
  83077. * @param z z value multiply with
  83078. * @param w w value multiply with
  83079. * @returns resulting new vector
  83080. */
  83081. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  83082. /**
  83083. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  83084. * @param otherVector vector to devide with
  83085. * @returns resulting new vector
  83086. */
  83087. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  83088. /**
  83089. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  83090. * @param otherVector vector to devide with
  83091. * @param result vector to store the result
  83092. * @returns the current Vector4.
  83093. */
  83094. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83095. /**
  83096. * Divides the current Vector3 coordinates by the given ones.
  83097. * @param otherVector vector to devide with
  83098. * @returns the updated Vector3.
  83099. */
  83100. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83101. /**
  83102. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  83103. * @param other defines the second operand
  83104. * @returns the current updated Vector4
  83105. */
  83106. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83107. /**
  83108. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  83109. * @param other defines the second operand
  83110. * @returns the current updated Vector4
  83111. */
  83112. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83113. /**
  83114. * Gets a new Vector4 from current Vector4 floored values
  83115. * @returns a new Vector4
  83116. */
  83117. floor(): Vector4;
  83118. /**
  83119. * Gets a new Vector4 from current Vector3 floored values
  83120. * @returns a new Vector4
  83121. */
  83122. fract(): Vector4;
  83123. /**
  83124. * Returns the Vector4 length (float).
  83125. * @returns the length
  83126. */
  83127. length(): number;
  83128. /**
  83129. * Returns the Vector4 squared length (float).
  83130. * @returns the length squared
  83131. */
  83132. lengthSquared(): number;
  83133. /**
  83134. * Normalizes in place the Vector4.
  83135. * @returns the updated Vector4.
  83136. */
  83137. normalize(): Vector4;
  83138. /**
  83139. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  83140. * @returns this converted to a new vector3
  83141. */
  83142. toVector3(): Vector3;
  83143. /**
  83144. * Returns a new Vector4 copied from the current one.
  83145. * @returns the new cloned vector
  83146. */
  83147. clone(): Vector4;
  83148. /**
  83149. * Updates the current Vector4 with the given one coordinates.
  83150. * @param source the source vector to copy from
  83151. * @returns the updated Vector4.
  83152. */
  83153. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  83154. /**
  83155. * Updates the current Vector4 coordinates with the given floats.
  83156. * @param x float to copy from
  83157. * @param y float to copy from
  83158. * @param z float to copy from
  83159. * @param w float to copy from
  83160. * @returns the updated Vector4.
  83161. */
  83162. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83163. /**
  83164. * Updates the current Vector4 coordinates with the given floats.
  83165. * @param x float to set from
  83166. * @param y float to set from
  83167. * @param z float to set from
  83168. * @param w float to set from
  83169. * @returns the updated Vector4.
  83170. */
  83171. set(x: number, y: number, z: number, w: number): Vector4;
  83172. /**
  83173. * Copies the given float to the current Vector3 coordinates
  83174. * @param v defines the x, y, z and w coordinates of the operand
  83175. * @returns the current updated Vector3
  83176. */
  83177. setAll(v: number): Vector4;
  83178. /**
  83179. * Returns a new Vector4 set from the starting index of the given array.
  83180. * @param array the array to pull values from
  83181. * @param offset the offset into the array to start at
  83182. * @returns the new vector
  83183. */
  83184. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  83185. /**
  83186. * Updates the given vector "result" from the starting index of the given array.
  83187. * @param array the array to pull values from
  83188. * @param offset the offset into the array to start at
  83189. * @param result the vector to store the result in
  83190. */
  83191. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  83192. /**
  83193. * Updates the given vector "result" from the starting index of the given Float32Array.
  83194. * @param array the array to pull values from
  83195. * @param offset the offset into the array to start at
  83196. * @param result the vector to store the result in
  83197. */
  83198. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  83199. /**
  83200. * Updates the given vector "result" coordinates from the given floats.
  83201. * @param x float to set from
  83202. * @param y float to set from
  83203. * @param z float to set from
  83204. * @param w float to set from
  83205. * @param result the vector to the floats in
  83206. */
  83207. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  83208. /**
  83209. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  83210. * @returns the new vector
  83211. */
  83212. static Zero(): Vector4;
  83213. /**
  83214. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  83215. * @returns the new vector
  83216. */
  83217. static One(): Vector4;
  83218. /**
  83219. * Returns a new normalized Vector4 from the given one.
  83220. * @param vector the vector to normalize
  83221. * @returns the vector
  83222. */
  83223. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  83224. /**
  83225. * Updates the given vector "result" from the normalization of the given one.
  83226. * @param vector the vector to normalize
  83227. * @param result the vector to store the result in
  83228. */
  83229. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  83230. /**
  83231. * Returns a vector with the minimum values from the left and right vectors
  83232. * @param left left vector to minimize
  83233. * @param right right vector to minimize
  83234. * @returns a new vector with the minimum of the left and right vector values
  83235. */
  83236. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83237. /**
  83238. * Returns a vector with the maximum values from the left and right vectors
  83239. * @param left left vector to maximize
  83240. * @param right right vector to maximize
  83241. * @returns a new vector with the maximum of the left and right vector values
  83242. */
  83243. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83244. /**
  83245. * Returns the distance (float) between the vectors "value1" and "value2".
  83246. * @param value1 value to calulate the distance between
  83247. * @param value2 value to calulate the distance between
  83248. * @return the distance between the two vectors
  83249. */
  83250. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83251. /**
  83252. * Returns the squared distance (float) between the vectors "value1" and "value2".
  83253. * @param value1 value to calulate the distance between
  83254. * @param value2 value to calulate the distance between
  83255. * @return the distance between the two vectors squared
  83256. */
  83257. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83258. /**
  83259. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  83260. * @param value1 value to calulate the center between
  83261. * @param value2 value to calulate the center between
  83262. * @return the center between the two vectors
  83263. */
  83264. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  83265. /**
  83266. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  83267. * This methods computes transformed normalized direction vectors only.
  83268. * @param vector the vector to transform
  83269. * @param transformation the transformation matrix to apply
  83270. * @returns the new vector
  83271. */
  83272. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  83273. /**
  83274. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  83275. * This methods computes transformed normalized direction vectors only.
  83276. * @param vector the vector to transform
  83277. * @param transformation the transformation matrix to apply
  83278. * @param result the vector to store the result in
  83279. */
  83280. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83281. /**
  83282. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  83283. * This methods computes transformed normalized direction vectors only.
  83284. * @param x value to transform
  83285. * @param y value to transform
  83286. * @param z value to transform
  83287. * @param w value to transform
  83288. * @param transformation the transformation matrix to apply
  83289. * @param result the vector to store the results in
  83290. */
  83291. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83292. /**
  83293. * Creates a new Vector4 from a Vector3
  83294. * @param source defines the source data
  83295. * @param w defines the 4th component (default is 0)
  83296. * @returns a new Vector4
  83297. */
  83298. static FromVector3(source: Vector3, w?: number): Vector4;
  83299. }
  83300. /**
  83301. * Class used to store quaternion data
  83302. * @see https://en.wikipedia.org/wiki/Quaternion
  83303. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  83304. */
  83305. export class Quaternion {
  83306. /** @hidden */
  83307. _x: number;
  83308. /** @hidden */
  83309. _y: number;
  83310. /** @hidden */
  83311. _z: number;
  83312. /** @hidden */
  83313. _w: number;
  83314. /** @hidden */
  83315. _isDirty: boolean;
  83316. /** Gets or sets the x coordinate */
  83317. get x(): number;
  83318. set x(value: number);
  83319. /** Gets or sets the y coordinate */
  83320. get y(): number;
  83321. set y(value: number);
  83322. /** Gets or sets the z coordinate */
  83323. get z(): number;
  83324. set z(value: number);
  83325. /** Gets or sets the w coordinate */
  83326. get w(): number;
  83327. set w(value: number);
  83328. /**
  83329. * Creates a new Quaternion from the given floats
  83330. * @param x defines the first component (0 by default)
  83331. * @param y defines the second component (0 by default)
  83332. * @param z defines the third component (0 by default)
  83333. * @param w defines the fourth component (1.0 by default)
  83334. */
  83335. constructor(x?: number, y?: number, z?: number, w?: number);
  83336. /**
  83337. * Gets a string representation for the current quaternion
  83338. * @returns a string with the Quaternion coordinates
  83339. */
  83340. toString(): string;
  83341. /**
  83342. * Gets the class name of the quaternion
  83343. * @returns the string "Quaternion"
  83344. */
  83345. getClassName(): string;
  83346. /**
  83347. * Gets a hash code for this quaternion
  83348. * @returns the quaternion hash code
  83349. */
  83350. getHashCode(): number;
  83351. /**
  83352. * Copy the quaternion to an array
  83353. * @returns a new array populated with 4 elements from the quaternion coordinates
  83354. */
  83355. asArray(): number[];
  83356. /**
  83357. * Check if two quaternions are equals
  83358. * @param otherQuaternion defines the second operand
  83359. * @return true if the current quaternion and the given one coordinates are strictly equals
  83360. */
  83361. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  83362. /**
  83363. * Gets a boolean if two quaternions are equals (using an epsilon value)
  83364. * @param otherQuaternion defines the other quaternion
  83365. * @param epsilon defines the minimal distance to consider equality
  83366. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  83367. */
  83368. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  83369. /**
  83370. * Clone the current quaternion
  83371. * @returns a new quaternion copied from the current one
  83372. */
  83373. clone(): Quaternion;
  83374. /**
  83375. * Copy a quaternion to the current one
  83376. * @param other defines the other quaternion
  83377. * @returns the updated current quaternion
  83378. */
  83379. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  83380. /**
  83381. * Updates the current quaternion with the given float coordinates
  83382. * @param x defines the x coordinate
  83383. * @param y defines the y coordinate
  83384. * @param z defines the z coordinate
  83385. * @param w defines the w coordinate
  83386. * @returns the updated current quaternion
  83387. */
  83388. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  83389. /**
  83390. * Updates the current quaternion from the given float coordinates
  83391. * @param x defines the x coordinate
  83392. * @param y defines the y coordinate
  83393. * @param z defines the z coordinate
  83394. * @param w defines the w coordinate
  83395. * @returns the updated current quaternion
  83396. */
  83397. set(x: number, y: number, z: number, w: number): Quaternion;
  83398. /**
  83399. * Adds two quaternions
  83400. * @param other defines the second operand
  83401. * @returns a new quaternion as the addition result of the given one and the current quaternion
  83402. */
  83403. add(other: DeepImmutable<Quaternion>): Quaternion;
  83404. /**
  83405. * Add a quaternion to the current one
  83406. * @param other defines the quaternion to add
  83407. * @returns the current quaternion
  83408. */
  83409. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  83410. /**
  83411. * Subtract two quaternions
  83412. * @param other defines the second operand
  83413. * @returns a new quaternion as the subtraction result of the given one from the current one
  83414. */
  83415. subtract(other: Quaternion): Quaternion;
  83416. /**
  83417. * Multiplies the current quaternion by a scale factor
  83418. * @param value defines the scale factor
  83419. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  83420. */
  83421. scale(value: number): Quaternion;
  83422. /**
  83423. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  83424. * @param scale defines the scale factor
  83425. * @param result defines the Quaternion object where to store the result
  83426. * @returns the unmodified current quaternion
  83427. */
  83428. scaleToRef(scale: number, result: Quaternion): Quaternion;
  83429. /**
  83430. * Multiplies in place the current quaternion by a scale factor
  83431. * @param value defines the scale factor
  83432. * @returns the current modified quaternion
  83433. */
  83434. scaleInPlace(value: number): Quaternion;
  83435. /**
  83436. * Scale the current quaternion values by a factor and add the result to a given quaternion
  83437. * @param scale defines the scale factor
  83438. * @param result defines the Quaternion object where to store the result
  83439. * @returns the unmodified current quaternion
  83440. */
  83441. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  83442. /**
  83443. * Multiplies two quaternions
  83444. * @param q1 defines the second operand
  83445. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  83446. */
  83447. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  83448. /**
  83449. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  83450. * @param q1 defines the second operand
  83451. * @param result defines the target quaternion
  83452. * @returns the current quaternion
  83453. */
  83454. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  83455. /**
  83456. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  83457. * @param q1 defines the second operand
  83458. * @returns the currentupdated quaternion
  83459. */
  83460. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  83461. /**
  83462. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  83463. * @param ref defines the target quaternion
  83464. * @returns the current quaternion
  83465. */
  83466. conjugateToRef(ref: Quaternion): Quaternion;
  83467. /**
  83468. * Conjugates in place (1-q) the current quaternion
  83469. * @returns the current updated quaternion
  83470. */
  83471. conjugateInPlace(): Quaternion;
  83472. /**
  83473. * Conjugates in place (1-q) the current quaternion
  83474. * @returns a new quaternion
  83475. */
  83476. conjugate(): Quaternion;
  83477. /**
  83478. * Gets length of current quaternion
  83479. * @returns the quaternion length (float)
  83480. */
  83481. length(): number;
  83482. /**
  83483. * Normalize in place the current quaternion
  83484. * @returns the current updated quaternion
  83485. */
  83486. normalize(): Quaternion;
  83487. /**
  83488. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  83489. * @param order is a reserved parameter and is ignore for now
  83490. * @returns a new Vector3 containing the Euler angles
  83491. */
  83492. toEulerAngles(order?: string): Vector3;
  83493. /**
  83494. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  83495. * @param result defines the vector which will be filled with the Euler angles
  83496. * @param order is a reserved parameter and is ignore for now
  83497. * @returns the current unchanged quaternion
  83498. */
  83499. toEulerAnglesToRef(result: Vector3): Quaternion;
  83500. /**
  83501. * Updates the given rotation matrix with the current quaternion values
  83502. * @param result defines the target matrix
  83503. * @returns the current unchanged quaternion
  83504. */
  83505. toRotationMatrix(result: Matrix): Quaternion;
  83506. /**
  83507. * Updates the current quaternion from the given rotation matrix values
  83508. * @param matrix defines the source matrix
  83509. * @returns the current updated quaternion
  83510. */
  83511. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83512. /**
  83513. * Creates a new quaternion from a rotation matrix
  83514. * @param matrix defines the source matrix
  83515. * @returns a new quaternion created from the given rotation matrix values
  83516. */
  83517. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83518. /**
  83519. * Updates the given quaternion with the given rotation matrix values
  83520. * @param matrix defines the source matrix
  83521. * @param result defines the target quaternion
  83522. */
  83523. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  83524. /**
  83525. * Returns the dot product (float) between the quaternions "left" and "right"
  83526. * @param left defines the left operand
  83527. * @param right defines the right operand
  83528. * @returns the dot product
  83529. */
  83530. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  83531. /**
  83532. * Checks if the two quaternions are close to each other
  83533. * @param quat0 defines the first quaternion to check
  83534. * @param quat1 defines the second quaternion to check
  83535. * @returns true if the two quaternions are close to each other
  83536. */
  83537. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  83538. /**
  83539. * Creates an empty quaternion
  83540. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  83541. */
  83542. static Zero(): Quaternion;
  83543. /**
  83544. * Inverse a given quaternion
  83545. * @param q defines the source quaternion
  83546. * @returns a new quaternion as the inverted current quaternion
  83547. */
  83548. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  83549. /**
  83550. * Inverse a given quaternion
  83551. * @param q defines the source quaternion
  83552. * @param result the quaternion the result will be stored in
  83553. * @returns the result quaternion
  83554. */
  83555. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  83556. /**
  83557. * Creates an identity quaternion
  83558. * @returns the identity quaternion
  83559. */
  83560. static Identity(): Quaternion;
  83561. /**
  83562. * Gets a boolean indicating if the given quaternion is identity
  83563. * @param quaternion defines the quaternion to check
  83564. * @returns true if the quaternion is identity
  83565. */
  83566. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  83567. /**
  83568. * Creates a quaternion from a rotation around an axis
  83569. * @param axis defines the axis to use
  83570. * @param angle defines the angle to use
  83571. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  83572. */
  83573. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  83574. /**
  83575. * Creates a rotation around an axis and stores it into the given quaternion
  83576. * @param axis defines the axis to use
  83577. * @param angle defines the angle to use
  83578. * @param result defines the target quaternion
  83579. * @returns the target quaternion
  83580. */
  83581. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  83582. /**
  83583. * Creates a new quaternion from data stored into an array
  83584. * @param array defines the data source
  83585. * @param offset defines the offset in the source array where the data starts
  83586. * @returns a new quaternion
  83587. */
  83588. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  83589. /**
  83590. * Updates the given quaternion "result" from the starting index of the given array.
  83591. * @param array the array to pull values from
  83592. * @param offset the offset into the array to start at
  83593. * @param result the quaternion to store the result in
  83594. */
  83595. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  83596. /**
  83597. * Create a quaternion from Euler rotation angles
  83598. * @param x Pitch
  83599. * @param y Yaw
  83600. * @param z Roll
  83601. * @returns the new Quaternion
  83602. */
  83603. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  83604. /**
  83605. * Updates a quaternion from Euler rotation angles
  83606. * @param x Pitch
  83607. * @param y Yaw
  83608. * @param z Roll
  83609. * @param result the quaternion to store the result
  83610. * @returns the updated quaternion
  83611. */
  83612. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  83613. /**
  83614. * Create a quaternion from Euler rotation vector
  83615. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83616. * @returns the new Quaternion
  83617. */
  83618. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  83619. /**
  83620. * Updates a quaternion from Euler rotation vector
  83621. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83622. * @param result the quaternion to store the result
  83623. * @returns the updated quaternion
  83624. */
  83625. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  83626. /**
  83627. * Creates a new quaternion from the given Euler float angles (y, x, z)
  83628. * @param yaw defines the rotation around Y axis
  83629. * @param pitch defines the rotation around X axis
  83630. * @param roll defines the rotation around Z axis
  83631. * @returns the new quaternion
  83632. */
  83633. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  83634. /**
  83635. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  83636. * @param yaw defines the rotation around Y axis
  83637. * @param pitch defines the rotation around X axis
  83638. * @param roll defines the rotation around Z axis
  83639. * @param result defines the target quaternion
  83640. */
  83641. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  83642. /**
  83643. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  83644. * @param alpha defines the rotation around first axis
  83645. * @param beta defines the rotation around second axis
  83646. * @param gamma defines the rotation around third axis
  83647. * @returns the new quaternion
  83648. */
  83649. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  83650. /**
  83651. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  83652. * @param alpha defines the rotation around first axis
  83653. * @param beta defines the rotation around second axis
  83654. * @param gamma defines the rotation around third axis
  83655. * @param result defines the target quaternion
  83656. */
  83657. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  83658. /**
  83659. * 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)
  83660. * @param axis1 defines the first axis
  83661. * @param axis2 defines the second axis
  83662. * @param axis3 defines the third axis
  83663. * @returns the new quaternion
  83664. */
  83665. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  83666. /**
  83667. * 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
  83668. * @param axis1 defines the first axis
  83669. * @param axis2 defines the second axis
  83670. * @param axis3 defines the third axis
  83671. * @param ref defines the target quaternion
  83672. */
  83673. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  83674. /**
  83675. * Interpolates between two quaternions
  83676. * @param left defines first quaternion
  83677. * @param right defines second quaternion
  83678. * @param amount defines the gradient to use
  83679. * @returns the new interpolated quaternion
  83680. */
  83681. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83682. /**
  83683. * Interpolates between two quaternions and stores it into a target quaternion
  83684. * @param left defines first quaternion
  83685. * @param right defines second quaternion
  83686. * @param amount defines the gradient to use
  83687. * @param result defines the target quaternion
  83688. */
  83689. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  83690. /**
  83691. * Interpolate between two quaternions using Hermite interpolation
  83692. * @param value1 defines first quaternion
  83693. * @param tangent1 defines the incoming tangent
  83694. * @param value2 defines second quaternion
  83695. * @param tangent2 defines the outgoing tangent
  83696. * @param amount defines the target quaternion
  83697. * @returns the new interpolated quaternion
  83698. */
  83699. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83700. }
  83701. /**
  83702. * Class used to store matrix data (4x4)
  83703. */
  83704. export class Matrix {
  83705. /**
  83706. * Gets the precision of matrix computations
  83707. */
  83708. static get Use64Bits(): boolean;
  83709. private static _updateFlagSeed;
  83710. private static _identityReadOnly;
  83711. private _isIdentity;
  83712. private _isIdentityDirty;
  83713. private _isIdentity3x2;
  83714. private _isIdentity3x2Dirty;
  83715. /**
  83716. * Gets the update flag of the matrix which is an unique number for the matrix.
  83717. * It will be incremented every time the matrix data change.
  83718. * You can use it to speed the comparison between two versions of the same matrix.
  83719. */
  83720. updateFlag: number;
  83721. private readonly _m;
  83722. /**
  83723. * Gets the internal data of the matrix
  83724. */
  83725. get m(): DeepImmutable<Float32Array | Array<number>>;
  83726. /** @hidden */
  83727. _markAsUpdated(): void;
  83728. /** @hidden */
  83729. private _updateIdentityStatus;
  83730. /**
  83731. * Creates an empty matrix (filled with zeros)
  83732. */
  83733. constructor();
  83734. /**
  83735. * Check if the current matrix is identity
  83736. * @returns true is the matrix is the identity matrix
  83737. */
  83738. isIdentity(): boolean;
  83739. /**
  83740. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  83741. * @returns true is the matrix is the identity matrix
  83742. */
  83743. isIdentityAs3x2(): boolean;
  83744. /**
  83745. * Gets the determinant of the matrix
  83746. * @returns the matrix determinant
  83747. */
  83748. determinant(): number;
  83749. /**
  83750. * Returns the matrix as a Float32Array or Array<number>
  83751. * @returns the matrix underlying array
  83752. */
  83753. toArray(): DeepImmutable<Float32Array | Array<number>>;
  83754. /**
  83755. * Returns the matrix as a Float32Array or Array<number>
  83756. * @returns the matrix underlying array.
  83757. */
  83758. asArray(): DeepImmutable<Float32Array | Array<number>>;
  83759. /**
  83760. * Inverts the current matrix in place
  83761. * @returns the current inverted matrix
  83762. */
  83763. invert(): Matrix;
  83764. /**
  83765. * Sets all the matrix elements to zero
  83766. * @returns the current matrix
  83767. */
  83768. reset(): Matrix;
  83769. /**
  83770. * Adds the current matrix with a second one
  83771. * @param other defines the matrix to add
  83772. * @returns a new matrix as the addition of the current matrix and the given one
  83773. */
  83774. add(other: DeepImmutable<Matrix>): Matrix;
  83775. /**
  83776. * Sets the given matrix "result" to the addition of the current matrix and the given one
  83777. * @param other defines the matrix to add
  83778. * @param result defines the target matrix
  83779. * @returns the current matrix
  83780. */
  83781. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83782. /**
  83783. * Adds in place the given matrix to the current matrix
  83784. * @param other defines the second operand
  83785. * @returns the current updated matrix
  83786. */
  83787. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  83788. /**
  83789. * Sets the given matrix to the current inverted Matrix
  83790. * @param other defines the target matrix
  83791. * @returns the unmodified current matrix
  83792. */
  83793. invertToRef(other: Matrix): Matrix;
  83794. /**
  83795. * add a value at the specified position in the current Matrix
  83796. * @param index the index of the value within the matrix. between 0 and 15.
  83797. * @param value the value to be added
  83798. * @returns the current updated matrix
  83799. */
  83800. addAtIndex(index: number, value: number): Matrix;
  83801. /**
  83802. * mutiply the specified position in the current Matrix by a value
  83803. * @param index the index of the value within the matrix. between 0 and 15.
  83804. * @param value the value to be added
  83805. * @returns the current updated matrix
  83806. */
  83807. multiplyAtIndex(index: number, value: number): Matrix;
  83808. /**
  83809. * Inserts the translation vector (using 3 floats) in the current matrix
  83810. * @param x defines the 1st component of the translation
  83811. * @param y defines the 2nd component of the translation
  83812. * @param z defines the 3rd component of the translation
  83813. * @returns the current updated matrix
  83814. */
  83815. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83816. /**
  83817. * Adds the translation vector (using 3 floats) in the current matrix
  83818. * @param x defines the 1st component of the translation
  83819. * @param y defines the 2nd component of the translation
  83820. * @param z defines the 3rd component of the translation
  83821. * @returns the current updated matrix
  83822. */
  83823. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83824. /**
  83825. * Inserts the translation vector in the current matrix
  83826. * @param vector3 defines the translation to insert
  83827. * @returns the current updated matrix
  83828. */
  83829. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  83830. /**
  83831. * Gets the translation value of the current matrix
  83832. * @returns a new Vector3 as the extracted translation from the matrix
  83833. */
  83834. getTranslation(): Vector3;
  83835. /**
  83836. * Fill a Vector3 with the extracted translation from the matrix
  83837. * @param result defines the Vector3 where to store the translation
  83838. * @returns the current matrix
  83839. */
  83840. getTranslationToRef(result: Vector3): Matrix;
  83841. /**
  83842. * Remove rotation and scaling part from the matrix
  83843. * @returns the updated matrix
  83844. */
  83845. removeRotationAndScaling(): Matrix;
  83846. /**
  83847. * Multiply two matrices
  83848. * @param other defines the second operand
  83849. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  83850. */
  83851. multiply(other: DeepImmutable<Matrix>): Matrix;
  83852. /**
  83853. * Copy the current matrix from the given one
  83854. * @param other defines the source matrix
  83855. * @returns the current updated matrix
  83856. */
  83857. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  83858. /**
  83859. * Populates the given array from the starting index with the current matrix values
  83860. * @param array defines the target array
  83861. * @param offset defines the offset in the target array where to start storing values
  83862. * @returns the current matrix
  83863. */
  83864. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  83865. /**
  83866. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  83867. * @param other defines the second operand
  83868. * @param result defines the matrix where to store the multiplication
  83869. * @returns the current matrix
  83870. */
  83871. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83872. /**
  83873. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  83874. * @param other defines the second operand
  83875. * @param result defines the array where to store the multiplication
  83876. * @param offset defines the offset in the target array where to start storing values
  83877. * @returns the current matrix
  83878. */
  83879. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  83880. /**
  83881. * Check equality between this matrix and a second one
  83882. * @param value defines the second matrix to compare
  83883. * @returns true is the current matrix and the given one values are strictly equal
  83884. */
  83885. equals(value: DeepImmutable<Matrix>): boolean;
  83886. /**
  83887. * Clone the current matrix
  83888. * @returns a new matrix from the current matrix
  83889. */
  83890. clone(): Matrix;
  83891. /**
  83892. * Returns the name of the current matrix class
  83893. * @returns the string "Matrix"
  83894. */
  83895. getClassName(): string;
  83896. /**
  83897. * Gets the hash code of the current matrix
  83898. * @returns the hash code
  83899. */
  83900. getHashCode(): number;
  83901. /**
  83902. * Decomposes the current Matrix into a translation, rotation and scaling components
  83903. * @param scale defines the scale vector3 given as a reference to update
  83904. * @param rotation defines the rotation quaternion given as a reference to update
  83905. * @param translation defines the translation vector3 given as a reference to update
  83906. * @returns true if operation was successful
  83907. */
  83908. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  83909. /**
  83910. * Gets specific row of the matrix
  83911. * @param index defines the number of the row to get
  83912. * @returns the index-th row of the current matrix as a new Vector4
  83913. */
  83914. getRow(index: number): Nullable<Vector4>;
  83915. /**
  83916. * Sets the index-th row of the current matrix to the vector4 values
  83917. * @param index defines the number of the row to set
  83918. * @param row defines the target vector4
  83919. * @returns the updated current matrix
  83920. */
  83921. setRow(index: number, row: Vector4): Matrix;
  83922. /**
  83923. * Compute the transpose of the matrix
  83924. * @returns the new transposed matrix
  83925. */
  83926. transpose(): Matrix;
  83927. /**
  83928. * Compute the transpose of the matrix and store it in a given matrix
  83929. * @param result defines the target matrix
  83930. * @returns the current matrix
  83931. */
  83932. transposeToRef(result: Matrix): Matrix;
  83933. /**
  83934. * Sets the index-th row of the current matrix with the given 4 x float values
  83935. * @param index defines the row index
  83936. * @param x defines the x component to set
  83937. * @param y defines the y component to set
  83938. * @param z defines the z component to set
  83939. * @param w defines the w component to set
  83940. * @returns the updated current matrix
  83941. */
  83942. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  83943. /**
  83944. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  83945. * @param scale defines the scale factor
  83946. * @returns a new matrix
  83947. */
  83948. scale(scale: number): Matrix;
  83949. /**
  83950. * Scale the current matrix values by a factor to a given result matrix
  83951. * @param scale defines the scale factor
  83952. * @param result defines the matrix to store the result
  83953. * @returns the current matrix
  83954. */
  83955. scaleToRef(scale: number, result: Matrix): Matrix;
  83956. /**
  83957. * Scale the current matrix values by a factor and add the result to a given matrix
  83958. * @param scale defines the scale factor
  83959. * @param result defines the Matrix to store the result
  83960. * @returns the current matrix
  83961. */
  83962. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  83963. /**
  83964. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  83965. * @param ref matrix to store the result
  83966. */
  83967. toNormalMatrix(ref: Matrix): void;
  83968. /**
  83969. * Gets only rotation part of the current matrix
  83970. * @returns a new matrix sets to the extracted rotation matrix from the current one
  83971. */
  83972. getRotationMatrix(): Matrix;
  83973. /**
  83974. * Extracts the rotation matrix from the current one and sets it as the given "result"
  83975. * @param result defines the target matrix to store data to
  83976. * @returns the current matrix
  83977. */
  83978. getRotationMatrixToRef(result: Matrix): Matrix;
  83979. /**
  83980. * Toggles model matrix from being right handed to left handed in place and vice versa
  83981. */
  83982. toggleModelMatrixHandInPlace(): void;
  83983. /**
  83984. * Toggles projection matrix from being right handed to left handed in place and vice versa
  83985. */
  83986. toggleProjectionMatrixHandInPlace(): void;
  83987. /**
  83988. * Creates a matrix from an array
  83989. * @param array defines the source array
  83990. * @param offset defines an offset in the source array
  83991. * @returns a new Matrix set from the starting index of the given array
  83992. */
  83993. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  83994. /**
  83995. * Copy the content of an array into a given matrix
  83996. * @param array defines the source array
  83997. * @param offset defines an offset in the source array
  83998. * @param result defines the target matrix
  83999. */
  84000. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  84001. /**
  84002. * Stores an array into a matrix after having multiplied each component by a given factor
  84003. * @param array defines the source array
  84004. * @param offset defines the offset in the source array
  84005. * @param scale defines the scaling factor
  84006. * @param result defines the target matrix
  84007. */
  84008. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  84009. /**
  84010. * Gets an identity matrix that must not be updated
  84011. */
  84012. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  84013. /**
  84014. * Stores a list of values (16) inside a given matrix
  84015. * @param initialM11 defines 1st value of 1st row
  84016. * @param initialM12 defines 2nd value of 1st row
  84017. * @param initialM13 defines 3rd value of 1st row
  84018. * @param initialM14 defines 4th value of 1st row
  84019. * @param initialM21 defines 1st value of 2nd row
  84020. * @param initialM22 defines 2nd value of 2nd row
  84021. * @param initialM23 defines 3rd value of 2nd row
  84022. * @param initialM24 defines 4th value of 2nd row
  84023. * @param initialM31 defines 1st value of 3rd row
  84024. * @param initialM32 defines 2nd value of 3rd row
  84025. * @param initialM33 defines 3rd value of 3rd row
  84026. * @param initialM34 defines 4th value of 3rd row
  84027. * @param initialM41 defines 1st value of 4th row
  84028. * @param initialM42 defines 2nd value of 4th row
  84029. * @param initialM43 defines 3rd value of 4th row
  84030. * @param initialM44 defines 4th value of 4th row
  84031. * @param result defines the target matrix
  84032. */
  84033. 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;
  84034. /**
  84035. * Creates new matrix from a list of values (16)
  84036. * @param initialM11 defines 1st value of 1st row
  84037. * @param initialM12 defines 2nd value of 1st row
  84038. * @param initialM13 defines 3rd value of 1st row
  84039. * @param initialM14 defines 4th value of 1st row
  84040. * @param initialM21 defines 1st value of 2nd row
  84041. * @param initialM22 defines 2nd value of 2nd row
  84042. * @param initialM23 defines 3rd value of 2nd row
  84043. * @param initialM24 defines 4th value of 2nd row
  84044. * @param initialM31 defines 1st value of 3rd row
  84045. * @param initialM32 defines 2nd value of 3rd row
  84046. * @param initialM33 defines 3rd value of 3rd row
  84047. * @param initialM34 defines 4th value of 3rd row
  84048. * @param initialM41 defines 1st value of 4th row
  84049. * @param initialM42 defines 2nd value of 4th row
  84050. * @param initialM43 defines 3rd value of 4th row
  84051. * @param initialM44 defines 4th value of 4th row
  84052. * @returns the new matrix
  84053. */
  84054. 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;
  84055. /**
  84056. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84057. * @param scale defines the scale vector3
  84058. * @param rotation defines the rotation quaternion
  84059. * @param translation defines the translation vector3
  84060. * @returns a new matrix
  84061. */
  84062. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  84063. /**
  84064. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84065. * @param scale defines the scale vector3
  84066. * @param rotation defines the rotation quaternion
  84067. * @param translation defines the translation vector3
  84068. * @param result defines the target matrix
  84069. */
  84070. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  84071. /**
  84072. * Creates a new identity matrix
  84073. * @returns a new identity matrix
  84074. */
  84075. static Identity(): Matrix;
  84076. /**
  84077. * Creates a new identity matrix and stores the result in a given matrix
  84078. * @param result defines the target matrix
  84079. */
  84080. static IdentityToRef(result: Matrix): void;
  84081. /**
  84082. * Creates a new zero matrix
  84083. * @returns a new zero matrix
  84084. */
  84085. static Zero(): Matrix;
  84086. /**
  84087. * Creates a new rotation matrix for "angle" radians around the X axis
  84088. * @param angle defines the angle (in radians) to use
  84089. * @return the new matrix
  84090. */
  84091. static RotationX(angle: number): Matrix;
  84092. /**
  84093. * Creates a new matrix as the invert of a given matrix
  84094. * @param source defines the source matrix
  84095. * @returns the new matrix
  84096. */
  84097. static Invert(source: DeepImmutable<Matrix>): Matrix;
  84098. /**
  84099. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  84100. * @param angle defines the angle (in radians) to use
  84101. * @param result defines the target matrix
  84102. */
  84103. static RotationXToRef(angle: number, result: Matrix): void;
  84104. /**
  84105. * Creates a new rotation matrix for "angle" radians around the Y axis
  84106. * @param angle defines the angle (in radians) to use
  84107. * @return the new matrix
  84108. */
  84109. static RotationY(angle: number): Matrix;
  84110. /**
  84111. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  84112. * @param angle defines the angle (in radians) to use
  84113. * @param result defines the target matrix
  84114. */
  84115. static RotationYToRef(angle: number, result: Matrix): void;
  84116. /**
  84117. * Creates a new rotation matrix for "angle" radians around the Z axis
  84118. * @param angle defines the angle (in radians) to use
  84119. * @return the new matrix
  84120. */
  84121. static RotationZ(angle: number): Matrix;
  84122. /**
  84123. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  84124. * @param angle defines the angle (in radians) to use
  84125. * @param result defines the target matrix
  84126. */
  84127. static RotationZToRef(angle: number, result: Matrix): void;
  84128. /**
  84129. * Creates a new rotation matrix for "angle" radians around the given axis
  84130. * @param axis defines the axis to use
  84131. * @param angle defines the angle (in radians) to use
  84132. * @return the new matrix
  84133. */
  84134. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  84135. /**
  84136. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  84137. * @param axis defines the axis to use
  84138. * @param angle defines the angle (in radians) to use
  84139. * @param result defines the target matrix
  84140. */
  84141. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  84142. /**
  84143. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  84144. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  84145. * @param from defines the vector to align
  84146. * @param to defines the vector to align to
  84147. * @param result defines the target matrix
  84148. */
  84149. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  84150. /**
  84151. * Creates a rotation matrix
  84152. * @param yaw defines the yaw angle in radians (Y axis)
  84153. * @param pitch defines the pitch angle in radians (X axis)
  84154. * @param roll defines the roll angle in radians (Z axis)
  84155. * @returns the new rotation matrix
  84156. */
  84157. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  84158. /**
  84159. * Creates a rotation matrix and stores it in a given matrix
  84160. * @param yaw defines the yaw angle in radians (Y axis)
  84161. * @param pitch defines the pitch angle in radians (X axis)
  84162. * @param roll defines the roll angle in radians (Z axis)
  84163. * @param result defines the target matrix
  84164. */
  84165. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  84166. /**
  84167. * Creates a scaling matrix
  84168. * @param x defines the scale factor on X axis
  84169. * @param y defines the scale factor on Y axis
  84170. * @param z defines the scale factor on Z axis
  84171. * @returns the new matrix
  84172. */
  84173. static Scaling(x: number, y: number, z: number): Matrix;
  84174. /**
  84175. * Creates a scaling matrix and stores it in a given matrix
  84176. * @param x defines the scale factor on X axis
  84177. * @param y defines the scale factor on Y axis
  84178. * @param z defines the scale factor on Z axis
  84179. * @param result defines the target matrix
  84180. */
  84181. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  84182. /**
  84183. * Creates a translation matrix
  84184. * @param x defines the translation on X axis
  84185. * @param y defines the translation on Y axis
  84186. * @param z defines the translationon Z axis
  84187. * @returns the new matrix
  84188. */
  84189. static Translation(x: number, y: number, z: number): Matrix;
  84190. /**
  84191. * Creates a translation matrix and stores it in a given matrix
  84192. * @param x defines the translation on X axis
  84193. * @param y defines the translation on Y axis
  84194. * @param z defines the translationon Z axis
  84195. * @param result defines the target matrix
  84196. */
  84197. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  84198. /**
  84199. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84200. * @param startValue defines the start value
  84201. * @param endValue defines the end value
  84202. * @param gradient defines the gradient factor
  84203. * @returns the new matrix
  84204. */
  84205. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84206. /**
  84207. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84208. * @param startValue defines the start value
  84209. * @param endValue defines the end value
  84210. * @param gradient defines the gradient factor
  84211. * @param result defines the Matrix object where to store data
  84212. */
  84213. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84214. /**
  84215. * Builds a new matrix whose values are computed by:
  84216. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84217. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84218. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84219. * @param startValue defines the first matrix
  84220. * @param endValue defines the second matrix
  84221. * @param gradient defines the gradient between the two matrices
  84222. * @returns the new matrix
  84223. */
  84224. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84225. /**
  84226. * Update a matrix to values which are computed by:
  84227. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84228. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84229. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84230. * @param startValue defines the first matrix
  84231. * @param endValue defines the second matrix
  84232. * @param gradient defines the gradient between the two matrices
  84233. * @param result defines the target matrix
  84234. */
  84235. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84236. /**
  84237. * 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"
  84238. * This function works in left handed mode
  84239. * @param eye defines the final position of the entity
  84240. * @param target defines where the entity should look at
  84241. * @param up defines the up vector for the entity
  84242. * @returns the new matrix
  84243. */
  84244. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84245. /**
  84246. * 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".
  84247. * This function works in left handed mode
  84248. * @param eye defines the final position of the entity
  84249. * @param target defines where the entity should look at
  84250. * @param up defines the up vector for the entity
  84251. * @param result defines the target matrix
  84252. */
  84253. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84254. /**
  84255. * 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"
  84256. * This function works in right handed mode
  84257. * @param eye defines the final position of the entity
  84258. * @param target defines where the entity should look at
  84259. * @param up defines the up vector for the entity
  84260. * @returns the new matrix
  84261. */
  84262. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84263. /**
  84264. * 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".
  84265. * This function works in right handed mode
  84266. * @param eye defines the final position of the entity
  84267. * @param target defines where the entity should look at
  84268. * @param up defines the up vector for the entity
  84269. * @param result defines the target matrix
  84270. */
  84271. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84272. /**
  84273. * Create a left-handed orthographic projection matrix
  84274. * @param width defines the viewport width
  84275. * @param height defines the viewport height
  84276. * @param znear defines the near clip plane
  84277. * @param zfar defines the far clip plane
  84278. * @returns a new matrix as a left-handed orthographic projection matrix
  84279. */
  84280. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84281. /**
  84282. * Store a left-handed orthographic projection to a given matrix
  84283. * @param width defines the viewport width
  84284. * @param height defines the viewport height
  84285. * @param znear defines the near clip plane
  84286. * @param zfar defines the far clip plane
  84287. * @param result defines the target matrix
  84288. */
  84289. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  84290. /**
  84291. * Create a left-handed orthographic projection matrix
  84292. * @param left defines the viewport left coordinate
  84293. * @param right defines the viewport right coordinate
  84294. * @param bottom defines the viewport bottom coordinate
  84295. * @param top defines the viewport top coordinate
  84296. * @param znear defines the near clip plane
  84297. * @param zfar defines the far clip plane
  84298. * @returns a new matrix as a left-handed orthographic projection matrix
  84299. */
  84300. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84301. /**
  84302. * Stores a left-handed orthographic projection into a given matrix
  84303. * @param left defines the viewport left coordinate
  84304. * @param right defines the viewport right coordinate
  84305. * @param bottom defines the viewport bottom coordinate
  84306. * @param top defines the viewport top coordinate
  84307. * @param znear defines the near clip plane
  84308. * @param zfar defines the far clip plane
  84309. * @param result defines the target matrix
  84310. */
  84311. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84312. /**
  84313. * Creates a right-handed orthographic projection matrix
  84314. * @param left defines the viewport left coordinate
  84315. * @param right defines the viewport right coordinate
  84316. * @param bottom defines the viewport bottom coordinate
  84317. * @param top defines the viewport top coordinate
  84318. * @param znear defines the near clip plane
  84319. * @param zfar defines the far clip plane
  84320. * @returns a new matrix as a right-handed orthographic projection matrix
  84321. */
  84322. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84323. /**
  84324. * Stores a right-handed orthographic projection into a given matrix
  84325. * @param left defines the viewport left coordinate
  84326. * @param right defines the viewport right coordinate
  84327. * @param bottom defines the viewport bottom coordinate
  84328. * @param top defines the viewport top coordinate
  84329. * @param znear defines the near clip plane
  84330. * @param zfar defines the far clip plane
  84331. * @param result defines the target matrix
  84332. */
  84333. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84334. /**
  84335. * Creates a left-handed perspective projection matrix
  84336. * @param width defines the viewport width
  84337. * @param height defines the viewport height
  84338. * @param znear defines the near clip plane
  84339. * @param zfar defines the far clip plane
  84340. * @returns a new matrix as a left-handed perspective projection matrix
  84341. */
  84342. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84343. /**
  84344. * Creates a left-handed perspective projection matrix
  84345. * @param fov defines the horizontal field of view
  84346. * @param aspect defines the aspect ratio
  84347. * @param znear defines the near clip plane
  84348. * @param zfar defines the far clip plane
  84349. * @returns a new matrix as a left-handed perspective projection matrix
  84350. */
  84351. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84352. /**
  84353. * Stores a left-handed perspective projection into a given matrix
  84354. * @param fov defines the horizontal field of view
  84355. * @param aspect defines the aspect ratio
  84356. * @param znear defines the near clip plane
  84357. * @param zfar defines the far clip plane
  84358. * @param result defines the target matrix
  84359. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84360. */
  84361. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84362. /**
  84363. * Stores a left-handed perspective projection into a given matrix with depth reversed
  84364. * @param fov defines the horizontal field of view
  84365. * @param aspect defines the aspect ratio
  84366. * @param znear defines the near clip plane
  84367. * @param zfar not used as infinity is used as far clip
  84368. * @param result defines the target matrix
  84369. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84370. */
  84371. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84372. /**
  84373. * Creates a right-handed perspective projection matrix
  84374. * @param fov defines the horizontal field of view
  84375. * @param aspect defines the aspect ratio
  84376. * @param znear defines the near clip plane
  84377. * @param zfar defines the far clip plane
  84378. * @returns a new matrix as a right-handed perspective projection matrix
  84379. */
  84380. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84381. /**
  84382. * Stores a right-handed perspective projection into a given matrix
  84383. * @param fov defines the horizontal field of view
  84384. * @param aspect defines the aspect ratio
  84385. * @param znear defines the near clip plane
  84386. * @param zfar defines the far clip plane
  84387. * @param result defines the target matrix
  84388. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84389. */
  84390. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84391. /**
  84392. * Stores a right-handed perspective projection into a given matrix
  84393. * @param fov defines the horizontal field of view
  84394. * @param aspect defines the aspect ratio
  84395. * @param znear defines the near clip plane
  84396. * @param zfar not used as infinity is used as far clip
  84397. * @param result defines the target matrix
  84398. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84399. */
  84400. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84401. /**
  84402. * Stores a perspective projection for WebVR info a given matrix
  84403. * @param fov defines the field of view
  84404. * @param znear defines the near clip plane
  84405. * @param zfar defines the far clip plane
  84406. * @param result defines the target matrix
  84407. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  84408. */
  84409. static PerspectiveFovWebVRToRef(fov: {
  84410. upDegrees: number;
  84411. downDegrees: number;
  84412. leftDegrees: number;
  84413. rightDegrees: number;
  84414. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  84415. /**
  84416. * Computes a complete transformation matrix
  84417. * @param viewport defines the viewport to use
  84418. * @param world defines the world matrix
  84419. * @param view defines the view matrix
  84420. * @param projection defines the projection matrix
  84421. * @param zmin defines the near clip plane
  84422. * @param zmax defines the far clip plane
  84423. * @returns the transformation matrix
  84424. */
  84425. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  84426. /**
  84427. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  84428. * @param matrix defines the matrix to use
  84429. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  84430. */
  84431. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84432. /**
  84433. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  84434. * @param matrix defines the matrix to use
  84435. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  84436. */
  84437. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84438. /**
  84439. * Compute the transpose of a given matrix
  84440. * @param matrix defines the matrix to transpose
  84441. * @returns the new matrix
  84442. */
  84443. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  84444. /**
  84445. * Compute the transpose of a matrix and store it in a target matrix
  84446. * @param matrix defines the matrix to transpose
  84447. * @param result defines the target matrix
  84448. */
  84449. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  84450. /**
  84451. * Computes a reflection matrix from a plane
  84452. * @param plane defines the reflection plane
  84453. * @returns a new matrix
  84454. */
  84455. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  84456. /**
  84457. * Computes a reflection matrix from a plane
  84458. * @param plane defines the reflection plane
  84459. * @param result defines the target matrix
  84460. */
  84461. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  84462. /**
  84463. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  84464. * @param xaxis defines the value of the 1st axis
  84465. * @param yaxis defines the value of the 2nd axis
  84466. * @param zaxis defines the value of the 3rd axis
  84467. * @param result defines the target matrix
  84468. */
  84469. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  84470. /**
  84471. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  84472. * @param quat defines the quaternion to use
  84473. * @param result defines the target matrix
  84474. */
  84475. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  84476. }
  84477. /**
  84478. * @hidden
  84479. */
  84480. export class TmpVectors {
  84481. static Vector2: Vector2[];
  84482. static Vector3: Vector3[];
  84483. static Vector4: Vector4[];
  84484. static Quaternion: Quaternion[];
  84485. static Matrix: Matrix[];
  84486. }
  84487. }
  84488. declare module BABYLON {
  84489. /**
  84490. * Defines potential orientation for back face culling
  84491. */
  84492. export enum Orientation {
  84493. /**
  84494. * Clockwise
  84495. */
  84496. CW = 0,
  84497. /** Counter clockwise */
  84498. CCW = 1
  84499. }
  84500. /** Class used to represent a Bezier curve */
  84501. export class BezierCurve {
  84502. /**
  84503. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  84504. * @param t defines the time
  84505. * @param x1 defines the left coordinate on X axis
  84506. * @param y1 defines the left coordinate on Y axis
  84507. * @param x2 defines the right coordinate on X axis
  84508. * @param y2 defines the right coordinate on Y axis
  84509. * @returns the interpolated value
  84510. */
  84511. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  84512. }
  84513. /**
  84514. * Defines angle representation
  84515. */
  84516. export class Angle {
  84517. private _radians;
  84518. /**
  84519. * Creates an Angle object of "radians" radians (float).
  84520. * @param radians the angle in radians
  84521. */
  84522. constructor(radians: number);
  84523. /**
  84524. * Get value in degrees
  84525. * @returns the Angle value in degrees (float)
  84526. */
  84527. degrees(): number;
  84528. /**
  84529. * Get value in radians
  84530. * @returns the Angle value in radians (float)
  84531. */
  84532. radians(): number;
  84533. /**
  84534. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  84535. * @param a defines first point as the origin
  84536. * @param b defines point
  84537. * @returns a new Angle
  84538. */
  84539. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  84540. /**
  84541. * Gets a new Angle object from the given float in radians
  84542. * @param radians defines the angle value in radians
  84543. * @returns a new Angle
  84544. */
  84545. static FromRadians(radians: number): Angle;
  84546. /**
  84547. * Gets a new Angle object from the given float in degrees
  84548. * @param degrees defines the angle value in degrees
  84549. * @returns a new Angle
  84550. */
  84551. static FromDegrees(degrees: number): Angle;
  84552. }
  84553. /**
  84554. * This represents an arc in a 2d space.
  84555. */
  84556. export class Arc2 {
  84557. /** Defines the start point of the arc */
  84558. startPoint: Vector2;
  84559. /** Defines the mid point of the arc */
  84560. midPoint: Vector2;
  84561. /** Defines the end point of the arc */
  84562. endPoint: Vector2;
  84563. /**
  84564. * Defines the center point of the arc.
  84565. */
  84566. centerPoint: Vector2;
  84567. /**
  84568. * Defines the radius of the arc.
  84569. */
  84570. radius: number;
  84571. /**
  84572. * Defines the angle of the arc (from mid point to end point).
  84573. */
  84574. angle: Angle;
  84575. /**
  84576. * Defines the start angle of the arc (from start point to middle point).
  84577. */
  84578. startAngle: Angle;
  84579. /**
  84580. * Defines the orientation of the arc (clock wise/counter clock wise).
  84581. */
  84582. orientation: Orientation;
  84583. /**
  84584. * Creates an Arc object from the three given points : start, middle and end.
  84585. * @param startPoint Defines the start point of the arc
  84586. * @param midPoint Defines the midlle point of the arc
  84587. * @param endPoint Defines the end point of the arc
  84588. */
  84589. constructor(
  84590. /** Defines the start point of the arc */
  84591. startPoint: Vector2,
  84592. /** Defines the mid point of the arc */
  84593. midPoint: Vector2,
  84594. /** Defines the end point of the arc */
  84595. endPoint: Vector2);
  84596. }
  84597. /**
  84598. * Represents a 2D path made up of multiple 2D points
  84599. */
  84600. export class Path2 {
  84601. private _points;
  84602. private _length;
  84603. /**
  84604. * If the path start and end point are the same
  84605. */
  84606. closed: boolean;
  84607. /**
  84608. * Creates a Path2 object from the starting 2D coordinates x and y.
  84609. * @param x the starting points x value
  84610. * @param y the starting points y value
  84611. */
  84612. constructor(x: number, y: number);
  84613. /**
  84614. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  84615. * @param x the added points x value
  84616. * @param y the added points y value
  84617. * @returns the updated Path2.
  84618. */
  84619. addLineTo(x: number, y: number): Path2;
  84620. /**
  84621. * 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.
  84622. * @param midX middle point x value
  84623. * @param midY middle point y value
  84624. * @param endX end point x value
  84625. * @param endY end point y value
  84626. * @param numberOfSegments (default: 36)
  84627. * @returns the updated Path2.
  84628. */
  84629. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  84630. /**
  84631. * Closes the Path2.
  84632. * @returns the Path2.
  84633. */
  84634. close(): Path2;
  84635. /**
  84636. * Gets the sum of the distance between each sequential point in the path
  84637. * @returns the Path2 total length (float).
  84638. */
  84639. length(): number;
  84640. /**
  84641. * Gets the points which construct the path
  84642. * @returns the Path2 internal array of points.
  84643. */
  84644. getPoints(): Vector2[];
  84645. /**
  84646. * Retreives the point at the distance aways from the starting point
  84647. * @param normalizedLengthPosition the length along the path to retreive the point from
  84648. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  84649. */
  84650. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  84651. /**
  84652. * Creates a new path starting from an x and y position
  84653. * @param x starting x value
  84654. * @param y starting y value
  84655. * @returns a new Path2 starting at the coordinates (x, y).
  84656. */
  84657. static StartingAt(x: number, y: number): Path2;
  84658. }
  84659. /**
  84660. * Represents a 3D path made up of multiple 3D points
  84661. */
  84662. export class Path3D {
  84663. /**
  84664. * an array of Vector3, the curve axis of the Path3D
  84665. */
  84666. path: Vector3[];
  84667. private _curve;
  84668. private _distances;
  84669. private _tangents;
  84670. private _normals;
  84671. private _binormals;
  84672. private _raw;
  84673. private _alignTangentsWithPath;
  84674. private readonly _pointAtData;
  84675. /**
  84676. * new Path3D(path, normal, raw)
  84677. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  84678. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  84679. * @param path an array of Vector3, the curve axis of the Path3D
  84680. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  84681. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  84682. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  84683. */
  84684. constructor(
  84685. /**
  84686. * an array of Vector3, the curve axis of the Path3D
  84687. */
  84688. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  84689. /**
  84690. * Returns the Path3D array of successive Vector3 designing its curve.
  84691. * @returns the Path3D array of successive Vector3 designing its curve.
  84692. */
  84693. getCurve(): Vector3[];
  84694. /**
  84695. * Returns the Path3D array of successive Vector3 designing its curve.
  84696. * @returns the Path3D array of successive Vector3 designing its curve.
  84697. */
  84698. getPoints(): Vector3[];
  84699. /**
  84700. * @returns the computed length (float) of the path.
  84701. */
  84702. length(): number;
  84703. /**
  84704. * Returns an array populated with tangent vectors on each Path3D curve point.
  84705. * @returns an array populated with tangent vectors on each Path3D curve point.
  84706. */
  84707. getTangents(): Vector3[];
  84708. /**
  84709. * Returns an array populated with normal vectors on each Path3D curve point.
  84710. * @returns an array populated with normal vectors on each Path3D curve point.
  84711. */
  84712. getNormals(): Vector3[];
  84713. /**
  84714. * Returns an array populated with binormal vectors on each Path3D curve point.
  84715. * @returns an array populated with binormal vectors on each Path3D curve point.
  84716. */
  84717. getBinormals(): Vector3[];
  84718. /**
  84719. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  84720. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  84721. */
  84722. getDistances(): number[];
  84723. /**
  84724. * Returns an interpolated point along this path
  84725. * @param position the position of the point along this path, from 0.0 to 1.0
  84726. * @returns a new Vector3 as the point
  84727. */
  84728. getPointAt(position: number): Vector3;
  84729. /**
  84730. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84731. * @param position the position of the point along this path, from 0.0 to 1.0
  84732. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  84733. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  84734. */
  84735. getTangentAt(position: number, interpolated?: boolean): Vector3;
  84736. /**
  84737. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84738. * @param position the position of the point along this path, from 0.0 to 1.0
  84739. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  84740. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  84741. */
  84742. getNormalAt(position: number, interpolated?: boolean): Vector3;
  84743. /**
  84744. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  84745. * @param position the position of the point along this path, from 0.0 to 1.0
  84746. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  84747. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  84748. */
  84749. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  84750. /**
  84751. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  84752. * @param position the position of the point along this path, from 0.0 to 1.0
  84753. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  84754. */
  84755. getDistanceAt(position: number): number;
  84756. /**
  84757. * Returns the array index of the previous point of an interpolated point along this path
  84758. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84759. * @returns the array index
  84760. */
  84761. getPreviousPointIndexAt(position: number): number;
  84762. /**
  84763. * 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)
  84764. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84765. * @returns the sub position
  84766. */
  84767. getSubPositionAt(position: number): number;
  84768. /**
  84769. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  84770. * @param target the vector of which to get the closest position to
  84771. * @returns the position of the closest virtual point on this path to the target vector
  84772. */
  84773. getClosestPositionTo(target: Vector3): number;
  84774. /**
  84775. * Returns a sub path (slice) of this path
  84776. * @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
  84777. * @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
  84778. * @returns a sub path (slice) of this path
  84779. */
  84780. slice(start?: number, end?: number): Path3D;
  84781. /**
  84782. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  84783. * @param path path which all values are copied into the curves points
  84784. * @param firstNormal which should be projected onto the curve
  84785. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  84786. * @returns the same object updated.
  84787. */
  84788. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  84789. private _compute;
  84790. private _getFirstNonNullVector;
  84791. private _getLastNonNullVector;
  84792. private _normalVector;
  84793. /**
  84794. * Updates the point at data for an interpolated point along this curve
  84795. * @param position the position of the point along this curve, from 0.0 to 1.0
  84796. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  84797. * @returns the (updated) point at data
  84798. */
  84799. private _updatePointAtData;
  84800. /**
  84801. * Updates the point at data from the specified parameters
  84802. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  84803. * @param point the interpolated point
  84804. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  84805. */
  84806. private _setPointAtData;
  84807. /**
  84808. * Updates the point at interpolation matrix for the tangents, normals and binormals
  84809. */
  84810. private _updateInterpolationMatrix;
  84811. }
  84812. /**
  84813. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84814. * A Curve3 is designed from a series of successive Vector3.
  84815. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  84816. */
  84817. export class Curve3 {
  84818. private _points;
  84819. private _length;
  84820. /**
  84821. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  84822. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  84823. * @param v1 (Vector3) the control point
  84824. * @param v2 (Vector3) the end point of the Quadratic Bezier
  84825. * @param nbPoints (integer) the wanted number of points in the curve
  84826. * @returns the created Curve3
  84827. */
  84828. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84829. /**
  84830. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  84831. * @param v0 (Vector3) the origin point of the Cubic Bezier
  84832. * @param v1 (Vector3) the first control point
  84833. * @param v2 (Vector3) the second control point
  84834. * @param v3 (Vector3) the end point of the Cubic Bezier
  84835. * @param nbPoints (integer) the wanted number of points in the curve
  84836. * @returns the created Curve3
  84837. */
  84838. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84839. /**
  84840. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  84841. * @param p1 (Vector3) the origin point of the Hermite Spline
  84842. * @param t1 (Vector3) the tangent vector at the origin point
  84843. * @param p2 (Vector3) the end point of the Hermite Spline
  84844. * @param t2 (Vector3) the tangent vector at the end point
  84845. * @param nbPoints (integer) the wanted number of points in the curve
  84846. * @returns the created Curve3
  84847. */
  84848. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84849. /**
  84850. * Returns a Curve3 object along a CatmullRom Spline curve :
  84851. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  84852. * @param nbPoints (integer) the wanted number of points between each curve control points
  84853. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  84854. * @returns the created Curve3
  84855. */
  84856. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  84857. /**
  84858. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84859. * A Curve3 is designed from a series of successive Vector3.
  84860. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  84861. * @param points points which make up the curve
  84862. */
  84863. constructor(points: Vector3[]);
  84864. /**
  84865. * @returns the Curve3 stored array of successive Vector3
  84866. */
  84867. getPoints(): Vector3[];
  84868. /**
  84869. * @returns the computed length (float) of the curve.
  84870. */
  84871. length(): number;
  84872. /**
  84873. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  84874. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  84875. * curveA and curveB keep unchanged.
  84876. * @param curve the curve to continue from this curve
  84877. * @returns the newly constructed curve
  84878. */
  84879. continue(curve: DeepImmutable<Curve3>): Curve3;
  84880. private _computeLength;
  84881. }
  84882. }
  84883. declare module BABYLON {
  84884. /**
  84885. * This represents the main contract an easing function should follow.
  84886. * Easing functions are used throughout the animation system.
  84887. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84888. */
  84889. export interface IEasingFunction {
  84890. /**
  84891. * Given an input gradient between 0 and 1, this returns the corrseponding value
  84892. * of the easing function.
  84893. * The link below provides some of the most common examples of easing functions.
  84894. * @see https://easings.net/
  84895. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84896. * @returns the corresponding value on the curve defined by the easing function
  84897. */
  84898. ease(gradient: number): number;
  84899. }
  84900. /**
  84901. * Base class used for every default easing function.
  84902. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84903. */
  84904. export class EasingFunction implements IEasingFunction {
  84905. /**
  84906. * Interpolation follows the mathematical formula associated with the easing function.
  84907. */
  84908. static readonly EASINGMODE_EASEIN: number;
  84909. /**
  84910. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  84911. */
  84912. static readonly EASINGMODE_EASEOUT: number;
  84913. /**
  84914. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  84915. */
  84916. static readonly EASINGMODE_EASEINOUT: number;
  84917. private _easingMode;
  84918. /**
  84919. * Sets the easing mode of the current function.
  84920. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  84921. */
  84922. setEasingMode(easingMode: number): void;
  84923. /**
  84924. * Gets the current easing mode.
  84925. * @returns the easing mode
  84926. */
  84927. getEasingMode(): number;
  84928. /**
  84929. * @hidden
  84930. */
  84931. easeInCore(gradient: number): number;
  84932. /**
  84933. * Given an input gradient between 0 and 1, this returns the corresponding value
  84934. * of the easing function.
  84935. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84936. * @returns the corresponding value on the curve defined by the easing function
  84937. */
  84938. ease(gradient: number): number;
  84939. }
  84940. /**
  84941. * Easing function with a circle shape (see link below).
  84942. * @see https://easings.net/#easeInCirc
  84943. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84944. */
  84945. export class CircleEase extends EasingFunction implements IEasingFunction {
  84946. /** @hidden */
  84947. easeInCore(gradient: number): number;
  84948. }
  84949. /**
  84950. * Easing function with a ease back shape (see link below).
  84951. * @see https://easings.net/#easeInBack
  84952. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84953. */
  84954. export class BackEase extends EasingFunction implements IEasingFunction {
  84955. /** Defines the amplitude of the function */
  84956. amplitude: number;
  84957. /**
  84958. * Instantiates a back ease easing
  84959. * @see https://easings.net/#easeInBack
  84960. * @param amplitude Defines the amplitude of the function
  84961. */
  84962. constructor(
  84963. /** Defines the amplitude of the function */
  84964. amplitude?: number);
  84965. /** @hidden */
  84966. easeInCore(gradient: number): number;
  84967. }
  84968. /**
  84969. * Easing function with a bouncing shape (see link below).
  84970. * @see https://easings.net/#easeInBounce
  84971. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84972. */
  84973. export class BounceEase extends EasingFunction implements IEasingFunction {
  84974. /** Defines the number of bounces */
  84975. bounces: number;
  84976. /** Defines the amplitude of the bounce */
  84977. bounciness: number;
  84978. /**
  84979. * Instantiates a bounce easing
  84980. * @see https://easings.net/#easeInBounce
  84981. * @param bounces Defines the number of bounces
  84982. * @param bounciness Defines the amplitude of the bounce
  84983. */
  84984. constructor(
  84985. /** Defines the number of bounces */
  84986. bounces?: number,
  84987. /** Defines the amplitude of the bounce */
  84988. bounciness?: number);
  84989. /** @hidden */
  84990. easeInCore(gradient: number): number;
  84991. }
  84992. /**
  84993. * Easing function with a power of 3 shape (see link below).
  84994. * @see https://easings.net/#easeInCubic
  84995. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84996. */
  84997. export class CubicEase extends EasingFunction implements IEasingFunction {
  84998. /** @hidden */
  84999. easeInCore(gradient: number): number;
  85000. }
  85001. /**
  85002. * Easing function with an elastic shape (see link below).
  85003. * @see https://easings.net/#easeInElastic
  85004. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85005. */
  85006. export class ElasticEase extends EasingFunction implements IEasingFunction {
  85007. /** Defines the number of oscillations*/
  85008. oscillations: number;
  85009. /** Defines the amplitude of the oscillations*/
  85010. springiness: number;
  85011. /**
  85012. * Instantiates an elastic easing function
  85013. * @see https://easings.net/#easeInElastic
  85014. * @param oscillations Defines the number of oscillations
  85015. * @param springiness Defines the amplitude of the oscillations
  85016. */
  85017. constructor(
  85018. /** Defines the number of oscillations*/
  85019. oscillations?: number,
  85020. /** Defines the amplitude of the oscillations*/
  85021. springiness?: number);
  85022. /** @hidden */
  85023. easeInCore(gradient: number): number;
  85024. }
  85025. /**
  85026. * Easing function with an exponential shape (see link below).
  85027. * @see https://easings.net/#easeInExpo
  85028. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85029. */
  85030. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  85031. /** Defines the exponent of the function */
  85032. exponent: number;
  85033. /**
  85034. * Instantiates an exponential easing function
  85035. * @see https://easings.net/#easeInExpo
  85036. * @param exponent Defines the exponent of the function
  85037. */
  85038. constructor(
  85039. /** Defines the exponent of the function */
  85040. exponent?: number);
  85041. /** @hidden */
  85042. easeInCore(gradient: number): number;
  85043. }
  85044. /**
  85045. * Easing function with a power shape (see link below).
  85046. * @see https://easings.net/#easeInQuad
  85047. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85048. */
  85049. export class PowerEase extends EasingFunction implements IEasingFunction {
  85050. /** Defines the power of the function */
  85051. power: number;
  85052. /**
  85053. * Instantiates an power base easing function
  85054. * @see https://easings.net/#easeInQuad
  85055. * @param power Defines the power of the function
  85056. */
  85057. constructor(
  85058. /** Defines the power of the function */
  85059. power?: number);
  85060. /** @hidden */
  85061. easeInCore(gradient: number): number;
  85062. }
  85063. /**
  85064. * Easing function with a power of 2 shape (see link below).
  85065. * @see https://easings.net/#easeInQuad
  85066. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85067. */
  85068. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  85069. /** @hidden */
  85070. easeInCore(gradient: number): number;
  85071. }
  85072. /**
  85073. * Easing function with a power of 4 shape (see link below).
  85074. * @see https://easings.net/#easeInQuart
  85075. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85076. */
  85077. export class QuarticEase extends EasingFunction implements IEasingFunction {
  85078. /** @hidden */
  85079. easeInCore(gradient: number): number;
  85080. }
  85081. /**
  85082. * Easing function with a power of 5 shape (see link below).
  85083. * @see https://easings.net/#easeInQuint
  85084. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85085. */
  85086. export class QuinticEase extends EasingFunction implements IEasingFunction {
  85087. /** @hidden */
  85088. easeInCore(gradient: number): number;
  85089. }
  85090. /**
  85091. * Easing function with a sin shape (see link below).
  85092. * @see https://easings.net/#easeInSine
  85093. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85094. */
  85095. export class SineEase extends EasingFunction implements IEasingFunction {
  85096. /** @hidden */
  85097. easeInCore(gradient: number): number;
  85098. }
  85099. /**
  85100. * Easing function with a bezier shape (see link below).
  85101. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85102. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85103. */
  85104. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  85105. /** Defines the x component of the start tangent in the bezier curve */
  85106. x1: number;
  85107. /** Defines the y component of the start tangent in the bezier curve */
  85108. y1: number;
  85109. /** Defines the x component of the end tangent in the bezier curve */
  85110. x2: number;
  85111. /** Defines the y component of the end tangent in the bezier curve */
  85112. y2: number;
  85113. /**
  85114. * Instantiates a bezier function
  85115. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85116. * @param x1 Defines the x component of the start tangent in the bezier curve
  85117. * @param y1 Defines the y component of the start tangent in the bezier curve
  85118. * @param x2 Defines the x component of the end tangent in the bezier curve
  85119. * @param y2 Defines the y component of the end tangent in the bezier curve
  85120. */
  85121. constructor(
  85122. /** Defines the x component of the start tangent in the bezier curve */
  85123. x1?: number,
  85124. /** Defines the y component of the start tangent in the bezier curve */
  85125. y1?: number,
  85126. /** Defines the x component of the end tangent in the bezier curve */
  85127. x2?: number,
  85128. /** Defines the y component of the end tangent in the bezier curve */
  85129. y2?: number);
  85130. /** @hidden */
  85131. easeInCore(gradient: number): number;
  85132. }
  85133. }
  85134. declare module BABYLON {
  85135. /**
  85136. * Class used to hold a RBG color
  85137. */
  85138. export class Color3 {
  85139. /**
  85140. * Defines the red component (between 0 and 1, default is 0)
  85141. */
  85142. r: number;
  85143. /**
  85144. * Defines the green component (between 0 and 1, default is 0)
  85145. */
  85146. g: number;
  85147. /**
  85148. * Defines the blue component (between 0 and 1, default is 0)
  85149. */
  85150. b: number;
  85151. /**
  85152. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  85153. * @param r defines the red component (between 0 and 1, default is 0)
  85154. * @param g defines the green component (between 0 and 1, default is 0)
  85155. * @param b defines the blue component (between 0 and 1, default is 0)
  85156. */
  85157. constructor(
  85158. /**
  85159. * Defines the red component (between 0 and 1, default is 0)
  85160. */
  85161. r?: number,
  85162. /**
  85163. * Defines the green component (between 0 and 1, default is 0)
  85164. */
  85165. g?: number,
  85166. /**
  85167. * Defines the blue component (between 0 and 1, default is 0)
  85168. */
  85169. b?: number);
  85170. /**
  85171. * Creates a string with the Color3 current values
  85172. * @returns the string representation of the Color3 object
  85173. */
  85174. toString(): string;
  85175. /**
  85176. * Returns the string "Color3"
  85177. * @returns "Color3"
  85178. */
  85179. getClassName(): string;
  85180. /**
  85181. * Compute the Color3 hash code
  85182. * @returns an unique number that can be used to hash Color3 objects
  85183. */
  85184. getHashCode(): number;
  85185. /**
  85186. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  85187. * @param array defines the array where to store the r,g,b components
  85188. * @param index defines an optional index in the target array to define where to start storing values
  85189. * @returns the current Color3 object
  85190. */
  85191. toArray(array: FloatArray, index?: number): Color3;
  85192. /**
  85193. * Update the current color with values stored in an array from the starting index of the given array
  85194. * @param array defines the source array
  85195. * @param offset defines an offset in the source array
  85196. * @returns the current Color3 object
  85197. */
  85198. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85199. /**
  85200. * Returns a new Color4 object from the current Color3 and the given alpha
  85201. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  85202. * @returns a new Color4 object
  85203. */
  85204. toColor4(alpha?: number): Color4;
  85205. /**
  85206. * Returns a new array populated with 3 numeric elements : red, green and blue values
  85207. * @returns the new array
  85208. */
  85209. asArray(): number[];
  85210. /**
  85211. * Returns the luminance value
  85212. * @returns a float value
  85213. */
  85214. toLuminance(): number;
  85215. /**
  85216. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  85217. * @param otherColor defines the second operand
  85218. * @returns the new Color3 object
  85219. */
  85220. multiply(otherColor: DeepImmutable<Color3>): Color3;
  85221. /**
  85222. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  85223. * @param otherColor defines the second operand
  85224. * @param result defines the Color3 object where to store the result
  85225. * @returns the current Color3
  85226. */
  85227. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85228. /**
  85229. * Determines equality between Color3 objects
  85230. * @param otherColor defines the second operand
  85231. * @returns true if the rgb values are equal to the given ones
  85232. */
  85233. equals(otherColor: DeepImmutable<Color3>): boolean;
  85234. /**
  85235. * Determines equality between the current Color3 object and a set of r,b,g values
  85236. * @param r defines the red component to check
  85237. * @param g defines the green component to check
  85238. * @param b defines the blue component to check
  85239. * @returns true if the rgb values are equal to the given ones
  85240. */
  85241. equalsFloats(r: number, g: number, b: number): boolean;
  85242. /**
  85243. * Multiplies in place each rgb value by scale
  85244. * @param scale defines the scaling factor
  85245. * @returns the updated Color3
  85246. */
  85247. scale(scale: number): Color3;
  85248. /**
  85249. * Multiplies the rgb values by scale and stores the result into "result"
  85250. * @param scale defines the scaling factor
  85251. * @param result defines the Color3 object where to store the result
  85252. * @returns the unmodified current Color3
  85253. */
  85254. scaleToRef(scale: number, result: Color3): Color3;
  85255. /**
  85256. * Scale the current Color3 values by a factor and add the result to a given Color3
  85257. * @param scale defines the scale factor
  85258. * @param result defines color to store the result into
  85259. * @returns the unmodified current Color3
  85260. */
  85261. scaleAndAddToRef(scale: number, result: Color3): Color3;
  85262. /**
  85263. * Clamps the rgb values by the min and max values and stores the result into "result"
  85264. * @param min defines minimum clamping value (default is 0)
  85265. * @param max defines maximum clamping value (default is 1)
  85266. * @param result defines color to store the result into
  85267. * @returns the original Color3
  85268. */
  85269. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  85270. /**
  85271. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  85272. * @param otherColor defines the second operand
  85273. * @returns the new Color3
  85274. */
  85275. add(otherColor: DeepImmutable<Color3>): Color3;
  85276. /**
  85277. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  85278. * @param otherColor defines the second operand
  85279. * @param result defines Color3 object to store the result into
  85280. * @returns the unmodified current Color3
  85281. */
  85282. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85283. /**
  85284. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  85285. * @param otherColor defines the second operand
  85286. * @returns the new Color3
  85287. */
  85288. subtract(otherColor: DeepImmutable<Color3>): Color3;
  85289. /**
  85290. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  85291. * @param otherColor defines the second operand
  85292. * @param result defines Color3 object to store the result into
  85293. * @returns the unmodified current Color3
  85294. */
  85295. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85296. /**
  85297. * Copy the current object
  85298. * @returns a new Color3 copied the current one
  85299. */
  85300. clone(): Color3;
  85301. /**
  85302. * Copies the rgb values from the source in the current Color3
  85303. * @param source defines the source Color3 object
  85304. * @returns the updated Color3 object
  85305. */
  85306. copyFrom(source: DeepImmutable<Color3>): Color3;
  85307. /**
  85308. * Updates the Color3 rgb values from the given floats
  85309. * @param r defines the red component to read from
  85310. * @param g defines the green component to read from
  85311. * @param b defines the blue component to read from
  85312. * @returns the current Color3 object
  85313. */
  85314. copyFromFloats(r: number, g: number, b: number): Color3;
  85315. /**
  85316. * Updates the Color3 rgb values from the given floats
  85317. * @param r defines the red component to read from
  85318. * @param g defines the green component to read from
  85319. * @param b defines the blue component to read from
  85320. * @returns the current Color3 object
  85321. */
  85322. set(r: number, g: number, b: number): Color3;
  85323. /**
  85324. * Compute the Color3 hexadecimal code as a string
  85325. * @returns a string containing the hexadecimal representation of the Color3 object
  85326. */
  85327. toHexString(): string;
  85328. /**
  85329. * Computes a new Color3 converted from the current one to linear space
  85330. * @returns a new Color3 object
  85331. */
  85332. toLinearSpace(): Color3;
  85333. /**
  85334. * Converts current color in rgb space to HSV values
  85335. * @returns a new color3 representing the HSV values
  85336. */
  85337. toHSV(): Color3;
  85338. /**
  85339. * Converts current color in rgb space to HSV values
  85340. * @param result defines the Color3 where to store the HSV values
  85341. */
  85342. toHSVToRef(result: Color3): void;
  85343. /**
  85344. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  85345. * @param convertedColor defines the Color3 object where to store the linear space version
  85346. * @returns the unmodified Color3
  85347. */
  85348. toLinearSpaceToRef(convertedColor: Color3): Color3;
  85349. /**
  85350. * Computes a new Color3 converted from the current one to gamma space
  85351. * @returns a new Color3 object
  85352. */
  85353. toGammaSpace(): Color3;
  85354. /**
  85355. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  85356. * @param convertedColor defines the Color3 object where to store the gamma space version
  85357. * @returns the unmodified Color3
  85358. */
  85359. toGammaSpaceToRef(convertedColor: Color3): Color3;
  85360. private static _BlackReadOnly;
  85361. /**
  85362. * Convert Hue, saturation and value to a Color3 (RGB)
  85363. * @param hue defines the hue
  85364. * @param saturation defines the saturation
  85365. * @param value defines the value
  85366. * @param result defines the Color3 where to store the RGB values
  85367. */
  85368. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  85369. /**
  85370. * Creates a new Color3 from the string containing valid hexadecimal values
  85371. * @param hex defines a string containing valid hexadecimal values
  85372. * @returns a new Color3 object
  85373. */
  85374. static FromHexString(hex: string): Color3;
  85375. /**
  85376. * Creates a new Color3 from the starting index of the given array
  85377. * @param array defines the source array
  85378. * @param offset defines an offset in the source array
  85379. * @returns a new Color3 object
  85380. */
  85381. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85382. /**
  85383. * Creates a new Color3 from the starting index element of the given array
  85384. * @param array defines the source array to read from
  85385. * @param offset defines the offset in the source array
  85386. * @param result defines the target Color3 object
  85387. */
  85388. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  85389. /**
  85390. * Creates a new Color3 from integer values (< 256)
  85391. * @param r defines the red component to read from (value between 0 and 255)
  85392. * @param g defines the green component to read from (value between 0 and 255)
  85393. * @param b defines the blue component to read from (value between 0 and 255)
  85394. * @returns a new Color3 object
  85395. */
  85396. static FromInts(r: number, g: number, b: number): Color3;
  85397. /**
  85398. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85399. * @param start defines the start Color3 value
  85400. * @param end defines the end Color3 value
  85401. * @param amount defines the gradient value between start and end
  85402. * @returns a new Color3 object
  85403. */
  85404. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  85405. /**
  85406. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85407. * @param left defines the start value
  85408. * @param right defines the end value
  85409. * @param amount defines the gradient factor
  85410. * @param result defines the Color3 object where to store the result
  85411. */
  85412. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  85413. /**
  85414. * Returns a Color3 value containing a red color
  85415. * @returns a new Color3 object
  85416. */
  85417. static Red(): Color3;
  85418. /**
  85419. * Returns a Color3 value containing a green color
  85420. * @returns a new Color3 object
  85421. */
  85422. static Green(): Color3;
  85423. /**
  85424. * Returns a Color3 value containing a blue color
  85425. * @returns a new Color3 object
  85426. */
  85427. static Blue(): Color3;
  85428. /**
  85429. * Returns a Color3 value containing a black color
  85430. * @returns a new Color3 object
  85431. */
  85432. static Black(): Color3;
  85433. /**
  85434. * Gets a Color3 value containing a black color that must not be updated
  85435. */
  85436. static get BlackReadOnly(): DeepImmutable<Color3>;
  85437. /**
  85438. * Returns a Color3 value containing a white color
  85439. * @returns a new Color3 object
  85440. */
  85441. static White(): Color3;
  85442. /**
  85443. * Returns a Color3 value containing a purple color
  85444. * @returns a new Color3 object
  85445. */
  85446. static Purple(): Color3;
  85447. /**
  85448. * Returns a Color3 value containing a magenta color
  85449. * @returns a new Color3 object
  85450. */
  85451. static Magenta(): Color3;
  85452. /**
  85453. * Returns a Color3 value containing a yellow color
  85454. * @returns a new Color3 object
  85455. */
  85456. static Yellow(): Color3;
  85457. /**
  85458. * Returns a Color3 value containing a gray color
  85459. * @returns a new Color3 object
  85460. */
  85461. static Gray(): Color3;
  85462. /**
  85463. * Returns a Color3 value containing a teal color
  85464. * @returns a new Color3 object
  85465. */
  85466. static Teal(): Color3;
  85467. /**
  85468. * Returns a Color3 value containing a random color
  85469. * @returns a new Color3 object
  85470. */
  85471. static Random(): Color3;
  85472. }
  85473. /**
  85474. * Class used to hold a RBGA color
  85475. */
  85476. export class Color4 {
  85477. /**
  85478. * Defines the red component (between 0 and 1, default is 0)
  85479. */
  85480. r: number;
  85481. /**
  85482. * Defines the green component (between 0 and 1, default is 0)
  85483. */
  85484. g: number;
  85485. /**
  85486. * Defines the blue component (between 0 and 1, default is 0)
  85487. */
  85488. b: number;
  85489. /**
  85490. * Defines the alpha component (between 0 and 1, default is 1)
  85491. */
  85492. a: number;
  85493. /**
  85494. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  85495. * @param r defines the red component (between 0 and 1, default is 0)
  85496. * @param g defines the green component (between 0 and 1, default is 0)
  85497. * @param b defines the blue component (between 0 and 1, default is 0)
  85498. * @param a defines the alpha component (between 0 and 1, default is 1)
  85499. */
  85500. constructor(
  85501. /**
  85502. * Defines the red component (between 0 and 1, default is 0)
  85503. */
  85504. r?: number,
  85505. /**
  85506. * Defines the green component (between 0 and 1, default is 0)
  85507. */
  85508. g?: number,
  85509. /**
  85510. * Defines the blue component (between 0 and 1, default is 0)
  85511. */
  85512. b?: number,
  85513. /**
  85514. * Defines the alpha component (between 0 and 1, default is 1)
  85515. */
  85516. a?: number);
  85517. /**
  85518. * Adds in place the given Color4 values to the current Color4 object
  85519. * @param right defines the second operand
  85520. * @returns the current updated Color4 object
  85521. */
  85522. addInPlace(right: DeepImmutable<Color4>): Color4;
  85523. /**
  85524. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  85525. * @returns the new array
  85526. */
  85527. asArray(): number[];
  85528. /**
  85529. * Stores from the starting index in the given array the Color4 successive values
  85530. * @param array defines the array where to store the r,g,b components
  85531. * @param index defines an optional index in the target array to define where to start storing values
  85532. * @returns the current Color4 object
  85533. */
  85534. toArray(array: number[], index?: number): Color4;
  85535. /**
  85536. * Update the current color with values stored in an array from the starting index of the given array
  85537. * @param array defines the source array
  85538. * @param offset defines an offset in the source array
  85539. * @returns the current Color4 object
  85540. */
  85541. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85542. /**
  85543. * Determines equality between Color4 objects
  85544. * @param otherColor defines the second operand
  85545. * @returns true if the rgba values are equal to the given ones
  85546. */
  85547. equals(otherColor: DeepImmutable<Color4>): boolean;
  85548. /**
  85549. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  85550. * @param right defines the second operand
  85551. * @returns a new Color4 object
  85552. */
  85553. add(right: DeepImmutable<Color4>): Color4;
  85554. /**
  85555. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  85556. * @param right defines the second operand
  85557. * @returns a new Color4 object
  85558. */
  85559. subtract(right: DeepImmutable<Color4>): Color4;
  85560. /**
  85561. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  85562. * @param right defines the second operand
  85563. * @param result defines the Color4 object where to store the result
  85564. * @returns the current Color4 object
  85565. */
  85566. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  85567. /**
  85568. * Creates a new Color4 with the current Color4 values multiplied by scale
  85569. * @param scale defines the scaling factor to apply
  85570. * @returns a new Color4 object
  85571. */
  85572. scale(scale: number): Color4;
  85573. /**
  85574. * Multiplies the current Color4 values by scale and stores the result in "result"
  85575. * @param scale defines the scaling factor to apply
  85576. * @param result defines the Color4 object where to store the result
  85577. * @returns the current unmodified Color4
  85578. */
  85579. scaleToRef(scale: number, result: Color4): Color4;
  85580. /**
  85581. * Scale the current Color4 values by a factor and add the result to a given Color4
  85582. * @param scale defines the scale factor
  85583. * @param result defines the Color4 object where to store the result
  85584. * @returns the unmodified current Color4
  85585. */
  85586. scaleAndAddToRef(scale: number, result: Color4): Color4;
  85587. /**
  85588. * Clamps the rgb values by the min and max values and stores the result into "result"
  85589. * @param min defines minimum clamping value (default is 0)
  85590. * @param max defines maximum clamping value (default is 1)
  85591. * @param result defines color to store the result into.
  85592. * @returns the cuurent Color4
  85593. */
  85594. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  85595. /**
  85596. * Multipy an Color4 value by another and return a new Color4 object
  85597. * @param color defines the Color4 value to multiply by
  85598. * @returns a new Color4 object
  85599. */
  85600. multiply(color: Color4): Color4;
  85601. /**
  85602. * Multipy a Color4 value by another and push the result in a reference value
  85603. * @param color defines the Color4 value to multiply by
  85604. * @param result defines the Color4 to fill the result in
  85605. * @returns the result Color4
  85606. */
  85607. multiplyToRef(color: Color4, result: Color4): Color4;
  85608. /**
  85609. * Creates a string with the Color4 current values
  85610. * @returns the string representation of the Color4 object
  85611. */
  85612. toString(): string;
  85613. /**
  85614. * Returns the string "Color4"
  85615. * @returns "Color4"
  85616. */
  85617. getClassName(): string;
  85618. /**
  85619. * Compute the Color4 hash code
  85620. * @returns an unique number that can be used to hash Color4 objects
  85621. */
  85622. getHashCode(): number;
  85623. /**
  85624. * Creates a new Color4 copied from the current one
  85625. * @returns a new Color4 object
  85626. */
  85627. clone(): Color4;
  85628. /**
  85629. * Copies the given Color4 values into the current one
  85630. * @param source defines the source Color4 object
  85631. * @returns the current updated Color4 object
  85632. */
  85633. copyFrom(source: Color4): Color4;
  85634. /**
  85635. * Copies the given float values into the current one
  85636. * @param r defines the red component to read from
  85637. * @param g defines the green component to read from
  85638. * @param b defines the blue component to read from
  85639. * @param a defines the alpha component to read from
  85640. * @returns the current updated Color4 object
  85641. */
  85642. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  85643. /**
  85644. * Copies the given float values into the current one
  85645. * @param r defines the red component to read from
  85646. * @param g defines the green component to read from
  85647. * @param b defines the blue component to read from
  85648. * @param a defines the alpha component to read from
  85649. * @returns the current updated Color4 object
  85650. */
  85651. set(r: number, g: number, b: number, a: number): Color4;
  85652. /**
  85653. * Compute the Color4 hexadecimal code as a string
  85654. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  85655. * @returns a string containing the hexadecimal representation of the Color4 object
  85656. */
  85657. toHexString(returnAsColor3?: boolean): string;
  85658. /**
  85659. * Computes a new Color4 converted from the current one to linear space
  85660. * @returns a new Color4 object
  85661. */
  85662. toLinearSpace(): Color4;
  85663. /**
  85664. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  85665. * @param convertedColor defines the Color4 object where to store the linear space version
  85666. * @returns the unmodified Color4
  85667. */
  85668. toLinearSpaceToRef(convertedColor: Color4): Color4;
  85669. /**
  85670. * Computes a new Color4 converted from the current one to gamma space
  85671. * @returns a new Color4 object
  85672. */
  85673. toGammaSpace(): Color4;
  85674. /**
  85675. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  85676. * @param convertedColor defines the Color4 object where to store the gamma space version
  85677. * @returns the unmodified Color4
  85678. */
  85679. toGammaSpaceToRef(convertedColor: Color4): Color4;
  85680. /**
  85681. * Creates a new Color4 from the string containing valid hexadecimal values
  85682. * @param hex defines a string containing valid hexadecimal values
  85683. * @returns a new Color4 object
  85684. */
  85685. static FromHexString(hex: string): Color4;
  85686. /**
  85687. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85688. * @param left defines the start value
  85689. * @param right defines the end value
  85690. * @param amount defines the gradient factor
  85691. * @returns a new Color4 object
  85692. */
  85693. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  85694. /**
  85695. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85696. * @param left defines the start value
  85697. * @param right defines the end value
  85698. * @param amount defines the gradient factor
  85699. * @param result defines the Color4 object where to store data
  85700. */
  85701. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  85702. /**
  85703. * Creates a new Color4 from a Color3 and an alpha value
  85704. * @param color3 defines the source Color3 to read from
  85705. * @param alpha defines the alpha component (1.0 by default)
  85706. * @returns a new Color4 object
  85707. */
  85708. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  85709. /**
  85710. * Creates a new Color4 from the starting index element of the given array
  85711. * @param array defines the source array to read from
  85712. * @param offset defines the offset in the source array
  85713. * @returns a new Color4 object
  85714. */
  85715. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85716. /**
  85717. * Creates a new Color4 from the starting index element of the given array
  85718. * @param array defines the source array to read from
  85719. * @param offset defines the offset in the source array
  85720. * @param result defines the target Color4 object
  85721. */
  85722. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  85723. /**
  85724. * Creates a new Color3 from integer values (< 256)
  85725. * @param r defines the red component to read from (value between 0 and 255)
  85726. * @param g defines the green component to read from (value between 0 and 255)
  85727. * @param b defines the blue component to read from (value between 0 and 255)
  85728. * @param a defines the alpha component to read from (value between 0 and 255)
  85729. * @returns a new Color3 object
  85730. */
  85731. static FromInts(r: number, g: number, b: number, a: number): Color4;
  85732. /**
  85733. * Check the content of a given array and convert it to an array containing RGBA data
  85734. * If the original array was already containing count * 4 values then it is returned directly
  85735. * @param colors defines the array to check
  85736. * @param count defines the number of RGBA data to expect
  85737. * @returns an array containing count * 4 values (RGBA)
  85738. */
  85739. static CheckColors4(colors: number[], count: number): number[];
  85740. }
  85741. /**
  85742. * @hidden
  85743. */
  85744. export class TmpColors {
  85745. static Color3: Color3[];
  85746. static Color4: Color4[];
  85747. }
  85748. }
  85749. declare module BABYLON {
  85750. /**
  85751. * Defines an interface which represents an animation key frame
  85752. */
  85753. export interface IAnimationKey {
  85754. /**
  85755. * Frame of the key frame
  85756. */
  85757. frame: number;
  85758. /**
  85759. * Value at the specifies key frame
  85760. */
  85761. value: any;
  85762. /**
  85763. * The input tangent for the cubic hermite spline
  85764. */
  85765. inTangent?: any;
  85766. /**
  85767. * The output tangent for the cubic hermite spline
  85768. */
  85769. outTangent?: any;
  85770. /**
  85771. * The animation interpolation type
  85772. */
  85773. interpolation?: AnimationKeyInterpolation;
  85774. }
  85775. /**
  85776. * Enum for the animation key frame interpolation type
  85777. */
  85778. export enum AnimationKeyInterpolation {
  85779. /**
  85780. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  85781. */
  85782. STEP = 1
  85783. }
  85784. }
  85785. declare module BABYLON {
  85786. /**
  85787. * Represents the range of an animation
  85788. */
  85789. export class AnimationRange {
  85790. /**The name of the animation range**/
  85791. name: string;
  85792. /**The starting frame of the animation */
  85793. from: number;
  85794. /**The ending frame of the animation*/
  85795. to: number;
  85796. /**
  85797. * Initializes the range of an animation
  85798. * @param name The name of the animation range
  85799. * @param from The starting frame of the animation
  85800. * @param to The ending frame of the animation
  85801. */
  85802. constructor(
  85803. /**The name of the animation range**/
  85804. name: string,
  85805. /**The starting frame of the animation */
  85806. from: number,
  85807. /**The ending frame of the animation*/
  85808. to: number);
  85809. /**
  85810. * Makes a copy of the animation range
  85811. * @returns A copy of the animation range
  85812. */
  85813. clone(): AnimationRange;
  85814. }
  85815. }
  85816. declare module BABYLON {
  85817. /**
  85818. * Composed of a frame, and an action function
  85819. */
  85820. export class AnimationEvent {
  85821. /** The frame for which the event is triggered **/
  85822. frame: number;
  85823. /** The event to perform when triggered **/
  85824. action: (currentFrame: number) => void;
  85825. /** Specifies if the event should be triggered only once**/
  85826. onlyOnce?: boolean | undefined;
  85827. /**
  85828. * Specifies if the animation event is done
  85829. */
  85830. isDone: boolean;
  85831. /**
  85832. * Initializes the animation event
  85833. * @param frame The frame for which the event is triggered
  85834. * @param action The event to perform when triggered
  85835. * @param onlyOnce Specifies if the event should be triggered only once
  85836. */
  85837. constructor(
  85838. /** The frame for which the event is triggered **/
  85839. frame: number,
  85840. /** The event to perform when triggered **/
  85841. action: (currentFrame: number) => void,
  85842. /** Specifies if the event should be triggered only once**/
  85843. onlyOnce?: boolean | undefined);
  85844. /** @hidden */
  85845. _clone(): AnimationEvent;
  85846. }
  85847. }
  85848. declare module BABYLON {
  85849. /**
  85850. * Interface used to define a behavior
  85851. */
  85852. export interface Behavior<T> {
  85853. /** gets or sets behavior's name */
  85854. name: string;
  85855. /**
  85856. * Function called when the behavior needs to be initialized (after attaching it to a target)
  85857. */
  85858. init(): void;
  85859. /**
  85860. * Called when the behavior is attached to a target
  85861. * @param target defines the target where the behavior is attached to
  85862. */
  85863. attach(target: T): void;
  85864. /**
  85865. * Called when the behavior is detached from its target
  85866. */
  85867. detach(): void;
  85868. }
  85869. /**
  85870. * Interface implemented by classes supporting behaviors
  85871. */
  85872. export interface IBehaviorAware<T> {
  85873. /**
  85874. * Attach a behavior
  85875. * @param behavior defines the behavior to attach
  85876. * @returns the current host
  85877. */
  85878. addBehavior(behavior: Behavior<T>): T;
  85879. /**
  85880. * Remove a behavior from the current object
  85881. * @param behavior defines the behavior to detach
  85882. * @returns the current host
  85883. */
  85884. removeBehavior(behavior: Behavior<T>): T;
  85885. /**
  85886. * Gets a behavior using its name to search
  85887. * @param name defines the name to search
  85888. * @returns the behavior or null if not found
  85889. */
  85890. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  85891. }
  85892. }
  85893. declare module BABYLON {
  85894. /**
  85895. * Defines an array and its length.
  85896. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  85897. */
  85898. export interface ISmartArrayLike<T> {
  85899. /**
  85900. * The data of the array.
  85901. */
  85902. data: Array<T>;
  85903. /**
  85904. * The active length of the array.
  85905. */
  85906. length: number;
  85907. }
  85908. /**
  85909. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85910. */
  85911. export class SmartArray<T> implements ISmartArrayLike<T> {
  85912. /**
  85913. * The full set of data from the array.
  85914. */
  85915. data: Array<T>;
  85916. /**
  85917. * The active length of the array.
  85918. */
  85919. length: number;
  85920. protected _id: number;
  85921. /**
  85922. * Instantiates a Smart Array.
  85923. * @param capacity defines the default capacity of the array.
  85924. */
  85925. constructor(capacity: number);
  85926. /**
  85927. * Pushes a value at the end of the active data.
  85928. * @param value defines the object to push in the array.
  85929. */
  85930. push(value: T): void;
  85931. /**
  85932. * Iterates over the active data and apply the lambda to them.
  85933. * @param func defines the action to apply on each value.
  85934. */
  85935. forEach(func: (content: T) => void): void;
  85936. /**
  85937. * Sorts the full sets of data.
  85938. * @param compareFn defines the comparison function to apply.
  85939. */
  85940. sort(compareFn: (a: T, b: T) => number): void;
  85941. /**
  85942. * Resets the active data to an empty array.
  85943. */
  85944. reset(): void;
  85945. /**
  85946. * Releases all the data from the array as well as the array.
  85947. */
  85948. dispose(): void;
  85949. /**
  85950. * Concats the active data with a given array.
  85951. * @param array defines the data to concatenate with.
  85952. */
  85953. concat(array: any): void;
  85954. /**
  85955. * Returns the position of a value in the active data.
  85956. * @param value defines the value to find the index for
  85957. * @returns the index if found in the active data otherwise -1
  85958. */
  85959. indexOf(value: T): number;
  85960. /**
  85961. * Returns whether an element is part of the active data.
  85962. * @param value defines the value to look for
  85963. * @returns true if found in the active data otherwise false
  85964. */
  85965. contains(value: T): boolean;
  85966. private static _GlobalId;
  85967. }
  85968. /**
  85969. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85970. * The data in this array can only be present once
  85971. */
  85972. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  85973. private _duplicateId;
  85974. /**
  85975. * Pushes a value at the end of the active data.
  85976. * THIS DOES NOT PREVENT DUPPLICATE DATA
  85977. * @param value defines the object to push in the array.
  85978. */
  85979. push(value: T): void;
  85980. /**
  85981. * Pushes a value at the end of the active data.
  85982. * If the data is already present, it won t be added again
  85983. * @param value defines the object to push in the array.
  85984. * @returns true if added false if it was already present
  85985. */
  85986. pushNoDuplicate(value: T): boolean;
  85987. /**
  85988. * Resets the active data to an empty array.
  85989. */
  85990. reset(): void;
  85991. /**
  85992. * Concats the active data with a given array.
  85993. * This ensures no dupplicate will be present in the result.
  85994. * @param array defines the data to concatenate with.
  85995. */
  85996. concatWithNoDuplicate(array: any): void;
  85997. }
  85998. }
  85999. declare module BABYLON {
  86000. /**
  86001. * @ignore
  86002. * This is a list of all the different input types that are available in the application.
  86003. * Fo instance: ArcRotateCameraGamepadInput...
  86004. */
  86005. export var CameraInputTypes: {};
  86006. /**
  86007. * This is the contract to implement in order to create a new input class.
  86008. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  86009. */
  86010. export interface ICameraInput<TCamera extends Camera> {
  86011. /**
  86012. * Defines the camera the input is attached to.
  86013. */
  86014. camera: Nullable<TCamera>;
  86015. /**
  86016. * Gets the class name of the current intput.
  86017. * @returns the class name
  86018. */
  86019. getClassName(): string;
  86020. /**
  86021. * Get the friendly name associated with the input class.
  86022. * @returns the input friendly name
  86023. */
  86024. getSimpleName(): string;
  86025. /**
  86026. * Attach the input controls to a specific dom element to get the input from.
  86027. * @param element Defines the element the controls should be listened from
  86028. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86029. */
  86030. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  86031. /**
  86032. * Detach the current controls from the specified dom element.
  86033. * @param element Defines the element to stop listening the inputs from
  86034. */
  86035. detachControl(element: Nullable<HTMLElement>): void;
  86036. /**
  86037. * Update the current camera state depending on the inputs that have been used this frame.
  86038. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86039. */
  86040. checkInputs?: () => void;
  86041. }
  86042. /**
  86043. * Represents a map of input types to input instance or input index to input instance.
  86044. */
  86045. export interface CameraInputsMap<TCamera extends Camera> {
  86046. /**
  86047. * Accessor to the input by input type.
  86048. */
  86049. [name: string]: ICameraInput<TCamera>;
  86050. /**
  86051. * Accessor to the input by input index.
  86052. */
  86053. [idx: number]: ICameraInput<TCamera>;
  86054. }
  86055. /**
  86056. * This represents the input manager used within a camera.
  86057. * It helps dealing with all the different kind of input attached to a camera.
  86058. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86059. */
  86060. export class CameraInputsManager<TCamera extends Camera> {
  86061. /**
  86062. * Defines the list of inputs attahed to the camera.
  86063. */
  86064. attached: CameraInputsMap<TCamera>;
  86065. /**
  86066. * Defines the dom element the camera is collecting inputs from.
  86067. * This is null if the controls have not been attached.
  86068. */
  86069. attachedElement: Nullable<HTMLElement>;
  86070. /**
  86071. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86072. */
  86073. noPreventDefault: boolean;
  86074. /**
  86075. * Defined the camera the input manager belongs to.
  86076. */
  86077. camera: TCamera;
  86078. /**
  86079. * Update the current camera state depending on the inputs that have been used this frame.
  86080. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86081. */
  86082. checkInputs: () => void;
  86083. /**
  86084. * Instantiate a new Camera Input Manager.
  86085. * @param camera Defines the camera the input manager blongs to
  86086. */
  86087. constructor(camera: TCamera);
  86088. /**
  86089. * Add an input method to a camera
  86090. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86091. * @param input camera input method
  86092. */
  86093. add(input: ICameraInput<TCamera>): void;
  86094. /**
  86095. * Remove a specific input method from a camera
  86096. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  86097. * @param inputToRemove camera input method
  86098. */
  86099. remove(inputToRemove: ICameraInput<TCamera>): void;
  86100. /**
  86101. * Remove a specific input type from a camera
  86102. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  86103. * @param inputType the type of the input to remove
  86104. */
  86105. removeByType(inputType: string): void;
  86106. private _addCheckInputs;
  86107. /**
  86108. * Attach the input controls to the currently attached dom element to listen the events from.
  86109. * @param input Defines the input to attach
  86110. */
  86111. attachInput(input: ICameraInput<TCamera>): void;
  86112. /**
  86113. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  86114. * @param element Defines the dom element to collect the events from
  86115. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86116. */
  86117. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  86118. /**
  86119. * Detach the current manager inputs controls from a specific dom element.
  86120. * @param element Defines the dom element to collect the events from
  86121. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  86122. */
  86123. detachElement(element: HTMLElement, disconnect?: boolean): void;
  86124. /**
  86125. * Rebuild the dynamic inputCheck function from the current list of
  86126. * defined inputs in the manager.
  86127. */
  86128. rebuildInputCheck(): void;
  86129. /**
  86130. * Remove all attached input methods from a camera
  86131. */
  86132. clear(): void;
  86133. /**
  86134. * Serialize the current input manager attached to a camera.
  86135. * This ensures than once parsed,
  86136. * the input associated to the camera will be identical to the current ones
  86137. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  86138. */
  86139. serialize(serializedCamera: any): void;
  86140. /**
  86141. * Parses an input manager serialized JSON to restore the previous list of inputs
  86142. * and states associated to a camera.
  86143. * @param parsedCamera Defines the JSON to parse
  86144. */
  86145. parse(parsedCamera: any): void;
  86146. }
  86147. }
  86148. declare module BABYLON {
  86149. /**
  86150. * Class used to store data that will be store in GPU memory
  86151. */
  86152. export class Buffer {
  86153. private _engine;
  86154. private _buffer;
  86155. /** @hidden */
  86156. _data: Nullable<DataArray>;
  86157. private _updatable;
  86158. private _instanced;
  86159. private _divisor;
  86160. /**
  86161. * Gets the byte stride.
  86162. */
  86163. readonly byteStride: number;
  86164. /**
  86165. * Constructor
  86166. * @param engine the engine
  86167. * @param data the data to use for this buffer
  86168. * @param updatable whether the data is updatable
  86169. * @param stride the stride (optional)
  86170. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86171. * @param instanced whether the buffer is instanced (optional)
  86172. * @param useBytes set to true if the stride in in bytes (optional)
  86173. * @param divisor sets an optional divisor for instances (1 by default)
  86174. */
  86175. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  86176. /**
  86177. * Create a new VertexBuffer based on the current buffer
  86178. * @param kind defines the vertex buffer kind (position, normal, etc.)
  86179. * @param offset defines offset in the buffer (0 by default)
  86180. * @param size defines the size in floats of attributes (position is 3 for instance)
  86181. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  86182. * @param instanced defines if the vertex buffer contains indexed data
  86183. * @param useBytes defines if the offset and stride are in bytes *
  86184. * @param divisor sets an optional divisor for instances (1 by default)
  86185. * @returns the new vertex buffer
  86186. */
  86187. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  86188. /**
  86189. * Gets a boolean indicating if the Buffer is updatable?
  86190. * @returns true if the buffer is updatable
  86191. */
  86192. isUpdatable(): boolean;
  86193. /**
  86194. * Gets current buffer's data
  86195. * @returns a DataArray or null
  86196. */
  86197. getData(): Nullable<DataArray>;
  86198. /**
  86199. * Gets underlying native buffer
  86200. * @returns underlying native buffer
  86201. */
  86202. getBuffer(): Nullable<DataBuffer>;
  86203. /**
  86204. * Gets the stride in float32 units (i.e. byte stride / 4).
  86205. * May not be an integer if the byte stride is not divisible by 4.
  86206. * @returns the stride in float32 units
  86207. * @deprecated Please use byteStride instead.
  86208. */
  86209. getStrideSize(): number;
  86210. /**
  86211. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86212. * @param data defines the data to store
  86213. */
  86214. create(data?: Nullable<DataArray>): void;
  86215. /** @hidden */
  86216. _rebuild(): void;
  86217. /**
  86218. * Update current buffer data
  86219. * @param data defines the data to store
  86220. */
  86221. update(data: DataArray): void;
  86222. /**
  86223. * Updates the data directly.
  86224. * @param data the new data
  86225. * @param offset the new offset
  86226. * @param vertexCount the vertex count (optional)
  86227. * @param useBytes set to true if the offset is in bytes
  86228. */
  86229. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  86230. /**
  86231. * Release all resources
  86232. */
  86233. dispose(): void;
  86234. }
  86235. /**
  86236. * Specialized buffer used to store vertex data
  86237. */
  86238. export class VertexBuffer {
  86239. /** @hidden */
  86240. _buffer: Buffer;
  86241. private _kind;
  86242. private _size;
  86243. private _ownsBuffer;
  86244. private _instanced;
  86245. private _instanceDivisor;
  86246. /**
  86247. * The byte type.
  86248. */
  86249. static readonly BYTE: number;
  86250. /**
  86251. * The unsigned byte type.
  86252. */
  86253. static readonly UNSIGNED_BYTE: number;
  86254. /**
  86255. * The short type.
  86256. */
  86257. static readonly SHORT: number;
  86258. /**
  86259. * The unsigned short type.
  86260. */
  86261. static readonly UNSIGNED_SHORT: number;
  86262. /**
  86263. * The integer type.
  86264. */
  86265. static readonly INT: number;
  86266. /**
  86267. * The unsigned integer type.
  86268. */
  86269. static readonly UNSIGNED_INT: number;
  86270. /**
  86271. * The float type.
  86272. */
  86273. static readonly FLOAT: number;
  86274. /**
  86275. * Gets or sets the instance divisor when in instanced mode
  86276. */
  86277. get instanceDivisor(): number;
  86278. set instanceDivisor(value: number);
  86279. /**
  86280. * Gets the byte stride.
  86281. */
  86282. readonly byteStride: number;
  86283. /**
  86284. * Gets the byte offset.
  86285. */
  86286. readonly byteOffset: number;
  86287. /**
  86288. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  86289. */
  86290. readonly normalized: boolean;
  86291. /**
  86292. * Gets the data type of each component in the array.
  86293. */
  86294. readonly type: number;
  86295. /**
  86296. * Constructor
  86297. * @param engine the engine
  86298. * @param data the data to use for this vertex buffer
  86299. * @param kind the vertex buffer kind
  86300. * @param updatable whether the data is updatable
  86301. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86302. * @param stride the stride (optional)
  86303. * @param instanced whether the buffer is instanced (optional)
  86304. * @param offset the offset of the data (optional)
  86305. * @param size the number of components (optional)
  86306. * @param type the type of the component (optional)
  86307. * @param normalized whether the data contains normalized data (optional)
  86308. * @param useBytes set to true if stride and offset are in bytes (optional)
  86309. * @param divisor defines the instance divisor to use (1 by default)
  86310. */
  86311. 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);
  86312. /** @hidden */
  86313. _rebuild(): void;
  86314. /**
  86315. * Returns the kind of the VertexBuffer (string)
  86316. * @returns a string
  86317. */
  86318. getKind(): string;
  86319. /**
  86320. * Gets a boolean indicating if the VertexBuffer is updatable?
  86321. * @returns true if the buffer is updatable
  86322. */
  86323. isUpdatable(): boolean;
  86324. /**
  86325. * Gets current buffer's data
  86326. * @returns a DataArray or null
  86327. */
  86328. getData(): Nullable<DataArray>;
  86329. /**
  86330. * Gets underlying native buffer
  86331. * @returns underlying native buffer
  86332. */
  86333. getBuffer(): Nullable<DataBuffer>;
  86334. /**
  86335. * Gets the stride in float32 units (i.e. byte stride / 4).
  86336. * May not be an integer if the byte stride is not divisible by 4.
  86337. * @returns the stride in float32 units
  86338. * @deprecated Please use byteStride instead.
  86339. */
  86340. getStrideSize(): number;
  86341. /**
  86342. * Returns the offset as a multiple of the type byte length.
  86343. * @returns the offset in bytes
  86344. * @deprecated Please use byteOffset instead.
  86345. */
  86346. getOffset(): number;
  86347. /**
  86348. * Returns the number of components per vertex attribute (integer)
  86349. * @returns the size in float
  86350. */
  86351. getSize(): number;
  86352. /**
  86353. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  86354. * @returns true if this buffer is instanced
  86355. */
  86356. getIsInstanced(): boolean;
  86357. /**
  86358. * Returns the instancing divisor, zero for non-instanced (integer).
  86359. * @returns a number
  86360. */
  86361. getInstanceDivisor(): number;
  86362. /**
  86363. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86364. * @param data defines the data to store
  86365. */
  86366. create(data?: DataArray): void;
  86367. /**
  86368. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  86369. * This function will create a new buffer if the current one is not updatable
  86370. * @param data defines the data to store
  86371. */
  86372. update(data: DataArray): void;
  86373. /**
  86374. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  86375. * Returns the directly updated WebGLBuffer.
  86376. * @param data the new data
  86377. * @param offset the new offset
  86378. * @param useBytes set to true if the offset is in bytes
  86379. */
  86380. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  86381. /**
  86382. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  86383. */
  86384. dispose(): void;
  86385. /**
  86386. * Enumerates each value of this vertex buffer as numbers.
  86387. * @param count the number of values to enumerate
  86388. * @param callback the callback function called for each value
  86389. */
  86390. forEach(count: number, callback: (value: number, index: number) => void): void;
  86391. /**
  86392. * Positions
  86393. */
  86394. static readonly PositionKind: string;
  86395. /**
  86396. * Normals
  86397. */
  86398. static readonly NormalKind: string;
  86399. /**
  86400. * Tangents
  86401. */
  86402. static readonly TangentKind: string;
  86403. /**
  86404. * Texture coordinates
  86405. */
  86406. static readonly UVKind: string;
  86407. /**
  86408. * Texture coordinates 2
  86409. */
  86410. static readonly UV2Kind: string;
  86411. /**
  86412. * Texture coordinates 3
  86413. */
  86414. static readonly UV3Kind: string;
  86415. /**
  86416. * Texture coordinates 4
  86417. */
  86418. static readonly UV4Kind: string;
  86419. /**
  86420. * Texture coordinates 5
  86421. */
  86422. static readonly UV5Kind: string;
  86423. /**
  86424. * Texture coordinates 6
  86425. */
  86426. static readonly UV6Kind: string;
  86427. /**
  86428. * Colors
  86429. */
  86430. static readonly ColorKind: string;
  86431. /**
  86432. * Matrix indices (for bones)
  86433. */
  86434. static readonly MatricesIndicesKind: string;
  86435. /**
  86436. * Matrix weights (for bones)
  86437. */
  86438. static readonly MatricesWeightsKind: string;
  86439. /**
  86440. * Additional matrix indices (for bones)
  86441. */
  86442. static readonly MatricesIndicesExtraKind: string;
  86443. /**
  86444. * Additional matrix weights (for bones)
  86445. */
  86446. static readonly MatricesWeightsExtraKind: string;
  86447. /**
  86448. * Deduces the stride given a kind.
  86449. * @param kind The kind string to deduce
  86450. * @returns The deduced stride
  86451. */
  86452. static DeduceStride(kind: string): number;
  86453. /**
  86454. * Gets the byte length of the given type.
  86455. * @param type the type
  86456. * @returns the number of bytes
  86457. */
  86458. static GetTypeByteLength(type: number): number;
  86459. /**
  86460. * Enumerates each value of the given parameters as numbers.
  86461. * @param data the data to enumerate
  86462. * @param byteOffset the byte offset of the data
  86463. * @param byteStride the byte stride of the data
  86464. * @param componentCount the number of components per element
  86465. * @param componentType the type of the component
  86466. * @param count the number of values to enumerate
  86467. * @param normalized whether the data is normalized
  86468. * @param callback the callback function called for each value
  86469. */
  86470. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  86471. private static _GetFloatValue;
  86472. }
  86473. }
  86474. declare module BABYLON {
  86475. /**
  86476. * @hidden
  86477. */
  86478. export class IntersectionInfo {
  86479. bu: Nullable<number>;
  86480. bv: Nullable<number>;
  86481. distance: number;
  86482. faceId: number;
  86483. subMeshId: number;
  86484. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  86485. }
  86486. }
  86487. declare module BABYLON {
  86488. /**
  86489. * Class used to store bounding sphere information
  86490. */
  86491. export class BoundingSphere {
  86492. /**
  86493. * Gets the center of the bounding sphere in local space
  86494. */
  86495. readonly center: Vector3;
  86496. /**
  86497. * Radius of the bounding sphere in local space
  86498. */
  86499. radius: number;
  86500. /**
  86501. * Gets the center of the bounding sphere in world space
  86502. */
  86503. readonly centerWorld: Vector3;
  86504. /**
  86505. * Radius of the bounding sphere in world space
  86506. */
  86507. radiusWorld: number;
  86508. /**
  86509. * Gets the minimum vector in local space
  86510. */
  86511. readonly minimum: Vector3;
  86512. /**
  86513. * Gets the maximum vector in local space
  86514. */
  86515. readonly maximum: Vector3;
  86516. private _worldMatrix;
  86517. private static readonly TmpVector3;
  86518. /**
  86519. * Creates a new bounding sphere
  86520. * @param min defines the minimum vector (in local space)
  86521. * @param max defines the maximum vector (in local space)
  86522. * @param worldMatrix defines the new world matrix
  86523. */
  86524. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86525. /**
  86526. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  86527. * @param min defines the new minimum vector (in local space)
  86528. * @param max defines the new maximum vector (in local space)
  86529. * @param worldMatrix defines the new world matrix
  86530. */
  86531. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86532. /**
  86533. * Scale the current bounding sphere by applying a scale factor
  86534. * @param factor defines the scale factor to apply
  86535. * @returns the current bounding box
  86536. */
  86537. scale(factor: number): BoundingSphere;
  86538. /**
  86539. * Gets the world matrix of the bounding box
  86540. * @returns a matrix
  86541. */
  86542. getWorldMatrix(): DeepImmutable<Matrix>;
  86543. /** @hidden */
  86544. _update(worldMatrix: DeepImmutable<Matrix>): void;
  86545. /**
  86546. * Tests if the bounding sphere is intersecting the frustum planes
  86547. * @param frustumPlanes defines the frustum planes to test
  86548. * @returns true if there is an intersection
  86549. */
  86550. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86551. /**
  86552. * Tests if the bounding sphere center is in between the frustum planes.
  86553. * Used for optimistic fast inclusion.
  86554. * @param frustumPlanes defines the frustum planes to test
  86555. * @returns true if the sphere center is in between the frustum planes
  86556. */
  86557. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86558. /**
  86559. * Tests if a point is inside the bounding sphere
  86560. * @param point defines the point to test
  86561. * @returns true if the point is inside the bounding sphere
  86562. */
  86563. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86564. /**
  86565. * Checks if two sphere intersct
  86566. * @param sphere0 sphere 0
  86567. * @param sphere1 sphere 1
  86568. * @returns true if the speres intersect
  86569. */
  86570. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  86571. }
  86572. }
  86573. declare module BABYLON {
  86574. /**
  86575. * Class used to store bounding box information
  86576. */
  86577. export class BoundingBox implements ICullable {
  86578. /**
  86579. * Gets the 8 vectors representing the bounding box in local space
  86580. */
  86581. readonly vectors: Vector3[];
  86582. /**
  86583. * Gets the center of the bounding box in local space
  86584. */
  86585. readonly center: Vector3;
  86586. /**
  86587. * Gets the center of the bounding box in world space
  86588. */
  86589. readonly centerWorld: Vector3;
  86590. /**
  86591. * Gets the extend size in local space
  86592. */
  86593. readonly extendSize: Vector3;
  86594. /**
  86595. * Gets the extend size in world space
  86596. */
  86597. readonly extendSizeWorld: Vector3;
  86598. /**
  86599. * Gets the OBB (object bounding box) directions
  86600. */
  86601. readonly directions: Vector3[];
  86602. /**
  86603. * Gets the 8 vectors representing the bounding box in world space
  86604. */
  86605. readonly vectorsWorld: Vector3[];
  86606. /**
  86607. * Gets the minimum vector in world space
  86608. */
  86609. readonly minimumWorld: Vector3;
  86610. /**
  86611. * Gets the maximum vector in world space
  86612. */
  86613. readonly maximumWorld: Vector3;
  86614. /**
  86615. * Gets the minimum vector in local space
  86616. */
  86617. readonly minimum: Vector3;
  86618. /**
  86619. * Gets the maximum vector in local space
  86620. */
  86621. readonly maximum: Vector3;
  86622. private _worldMatrix;
  86623. private static readonly TmpVector3;
  86624. /**
  86625. * @hidden
  86626. */
  86627. _tag: number;
  86628. /**
  86629. * Creates a new bounding box
  86630. * @param min defines the minimum vector (in local space)
  86631. * @param max defines the maximum vector (in local space)
  86632. * @param worldMatrix defines the new world matrix
  86633. */
  86634. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86635. /**
  86636. * Recreates the entire bounding box from scratch as if we call the constructor in place
  86637. * @param min defines the new minimum vector (in local space)
  86638. * @param max defines the new maximum vector (in local space)
  86639. * @param worldMatrix defines the new world matrix
  86640. */
  86641. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86642. /**
  86643. * Scale the current bounding box by applying a scale factor
  86644. * @param factor defines the scale factor to apply
  86645. * @returns the current bounding box
  86646. */
  86647. scale(factor: number): BoundingBox;
  86648. /**
  86649. * Gets the world matrix of the bounding box
  86650. * @returns a matrix
  86651. */
  86652. getWorldMatrix(): DeepImmutable<Matrix>;
  86653. /** @hidden */
  86654. _update(world: DeepImmutable<Matrix>): void;
  86655. /**
  86656. * Tests if the bounding box is intersecting the frustum planes
  86657. * @param frustumPlanes defines the frustum planes to test
  86658. * @returns true if there is an intersection
  86659. */
  86660. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86661. /**
  86662. * Tests if the bounding box is entirely inside the frustum planes
  86663. * @param frustumPlanes defines the frustum planes to test
  86664. * @returns true if there is an inclusion
  86665. */
  86666. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86667. /**
  86668. * Tests if a point is inside the bounding box
  86669. * @param point defines the point to test
  86670. * @returns true if the point is inside the bounding box
  86671. */
  86672. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86673. /**
  86674. * Tests if the bounding box intersects with a bounding sphere
  86675. * @param sphere defines the sphere to test
  86676. * @returns true if there is an intersection
  86677. */
  86678. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  86679. /**
  86680. * Tests if the bounding box intersects with a box defined by a min and max vectors
  86681. * @param min defines the min vector to use
  86682. * @param max defines the max vector to use
  86683. * @returns true if there is an intersection
  86684. */
  86685. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  86686. /**
  86687. * Tests if two bounding boxes are intersections
  86688. * @param box0 defines the first box to test
  86689. * @param box1 defines the second box to test
  86690. * @returns true if there is an intersection
  86691. */
  86692. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  86693. /**
  86694. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  86695. * @param minPoint defines the minimum vector of the bounding box
  86696. * @param maxPoint defines the maximum vector of the bounding box
  86697. * @param sphereCenter defines the sphere center
  86698. * @param sphereRadius defines the sphere radius
  86699. * @returns true if there is an intersection
  86700. */
  86701. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  86702. /**
  86703. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  86704. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86705. * @param frustumPlanes defines the frustum planes to test
  86706. * @return true if there is an inclusion
  86707. */
  86708. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86709. /**
  86710. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  86711. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86712. * @param frustumPlanes defines the frustum planes to test
  86713. * @return true if there is an intersection
  86714. */
  86715. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86716. }
  86717. }
  86718. declare module BABYLON {
  86719. /** @hidden */
  86720. export class Collider {
  86721. /** Define if a collision was found */
  86722. collisionFound: boolean;
  86723. /**
  86724. * Define last intersection point in local space
  86725. */
  86726. intersectionPoint: Vector3;
  86727. /**
  86728. * Define last collided mesh
  86729. */
  86730. collidedMesh: Nullable<AbstractMesh>;
  86731. private _collisionPoint;
  86732. private _planeIntersectionPoint;
  86733. private _tempVector;
  86734. private _tempVector2;
  86735. private _tempVector3;
  86736. private _tempVector4;
  86737. private _edge;
  86738. private _baseToVertex;
  86739. private _destinationPoint;
  86740. private _slidePlaneNormal;
  86741. private _displacementVector;
  86742. /** @hidden */
  86743. _radius: Vector3;
  86744. /** @hidden */
  86745. _retry: number;
  86746. private _velocity;
  86747. private _basePoint;
  86748. private _epsilon;
  86749. /** @hidden */
  86750. _velocityWorldLength: number;
  86751. /** @hidden */
  86752. _basePointWorld: Vector3;
  86753. private _velocityWorld;
  86754. private _normalizedVelocity;
  86755. /** @hidden */
  86756. _initialVelocity: Vector3;
  86757. /** @hidden */
  86758. _initialPosition: Vector3;
  86759. private _nearestDistance;
  86760. private _collisionMask;
  86761. get collisionMask(): number;
  86762. set collisionMask(mask: number);
  86763. /**
  86764. * Gets the plane normal used to compute the sliding response (in local space)
  86765. */
  86766. get slidePlaneNormal(): Vector3;
  86767. /** @hidden */
  86768. _initialize(source: Vector3, dir: Vector3, e: number): void;
  86769. /** @hidden */
  86770. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  86771. /** @hidden */
  86772. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  86773. /** @hidden */
  86774. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86775. /** @hidden */
  86776. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86777. /** @hidden */
  86778. _getResponse(pos: Vector3, vel: Vector3): void;
  86779. }
  86780. }
  86781. declare module BABYLON {
  86782. /**
  86783. * Interface for cullable objects
  86784. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  86785. */
  86786. export interface ICullable {
  86787. /**
  86788. * Checks if the object or part of the object is in the frustum
  86789. * @param frustumPlanes Camera near/planes
  86790. * @returns true if the object is in frustum otherwise false
  86791. */
  86792. isInFrustum(frustumPlanes: Plane[]): boolean;
  86793. /**
  86794. * Checks if a cullable object (mesh...) is in the camera frustum
  86795. * Unlike isInFrustum this cheks the full bounding box
  86796. * @param frustumPlanes Camera near/planes
  86797. * @returns true if the object is in frustum otherwise false
  86798. */
  86799. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  86800. }
  86801. /**
  86802. * Info for a bounding data of a mesh
  86803. */
  86804. export class BoundingInfo implements ICullable {
  86805. /**
  86806. * Bounding box for the mesh
  86807. */
  86808. readonly boundingBox: BoundingBox;
  86809. /**
  86810. * Bounding sphere for the mesh
  86811. */
  86812. readonly boundingSphere: BoundingSphere;
  86813. private _isLocked;
  86814. private static readonly TmpVector3;
  86815. /**
  86816. * Constructs bounding info
  86817. * @param minimum min vector of the bounding box/sphere
  86818. * @param maximum max vector of the bounding box/sphere
  86819. * @param worldMatrix defines the new world matrix
  86820. */
  86821. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86822. /**
  86823. * Recreates the entire bounding info from scratch as if we call the constructor in place
  86824. * @param min defines the new minimum vector (in local space)
  86825. * @param max defines the new maximum vector (in local space)
  86826. * @param worldMatrix defines the new world matrix
  86827. */
  86828. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86829. /**
  86830. * min vector of the bounding box/sphere
  86831. */
  86832. get minimum(): Vector3;
  86833. /**
  86834. * max vector of the bounding box/sphere
  86835. */
  86836. get maximum(): Vector3;
  86837. /**
  86838. * If the info is locked and won't be updated to avoid perf overhead
  86839. */
  86840. get isLocked(): boolean;
  86841. set isLocked(value: boolean);
  86842. /**
  86843. * Updates the bounding sphere and box
  86844. * @param world world matrix to be used to update
  86845. */
  86846. update(world: DeepImmutable<Matrix>): void;
  86847. /**
  86848. * Recreate the bounding info to be centered around a specific point given a specific extend.
  86849. * @param center New center of the bounding info
  86850. * @param extend New extend of the bounding info
  86851. * @returns the current bounding info
  86852. */
  86853. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  86854. /**
  86855. * Scale the current bounding info by applying a scale factor
  86856. * @param factor defines the scale factor to apply
  86857. * @returns the current bounding info
  86858. */
  86859. scale(factor: number): BoundingInfo;
  86860. /**
  86861. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  86862. * @param frustumPlanes defines the frustum to test
  86863. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  86864. * @returns true if the bounding info is in the frustum planes
  86865. */
  86866. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  86867. /**
  86868. * Gets the world distance between the min and max points of the bounding box
  86869. */
  86870. get diagonalLength(): number;
  86871. /**
  86872. * Checks if a cullable object (mesh...) is in the camera frustum
  86873. * Unlike isInFrustum this cheks the full bounding box
  86874. * @param frustumPlanes Camera near/planes
  86875. * @returns true if the object is in frustum otherwise false
  86876. */
  86877. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86878. /** @hidden */
  86879. _checkCollision(collider: Collider): boolean;
  86880. /**
  86881. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  86882. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86883. * @param point the point to check intersection with
  86884. * @returns if the point intersects
  86885. */
  86886. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86887. /**
  86888. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  86889. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86890. * @param boundingInfo the bounding info to check intersection with
  86891. * @param precise if the intersection should be done using OBB
  86892. * @returns if the bounding info intersects
  86893. */
  86894. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  86895. }
  86896. }
  86897. declare module BABYLON {
  86898. /**
  86899. * Extracts minimum and maximum values from a list of indexed positions
  86900. * @param positions defines the positions to use
  86901. * @param indices defines the indices to the positions
  86902. * @param indexStart defines the start index
  86903. * @param indexCount defines the end index
  86904. * @param bias defines bias value to add to the result
  86905. * @return minimum and maximum values
  86906. */
  86907. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  86908. minimum: Vector3;
  86909. maximum: Vector3;
  86910. };
  86911. /**
  86912. * Extracts minimum and maximum values from a list of positions
  86913. * @param positions defines the positions to use
  86914. * @param start defines the start index in the positions array
  86915. * @param count defines the number of positions to handle
  86916. * @param bias defines bias value to add to the result
  86917. * @param stride defines the stride size to use (distance between two positions in the positions array)
  86918. * @return minimum and maximum values
  86919. */
  86920. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  86921. minimum: Vector3;
  86922. maximum: Vector3;
  86923. };
  86924. }
  86925. declare module BABYLON {
  86926. /** @hidden */
  86927. export class WebGLDataBuffer extends DataBuffer {
  86928. private _buffer;
  86929. constructor(resource: WebGLBuffer);
  86930. get underlyingResource(): any;
  86931. }
  86932. }
  86933. declare module BABYLON {
  86934. /** @hidden */
  86935. export class WebGLPipelineContext implements IPipelineContext {
  86936. engine: ThinEngine;
  86937. program: Nullable<WebGLProgram>;
  86938. context?: WebGLRenderingContext;
  86939. vertexShader?: WebGLShader;
  86940. fragmentShader?: WebGLShader;
  86941. isParallelCompiled: boolean;
  86942. onCompiled?: () => void;
  86943. transformFeedback?: WebGLTransformFeedback | null;
  86944. vertexCompilationError: Nullable<string>;
  86945. fragmentCompilationError: Nullable<string>;
  86946. programLinkError: Nullable<string>;
  86947. programValidationError: Nullable<string>;
  86948. get isAsync(): boolean;
  86949. get isReady(): boolean;
  86950. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  86951. _getVertexShaderCode(): string | null;
  86952. _getFragmentShaderCode(): string | null;
  86953. }
  86954. }
  86955. declare module BABYLON {
  86956. interface ThinEngine {
  86957. /**
  86958. * Create an uniform buffer
  86959. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86960. * @param elements defines the content of the uniform buffer
  86961. * @returns the webGL uniform buffer
  86962. */
  86963. createUniformBuffer(elements: FloatArray): DataBuffer;
  86964. /**
  86965. * Create a dynamic uniform buffer
  86966. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86967. * @param elements defines the content of the uniform buffer
  86968. * @returns the webGL uniform buffer
  86969. */
  86970. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  86971. /**
  86972. * Update an existing uniform buffer
  86973. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86974. * @param uniformBuffer defines the target uniform buffer
  86975. * @param elements defines the content to update
  86976. * @param offset defines the offset in the uniform buffer where update should start
  86977. * @param count defines the size of the data to update
  86978. */
  86979. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  86980. /**
  86981. * Bind an uniform buffer to the current webGL context
  86982. * @param buffer defines the buffer to bind
  86983. */
  86984. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  86985. /**
  86986. * Bind a buffer to the current webGL context at a given location
  86987. * @param buffer defines the buffer to bind
  86988. * @param location defines the index where to bind the buffer
  86989. */
  86990. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  86991. /**
  86992. * Bind a specific block at a given index in a specific shader program
  86993. * @param pipelineContext defines the pipeline context to use
  86994. * @param blockName defines the block name
  86995. * @param index defines the index where to bind the block
  86996. */
  86997. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  86998. }
  86999. }
  87000. declare module BABYLON {
  87001. /**
  87002. * Uniform buffer objects.
  87003. *
  87004. * Handles blocks of uniform on the GPU.
  87005. *
  87006. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87007. *
  87008. * For more information, please refer to :
  87009. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87010. */
  87011. export class UniformBuffer {
  87012. private _engine;
  87013. private _buffer;
  87014. private _data;
  87015. private _bufferData;
  87016. private _dynamic?;
  87017. private _uniformLocations;
  87018. private _uniformSizes;
  87019. private _uniformLocationPointer;
  87020. private _needSync;
  87021. private _noUBO;
  87022. private _currentEffect;
  87023. /** @hidden */
  87024. _alreadyBound: boolean;
  87025. private static _MAX_UNIFORM_SIZE;
  87026. private static _tempBuffer;
  87027. /**
  87028. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  87029. * This is dynamic to allow compat with webgl 1 and 2.
  87030. * You will need to pass the name of the uniform as well as the value.
  87031. */
  87032. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  87033. /**
  87034. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  87035. * This is dynamic to allow compat with webgl 1 and 2.
  87036. * You will need to pass the name of the uniform as well as the value.
  87037. */
  87038. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  87039. /**
  87040. * Lambda to Update a single float in a uniform buffer.
  87041. * This is dynamic to allow compat with webgl 1 and 2.
  87042. * You will need to pass the name of the uniform as well as the value.
  87043. */
  87044. updateFloat: (name: string, x: number) => void;
  87045. /**
  87046. * Lambda to Update a vec2 of float in a uniform buffer.
  87047. * This is dynamic to allow compat with webgl 1 and 2.
  87048. * You will need to pass the name of the uniform as well as the value.
  87049. */
  87050. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  87051. /**
  87052. * Lambda to Update a vec3 of float in a uniform buffer.
  87053. * This is dynamic to allow compat with webgl 1 and 2.
  87054. * You will need to pass the name of the uniform as well as the value.
  87055. */
  87056. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  87057. /**
  87058. * Lambda to Update a vec4 of float in a uniform buffer.
  87059. * This is dynamic to allow compat with webgl 1 and 2.
  87060. * You will need to pass the name of the uniform as well as the value.
  87061. */
  87062. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  87063. /**
  87064. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  87065. * This is dynamic to allow compat with webgl 1 and 2.
  87066. * You will need to pass the name of the uniform as well as the value.
  87067. */
  87068. updateMatrix: (name: string, mat: Matrix) => void;
  87069. /**
  87070. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  87071. * This is dynamic to allow compat with webgl 1 and 2.
  87072. * You will need to pass the name of the uniform as well as the value.
  87073. */
  87074. updateVector3: (name: string, vector: Vector3) => void;
  87075. /**
  87076. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  87077. * This is dynamic to allow compat with webgl 1 and 2.
  87078. * You will need to pass the name of the uniform as well as the value.
  87079. */
  87080. updateVector4: (name: string, vector: Vector4) => void;
  87081. /**
  87082. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  87083. * This is dynamic to allow compat with webgl 1 and 2.
  87084. * You will need to pass the name of the uniform as well as the value.
  87085. */
  87086. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  87087. /**
  87088. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  87089. * This is dynamic to allow compat with webgl 1 and 2.
  87090. * You will need to pass the name of the uniform as well as the value.
  87091. */
  87092. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  87093. /**
  87094. * Instantiates a new Uniform buffer objects.
  87095. *
  87096. * Handles blocks of uniform on the GPU.
  87097. *
  87098. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87099. *
  87100. * For more information, please refer to :
  87101. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87102. * @param engine Define the engine the buffer is associated with
  87103. * @param data Define the data contained in the buffer
  87104. * @param dynamic Define if the buffer is updatable
  87105. */
  87106. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  87107. /**
  87108. * Indicates if the buffer is using the WebGL2 UBO implementation,
  87109. * or just falling back on setUniformXXX calls.
  87110. */
  87111. get useUbo(): boolean;
  87112. /**
  87113. * Indicates if the WebGL underlying uniform buffer is in sync
  87114. * with the javascript cache data.
  87115. */
  87116. get isSync(): boolean;
  87117. /**
  87118. * Indicates if the WebGL underlying uniform buffer is dynamic.
  87119. * Also, a dynamic UniformBuffer will disable cache verification and always
  87120. * update the underlying WebGL uniform buffer to the GPU.
  87121. * @returns if Dynamic, otherwise false
  87122. */
  87123. isDynamic(): boolean;
  87124. /**
  87125. * The data cache on JS side.
  87126. * @returns the underlying data as a float array
  87127. */
  87128. getData(): Float32Array;
  87129. /**
  87130. * The underlying WebGL Uniform buffer.
  87131. * @returns the webgl buffer
  87132. */
  87133. getBuffer(): Nullable<DataBuffer>;
  87134. /**
  87135. * std140 layout specifies how to align data within an UBO structure.
  87136. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  87137. * for specs.
  87138. */
  87139. private _fillAlignment;
  87140. /**
  87141. * Adds an uniform in the buffer.
  87142. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  87143. * for the layout to be correct !
  87144. * @param name Name of the uniform, as used in the uniform block in the shader.
  87145. * @param size Data size, or data directly.
  87146. */
  87147. addUniform(name: string, size: number | number[]): void;
  87148. /**
  87149. * Adds a Matrix 4x4 to the uniform buffer.
  87150. * @param name Name of the uniform, as used in the uniform block in the shader.
  87151. * @param mat A 4x4 matrix.
  87152. */
  87153. addMatrix(name: string, mat: Matrix): void;
  87154. /**
  87155. * Adds a vec2 to the uniform buffer.
  87156. * @param name Name of the uniform, as used in the uniform block in the shader.
  87157. * @param x Define the x component value of the vec2
  87158. * @param y Define the y component value of the vec2
  87159. */
  87160. addFloat2(name: string, x: number, y: number): void;
  87161. /**
  87162. * Adds a vec3 to the uniform buffer.
  87163. * @param name Name of the uniform, as used in the uniform block in the shader.
  87164. * @param x Define the x component value of the vec3
  87165. * @param y Define the y component value of the vec3
  87166. * @param z Define the z component value of the vec3
  87167. */
  87168. addFloat3(name: string, x: number, y: number, z: number): void;
  87169. /**
  87170. * Adds a vec3 to the uniform buffer.
  87171. * @param name Name of the uniform, as used in the uniform block in the shader.
  87172. * @param color Define the vec3 from a Color
  87173. */
  87174. addColor3(name: string, color: Color3): void;
  87175. /**
  87176. * Adds a vec4 to the uniform buffer.
  87177. * @param name Name of the uniform, as used in the uniform block in the shader.
  87178. * @param color Define the rgb components from a Color
  87179. * @param alpha Define the a component of the vec4
  87180. */
  87181. addColor4(name: string, color: Color3, alpha: number): void;
  87182. /**
  87183. * Adds a vec3 to the uniform buffer.
  87184. * @param name Name of the uniform, as used in the uniform block in the shader.
  87185. * @param vector Define the vec3 components from a Vector
  87186. */
  87187. addVector3(name: string, vector: Vector3): void;
  87188. /**
  87189. * Adds a Matrix 3x3 to the uniform buffer.
  87190. * @param name Name of the uniform, as used in the uniform block in the shader.
  87191. */
  87192. addMatrix3x3(name: string): void;
  87193. /**
  87194. * Adds a Matrix 2x2 to the uniform buffer.
  87195. * @param name Name of the uniform, as used in the uniform block in the shader.
  87196. */
  87197. addMatrix2x2(name: string): void;
  87198. /**
  87199. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  87200. */
  87201. create(): void;
  87202. /** @hidden */
  87203. _rebuild(): void;
  87204. /**
  87205. * Updates the WebGL Uniform Buffer on the GPU.
  87206. * If the `dynamic` flag is set to true, no cache comparison is done.
  87207. * Otherwise, the buffer will be updated only if the cache differs.
  87208. */
  87209. update(): void;
  87210. /**
  87211. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  87212. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87213. * @param data Define the flattened data
  87214. * @param size Define the size of the data.
  87215. */
  87216. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  87217. private _valueCache;
  87218. private _cacheMatrix;
  87219. private _updateMatrix3x3ForUniform;
  87220. private _updateMatrix3x3ForEffect;
  87221. private _updateMatrix2x2ForEffect;
  87222. private _updateMatrix2x2ForUniform;
  87223. private _updateFloatForEffect;
  87224. private _updateFloatForUniform;
  87225. private _updateFloat2ForEffect;
  87226. private _updateFloat2ForUniform;
  87227. private _updateFloat3ForEffect;
  87228. private _updateFloat3ForUniform;
  87229. private _updateFloat4ForEffect;
  87230. private _updateFloat4ForUniform;
  87231. private _updateMatrixForEffect;
  87232. private _updateMatrixForUniform;
  87233. private _updateVector3ForEffect;
  87234. private _updateVector3ForUniform;
  87235. private _updateVector4ForEffect;
  87236. private _updateVector4ForUniform;
  87237. private _updateColor3ForEffect;
  87238. private _updateColor3ForUniform;
  87239. private _updateColor4ForEffect;
  87240. private _updateColor4ForUniform;
  87241. /**
  87242. * Sets a sampler uniform on the effect.
  87243. * @param name Define the name of the sampler.
  87244. * @param texture Define the texture to set in the sampler
  87245. */
  87246. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  87247. /**
  87248. * Directly updates the value of the uniform in the cache AND on the GPU.
  87249. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87250. * @param data Define the flattened data
  87251. */
  87252. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  87253. /**
  87254. * Binds this uniform buffer to an effect.
  87255. * @param effect Define the effect to bind the buffer to
  87256. * @param name Name of the uniform block in the shader.
  87257. */
  87258. bindToEffect(effect: Effect, name: string): void;
  87259. /**
  87260. * Disposes the uniform buffer.
  87261. */
  87262. dispose(): void;
  87263. }
  87264. }
  87265. declare module BABYLON {
  87266. /**
  87267. * Enum that determines the text-wrapping mode to use.
  87268. */
  87269. export enum InspectableType {
  87270. /**
  87271. * Checkbox for booleans
  87272. */
  87273. Checkbox = 0,
  87274. /**
  87275. * Sliders for numbers
  87276. */
  87277. Slider = 1,
  87278. /**
  87279. * Vector3
  87280. */
  87281. Vector3 = 2,
  87282. /**
  87283. * Quaternions
  87284. */
  87285. Quaternion = 3,
  87286. /**
  87287. * Color3
  87288. */
  87289. Color3 = 4,
  87290. /**
  87291. * String
  87292. */
  87293. String = 5
  87294. }
  87295. /**
  87296. * Interface used to define custom inspectable properties.
  87297. * This interface is used by the inspector to display custom property grids
  87298. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  87299. */
  87300. export interface IInspectable {
  87301. /**
  87302. * Gets the label to display
  87303. */
  87304. label: string;
  87305. /**
  87306. * Gets the name of the property to edit
  87307. */
  87308. propertyName: string;
  87309. /**
  87310. * Gets the type of the editor to use
  87311. */
  87312. type: InspectableType;
  87313. /**
  87314. * Gets the minimum value of the property when using in "slider" mode
  87315. */
  87316. min?: number;
  87317. /**
  87318. * Gets the maximum value of the property when using in "slider" mode
  87319. */
  87320. max?: number;
  87321. /**
  87322. * Gets the setp to use when using in "slider" mode
  87323. */
  87324. step?: number;
  87325. }
  87326. }
  87327. declare module BABYLON {
  87328. /**
  87329. * Class used to provide helper for timing
  87330. */
  87331. export class TimingTools {
  87332. /**
  87333. * Polyfill for setImmediate
  87334. * @param action defines the action to execute after the current execution block
  87335. */
  87336. static SetImmediate(action: () => void): void;
  87337. }
  87338. }
  87339. declare module BABYLON {
  87340. /**
  87341. * Class used to enable instatition of objects by class name
  87342. */
  87343. export class InstantiationTools {
  87344. /**
  87345. * Use this object to register external classes like custom textures or material
  87346. * to allow the laoders to instantiate them
  87347. */
  87348. static RegisteredExternalClasses: {
  87349. [key: string]: Object;
  87350. };
  87351. /**
  87352. * Tries to instantiate a new object from a given class name
  87353. * @param className defines the class name to instantiate
  87354. * @returns the new object or null if the system was not able to do the instantiation
  87355. */
  87356. static Instantiate(className: string): any;
  87357. }
  87358. }
  87359. declare module BABYLON {
  87360. /**
  87361. * Define options used to create a depth texture
  87362. */
  87363. export class DepthTextureCreationOptions {
  87364. /** Specifies whether or not a stencil should be allocated in the texture */
  87365. generateStencil?: boolean;
  87366. /** Specifies whether or not bilinear filtering is enable on the texture */
  87367. bilinearFiltering?: boolean;
  87368. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  87369. comparisonFunction?: number;
  87370. /** Specifies if the created texture is a cube texture */
  87371. isCube?: boolean;
  87372. }
  87373. }
  87374. declare module BABYLON {
  87375. interface ThinEngine {
  87376. /**
  87377. * Creates a depth stencil cube texture.
  87378. * This is only available in WebGL 2.
  87379. * @param size The size of face edge in the cube texture.
  87380. * @param options The options defining the cube texture.
  87381. * @returns The cube texture
  87382. */
  87383. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  87384. /**
  87385. * Creates a cube texture
  87386. * @param rootUrl defines the url where the files to load is located
  87387. * @param scene defines the current scene
  87388. * @param files defines the list of files to load (1 per face)
  87389. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87390. * @param onLoad defines an optional callback raised when the texture is loaded
  87391. * @param onError defines an optional callback raised if there is an issue to load the texture
  87392. * @param format defines the format of the data
  87393. * @param forcedExtension defines the extension to use to pick the right loader
  87394. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87395. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87396. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87397. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  87398. * @returns the cube texture as an InternalTexture
  87399. */
  87400. 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;
  87401. /**
  87402. * Creates a cube texture
  87403. * @param rootUrl defines the url where the files to load is located
  87404. * @param scene defines the current scene
  87405. * @param files defines the list of files to load (1 per face)
  87406. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87407. * @param onLoad defines an optional callback raised when the texture is loaded
  87408. * @param onError defines an optional callback raised if there is an issue to load the texture
  87409. * @param format defines the format of the data
  87410. * @param forcedExtension defines the extension to use to pick the right loader
  87411. * @returns the cube texture as an InternalTexture
  87412. */
  87413. 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;
  87414. /**
  87415. * Creates a cube texture
  87416. * @param rootUrl defines the url where the files to load is located
  87417. * @param scene defines the current scene
  87418. * @param files defines the list of files to load (1 per face)
  87419. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87420. * @param onLoad defines an optional callback raised when the texture is loaded
  87421. * @param onError defines an optional callback raised if there is an issue to load the texture
  87422. * @param format defines the format of the data
  87423. * @param forcedExtension defines the extension to use to pick the right loader
  87424. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87425. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87426. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87427. * @returns the cube texture as an InternalTexture
  87428. */
  87429. 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;
  87430. /** @hidden */
  87431. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  87432. /** @hidden */
  87433. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  87434. /** @hidden */
  87435. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87436. /** @hidden */
  87437. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87438. /**
  87439. * @hidden
  87440. */
  87441. _setCubeMapTextureParams(loadMipmap: boolean): void;
  87442. }
  87443. }
  87444. declare module BABYLON {
  87445. /**
  87446. * Class for creating a cube texture
  87447. */
  87448. export class CubeTexture extends BaseTexture {
  87449. private _delayedOnLoad;
  87450. /**
  87451. * Observable triggered once the texture has been loaded.
  87452. */
  87453. onLoadObservable: Observable<CubeTexture>;
  87454. /**
  87455. * The url of the texture
  87456. */
  87457. url: string;
  87458. /**
  87459. * Gets or sets the center of the bounding box associated with the cube texture.
  87460. * It must define where the camera used to render the texture was set
  87461. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87462. */
  87463. boundingBoxPosition: Vector3;
  87464. private _boundingBoxSize;
  87465. /**
  87466. * Gets or sets the size of the bounding box associated with the cube texture
  87467. * When defined, the cubemap will switch to local mode
  87468. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  87469. * @example https://www.babylonjs-playground.com/#RNASML
  87470. */
  87471. set boundingBoxSize(value: Vector3);
  87472. /**
  87473. * Returns the bounding box size
  87474. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87475. */
  87476. get boundingBoxSize(): Vector3;
  87477. protected _rotationY: number;
  87478. /**
  87479. * Sets texture matrix rotation angle around Y axis in radians.
  87480. */
  87481. set rotationY(value: number);
  87482. /**
  87483. * Gets texture matrix rotation angle around Y axis radians.
  87484. */
  87485. get rotationY(): number;
  87486. /**
  87487. * Are mip maps generated for this texture or not.
  87488. */
  87489. get noMipmap(): boolean;
  87490. private _noMipmap;
  87491. private _files;
  87492. protected _forcedExtension: Nullable<string>;
  87493. private _extensions;
  87494. private _textureMatrix;
  87495. private _format;
  87496. private _createPolynomials;
  87497. /**
  87498. * Creates a cube texture from an array of image urls
  87499. * @param files defines an array of image urls
  87500. * @param scene defines the hosting scene
  87501. * @param noMipmap specifies if mip maps are not used
  87502. * @returns a cube texture
  87503. */
  87504. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  87505. /**
  87506. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  87507. * @param url defines the url of the prefiltered texture
  87508. * @param scene defines the scene the texture is attached to
  87509. * @param forcedExtension defines the extension of the file if different from the url
  87510. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87511. * @return the prefiltered texture
  87512. */
  87513. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  87514. /**
  87515. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  87516. * as prefiltered data.
  87517. * @param rootUrl defines the url of the texture or the root name of the six images
  87518. * @param null defines the scene or engine the texture is attached to
  87519. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  87520. * @param noMipmap defines if mipmaps should be created or not
  87521. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  87522. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  87523. * @param onError defines a callback triggered in case of error during load
  87524. * @param format defines the internal format to use for the texture once loaded
  87525. * @param prefiltered defines whether or not the texture is created from prefiltered data
  87526. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  87527. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87528. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87529. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87530. * @return the cube texture
  87531. */
  87532. 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);
  87533. /**
  87534. * Get the current class name of the texture useful for serialization or dynamic coding.
  87535. * @returns "CubeTexture"
  87536. */
  87537. getClassName(): string;
  87538. /**
  87539. * Update the url (and optional buffer) of this texture if url was null during construction.
  87540. * @param url the url of the texture
  87541. * @param forcedExtension defines the extension to use
  87542. * @param onLoad callback called when the texture is loaded (defaults to null)
  87543. * @param prefiltered Defines whether the updated texture is prefiltered or not
  87544. */
  87545. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  87546. /**
  87547. * Delays loading of the cube texture
  87548. * @param forcedExtension defines the extension to use
  87549. */
  87550. delayLoad(forcedExtension?: string): void;
  87551. /**
  87552. * Returns the reflection texture matrix
  87553. * @returns the reflection texture matrix
  87554. */
  87555. getReflectionTextureMatrix(): Matrix;
  87556. /**
  87557. * Sets the reflection texture matrix
  87558. * @param value Reflection texture matrix
  87559. */
  87560. setReflectionTextureMatrix(value: Matrix): void;
  87561. /**
  87562. * Parses text to create a cube texture
  87563. * @param parsedTexture define the serialized text to read from
  87564. * @param scene defines the hosting scene
  87565. * @param rootUrl defines the root url of the cube texture
  87566. * @returns a cube texture
  87567. */
  87568. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  87569. /**
  87570. * Makes a clone, or deep copy, of the cube texture
  87571. * @returns a new cube texture
  87572. */
  87573. clone(): CubeTexture;
  87574. }
  87575. }
  87576. declare module BABYLON {
  87577. /**
  87578. * Manages the defines for the Material
  87579. */
  87580. export class MaterialDefines {
  87581. /** @hidden */
  87582. protected _keys: string[];
  87583. private _isDirty;
  87584. /** @hidden */
  87585. _renderId: number;
  87586. /** @hidden */
  87587. _areLightsDirty: boolean;
  87588. /** @hidden */
  87589. _areLightsDisposed: boolean;
  87590. /** @hidden */
  87591. _areAttributesDirty: boolean;
  87592. /** @hidden */
  87593. _areTexturesDirty: boolean;
  87594. /** @hidden */
  87595. _areFresnelDirty: boolean;
  87596. /** @hidden */
  87597. _areMiscDirty: boolean;
  87598. /** @hidden */
  87599. _areImageProcessingDirty: boolean;
  87600. /** @hidden */
  87601. _normals: boolean;
  87602. /** @hidden */
  87603. _uvs: boolean;
  87604. /** @hidden */
  87605. _needNormals: boolean;
  87606. /** @hidden */
  87607. _needUVs: boolean;
  87608. [id: string]: any;
  87609. /**
  87610. * Specifies if the material needs to be re-calculated
  87611. */
  87612. get isDirty(): boolean;
  87613. /**
  87614. * Marks the material to indicate that it has been re-calculated
  87615. */
  87616. markAsProcessed(): void;
  87617. /**
  87618. * Marks the material to indicate that it needs to be re-calculated
  87619. */
  87620. markAsUnprocessed(): void;
  87621. /**
  87622. * Marks the material to indicate all of its defines need to be re-calculated
  87623. */
  87624. markAllAsDirty(): void;
  87625. /**
  87626. * Marks the material to indicate that image processing needs to be re-calculated
  87627. */
  87628. markAsImageProcessingDirty(): void;
  87629. /**
  87630. * Marks the material to indicate the lights need to be re-calculated
  87631. * @param disposed Defines whether the light is dirty due to dispose or not
  87632. */
  87633. markAsLightDirty(disposed?: boolean): void;
  87634. /**
  87635. * Marks the attribute state as changed
  87636. */
  87637. markAsAttributesDirty(): void;
  87638. /**
  87639. * Marks the texture state as changed
  87640. */
  87641. markAsTexturesDirty(): void;
  87642. /**
  87643. * Marks the fresnel state as changed
  87644. */
  87645. markAsFresnelDirty(): void;
  87646. /**
  87647. * Marks the misc state as changed
  87648. */
  87649. markAsMiscDirty(): void;
  87650. /**
  87651. * Rebuilds the material defines
  87652. */
  87653. rebuild(): void;
  87654. /**
  87655. * Specifies if two material defines are equal
  87656. * @param other - A material define instance to compare to
  87657. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  87658. */
  87659. isEqual(other: MaterialDefines): boolean;
  87660. /**
  87661. * Clones this instance's defines to another instance
  87662. * @param other - material defines to clone values to
  87663. */
  87664. cloneTo(other: MaterialDefines): void;
  87665. /**
  87666. * Resets the material define values
  87667. */
  87668. reset(): void;
  87669. /**
  87670. * Converts the material define values to a string
  87671. * @returns - String of material define information
  87672. */
  87673. toString(): string;
  87674. }
  87675. }
  87676. declare module BABYLON {
  87677. /**
  87678. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  87679. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  87680. * 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;
  87681. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  87682. */
  87683. export class ColorCurves {
  87684. private _dirty;
  87685. private _tempColor;
  87686. private _globalCurve;
  87687. private _highlightsCurve;
  87688. private _midtonesCurve;
  87689. private _shadowsCurve;
  87690. private _positiveCurve;
  87691. private _negativeCurve;
  87692. private _globalHue;
  87693. private _globalDensity;
  87694. private _globalSaturation;
  87695. private _globalExposure;
  87696. /**
  87697. * Gets the global Hue value.
  87698. * 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).
  87699. */
  87700. get globalHue(): number;
  87701. /**
  87702. * Sets the global Hue value.
  87703. * 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).
  87704. */
  87705. set globalHue(value: number);
  87706. /**
  87707. * Gets the global Density value.
  87708. * 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.
  87709. * Values less than zero provide a filter of opposite hue.
  87710. */
  87711. get globalDensity(): number;
  87712. /**
  87713. * Sets the global Density value.
  87714. * 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.
  87715. * Values less than zero provide a filter of opposite hue.
  87716. */
  87717. set globalDensity(value: number);
  87718. /**
  87719. * Gets the global Saturation value.
  87720. * 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.
  87721. */
  87722. get globalSaturation(): number;
  87723. /**
  87724. * Sets the global Saturation value.
  87725. * 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.
  87726. */
  87727. set globalSaturation(value: number);
  87728. /**
  87729. * Gets the global Exposure value.
  87730. * 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.
  87731. */
  87732. get globalExposure(): number;
  87733. /**
  87734. * Sets the global Exposure value.
  87735. * 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.
  87736. */
  87737. set globalExposure(value: number);
  87738. private _highlightsHue;
  87739. private _highlightsDensity;
  87740. private _highlightsSaturation;
  87741. private _highlightsExposure;
  87742. /**
  87743. * Gets the highlights Hue value.
  87744. * 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).
  87745. */
  87746. get highlightsHue(): number;
  87747. /**
  87748. * Sets the highlights Hue value.
  87749. * 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).
  87750. */
  87751. set highlightsHue(value: number);
  87752. /**
  87753. * Gets the highlights Density value.
  87754. * 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.
  87755. * Values less than zero provide a filter of opposite hue.
  87756. */
  87757. get highlightsDensity(): number;
  87758. /**
  87759. * Sets the highlights Density value.
  87760. * 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.
  87761. * Values less than zero provide a filter of opposite hue.
  87762. */
  87763. set highlightsDensity(value: number);
  87764. /**
  87765. * Gets the highlights Saturation value.
  87766. * 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.
  87767. */
  87768. get highlightsSaturation(): number;
  87769. /**
  87770. * Sets the highlights Saturation value.
  87771. * 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.
  87772. */
  87773. set highlightsSaturation(value: number);
  87774. /**
  87775. * Gets the highlights Exposure value.
  87776. * 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.
  87777. */
  87778. get highlightsExposure(): number;
  87779. /**
  87780. * Sets the highlights Exposure value.
  87781. * 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.
  87782. */
  87783. set highlightsExposure(value: number);
  87784. private _midtonesHue;
  87785. private _midtonesDensity;
  87786. private _midtonesSaturation;
  87787. private _midtonesExposure;
  87788. /**
  87789. * Gets the midtones Hue value.
  87790. * 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).
  87791. */
  87792. get midtonesHue(): number;
  87793. /**
  87794. * Sets the midtones Hue value.
  87795. * 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).
  87796. */
  87797. set midtonesHue(value: number);
  87798. /**
  87799. * Gets the midtones Density value.
  87800. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  87801. * Values less than zero provide a filter of opposite hue.
  87802. */
  87803. get midtonesDensity(): number;
  87804. /**
  87805. * Sets the midtones Density value.
  87806. * 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.
  87807. * Values less than zero provide a filter of opposite hue.
  87808. */
  87809. set midtonesDensity(value: number);
  87810. /**
  87811. * Gets the midtones Saturation value.
  87812. * 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.
  87813. */
  87814. get midtonesSaturation(): number;
  87815. /**
  87816. * Sets the midtones Saturation value.
  87817. * 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.
  87818. */
  87819. set midtonesSaturation(value: number);
  87820. /**
  87821. * Gets the midtones Exposure value.
  87822. * 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.
  87823. */
  87824. get midtonesExposure(): number;
  87825. /**
  87826. * Sets the midtones Exposure value.
  87827. * 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.
  87828. */
  87829. set midtonesExposure(value: number);
  87830. private _shadowsHue;
  87831. private _shadowsDensity;
  87832. private _shadowsSaturation;
  87833. private _shadowsExposure;
  87834. /**
  87835. * Gets the shadows Hue value.
  87836. * 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).
  87837. */
  87838. get shadowsHue(): number;
  87839. /**
  87840. * Sets the shadows Hue value.
  87841. * 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).
  87842. */
  87843. set shadowsHue(value: number);
  87844. /**
  87845. * Gets the shadows Density value.
  87846. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  87847. * Values less than zero provide a filter of opposite hue.
  87848. */
  87849. get shadowsDensity(): number;
  87850. /**
  87851. * Sets the shadows Density value.
  87852. * 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.
  87853. * Values less than zero provide a filter of opposite hue.
  87854. */
  87855. set shadowsDensity(value: number);
  87856. /**
  87857. * Gets the shadows Saturation value.
  87858. * 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.
  87859. */
  87860. get shadowsSaturation(): number;
  87861. /**
  87862. * Sets the shadows Saturation value.
  87863. * 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.
  87864. */
  87865. set shadowsSaturation(value: number);
  87866. /**
  87867. * Gets the shadows Exposure value.
  87868. * 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.
  87869. */
  87870. get shadowsExposure(): number;
  87871. /**
  87872. * Sets the shadows Exposure value.
  87873. * 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.
  87874. */
  87875. set shadowsExposure(value: number);
  87876. /**
  87877. * Returns the class name
  87878. * @returns The class name
  87879. */
  87880. getClassName(): string;
  87881. /**
  87882. * Binds the color curves to the shader.
  87883. * @param colorCurves The color curve to bind
  87884. * @param effect The effect to bind to
  87885. * @param positiveUniform The positive uniform shader parameter
  87886. * @param neutralUniform The neutral uniform shader parameter
  87887. * @param negativeUniform The negative uniform shader parameter
  87888. */
  87889. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  87890. /**
  87891. * Prepare the list of uniforms associated with the ColorCurves effects.
  87892. * @param uniformsList The list of uniforms used in the effect
  87893. */
  87894. static PrepareUniforms(uniformsList: string[]): void;
  87895. /**
  87896. * Returns color grading data based on a hue, density, saturation and exposure value.
  87897. * @param filterHue The hue of the color filter.
  87898. * @param filterDensity The density of the color filter.
  87899. * @param saturation The saturation.
  87900. * @param exposure The exposure.
  87901. * @param result The result data container.
  87902. */
  87903. private getColorGradingDataToRef;
  87904. /**
  87905. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  87906. * @param value The input slider value in range [-100,100].
  87907. * @returns Adjusted value.
  87908. */
  87909. private static applyColorGradingSliderNonlinear;
  87910. /**
  87911. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  87912. * @param hue The hue (H) input.
  87913. * @param saturation The saturation (S) input.
  87914. * @param brightness The brightness (B) input.
  87915. * @result An RGBA color represented as Vector4.
  87916. */
  87917. private static fromHSBToRef;
  87918. /**
  87919. * Returns a value clamped between min and max
  87920. * @param value The value to clamp
  87921. * @param min The minimum of value
  87922. * @param max The maximum of value
  87923. * @returns The clamped value.
  87924. */
  87925. private static clamp;
  87926. /**
  87927. * Clones the current color curve instance.
  87928. * @return The cloned curves
  87929. */
  87930. clone(): ColorCurves;
  87931. /**
  87932. * Serializes the current color curve instance to a json representation.
  87933. * @return a JSON representation
  87934. */
  87935. serialize(): any;
  87936. /**
  87937. * Parses the color curve from a json representation.
  87938. * @param source the JSON source to parse
  87939. * @return The parsed curves
  87940. */
  87941. static Parse(source: any): ColorCurves;
  87942. }
  87943. }
  87944. declare module BABYLON {
  87945. /**
  87946. * Interface to follow in your material defines to integrate easily the
  87947. * Image proccessing functions.
  87948. * @hidden
  87949. */
  87950. export interface IImageProcessingConfigurationDefines {
  87951. IMAGEPROCESSING: boolean;
  87952. VIGNETTE: boolean;
  87953. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87954. VIGNETTEBLENDMODEOPAQUE: boolean;
  87955. TONEMAPPING: boolean;
  87956. TONEMAPPING_ACES: boolean;
  87957. CONTRAST: boolean;
  87958. EXPOSURE: boolean;
  87959. COLORCURVES: boolean;
  87960. COLORGRADING: boolean;
  87961. COLORGRADING3D: boolean;
  87962. SAMPLER3DGREENDEPTH: boolean;
  87963. SAMPLER3DBGRMAP: boolean;
  87964. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87965. }
  87966. /**
  87967. * @hidden
  87968. */
  87969. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  87970. IMAGEPROCESSING: boolean;
  87971. VIGNETTE: boolean;
  87972. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87973. VIGNETTEBLENDMODEOPAQUE: boolean;
  87974. TONEMAPPING: boolean;
  87975. TONEMAPPING_ACES: boolean;
  87976. CONTRAST: boolean;
  87977. COLORCURVES: boolean;
  87978. COLORGRADING: boolean;
  87979. COLORGRADING3D: boolean;
  87980. SAMPLER3DGREENDEPTH: boolean;
  87981. SAMPLER3DBGRMAP: boolean;
  87982. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87983. EXPOSURE: boolean;
  87984. constructor();
  87985. }
  87986. /**
  87987. * This groups together the common properties used for image processing either in direct forward pass
  87988. * or through post processing effect depending on the use of the image processing pipeline in your scene
  87989. * or not.
  87990. */
  87991. export class ImageProcessingConfiguration {
  87992. /**
  87993. * Default tone mapping applied in BabylonJS.
  87994. */
  87995. static readonly TONEMAPPING_STANDARD: number;
  87996. /**
  87997. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  87998. * to other engines rendering to increase portability.
  87999. */
  88000. static readonly TONEMAPPING_ACES: number;
  88001. /**
  88002. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  88003. */
  88004. colorCurves: Nullable<ColorCurves>;
  88005. private _colorCurvesEnabled;
  88006. /**
  88007. * Gets wether the color curves effect is enabled.
  88008. */
  88009. get colorCurvesEnabled(): boolean;
  88010. /**
  88011. * Sets wether the color curves effect is enabled.
  88012. */
  88013. set colorCurvesEnabled(value: boolean);
  88014. private _colorGradingTexture;
  88015. /**
  88016. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88017. */
  88018. get colorGradingTexture(): Nullable<BaseTexture>;
  88019. /**
  88020. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88021. */
  88022. set colorGradingTexture(value: Nullable<BaseTexture>);
  88023. private _colorGradingEnabled;
  88024. /**
  88025. * Gets wether the color grading effect is enabled.
  88026. */
  88027. get colorGradingEnabled(): boolean;
  88028. /**
  88029. * Sets wether the color grading effect is enabled.
  88030. */
  88031. set colorGradingEnabled(value: boolean);
  88032. private _colorGradingWithGreenDepth;
  88033. /**
  88034. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  88035. */
  88036. get colorGradingWithGreenDepth(): boolean;
  88037. /**
  88038. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  88039. */
  88040. set colorGradingWithGreenDepth(value: boolean);
  88041. private _colorGradingBGR;
  88042. /**
  88043. * Gets wether the color grading texture contains BGR values.
  88044. */
  88045. get colorGradingBGR(): boolean;
  88046. /**
  88047. * Sets wether the color grading texture contains BGR values.
  88048. */
  88049. set colorGradingBGR(value: boolean);
  88050. /** @hidden */
  88051. _exposure: number;
  88052. /**
  88053. * Gets the Exposure used in the effect.
  88054. */
  88055. get exposure(): number;
  88056. /**
  88057. * Sets the Exposure used in the effect.
  88058. */
  88059. set exposure(value: number);
  88060. private _toneMappingEnabled;
  88061. /**
  88062. * Gets wether the tone mapping effect is enabled.
  88063. */
  88064. get toneMappingEnabled(): boolean;
  88065. /**
  88066. * Sets wether the tone mapping effect is enabled.
  88067. */
  88068. set toneMappingEnabled(value: boolean);
  88069. private _toneMappingType;
  88070. /**
  88071. * Gets the type of tone mapping effect.
  88072. */
  88073. get toneMappingType(): number;
  88074. /**
  88075. * Sets the type of tone mapping effect used in BabylonJS.
  88076. */
  88077. set toneMappingType(value: number);
  88078. protected _contrast: number;
  88079. /**
  88080. * Gets the contrast used in the effect.
  88081. */
  88082. get contrast(): number;
  88083. /**
  88084. * Sets the contrast used in the effect.
  88085. */
  88086. set contrast(value: number);
  88087. /**
  88088. * Vignette stretch size.
  88089. */
  88090. vignetteStretch: number;
  88091. /**
  88092. * Vignette centre X Offset.
  88093. */
  88094. vignetteCentreX: number;
  88095. /**
  88096. * Vignette centre Y Offset.
  88097. */
  88098. vignetteCentreY: number;
  88099. /**
  88100. * Vignette weight or intensity of the vignette effect.
  88101. */
  88102. vignetteWeight: number;
  88103. /**
  88104. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  88105. * if vignetteEnabled is set to true.
  88106. */
  88107. vignetteColor: Color4;
  88108. /**
  88109. * Camera field of view used by the Vignette effect.
  88110. */
  88111. vignetteCameraFov: number;
  88112. private _vignetteBlendMode;
  88113. /**
  88114. * Gets the vignette blend mode allowing different kind of effect.
  88115. */
  88116. get vignetteBlendMode(): number;
  88117. /**
  88118. * Sets the vignette blend mode allowing different kind of effect.
  88119. */
  88120. set vignetteBlendMode(value: number);
  88121. private _vignetteEnabled;
  88122. /**
  88123. * Gets wether the vignette effect is enabled.
  88124. */
  88125. get vignetteEnabled(): boolean;
  88126. /**
  88127. * Sets wether the vignette effect is enabled.
  88128. */
  88129. set vignetteEnabled(value: boolean);
  88130. private _applyByPostProcess;
  88131. /**
  88132. * Gets wether the image processing is applied through a post process or not.
  88133. */
  88134. get applyByPostProcess(): boolean;
  88135. /**
  88136. * Sets wether the image processing is applied through a post process or not.
  88137. */
  88138. set applyByPostProcess(value: boolean);
  88139. private _isEnabled;
  88140. /**
  88141. * Gets wether the image processing is enabled or not.
  88142. */
  88143. get isEnabled(): boolean;
  88144. /**
  88145. * Sets wether the image processing is enabled or not.
  88146. */
  88147. set isEnabled(value: boolean);
  88148. /**
  88149. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  88150. */
  88151. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  88152. /**
  88153. * Method called each time the image processing information changes requires to recompile the effect.
  88154. */
  88155. protected _updateParameters(): void;
  88156. /**
  88157. * Gets the current class name.
  88158. * @return "ImageProcessingConfiguration"
  88159. */
  88160. getClassName(): string;
  88161. /**
  88162. * Prepare the list of uniforms associated with the Image Processing effects.
  88163. * @param uniforms The list of uniforms used in the effect
  88164. * @param defines the list of defines currently in use
  88165. */
  88166. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  88167. /**
  88168. * Prepare the list of samplers associated with the Image Processing effects.
  88169. * @param samplersList The list of uniforms used in the effect
  88170. * @param defines the list of defines currently in use
  88171. */
  88172. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  88173. /**
  88174. * Prepare the list of defines associated to the shader.
  88175. * @param defines the list of defines to complete
  88176. * @param forPostProcess Define if we are currently in post process mode or not
  88177. */
  88178. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  88179. /**
  88180. * Returns true if all the image processing information are ready.
  88181. * @returns True if ready, otherwise, false
  88182. */
  88183. isReady(): boolean;
  88184. /**
  88185. * Binds the image processing to the shader.
  88186. * @param effect The effect to bind to
  88187. * @param overrideAspectRatio Override the aspect ratio of the effect
  88188. */
  88189. bind(effect: Effect, overrideAspectRatio?: number): void;
  88190. /**
  88191. * Clones the current image processing instance.
  88192. * @return The cloned image processing
  88193. */
  88194. clone(): ImageProcessingConfiguration;
  88195. /**
  88196. * Serializes the current image processing instance to a json representation.
  88197. * @return a JSON representation
  88198. */
  88199. serialize(): any;
  88200. /**
  88201. * Parses the image processing from a json representation.
  88202. * @param source the JSON source to parse
  88203. * @return The parsed image processing
  88204. */
  88205. static Parse(source: any): ImageProcessingConfiguration;
  88206. private static _VIGNETTEMODE_MULTIPLY;
  88207. private static _VIGNETTEMODE_OPAQUE;
  88208. /**
  88209. * Used to apply the vignette as a mix with the pixel color.
  88210. */
  88211. static get VIGNETTEMODE_MULTIPLY(): number;
  88212. /**
  88213. * Used to apply the vignette as a replacement of the pixel color.
  88214. */
  88215. static get VIGNETTEMODE_OPAQUE(): number;
  88216. }
  88217. }
  88218. declare module BABYLON {
  88219. /** @hidden */
  88220. export var postprocessVertexShader: {
  88221. name: string;
  88222. shader: string;
  88223. };
  88224. }
  88225. declare module BABYLON {
  88226. interface ThinEngine {
  88227. /**
  88228. * Creates a new render target texture
  88229. * @param size defines the size of the texture
  88230. * @param options defines the options used to create the texture
  88231. * @returns a new render target texture stored in an InternalTexture
  88232. */
  88233. createRenderTargetTexture(size: number | {
  88234. width: number;
  88235. height: number;
  88236. layers?: number;
  88237. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  88238. /**
  88239. * Creates a depth stencil texture.
  88240. * This is only available in WebGL 2 or with the depth texture extension available.
  88241. * @param size The size of face edge in the texture.
  88242. * @param options The options defining the texture.
  88243. * @returns The texture
  88244. */
  88245. createDepthStencilTexture(size: number | {
  88246. width: number;
  88247. height: number;
  88248. layers?: number;
  88249. }, options: DepthTextureCreationOptions): InternalTexture;
  88250. /** @hidden */
  88251. _createDepthStencilTexture(size: number | {
  88252. width: number;
  88253. height: number;
  88254. layers?: number;
  88255. }, options: DepthTextureCreationOptions): InternalTexture;
  88256. }
  88257. }
  88258. declare module BABYLON {
  88259. /**
  88260. * Defines the kind of connection point for node based material
  88261. */
  88262. export enum NodeMaterialBlockConnectionPointTypes {
  88263. /** Float */
  88264. Float = 1,
  88265. /** Int */
  88266. Int = 2,
  88267. /** Vector2 */
  88268. Vector2 = 4,
  88269. /** Vector3 */
  88270. Vector3 = 8,
  88271. /** Vector4 */
  88272. Vector4 = 16,
  88273. /** Color3 */
  88274. Color3 = 32,
  88275. /** Color4 */
  88276. Color4 = 64,
  88277. /** Matrix */
  88278. Matrix = 128,
  88279. /** Custom object */
  88280. Object = 256,
  88281. /** Detect type based on connection */
  88282. AutoDetect = 1024,
  88283. /** Output type that will be defined by input type */
  88284. BasedOnInput = 2048
  88285. }
  88286. }
  88287. declare module BABYLON {
  88288. /**
  88289. * Enum used to define the target of a block
  88290. */
  88291. export enum NodeMaterialBlockTargets {
  88292. /** Vertex shader */
  88293. Vertex = 1,
  88294. /** Fragment shader */
  88295. Fragment = 2,
  88296. /** Neutral */
  88297. Neutral = 4,
  88298. /** Vertex and Fragment */
  88299. VertexAndFragment = 3
  88300. }
  88301. }
  88302. declare module BABYLON {
  88303. /**
  88304. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  88305. */
  88306. export enum NodeMaterialBlockConnectionPointMode {
  88307. /** Value is an uniform */
  88308. Uniform = 0,
  88309. /** Value is a mesh attribute */
  88310. Attribute = 1,
  88311. /** Value is a varying between vertex and fragment shaders */
  88312. Varying = 2,
  88313. /** Mode is undefined */
  88314. Undefined = 3
  88315. }
  88316. }
  88317. declare module BABYLON {
  88318. /**
  88319. * Enum used to define system values e.g. values automatically provided by the system
  88320. */
  88321. export enum NodeMaterialSystemValues {
  88322. /** World */
  88323. World = 1,
  88324. /** View */
  88325. View = 2,
  88326. /** Projection */
  88327. Projection = 3,
  88328. /** ViewProjection */
  88329. ViewProjection = 4,
  88330. /** WorldView */
  88331. WorldView = 5,
  88332. /** WorldViewProjection */
  88333. WorldViewProjection = 6,
  88334. /** CameraPosition */
  88335. CameraPosition = 7,
  88336. /** Fog Color */
  88337. FogColor = 8,
  88338. /** Delta time */
  88339. DeltaTime = 9
  88340. }
  88341. }
  88342. declare module BABYLON {
  88343. /** Defines supported spaces */
  88344. export enum Space {
  88345. /** Local (object) space */
  88346. LOCAL = 0,
  88347. /** World space */
  88348. WORLD = 1,
  88349. /** Bone space */
  88350. BONE = 2
  88351. }
  88352. /** Defines the 3 main axes */
  88353. export class Axis {
  88354. /** X axis */
  88355. static X: Vector3;
  88356. /** Y axis */
  88357. static Y: Vector3;
  88358. /** Z axis */
  88359. static Z: Vector3;
  88360. }
  88361. }
  88362. declare module BABYLON {
  88363. /**
  88364. * Represents a camera frustum
  88365. */
  88366. export class Frustum {
  88367. /**
  88368. * Gets the planes representing the frustum
  88369. * @param transform matrix to be applied to the returned planes
  88370. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  88371. */
  88372. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  88373. /**
  88374. * Gets the near frustum plane transformed by the transform matrix
  88375. * @param transform transformation matrix to be applied to the resulting frustum plane
  88376. * @param frustumPlane the resuling frustum plane
  88377. */
  88378. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88379. /**
  88380. * Gets the far frustum plane transformed by the transform matrix
  88381. * @param transform transformation matrix to be applied to the resulting frustum plane
  88382. * @param frustumPlane the resuling frustum plane
  88383. */
  88384. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88385. /**
  88386. * Gets the left frustum plane transformed by the transform matrix
  88387. * @param transform transformation matrix to be applied to the resulting frustum plane
  88388. * @param frustumPlane the resuling frustum plane
  88389. */
  88390. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88391. /**
  88392. * Gets the right frustum plane transformed by the transform matrix
  88393. * @param transform transformation matrix to be applied to the resulting frustum plane
  88394. * @param frustumPlane the resuling frustum plane
  88395. */
  88396. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88397. /**
  88398. * Gets the top frustum plane transformed by the transform matrix
  88399. * @param transform transformation matrix to be applied to the resulting frustum plane
  88400. * @param frustumPlane the resuling frustum plane
  88401. */
  88402. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88403. /**
  88404. * Gets the bottom frustum plane transformed by the transform matrix
  88405. * @param transform transformation matrix to be applied to the resulting frustum plane
  88406. * @param frustumPlane the resuling frustum plane
  88407. */
  88408. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88409. /**
  88410. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  88411. * @param transform transformation matrix to be applied to the resulting frustum planes
  88412. * @param frustumPlanes the resuling frustum planes
  88413. */
  88414. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  88415. }
  88416. }
  88417. declare module BABYLON {
  88418. /**
  88419. * Interface for the size containing width and height
  88420. */
  88421. export interface ISize {
  88422. /**
  88423. * Width
  88424. */
  88425. width: number;
  88426. /**
  88427. * Heighht
  88428. */
  88429. height: number;
  88430. }
  88431. /**
  88432. * Size containing widht and height
  88433. */
  88434. export class Size implements ISize {
  88435. /**
  88436. * Width
  88437. */
  88438. width: number;
  88439. /**
  88440. * Height
  88441. */
  88442. height: number;
  88443. /**
  88444. * Creates a Size object from the given width and height (floats).
  88445. * @param width width of the new size
  88446. * @param height height of the new size
  88447. */
  88448. constructor(width: number, height: number);
  88449. /**
  88450. * Returns a string with the Size width and height
  88451. * @returns a string with the Size width and height
  88452. */
  88453. toString(): string;
  88454. /**
  88455. * "Size"
  88456. * @returns the string "Size"
  88457. */
  88458. getClassName(): string;
  88459. /**
  88460. * Returns the Size hash code.
  88461. * @returns a hash code for a unique width and height
  88462. */
  88463. getHashCode(): number;
  88464. /**
  88465. * Updates the current size from the given one.
  88466. * @param src the given size
  88467. */
  88468. copyFrom(src: Size): void;
  88469. /**
  88470. * Updates in place the current Size from the given floats.
  88471. * @param width width of the new size
  88472. * @param height height of the new size
  88473. * @returns the updated Size.
  88474. */
  88475. copyFromFloats(width: number, height: number): Size;
  88476. /**
  88477. * Updates in place the current Size from the given floats.
  88478. * @param width width to set
  88479. * @param height height to set
  88480. * @returns the updated Size.
  88481. */
  88482. set(width: number, height: number): Size;
  88483. /**
  88484. * Multiplies the width and height by numbers
  88485. * @param w factor to multiple the width by
  88486. * @param h factor to multiple the height by
  88487. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  88488. */
  88489. multiplyByFloats(w: number, h: number): Size;
  88490. /**
  88491. * Clones the size
  88492. * @returns a new Size copied from the given one.
  88493. */
  88494. clone(): Size;
  88495. /**
  88496. * True if the current Size and the given one width and height are strictly equal.
  88497. * @param other the other size to compare against
  88498. * @returns True if the current Size and the given one width and height are strictly equal.
  88499. */
  88500. equals(other: Size): boolean;
  88501. /**
  88502. * The surface of the Size : width * height (float).
  88503. */
  88504. get surface(): number;
  88505. /**
  88506. * Create a new size of zero
  88507. * @returns a new Size set to (0.0, 0.0)
  88508. */
  88509. static Zero(): Size;
  88510. /**
  88511. * Sums the width and height of two sizes
  88512. * @param otherSize size to add to this size
  88513. * @returns a new Size set as the addition result of the current Size and the given one.
  88514. */
  88515. add(otherSize: Size): Size;
  88516. /**
  88517. * Subtracts the width and height of two
  88518. * @param otherSize size to subtract to this size
  88519. * @returns a new Size set as the subtraction result of the given one from the current Size.
  88520. */
  88521. subtract(otherSize: Size): Size;
  88522. /**
  88523. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  88524. * @param start starting size to lerp between
  88525. * @param end end size to lerp between
  88526. * @param amount amount to lerp between the start and end values
  88527. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  88528. */
  88529. static Lerp(start: Size, end: Size, amount: number): Size;
  88530. }
  88531. }
  88532. declare module BABYLON {
  88533. /**
  88534. * Contains position and normal vectors for a vertex
  88535. */
  88536. export class PositionNormalVertex {
  88537. /** the position of the vertex (defaut: 0,0,0) */
  88538. position: Vector3;
  88539. /** the normal of the vertex (defaut: 0,1,0) */
  88540. normal: Vector3;
  88541. /**
  88542. * Creates a PositionNormalVertex
  88543. * @param position the position of the vertex (defaut: 0,0,0)
  88544. * @param normal the normal of the vertex (defaut: 0,1,0)
  88545. */
  88546. constructor(
  88547. /** the position of the vertex (defaut: 0,0,0) */
  88548. position?: Vector3,
  88549. /** the normal of the vertex (defaut: 0,1,0) */
  88550. normal?: Vector3);
  88551. /**
  88552. * Clones the PositionNormalVertex
  88553. * @returns the cloned PositionNormalVertex
  88554. */
  88555. clone(): PositionNormalVertex;
  88556. }
  88557. /**
  88558. * Contains position, normal and uv vectors for a vertex
  88559. */
  88560. export class PositionNormalTextureVertex {
  88561. /** the position of the vertex (defaut: 0,0,0) */
  88562. position: Vector3;
  88563. /** the normal of the vertex (defaut: 0,1,0) */
  88564. normal: Vector3;
  88565. /** the uv of the vertex (default: 0,0) */
  88566. uv: Vector2;
  88567. /**
  88568. * Creates a PositionNormalTextureVertex
  88569. * @param position the position of the vertex (defaut: 0,0,0)
  88570. * @param normal the normal of the vertex (defaut: 0,1,0)
  88571. * @param uv the uv of the vertex (default: 0,0)
  88572. */
  88573. constructor(
  88574. /** the position of the vertex (defaut: 0,0,0) */
  88575. position?: Vector3,
  88576. /** the normal of the vertex (defaut: 0,1,0) */
  88577. normal?: Vector3,
  88578. /** the uv of the vertex (default: 0,0) */
  88579. uv?: Vector2);
  88580. /**
  88581. * Clones the PositionNormalTextureVertex
  88582. * @returns the cloned PositionNormalTextureVertex
  88583. */
  88584. clone(): PositionNormalTextureVertex;
  88585. }
  88586. }
  88587. declare module BABYLON {
  88588. /**
  88589. * Enum defining the type of animations supported by InputBlock
  88590. */
  88591. export enum AnimatedInputBlockTypes {
  88592. /** No animation */
  88593. None = 0,
  88594. /** Time based animation. Will only work for floats */
  88595. Time = 1
  88596. }
  88597. }
  88598. declare module BABYLON {
  88599. /**
  88600. * Interface describing all the common properties and methods a shadow light needs to implement.
  88601. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  88602. * as well as binding the different shadow properties to the effects.
  88603. */
  88604. export interface IShadowLight extends Light {
  88605. /**
  88606. * The light id in the scene (used in scene.findLighById for instance)
  88607. */
  88608. id: string;
  88609. /**
  88610. * The position the shdow will be casted from.
  88611. */
  88612. position: Vector3;
  88613. /**
  88614. * In 2d mode (needCube being false), the direction used to cast the shadow.
  88615. */
  88616. direction: Vector3;
  88617. /**
  88618. * The transformed position. Position of the light in world space taking parenting in account.
  88619. */
  88620. transformedPosition: Vector3;
  88621. /**
  88622. * The transformed direction. Direction of the light in world space taking parenting in account.
  88623. */
  88624. transformedDirection: Vector3;
  88625. /**
  88626. * The friendly name of the light in the scene.
  88627. */
  88628. name: string;
  88629. /**
  88630. * Defines the shadow projection clipping minimum z value.
  88631. */
  88632. shadowMinZ: number;
  88633. /**
  88634. * Defines the shadow projection clipping maximum z value.
  88635. */
  88636. shadowMaxZ: number;
  88637. /**
  88638. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88639. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88640. */
  88641. computeTransformedInformation(): boolean;
  88642. /**
  88643. * Gets the scene the light belongs to.
  88644. * @returns The scene
  88645. */
  88646. getScene(): Scene;
  88647. /**
  88648. * Callback defining a custom Projection Matrix Builder.
  88649. * This can be used to override the default projection matrix computation.
  88650. */
  88651. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88652. /**
  88653. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88654. * @param matrix The materix to updated with the projection information
  88655. * @param viewMatrix The transform matrix of the light
  88656. * @param renderList The list of mesh to render in the map
  88657. * @returns The current light
  88658. */
  88659. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88660. /**
  88661. * Gets the current depth scale used in ESM.
  88662. * @returns The scale
  88663. */
  88664. getDepthScale(): number;
  88665. /**
  88666. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88667. * @returns true if a cube texture needs to be use
  88668. */
  88669. needCube(): boolean;
  88670. /**
  88671. * Detects if the projection matrix requires to be recomputed this frame.
  88672. * @returns true if it requires to be recomputed otherwise, false.
  88673. */
  88674. needProjectionMatrixCompute(): boolean;
  88675. /**
  88676. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88677. */
  88678. forceProjectionMatrixCompute(): void;
  88679. /**
  88680. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88681. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88682. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88683. */
  88684. getShadowDirection(faceIndex?: number): Vector3;
  88685. /**
  88686. * Gets the minZ used for shadow according to both the scene and the light.
  88687. * @param activeCamera The camera we are returning the min for
  88688. * @returns the depth min z
  88689. */
  88690. getDepthMinZ(activeCamera: Camera): number;
  88691. /**
  88692. * Gets the maxZ used for shadow according to both the scene and the light.
  88693. * @param activeCamera The camera we are returning the max for
  88694. * @returns the depth max z
  88695. */
  88696. getDepthMaxZ(activeCamera: Camera): number;
  88697. }
  88698. /**
  88699. * Base implementation IShadowLight
  88700. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  88701. */
  88702. export abstract class ShadowLight extends Light implements IShadowLight {
  88703. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  88704. protected _position: Vector3;
  88705. protected _setPosition(value: Vector3): void;
  88706. /**
  88707. * Sets the position the shadow will be casted from. Also use as the light position for both
  88708. * point and spot lights.
  88709. */
  88710. get position(): Vector3;
  88711. /**
  88712. * Sets the position the shadow will be casted from. Also use as the light position for both
  88713. * point and spot lights.
  88714. */
  88715. set position(value: Vector3);
  88716. protected _direction: Vector3;
  88717. protected _setDirection(value: Vector3): void;
  88718. /**
  88719. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  88720. * Also use as the light direction on spot and directional lights.
  88721. */
  88722. get direction(): Vector3;
  88723. /**
  88724. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  88725. * Also use as the light direction on spot and directional lights.
  88726. */
  88727. set direction(value: Vector3);
  88728. protected _shadowMinZ: number;
  88729. /**
  88730. * Gets the shadow projection clipping minimum z value.
  88731. */
  88732. get shadowMinZ(): number;
  88733. /**
  88734. * Sets the shadow projection clipping minimum z value.
  88735. */
  88736. set shadowMinZ(value: number);
  88737. protected _shadowMaxZ: number;
  88738. /**
  88739. * Sets the shadow projection clipping maximum z value.
  88740. */
  88741. get shadowMaxZ(): number;
  88742. /**
  88743. * Gets the shadow projection clipping maximum z value.
  88744. */
  88745. set shadowMaxZ(value: number);
  88746. /**
  88747. * Callback defining a custom Projection Matrix Builder.
  88748. * This can be used to override the default projection matrix computation.
  88749. */
  88750. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88751. /**
  88752. * The transformed position. Position of the light in world space taking parenting in account.
  88753. */
  88754. transformedPosition: Vector3;
  88755. /**
  88756. * The transformed direction. Direction of the light in world space taking parenting in account.
  88757. */
  88758. transformedDirection: Vector3;
  88759. private _needProjectionMatrixCompute;
  88760. /**
  88761. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88762. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88763. */
  88764. computeTransformedInformation(): boolean;
  88765. /**
  88766. * Return the depth scale used for the shadow map.
  88767. * @returns the depth scale.
  88768. */
  88769. getDepthScale(): number;
  88770. /**
  88771. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88772. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88773. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88774. */
  88775. getShadowDirection(faceIndex?: number): Vector3;
  88776. /**
  88777. * Returns the ShadowLight absolute position in the World.
  88778. * @returns the position vector in world space
  88779. */
  88780. getAbsolutePosition(): Vector3;
  88781. /**
  88782. * Sets the ShadowLight direction toward the passed target.
  88783. * @param target The point to target in local space
  88784. * @returns the updated ShadowLight direction
  88785. */
  88786. setDirectionToTarget(target: Vector3): Vector3;
  88787. /**
  88788. * Returns the light rotation in euler definition.
  88789. * @returns the x y z rotation in local space.
  88790. */
  88791. getRotation(): Vector3;
  88792. /**
  88793. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88794. * @returns true if a cube texture needs to be use
  88795. */
  88796. needCube(): boolean;
  88797. /**
  88798. * Detects if the projection matrix requires to be recomputed this frame.
  88799. * @returns true if it requires to be recomputed otherwise, false.
  88800. */
  88801. needProjectionMatrixCompute(): boolean;
  88802. /**
  88803. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88804. */
  88805. forceProjectionMatrixCompute(): void;
  88806. /** @hidden */
  88807. _initCache(): void;
  88808. /** @hidden */
  88809. _isSynchronized(): boolean;
  88810. /**
  88811. * Computes the world matrix of the node
  88812. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  88813. * @returns the world matrix
  88814. */
  88815. computeWorldMatrix(force?: boolean): Matrix;
  88816. /**
  88817. * Gets the minZ used for shadow according to both the scene and the light.
  88818. * @param activeCamera The camera we are returning the min for
  88819. * @returns the depth min z
  88820. */
  88821. getDepthMinZ(activeCamera: Camera): number;
  88822. /**
  88823. * Gets the maxZ used for shadow according to both the scene and the light.
  88824. * @param activeCamera The camera we are returning the max for
  88825. * @returns the depth max z
  88826. */
  88827. getDepthMaxZ(activeCamera: Camera): number;
  88828. /**
  88829. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88830. * @param matrix The materix to updated with the projection information
  88831. * @param viewMatrix The transform matrix of the light
  88832. * @param renderList The list of mesh to render in the map
  88833. * @returns The current light
  88834. */
  88835. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88836. }
  88837. }
  88838. declare module BABYLON {
  88839. /** @hidden */
  88840. export var packingFunctions: {
  88841. name: string;
  88842. shader: string;
  88843. };
  88844. }
  88845. declare module BABYLON {
  88846. /** @hidden */
  88847. export var bayerDitherFunctions: {
  88848. name: string;
  88849. shader: string;
  88850. };
  88851. }
  88852. declare module BABYLON {
  88853. /** @hidden */
  88854. export var shadowMapFragmentDeclaration: {
  88855. name: string;
  88856. shader: string;
  88857. };
  88858. }
  88859. declare module BABYLON {
  88860. /** @hidden */
  88861. export var clipPlaneFragmentDeclaration: {
  88862. name: string;
  88863. shader: string;
  88864. };
  88865. }
  88866. declare module BABYLON {
  88867. /** @hidden */
  88868. export var clipPlaneFragment: {
  88869. name: string;
  88870. shader: string;
  88871. };
  88872. }
  88873. declare module BABYLON {
  88874. /** @hidden */
  88875. export var shadowMapFragment: {
  88876. name: string;
  88877. shader: string;
  88878. };
  88879. }
  88880. declare module BABYLON {
  88881. /** @hidden */
  88882. export var shadowMapPixelShader: {
  88883. name: string;
  88884. shader: string;
  88885. };
  88886. }
  88887. declare module BABYLON {
  88888. /** @hidden */
  88889. export var bonesDeclaration: {
  88890. name: string;
  88891. shader: string;
  88892. };
  88893. }
  88894. declare module BABYLON {
  88895. /** @hidden */
  88896. export var morphTargetsVertexGlobalDeclaration: {
  88897. name: string;
  88898. shader: string;
  88899. };
  88900. }
  88901. declare module BABYLON {
  88902. /** @hidden */
  88903. export var morphTargetsVertexDeclaration: {
  88904. name: string;
  88905. shader: string;
  88906. };
  88907. }
  88908. declare module BABYLON {
  88909. /** @hidden */
  88910. export var instancesDeclaration: {
  88911. name: string;
  88912. shader: string;
  88913. };
  88914. }
  88915. declare module BABYLON {
  88916. /** @hidden */
  88917. export var helperFunctions: {
  88918. name: string;
  88919. shader: string;
  88920. };
  88921. }
  88922. declare module BABYLON {
  88923. /** @hidden */
  88924. export var shadowMapVertexDeclaration: {
  88925. name: string;
  88926. shader: string;
  88927. };
  88928. }
  88929. declare module BABYLON {
  88930. /** @hidden */
  88931. export var clipPlaneVertexDeclaration: {
  88932. name: string;
  88933. shader: string;
  88934. };
  88935. }
  88936. declare module BABYLON {
  88937. /** @hidden */
  88938. export var morphTargetsVertex: {
  88939. name: string;
  88940. shader: string;
  88941. };
  88942. }
  88943. declare module BABYLON {
  88944. /** @hidden */
  88945. export var instancesVertex: {
  88946. name: string;
  88947. shader: string;
  88948. };
  88949. }
  88950. declare module BABYLON {
  88951. /** @hidden */
  88952. export var bonesVertex: {
  88953. name: string;
  88954. shader: string;
  88955. };
  88956. }
  88957. declare module BABYLON {
  88958. /** @hidden */
  88959. export var shadowMapVertexNormalBias: {
  88960. name: string;
  88961. shader: string;
  88962. };
  88963. }
  88964. declare module BABYLON {
  88965. /** @hidden */
  88966. export var shadowMapVertexMetric: {
  88967. name: string;
  88968. shader: string;
  88969. };
  88970. }
  88971. declare module BABYLON {
  88972. /** @hidden */
  88973. export var clipPlaneVertex: {
  88974. name: string;
  88975. shader: string;
  88976. };
  88977. }
  88978. declare module BABYLON {
  88979. /** @hidden */
  88980. export var shadowMapVertexShader: {
  88981. name: string;
  88982. shader: string;
  88983. };
  88984. }
  88985. declare module BABYLON {
  88986. /** @hidden */
  88987. export var depthBoxBlurPixelShader: {
  88988. name: string;
  88989. shader: string;
  88990. };
  88991. }
  88992. declare module BABYLON {
  88993. /** @hidden */
  88994. export var shadowMapFragmentSoftTransparentShadow: {
  88995. name: string;
  88996. shader: string;
  88997. };
  88998. }
  88999. declare module BABYLON {
  89000. /**
  89001. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  89002. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  89003. */
  89004. export class EffectFallbacks implements IEffectFallbacks {
  89005. private _defines;
  89006. private _currentRank;
  89007. private _maxRank;
  89008. private _mesh;
  89009. /**
  89010. * Removes the fallback from the bound mesh.
  89011. */
  89012. unBindMesh(): void;
  89013. /**
  89014. * Adds a fallback on the specified property.
  89015. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89016. * @param define The name of the define in the shader
  89017. */
  89018. addFallback(rank: number, define: string): void;
  89019. /**
  89020. * Sets the mesh to use CPU skinning when needing to fallback.
  89021. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89022. * @param mesh The mesh to use the fallbacks.
  89023. */
  89024. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  89025. /**
  89026. * Checks to see if more fallbacks are still availible.
  89027. */
  89028. get hasMoreFallbacks(): boolean;
  89029. /**
  89030. * Removes the defines that should be removed when falling back.
  89031. * @param currentDefines defines the current define statements for the shader.
  89032. * @param effect defines the current effect we try to compile
  89033. * @returns The resulting defines with defines of the current rank removed.
  89034. */
  89035. reduce(currentDefines: string, effect: Effect): string;
  89036. }
  89037. }
  89038. declare module BABYLON {
  89039. /**
  89040. * Interface used to define Action
  89041. */
  89042. export interface IAction {
  89043. /**
  89044. * Trigger for the action
  89045. */
  89046. trigger: number;
  89047. /** Options of the trigger */
  89048. triggerOptions: any;
  89049. /**
  89050. * Gets the trigger parameters
  89051. * @returns the trigger parameters
  89052. */
  89053. getTriggerParameter(): any;
  89054. /**
  89055. * Internal only - executes current action event
  89056. * @hidden
  89057. */
  89058. _executeCurrent(evt?: ActionEvent): void;
  89059. /**
  89060. * Serialize placeholder for child classes
  89061. * @param parent of child
  89062. * @returns the serialized object
  89063. */
  89064. serialize(parent: any): any;
  89065. /**
  89066. * Internal only
  89067. * @hidden
  89068. */
  89069. _prepare(): void;
  89070. /**
  89071. * Internal only - manager for action
  89072. * @hidden
  89073. */
  89074. _actionManager: Nullable<AbstractActionManager>;
  89075. /**
  89076. * Adds action to chain of actions, may be a DoNothingAction
  89077. * @param action defines the next action to execute
  89078. * @returns The action passed in
  89079. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89080. */
  89081. then(action: IAction): IAction;
  89082. }
  89083. /**
  89084. * The action to be carried out following a trigger
  89085. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  89086. */
  89087. export class Action implements IAction {
  89088. /** the trigger, with or without parameters, for the action */
  89089. triggerOptions: any;
  89090. /**
  89091. * Trigger for the action
  89092. */
  89093. trigger: number;
  89094. /**
  89095. * Internal only - manager for action
  89096. * @hidden
  89097. */
  89098. _actionManager: ActionManager;
  89099. private _nextActiveAction;
  89100. private _child;
  89101. private _condition?;
  89102. private _triggerParameter;
  89103. /**
  89104. * An event triggered prior to action being executed.
  89105. */
  89106. onBeforeExecuteObservable: Observable<Action>;
  89107. /**
  89108. * Creates a new Action
  89109. * @param triggerOptions the trigger, with or without parameters, for the action
  89110. * @param condition an optional determinant of action
  89111. */
  89112. constructor(
  89113. /** the trigger, with or without parameters, for the action */
  89114. triggerOptions: any, condition?: Condition);
  89115. /**
  89116. * Internal only
  89117. * @hidden
  89118. */
  89119. _prepare(): void;
  89120. /**
  89121. * Gets the trigger parameters
  89122. * @returns the trigger parameters
  89123. */
  89124. getTriggerParameter(): any;
  89125. /**
  89126. * Internal only - executes current action event
  89127. * @hidden
  89128. */
  89129. _executeCurrent(evt?: ActionEvent): void;
  89130. /**
  89131. * Execute placeholder for child classes
  89132. * @param evt optional action event
  89133. */
  89134. execute(evt?: ActionEvent): void;
  89135. /**
  89136. * Skips to next active action
  89137. */
  89138. skipToNextActiveAction(): void;
  89139. /**
  89140. * Adds action to chain of actions, may be a DoNothingAction
  89141. * @param action defines the next action to execute
  89142. * @returns The action passed in
  89143. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89144. */
  89145. then(action: Action): Action;
  89146. /**
  89147. * Internal only
  89148. * @hidden
  89149. */
  89150. _getProperty(propertyPath: string): string;
  89151. /**
  89152. * Internal only
  89153. * @hidden
  89154. */
  89155. _getEffectiveTarget(target: any, propertyPath: string): any;
  89156. /**
  89157. * Serialize placeholder for child classes
  89158. * @param parent of child
  89159. * @returns the serialized object
  89160. */
  89161. serialize(parent: any): any;
  89162. /**
  89163. * Internal only called by serialize
  89164. * @hidden
  89165. */
  89166. protected _serialize(serializedAction: any, parent?: any): any;
  89167. /**
  89168. * Internal only
  89169. * @hidden
  89170. */
  89171. static _SerializeValueAsString: (value: any) => string;
  89172. /**
  89173. * Internal only
  89174. * @hidden
  89175. */
  89176. static _GetTargetProperty: (target: Scene | Node) => {
  89177. name: string;
  89178. targetType: string;
  89179. value: string;
  89180. };
  89181. }
  89182. }
  89183. declare module BABYLON {
  89184. /**
  89185. * A Condition applied to an Action
  89186. */
  89187. export class Condition {
  89188. /**
  89189. * Internal only - manager for action
  89190. * @hidden
  89191. */
  89192. _actionManager: ActionManager;
  89193. /**
  89194. * Internal only
  89195. * @hidden
  89196. */
  89197. _evaluationId: number;
  89198. /**
  89199. * Internal only
  89200. * @hidden
  89201. */
  89202. _currentResult: boolean;
  89203. /**
  89204. * Creates a new Condition
  89205. * @param actionManager the manager of the action the condition is applied to
  89206. */
  89207. constructor(actionManager: ActionManager);
  89208. /**
  89209. * Check if the current condition is valid
  89210. * @returns a boolean
  89211. */
  89212. isValid(): boolean;
  89213. /**
  89214. * Internal only
  89215. * @hidden
  89216. */
  89217. _getProperty(propertyPath: string): string;
  89218. /**
  89219. * Internal only
  89220. * @hidden
  89221. */
  89222. _getEffectiveTarget(target: any, propertyPath: string): any;
  89223. /**
  89224. * Serialize placeholder for child classes
  89225. * @returns the serialized object
  89226. */
  89227. serialize(): any;
  89228. /**
  89229. * Internal only
  89230. * @hidden
  89231. */
  89232. protected _serialize(serializedCondition: any): any;
  89233. }
  89234. /**
  89235. * Defines specific conditional operators as extensions of Condition
  89236. */
  89237. export class ValueCondition extends Condition {
  89238. /** path to specify the property of the target the conditional operator uses */
  89239. propertyPath: string;
  89240. /** the value compared by the conditional operator against the current value of the property */
  89241. value: any;
  89242. /** the conditional operator, default ValueCondition.IsEqual */
  89243. operator: number;
  89244. /**
  89245. * Internal only
  89246. * @hidden
  89247. */
  89248. private static _IsEqual;
  89249. /**
  89250. * Internal only
  89251. * @hidden
  89252. */
  89253. private static _IsDifferent;
  89254. /**
  89255. * Internal only
  89256. * @hidden
  89257. */
  89258. private static _IsGreater;
  89259. /**
  89260. * Internal only
  89261. * @hidden
  89262. */
  89263. private static _IsLesser;
  89264. /**
  89265. * returns the number for IsEqual
  89266. */
  89267. static get IsEqual(): number;
  89268. /**
  89269. * Returns the number for IsDifferent
  89270. */
  89271. static get IsDifferent(): number;
  89272. /**
  89273. * Returns the number for IsGreater
  89274. */
  89275. static get IsGreater(): number;
  89276. /**
  89277. * Returns the number for IsLesser
  89278. */
  89279. static get IsLesser(): number;
  89280. /**
  89281. * Internal only The action manager for the condition
  89282. * @hidden
  89283. */
  89284. _actionManager: ActionManager;
  89285. /**
  89286. * Internal only
  89287. * @hidden
  89288. */
  89289. private _target;
  89290. /**
  89291. * Internal only
  89292. * @hidden
  89293. */
  89294. private _effectiveTarget;
  89295. /**
  89296. * Internal only
  89297. * @hidden
  89298. */
  89299. private _property;
  89300. /**
  89301. * Creates a new ValueCondition
  89302. * @param actionManager manager for the action the condition applies to
  89303. * @param target for the action
  89304. * @param propertyPath path to specify the property of the target the conditional operator uses
  89305. * @param value the value compared by the conditional operator against the current value of the property
  89306. * @param operator the conditional operator, default ValueCondition.IsEqual
  89307. */
  89308. constructor(actionManager: ActionManager, target: any,
  89309. /** path to specify the property of the target the conditional operator uses */
  89310. propertyPath: string,
  89311. /** the value compared by the conditional operator against the current value of the property */
  89312. value: any,
  89313. /** the conditional operator, default ValueCondition.IsEqual */
  89314. operator?: number);
  89315. /**
  89316. * Compares the given value with the property value for the specified conditional operator
  89317. * @returns the result of the comparison
  89318. */
  89319. isValid(): boolean;
  89320. /**
  89321. * Serialize the ValueCondition into a JSON compatible object
  89322. * @returns serialization object
  89323. */
  89324. serialize(): any;
  89325. /**
  89326. * Gets the name of the conditional operator for the ValueCondition
  89327. * @param operator the conditional operator
  89328. * @returns the name
  89329. */
  89330. static GetOperatorName(operator: number): string;
  89331. }
  89332. /**
  89333. * Defines a predicate condition as an extension of Condition
  89334. */
  89335. export class PredicateCondition extends Condition {
  89336. /** defines the predicate function used to validate the condition */
  89337. predicate: () => boolean;
  89338. /**
  89339. * Internal only - manager for action
  89340. * @hidden
  89341. */
  89342. _actionManager: ActionManager;
  89343. /**
  89344. * Creates a new PredicateCondition
  89345. * @param actionManager manager for the action the condition applies to
  89346. * @param predicate defines the predicate function used to validate the condition
  89347. */
  89348. constructor(actionManager: ActionManager,
  89349. /** defines the predicate function used to validate the condition */
  89350. predicate: () => boolean);
  89351. /**
  89352. * @returns the validity of the predicate condition
  89353. */
  89354. isValid(): boolean;
  89355. }
  89356. /**
  89357. * Defines a state condition as an extension of Condition
  89358. */
  89359. export class StateCondition extends Condition {
  89360. /** Value to compare with target state */
  89361. value: string;
  89362. /**
  89363. * Internal only - manager for action
  89364. * @hidden
  89365. */
  89366. _actionManager: ActionManager;
  89367. /**
  89368. * Internal only
  89369. * @hidden
  89370. */
  89371. private _target;
  89372. /**
  89373. * Creates a new StateCondition
  89374. * @param actionManager manager for the action the condition applies to
  89375. * @param target of the condition
  89376. * @param value to compare with target state
  89377. */
  89378. constructor(actionManager: ActionManager, target: any,
  89379. /** Value to compare with target state */
  89380. value: string);
  89381. /**
  89382. * Gets a boolean indicating if the current condition is met
  89383. * @returns the validity of the state
  89384. */
  89385. isValid(): boolean;
  89386. /**
  89387. * Serialize the StateCondition into a JSON compatible object
  89388. * @returns serialization object
  89389. */
  89390. serialize(): any;
  89391. }
  89392. }
  89393. declare module BABYLON {
  89394. /**
  89395. * This defines an action responsible to toggle a boolean once triggered.
  89396. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89397. */
  89398. export class SwitchBooleanAction extends Action {
  89399. /**
  89400. * The path to the boolean property in the target object
  89401. */
  89402. propertyPath: string;
  89403. private _target;
  89404. private _effectiveTarget;
  89405. private _property;
  89406. /**
  89407. * Instantiate the action
  89408. * @param triggerOptions defines the trigger options
  89409. * @param target defines the object containing the boolean
  89410. * @param propertyPath defines the path to the boolean property in the target object
  89411. * @param condition defines the trigger related conditions
  89412. */
  89413. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  89414. /** @hidden */
  89415. _prepare(): void;
  89416. /**
  89417. * Execute the action toggle the boolean value.
  89418. */
  89419. execute(): void;
  89420. /**
  89421. * Serializes the actions and its related information.
  89422. * @param parent defines the object to serialize in
  89423. * @returns the serialized object
  89424. */
  89425. serialize(parent: any): any;
  89426. }
  89427. /**
  89428. * This defines an action responsible to set a the state field of the target
  89429. * to a desired value once triggered.
  89430. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89431. */
  89432. export class SetStateAction extends Action {
  89433. /**
  89434. * The value to store in the state field.
  89435. */
  89436. value: string;
  89437. private _target;
  89438. /**
  89439. * Instantiate the action
  89440. * @param triggerOptions defines the trigger options
  89441. * @param target defines the object containing the state property
  89442. * @param value defines the value to store in the state field
  89443. * @param condition defines the trigger related conditions
  89444. */
  89445. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  89446. /**
  89447. * Execute the action and store the value on the target state property.
  89448. */
  89449. execute(): void;
  89450. /**
  89451. * Serializes the actions and its related information.
  89452. * @param parent defines the object to serialize in
  89453. * @returns the serialized object
  89454. */
  89455. serialize(parent: any): any;
  89456. }
  89457. /**
  89458. * This defines an action responsible to set a property of the target
  89459. * to a desired value once triggered.
  89460. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89461. */
  89462. export class SetValueAction extends Action {
  89463. /**
  89464. * The path of the property to set in the target.
  89465. */
  89466. propertyPath: string;
  89467. /**
  89468. * The value to set in the property
  89469. */
  89470. value: any;
  89471. private _target;
  89472. private _effectiveTarget;
  89473. private _property;
  89474. /**
  89475. * Instantiate the action
  89476. * @param triggerOptions defines the trigger options
  89477. * @param target defines the object containing the property
  89478. * @param propertyPath defines the path of the property to set in the target
  89479. * @param value defines the value to set in the property
  89480. * @param condition defines the trigger related conditions
  89481. */
  89482. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89483. /** @hidden */
  89484. _prepare(): void;
  89485. /**
  89486. * Execute the action and set the targetted property to the desired value.
  89487. */
  89488. execute(): void;
  89489. /**
  89490. * Serializes the actions and its related information.
  89491. * @param parent defines the object to serialize in
  89492. * @returns the serialized object
  89493. */
  89494. serialize(parent: any): any;
  89495. }
  89496. /**
  89497. * This defines an action responsible to increment the target value
  89498. * to a desired value once triggered.
  89499. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89500. */
  89501. export class IncrementValueAction extends Action {
  89502. /**
  89503. * The path of the property to increment in the target.
  89504. */
  89505. propertyPath: string;
  89506. /**
  89507. * The value we should increment the property by.
  89508. */
  89509. value: any;
  89510. private _target;
  89511. private _effectiveTarget;
  89512. private _property;
  89513. /**
  89514. * Instantiate the action
  89515. * @param triggerOptions defines the trigger options
  89516. * @param target defines the object containing the property
  89517. * @param propertyPath defines the path of the property to increment in the target
  89518. * @param value defines the value value we should increment the property by
  89519. * @param condition defines the trigger related conditions
  89520. */
  89521. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89522. /** @hidden */
  89523. _prepare(): void;
  89524. /**
  89525. * Execute the action and increment the target of the value amount.
  89526. */
  89527. execute(): void;
  89528. /**
  89529. * Serializes the actions and its related information.
  89530. * @param parent defines the object to serialize in
  89531. * @returns the serialized object
  89532. */
  89533. serialize(parent: any): any;
  89534. }
  89535. /**
  89536. * This defines an action responsible to start an animation once triggered.
  89537. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89538. */
  89539. export class PlayAnimationAction extends Action {
  89540. /**
  89541. * Where the animation should start (animation frame)
  89542. */
  89543. from: number;
  89544. /**
  89545. * Where the animation should stop (animation frame)
  89546. */
  89547. to: number;
  89548. /**
  89549. * Define if the animation should loop or stop after the first play.
  89550. */
  89551. loop?: boolean;
  89552. private _target;
  89553. /**
  89554. * Instantiate the action
  89555. * @param triggerOptions defines the trigger options
  89556. * @param target defines the target animation or animation name
  89557. * @param from defines from where the animation should start (animation frame)
  89558. * @param end defines where the animation should stop (animation frame)
  89559. * @param loop defines if the animation should loop or stop after the first play
  89560. * @param condition defines the trigger related conditions
  89561. */
  89562. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  89563. /** @hidden */
  89564. _prepare(): void;
  89565. /**
  89566. * Execute the action and play the animation.
  89567. */
  89568. execute(): void;
  89569. /**
  89570. * Serializes the actions and its related information.
  89571. * @param parent defines the object to serialize in
  89572. * @returns the serialized object
  89573. */
  89574. serialize(parent: any): any;
  89575. }
  89576. /**
  89577. * This defines an action responsible to stop an animation once triggered.
  89578. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89579. */
  89580. export class StopAnimationAction extends Action {
  89581. private _target;
  89582. /**
  89583. * Instantiate the action
  89584. * @param triggerOptions defines the trigger options
  89585. * @param target defines the target animation or animation name
  89586. * @param condition defines the trigger related conditions
  89587. */
  89588. constructor(triggerOptions: any, target: any, condition?: Condition);
  89589. /** @hidden */
  89590. _prepare(): void;
  89591. /**
  89592. * Execute the action and stop the animation.
  89593. */
  89594. execute(): void;
  89595. /**
  89596. * Serializes the actions and its related information.
  89597. * @param parent defines the object to serialize in
  89598. * @returns the serialized object
  89599. */
  89600. serialize(parent: any): any;
  89601. }
  89602. /**
  89603. * This defines an action responsible that does nothing once triggered.
  89604. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89605. */
  89606. export class DoNothingAction extends Action {
  89607. /**
  89608. * Instantiate the action
  89609. * @param triggerOptions defines the trigger options
  89610. * @param condition defines the trigger related conditions
  89611. */
  89612. constructor(triggerOptions?: any, condition?: Condition);
  89613. /**
  89614. * Execute the action and do nothing.
  89615. */
  89616. execute(): void;
  89617. /**
  89618. * Serializes the actions and its related information.
  89619. * @param parent defines the object to serialize in
  89620. * @returns the serialized object
  89621. */
  89622. serialize(parent: any): any;
  89623. }
  89624. /**
  89625. * This defines an action responsible to trigger several actions once triggered.
  89626. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89627. */
  89628. export class CombineAction extends Action {
  89629. /**
  89630. * The list of aggregated animations to run.
  89631. */
  89632. children: Action[];
  89633. /**
  89634. * Instantiate the action
  89635. * @param triggerOptions defines the trigger options
  89636. * @param children defines the list of aggregated animations to run
  89637. * @param condition defines the trigger related conditions
  89638. */
  89639. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  89640. /** @hidden */
  89641. _prepare(): void;
  89642. /**
  89643. * Execute the action and executes all the aggregated actions.
  89644. */
  89645. execute(evt: ActionEvent): void;
  89646. /**
  89647. * Serializes the actions and its related information.
  89648. * @param parent defines the object to serialize in
  89649. * @returns the serialized object
  89650. */
  89651. serialize(parent: any): any;
  89652. }
  89653. /**
  89654. * This defines an action responsible to run code (external event) once triggered.
  89655. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89656. */
  89657. export class ExecuteCodeAction extends Action {
  89658. /**
  89659. * The callback function to run.
  89660. */
  89661. func: (evt: ActionEvent) => void;
  89662. /**
  89663. * Instantiate the action
  89664. * @param triggerOptions defines the trigger options
  89665. * @param func defines the callback function to run
  89666. * @param condition defines the trigger related conditions
  89667. */
  89668. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  89669. /**
  89670. * Execute the action and run the attached code.
  89671. */
  89672. execute(evt: ActionEvent): void;
  89673. }
  89674. /**
  89675. * This defines an action responsible to set the parent property of the target once triggered.
  89676. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89677. */
  89678. export class SetParentAction extends Action {
  89679. private _parent;
  89680. private _target;
  89681. /**
  89682. * Instantiate the action
  89683. * @param triggerOptions defines the trigger options
  89684. * @param target defines the target containing the parent property
  89685. * @param parent defines from where the animation should start (animation frame)
  89686. * @param condition defines the trigger related conditions
  89687. */
  89688. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  89689. /** @hidden */
  89690. _prepare(): void;
  89691. /**
  89692. * Execute the action and set the parent property.
  89693. */
  89694. execute(): void;
  89695. /**
  89696. * Serializes the actions and its related information.
  89697. * @param parent defines the object to serialize in
  89698. * @returns the serialized object
  89699. */
  89700. serialize(parent: any): any;
  89701. }
  89702. }
  89703. declare module BABYLON {
  89704. /**
  89705. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  89706. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  89707. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89708. */
  89709. export class ActionManager extends AbstractActionManager {
  89710. /**
  89711. * Nothing
  89712. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89713. */
  89714. static readonly NothingTrigger: number;
  89715. /**
  89716. * On pick
  89717. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89718. */
  89719. static readonly OnPickTrigger: number;
  89720. /**
  89721. * On left pick
  89722. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89723. */
  89724. static readonly OnLeftPickTrigger: number;
  89725. /**
  89726. * On right pick
  89727. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89728. */
  89729. static readonly OnRightPickTrigger: number;
  89730. /**
  89731. * On center pick
  89732. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89733. */
  89734. static readonly OnCenterPickTrigger: number;
  89735. /**
  89736. * On pick down
  89737. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89738. */
  89739. static readonly OnPickDownTrigger: number;
  89740. /**
  89741. * On double pick
  89742. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89743. */
  89744. static readonly OnDoublePickTrigger: number;
  89745. /**
  89746. * On pick up
  89747. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89748. */
  89749. static readonly OnPickUpTrigger: number;
  89750. /**
  89751. * On pick out.
  89752. * This trigger will only be raised if you also declared a OnPickDown
  89753. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89754. */
  89755. static readonly OnPickOutTrigger: number;
  89756. /**
  89757. * On long press
  89758. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89759. */
  89760. static readonly OnLongPressTrigger: number;
  89761. /**
  89762. * On pointer over
  89763. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89764. */
  89765. static readonly OnPointerOverTrigger: number;
  89766. /**
  89767. * On pointer out
  89768. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89769. */
  89770. static readonly OnPointerOutTrigger: number;
  89771. /**
  89772. * On every frame
  89773. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89774. */
  89775. static readonly OnEveryFrameTrigger: number;
  89776. /**
  89777. * On intersection enter
  89778. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89779. */
  89780. static readonly OnIntersectionEnterTrigger: number;
  89781. /**
  89782. * On intersection exit
  89783. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89784. */
  89785. static readonly OnIntersectionExitTrigger: number;
  89786. /**
  89787. * On key down
  89788. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89789. */
  89790. static readonly OnKeyDownTrigger: number;
  89791. /**
  89792. * On key up
  89793. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89794. */
  89795. static readonly OnKeyUpTrigger: number;
  89796. private _scene;
  89797. /**
  89798. * Creates a new action manager
  89799. * @param scene defines the hosting scene
  89800. */
  89801. constructor(scene: Scene);
  89802. /**
  89803. * Releases all associated resources
  89804. */
  89805. dispose(): void;
  89806. /**
  89807. * Gets hosting scene
  89808. * @returns the hosting scene
  89809. */
  89810. getScene(): Scene;
  89811. /**
  89812. * Does this action manager handles actions of any of the given triggers
  89813. * @param triggers defines the triggers to be tested
  89814. * @return a boolean indicating whether one (or more) of the triggers is handled
  89815. */
  89816. hasSpecificTriggers(triggers: number[]): boolean;
  89817. /**
  89818. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  89819. * speed.
  89820. * @param triggerA defines the trigger to be tested
  89821. * @param triggerB defines the trigger to be tested
  89822. * @return a boolean indicating whether one (or more) of the triggers is handled
  89823. */
  89824. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  89825. /**
  89826. * Does this action manager handles actions of a given trigger
  89827. * @param trigger defines the trigger to be tested
  89828. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  89829. * @return whether the trigger is handled
  89830. */
  89831. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  89832. /**
  89833. * Does this action manager has pointer triggers
  89834. */
  89835. get hasPointerTriggers(): boolean;
  89836. /**
  89837. * Does this action manager has pick triggers
  89838. */
  89839. get hasPickTriggers(): boolean;
  89840. /**
  89841. * Registers an action to this action manager
  89842. * @param action defines the action to be registered
  89843. * @return the action amended (prepared) after registration
  89844. */
  89845. registerAction(action: IAction): Nullable<IAction>;
  89846. /**
  89847. * Unregisters an action to this action manager
  89848. * @param action defines the action to be unregistered
  89849. * @return a boolean indicating whether the action has been unregistered
  89850. */
  89851. unregisterAction(action: IAction): Boolean;
  89852. /**
  89853. * Process a specific trigger
  89854. * @param trigger defines the trigger to process
  89855. * @param evt defines the event details to be processed
  89856. */
  89857. processTrigger(trigger: number, evt?: IActionEvent): void;
  89858. /** @hidden */
  89859. _getEffectiveTarget(target: any, propertyPath: string): any;
  89860. /** @hidden */
  89861. _getProperty(propertyPath: string): string;
  89862. /**
  89863. * Serialize this manager to a JSON object
  89864. * @param name defines the property name to store this manager
  89865. * @returns a JSON representation of this manager
  89866. */
  89867. serialize(name: string): any;
  89868. /**
  89869. * Creates a new ActionManager from a JSON data
  89870. * @param parsedActions defines the JSON data to read from
  89871. * @param object defines the hosting mesh
  89872. * @param scene defines the hosting scene
  89873. */
  89874. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  89875. /**
  89876. * Get a trigger name by index
  89877. * @param trigger defines the trigger index
  89878. * @returns a trigger name
  89879. */
  89880. static GetTriggerName(trigger: number): string;
  89881. }
  89882. }
  89883. declare module BABYLON {
  89884. /**
  89885. * Class used to represent a sprite
  89886. * @see https://doc.babylonjs.com/babylon101/sprites
  89887. */
  89888. export class Sprite implements IAnimatable {
  89889. /** defines the name */
  89890. name: string;
  89891. /** Gets or sets the current world position */
  89892. position: Vector3;
  89893. /** Gets or sets the main color */
  89894. color: Color4;
  89895. /** Gets or sets the width */
  89896. width: number;
  89897. /** Gets or sets the height */
  89898. height: number;
  89899. /** Gets or sets rotation angle */
  89900. angle: number;
  89901. /** Gets or sets the cell index in the sprite sheet */
  89902. cellIndex: number;
  89903. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  89904. cellRef: string;
  89905. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  89906. invertU: boolean;
  89907. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  89908. invertV: boolean;
  89909. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  89910. disposeWhenFinishedAnimating: boolean;
  89911. /** Gets the list of attached animations */
  89912. animations: Nullable<Array<Animation>>;
  89913. /** Gets or sets a boolean indicating if the sprite can be picked */
  89914. isPickable: boolean;
  89915. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  89916. useAlphaForPicking: boolean;
  89917. /** @hidden */
  89918. _xOffset: number;
  89919. /** @hidden */
  89920. _yOffset: number;
  89921. /** @hidden */
  89922. _xSize: number;
  89923. /** @hidden */
  89924. _ySize: number;
  89925. /**
  89926. * Gets or sets the associated action manager
  89927. */
  89928. actionManager: Nullable<ActionManager>;
  89929. /**
  89930. * An event triggered when the control has been disposed
  89931. */
  89932. onDisposeObservable: Observable<Sprite>;
  89933. private _animationStarted;
  89934. private _loopAnimation;
  89935. private _fromIndex;
  89936. private _toIndex;
  89937. private _delay;
  89938. private _direction;
  89939. private _manager;
  89940. private _time;
  89941. private _onAnimationEnd;
  89942. /**
  89943. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  89944. */
  89945. isVisible: boolean;
  89946. /**
  89947. * Gets or sets the sprite size
  89948. */
  89949. get size(): number;
  89950. set size(value: number);
  89951. /**
  89952. * Returns a boolean indicating if the animation is started
  89953. */
  89954. get animationStarted(): boolean;
  89955. /**
  89956. * Gets or sets the unique id of the sprite
  89957. */
  89958. uniqueId: number;
  89959. /**
  89960. * Gets the manager of this sprite
  89961. */
  89962. get manager(): ISpriteManager;
  89963. /**
  89964. * Creates a new Sprite
  89965. * @param name defines the name
  89966. * @param manager defines the manager
  89967. */
  89968. constructor(
  89969. /** defines the name */
  89970. name: string, manager: ISpriteManager);
  89971. /**
  89972. * Returns the string "Sprite"
  89973. * @returns "Sprite"
  89974. */
  89975. getClassName(): string;
  89976. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  89977. get fromIndex(): number;
  89978. set fromIndex(value: number);
  89979. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  89980. get toIndex(): number;
  89981. set toIndex(value: number);
  89982. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  89983. get loopAnimation(): boolean;
  89984. set loopAnimation(value: boolean);
  89985. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  89986. get delay(): number;
  89987. set delay(value: number);
  89988. /**
  89989. * Starts an animation
  89990. * @param from defines the initial key
  89991. * @param to defines the end key
  89992. * @param loop defines if the animation must loop
  89993. * @param delay defines the start delay (in ms)
  89994. * @param onAnimationEnd defines a callback to call when animation ends
  89995. */
  89996. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  89997. /** Stops current animation (if any) */
  89998. stopAnimation(): void;
  89999. /** @hidden */
  90000. _animate(deltaTime: number): void;
  90001. /** Release associated resources */
  90002. dispose(): void;
  90003. /**
  90004. * Serializes the sprite to a JSON object
  90005. * @returns the JSON object
  90006. */
  90007. serialize(): any;
  90008. /**
  90009. * Parses a JSON object to create a new sprite
  90010. * @param parsedSprite The JSON object to parse
  90011. * @param manager defines the hosting manager
  90012. * @returns the new sprite
  90013. */
  90014. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  90015. }
  90016. }
  90017. declare module BABYLON {
  90018. /**
  90019. * Information about the result of picking within a scene
  90020. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  90021. */
  90022. export class PickingInfo {
  90023. /** @hidden */
  90024. _pickingUnavailable: boolean;
  90025. /**
  90026. * If the pick collided with an object
  90027. */
  90028. hit: boolean;
  90029. /**
  90030. * Distance away where the pick collided
  90031. */
  90032. distance: number;
  90033. /**
  90034. * The location of pick collision
  90035. */
  90036. pickedPoint: Nullable<Vector3>;
  90037. /**
  90038. * The mesh corresponding the the pick collision
  90039. */
  90040. pickedMesh: Nullable<AbstractMesh>;
  90041. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  90042. bu: number;
  90043. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  90044. bv: number;
  90045. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90046. faceId: number;
  90047. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90048. subMeshFaceId: number;
  90049. /** Id of the the submesh that was picked */
  90050. subMeshId: number;
  90051. /** If a sprite was picked, this will be the sprite the pick collided with */
  90052. pickedSprite: Nullable<Sprite>;
  90053. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  90054. thinInstanceIndex: number;
  90055. /**
  90056. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  90057. */
  90058. originMesh: Nullable<AbstractMesh>;
  90059. /**
  90060. * The ray that was used to perform the picking.
  90061. */
  90062. ray: Nullable<Ray>;
  90063. /**
  90064. * Gets the normal correspodning to the face the pick collided with
  90065. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  90066. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  90067. * @returns The normal correspodning to the face the pick collided with
  90068. */
  90069. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  90070. /**
  90071. * Gets the texture coordinates of where the pick occured
  90072. * @returns the vector containing the coordnates of the texture
  90073. */
  90074. getTextureCoordinates(): Nullable<Vector2>;
  90075. }
  90076. }
  90077. declare module BABYLON {
  90078. /**
  90079. * Class representing a ray with position and direction
  90080. */
  90081. export class Ray {
  90082. /** origin point */
  90083. origin: Vector3;
  90084. /** direction */
  90085. direction: Vector3;
  90086. /** length of the ray */
  90087. length: number;
  90088. private static readonly _TmpVector3;
  90089. private _tmpRay;
  90090. /**
  90091. * Creates a new ray
  90092. * @param origin origin point
  90093. * @param direction direction
  90094. * @param length length of the ray
  90095. */
  90096. constructor(
  90097. /** origin point */
  90098. origin: Vector3,
  90099. /** direction */
  90100. direction: Vector3,
  90101. /** length of the ray */
  90102. length?: number);
  90103. /**
  90104. * Checks if the ray intersects a box
  90105. * This does not account for the ray lenght by design to improve perfs.
  90106. * @param minimum bound of the box
  90107. * @param maximum bound of the box
  90108. * @param intersectionTreshold extra extend to be added to the box in all direction
  90109. * @returns if the box was hit
  90110. */
  90111. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  90112. /**
  90113. * Checks if the ray intersects a box
  90114. * This does not account for the ray lenght by design to improve perfs.
  90115. * @param box the bounding box to check
  90116. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  90117. * @returns if the box was hit
  90118. */
  90119. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  90120. /**
  90121. * If the ray hits a sphere
  90122. * @param sphere the bounding sphere to check
  90123. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  90124. * @returns true if it hits the sphere
  90125. */
  90126. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  90127. /**
  90128. * If the ray hits a triange
  90129. * @param vertex0 triangle vertex
  90130. * @param vertex1 triangle vertex
  90131. * @param vertex2 triangle vertex
  90132. * @returns intersection information if hit
  90133. */
  90134. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  90135. /**
  90136. * Checks if ray intersects a plane
  90137. * @param plane the plane to check
  90138. * @returns the distance away it was hit
  90139. */
  90140. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  90141. /**
  90142. * Calculate the intercept of a ray on a given axis
  90143. * @param axis to check 'x' | 'y' | 'z'
  90144. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  90145. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  90146. */
  90147. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  90148. /**
  90149. * Checks if ray intersects a mesh
  90150. * @param mesh the mesh to check
  90151. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90152. * @returns picking info of the intersecton
  90153. */
  90154. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  90155. /**
  90156. * Checks if ray intersects a mesh
  90157. * @param meshes the meshes to check
  90158. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90159. * @param results array to store result in
  90160. * @returns Array of picking infos
  90161. */
  90162. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  90163. private _comparePickingInfo;
  90164. private static smallnum;
  90165. private static rayl;
  90166. /**
  90167. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  90168. * @param sega the first point of the segment to test the intersection against
  90169. * @param segb the second point of the segment to test the intersection against
  90170. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  90171. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  90172. */
  90173. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  90174. /**
  90175. * Update the ray from viewport position
  90176. * @param x position
  90177. * @param y y position
  90178. * @param viewportWidth viewport width
  90179. * @param viewportHeight viewport height
  90180. * @param world world matrix
  90181. * @param view view matrix
  90182. * @param projection projection matrix
  90183. * @returns this ray updated
  90184. */
  90185. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90186. /**
  90187. * Creates a ray with origin and direction of 0,0,0
  90188. * @returns the new ray
  90189. */
  90190. static Zero(): Ray;
  90191. /**
  90192. * Creates a new ray from screen space and viewport
  90193. * @param x position
  90194. * @param y y position
  90195. * @param viewportWidth viewport width
  90196. * @param viewportHeight viewport height
  90197. * @param world world matrix
  90198. * @param view view matrix
  90199. * @param projection projection matrix
  90200. * @returns new ray
  90201. */
  90202. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90203. /**
  90204. * 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
  90205. * transformed to the given world matrix.
  90206. * @param origin The origin point
  90207. * @param end The end point
  90208. * @param world a matrix to transform the ray to. Default is the identity matrix.
  90209. * @returns the new ray
  90210. */
  90211. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  90212. /**
  90213. * Transforms a ray by a matrix
  90214. * @param ray ray to transform
  90215. * @param matrix matrix to apply
  90216. * @returns the resulting new ray
  90217. */
  90218. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  90219. /**
  90220. * Transforms a ray by a matrix
  90221. * @param ray ray to transform
  90222. * @param matrix matrix to apply
  90223. * @param result ray to store result in
  90224. */
  90225. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  90226. /**
  90227. * Unproject a ray from screen space to object space
  90228. * @param sourceX defines the screen space x coordinate to use
  90229. * @param sourceY defines the screen space y coordinate to use
  90230. * @param viewportWidth defines the current width of the viewport
  90231. * @param viewportHeight defines the current height of the viewport
  90232. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  90233. * @param view defines the view matrix to use
  90234. * @param projection defines the projection matrix to use
  90235. */
  90236. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  90237. }
  90238. /**
  90239. * Type used to define predicate used to select faces when a mesh intersection is detected
  90240. */
  90241. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  90242. interface Scene {
  90243. /** @hidden */
  90244. _tempPickingRay: Nullable<Ray>;
  90245. /** @hidden */
  90246. _cachedRayForTransform: Ray;
  90247. /** @hidden */
  90248. _pickWithRayInverseMatrix: Matrix;
  90249. /** @hidden */
  90250. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90251. /** @hidden */
  90252. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  90253. /** @hidden */
  90254. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90255. }
  90256. }
  90257. declare module BABYLON {
  90258. /**
  90259. * Groups all the scene component constants in one place to ease maintenance.
  90260. * @hidden
  90261. */
  90262. export class SceneComponentConstants {
  90263. static readonly NAME_EFFECTLAYER: string;
  90264. static readonly NAME_LAYER: string;
  90265. static readonly NAME_LENSFLARESYSTEM: string;
  90266. static readonly NAME_BOUNDINGBOXRENDERER: string;
  90267. static readonly NAME_PARTICLESYSTEM: string;
  90268. static readonly NAME_GAMEPAD: string;
  90269. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  90270. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  90271. static readonly NAME_PREPASSRENDERER: string;
  90272. static readonly NAME_DEPTHRENDERER: string;
  90273. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  90274. static readonly NAME_SPRITE: string;
  90275. static readonly NAME_OUTLINERENDERER: string;
  90276. static readonly NAME_PROCEDURALTEXTURE: string;
  90277. static readonly NAME_SHADOWGENERATOR: string;
  90278. static readonly NAME_OCTREE: string;
  90279. static readonly NAME_PHYSICSENGINE: string;
  90280. static readonly NAME_AUDIO: string;
  90281. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  90282. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90283. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  90284. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90285. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  90286. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  90287. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  90288. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  90289. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  90290. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  90291. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  90292. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  90293. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  90294. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  90295. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  90296. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  90297. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  90298. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  90299. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  90300. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  90301. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  90302. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  90303. static readonly STEP_AFTERRENDER_AUDIO: number;
  90304. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  90305. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  90306. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  90307. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  90308. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  90309. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  90310. static readonly STEP_POINTERMOVE_SPRITE: number;
  90311. static readonly STEP_POINTERDOWN_SPRITE: number;
  90312. static readonly STEP_POINTERUP_SPRITE: number;
  90313. }
  90314. /**
  90315. * This represents a scene component.
  90316. *
  90317. * This is used to decouple the dependency the scene is having on the different workloads like
  90318. * layers, post processes...
  90319. */
  90320. export interface ISceneComponent {
  90321. /**
  90322. * The name of the component. Each component must have a unique name.
  90323. */
  90324. name: string;
  90325. /**
  90326. * The scene the component belongs to.
  90327. */
  90328. scene: Scene;
  90329. /**
  90330. * Register the component to one instance of a scene.
  90331. */
  90332. register(): void;
  90333. /**
  90334. * Rebuilds the elements related to this component in case of
  90335. * context lost for instance.
  90336. */
  90337. rebuild(): void;
  90338. /**
  90339. * Disposes the component and the associated ressources.
  90340. */
  90341. dispose(): void;
  90342. }
  90343. /**
  90344. * This represents a SERIALIZABLE scene component.
  90345. *
  90346. * This extends Scene Component to add Serialization methods on top.
  90347. */
  90348. export interface ISceneSerializableComponent extends ISceneComponent {
  90349. /**
  90350. * Adds all the elements from the container to the scene
  90351. * @param container the container holding the elements
  90352. */
  90353. addFromContainer(container: AbstractScene): void;
  90354. /**
  90355. * Removes all the elements in the container from the scene
  90356. * @param container contains the elements to remove
  90357. * @param dispose if the removed element should be disposed (default: false)
  90358. */
  90359. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  90360. /**
  90361. * Serializes the component data to the specified json object
  90362. * @param serializationObject The object to serialize to
  90363. */
  90364. serialize(serializationObject: any): void;
  90365. }
  90366. /**
  90367. * Strong typing of a Mesh related stage step action
  90368. */
  90369. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  90370. /**
  90371. * Strong typing of a Evaluate Sub Mesh related stage step action
  90372. */
  90373. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  90374. /**
  90375. * Strong typing of a Active Mesh related stage step action
  90376. */
  90377. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  90378. /**
  90379. * Strong typing of a Camera related stage step action
  90380. */
  90381. export type CameraStageAction = (camera: Camera) => void;
  90382. /**
  90383. * Strong typing of a Camera Frame buffer related stage step action
  90384. */
  90385. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  90386. /**
  90387. * Strong typing of a Render Target related stage step action
  90388. */
  90389. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  90390. /**
  90391. * Strong typing of a RenderingGroup related stage step action
  90392. */
  90393. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  90394. /**
  90395. * Strong typing of a Mesh Render related stage step action
  90396. */
  90397. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  90398. /**
  90399. * Strong typing of a simple stage step action
  90400. */
  90401. export type SimpleStageAction = () => void;
  90402. /**
  90403. * Strong typing of a render target action.
  90404. */
  90405. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  90406. /**
  90407. * Strong typing of a pointer move action.
  90408. */
  90409. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  90410. /**
  90411. * Strong typing of a pointer up/down action.
  90412. */
  90413. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  90414. /**
  90415. * Representation of a stage in the scene (Basically a list of ordered steps)
  90416. * @hidden
  90417. */
  90418. export class Stage<T extends Function> extends Array<{
  90419. index: number;
  90420. component: ISceneComponent;
  90421. action: T;
  90422. }> {
  90423. /**
  90424. * Hide ctor from the rest of the world.
  90425. * @param items The items to add.
  90426. */
  90427. private constructor();
  90428. /**
  90429. * Creates a new Stage.
  90430. * @returns A new instance of a Stage
  90431. */
  90432. static Create<T extends Function>(): Stage<T>;
  90433. /**
  90434. * Registers a step in an ordered way in the targeted stage.
  90435. * @param index Defines the position to register the step in
  90436. * @param component Defines the component attached to the step
  90437. * @param action Defines the action to launch during the step
  90438. */
  90439. registerStep(index: number, component: ISceneComponent, action: T): void;
  90440. /**
  90441. * Clears all the steps from the stage.
  90442. */
  90443. clear(): void;
  90444. }
  90445. }
  90446. declare module BABYLON {
  90447. interface Scene {
  90448. /** @hidden */
  90449. _pointerOverSprite: Nullable<Sprite>;
  90450. /** @hidden */
  90451. _pickedDownSprite: Nullable<Sprite>;
  90452. /** @hidden */
  90453. _tempSpritePickingRay: Nullable<Ray>;
  90454. /**
  90455. * All of the sprite managers added to this scene
  90456. * @see https://doc.babylonjs.com/babylon101/sprites
  90457. */
  90458. spriteManagers: Array<ISpriteManager>;
  90459. /**
  90460. * An event triggered when sprites rendering is about to start
  90461. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90462. */
  90463. onBeforeSpritesRenderingObservable: Observable<Scene>;
  90464. /**
  90465. * An event triggered when sprites rendering is done
  90466. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90467. */
  90468. onAfterSpritesRenderingObservable: Observable<Scene>;
  90469. /** @hidden */
  90470. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90471. /** Launch a ray to try to pick a sprite in the scene
  90472. * @param x position on screen
  90473. * @param y position on screen
  90474. * @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
  90475. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90476. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90477. * @returns a PickingInfo
  90478. */
  90479. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90480. /** Use the given ray to pick a sprite in the scene
  90481. * @param ray The ray (in world space) to use to pick meshes
  90482. * @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
  90483. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90484. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90485. * @returns a PickingInfo
  90486. */
  90487. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90488. /** @hidden */
  90489. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90490. /** Launch a ray to try to pick sprites in the scene
  90491. * @param x position on screen
  90492. * @param y position on screen
  90493. * @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
  90494. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90495. * @returns a PickingInfo array
  90496. */
  90497. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90498. /** Use the given ray to pick sprites in the scene
  90499. * @param ray The ray (in world space) to use to pick meshes
  90500. * @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
  90501. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90502. * @returns a PickingInfo array
  90503. */
  90504. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90505. /**
  90506. * Force the sprite under the pointer
  90507. * @param sprite defines the sprite to use
  90508. */
  90509. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  90510. /**
  90511. * Gets the sprite under the pointer
  90512. * @returns a Sprite or null if no sprite is under the pointer
  90513. */
  90514. getPointerOverSprite(): Nullable<Sprite>;
  90515. }
  90516. /**
  90517. * Defines the sprite scene component responsible to manage sprites
  90518. * in a given scene.
  90519. */
  90520. export class SpriteSceneComponent implements ISceneComponent {
  90521. /**
  90522. * The component name helpfull to identify the component in the list of scene components.
  90523. */
  90524. readonly name: string;
  90525. /**
  90526. * The scene the component belongs to.
  90527. */
  90528. scene: Scene;
  90529. /** @hidden */
  90530. private _spritePredicate;
  90531. /**
  90532. * Creates a new instance of the component for the given scene
  90533. * @param scene Defines the scene to register the component in
  90534. */
  90535. constructor(scene: Scene);
  90536. /**
  90537. * Registers the component in a given scene
  90538. */
  90539. register(): void;
  90540. /**
  90541. * Rebuilds the elements related to this component in case of
  90542. * context lost for instance.
  90543. */
  90544. rebuild(): void;
  90545. /**
  90546. * Disposes the component and the associated ressources.
  90547. */
  90548. dispose(): void;
  90549. private _pickSpriteButKeepRay;
  90550. private _pointerMove;
  90551. private _pointerDown;
  90552. private _pointerUp;
  90553. }
  90554. }
  90555. declare module BABYLON {
  90556. /** @hidden */
  90557. export var fogFragmentDeclaration: {
  90558. name: string;
  90559. shader: string;
  90560. };
  90561. }
  90562. declare module BABYLON {
  90563. /** @hidden */
  90564. export var fogFragment: {
  90565. name: string;
  90566. shader: string;
  90567. };
  90568. }
  90569. declare module BABYLON {
  90570. /** @hidden */
  90571. export var spritesPixelShader: {
  90572. name: string;
  90573. shader: string;
  90574. };
  90575. }
  90576. declare module BABYLON {
  90577. /** @hidden */
  90578. export var fogVertexDeclaration: {
  90579. name: string;
  90580. shader: string;
  90581. };
  90582. }
  90583. declare module BABYLON {
  90584. /** @hidden */
  90585. export var spritesVertexShader: {
  90586. name: string;
  90587. shader: string;
  90588. };
  90589. }
  90590. declare module BABYLON {
  90591. /**
  90592. * Defines the minimum interface to fullfil in order to be a sprite manager.
  90593. */
  90594. export interface ISpriteManager extends IDisposable {
  90595. /**
  90596. * Gets manager's name
  90597. */
  90598. name: string;
  90599. /**
  90600. * Restricts the camera to viewing objects with the same layerMask.
  90601. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  90602. */
  90603. layerMask: number;
  90604. /**
  90605. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  90606. */
  90607. isPickable: boolean;
  90608. /**
  90609. * Gets the hosting scene
  90610. */
  90611. scene: Scene;
  90612. /**
  90613. * Specifies the rendering group id for this mesh (0 by default)
  90614. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  90615. */
  90616. renderingGroupId: number;
  90617. /**
  90618. * Defines the list of sprites managed by the manager.
  90619. */
  90620. sprites: Array<Sprite>;
  90621. /**
  90622. * Gets or sets the spritesheet texture
  90623. */
  90624. texture: Texture;
  90625. /** Defines the default width of a cell in the spritesheet */
  90626. cellWidth: number;
  90627. /** Defines the default height of a cell in the spritesheet */
  90628. cellHeight: number;
  90629. /**
  90630. * Tests the intersection of a sprite with a specific ray.
  90631. * @param ray The ray we are sending to test the collision
  90632. * @param camera The camera space we are sending rays in
  90633. * @param predicate A predicate allowing excluding sprites from the list of object to test
  90634. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90635. * @returns picking info or null.
  90636. */
  90637. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90638. /**
  90639. * Intersects the sprites with a ray
  90640. * @param ray defines the ray to intersect with
  90641. * @param camera defines the current active camera
  90642. * @param predicate defines a predicate used to select candidate sprites
  90643. * @returns null if no hit or a PickingInfo array
  90644. */
  90645. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90646. /**
  90647. * Renders the list of sprites on screen.
  90648. */
  90649. render(): void;
  90650. }
  90651. /**
  90652. * Class used to manage multiple sprites on the same spritesheet
  90653. * @see https://doc.babylonjs.com/babylon101/sprites
  90654. */
  90655. export class SpriteManager implements ISpriteManager {
  90656. /** defines the manager's name */
  90657. name: string;
  90658. /** Define the Url to load snippets */
  90659. static SnippetUrl: string;
  90660. /** Snippet ID if the manager was created from the snippet server */
  90661. snippetId: string;
  90662. /** Gets the list of sprites */
  90663. sprites: Sprite[];
  90664. /** Gets or sets the rendering group id (0 by default) */
  90665. renderingGroupId: number;
  90666. /** Gets or sets camera layer mask */
  90667. layerMask: number;
  90668. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  90669. fogEnabled: boolean;
  90670. /** Gets or sets a boolean indicating if the sprites are pickable */
  90671. isPickable: boolean;
  90672. /** Defines the default width of a cell in the spritesheet */
  90673. cellWidth: number;
  90674. /** Defines the default height of a cell in the spritesheet */
  90675. cellHeight: number;
  90676. /** Associative array from JSON sprite data file */
  90677. private _cellData;
  90678. /** Array of sprite names from JSON sprite data file */
  90679. private _spriteMap;
  90680. /** True when packed cell data from JSON file is ready*/
  90681. private _packedAndReady;
  90682. private _textureContent;
  90683. private _useInstancing;
  90684. /**
  90685. * An event triggered when the manager is disposed.
  90686. */
  90687. onDisposeObservable: Observable<SpriteManager>;
  90688. private _onDisposeObserver;
  90689. /**
  90690. * Callback called when the manager is disposed
  90691. */
  90692. set onDispose(callback: () => void);
  90693. private _capacity;
  90694. private _fromPacked;
  90695. private _spriteTexture;
  90696. private _epsilon;
  90697. private _scene;
  90698. private _vertexData;
  90699. private _buffer;
  90700. private _vertexBuffers;
  90701. private _spriteBuffer;
  90702. private _indexBuffer;
  90703. private _effectBase;
  90704. private _effectFog;
  90705. private _vertexBufferSize;
  90706. /**
  90707. * Gets or sets the unique id of the sprite
  90708. */
  90709. uniqueId: number;
  90710. /**
  90711. * Gets the array of sprites
  90712. */
  90713. get children(): Sprite[];
  90714. /**
  90715. * Gets the hosting scene
  90716. */
  90717. get scene(): Scene;
  90718. /**
  90719. * Gets the capacity of the manager
  90720. */
  90721. get capacity(): number;
  90722. /**
  90723. * Gets or sets the spritesheet texture
  90724. */
  90725. get texture(): Texture;
  90726. set texture(value: Texture);
  90727. private _blendMode;
  90728. /**
  90729. * Blend mode use to render the particle, it can be any of
  90730. * the static Constants.ALPHA_x properties provided in this class.
  90731. * Default value is Constants.ALPHA_COMBINE
  90732. */
  90733. get blendMode(): number;
  90734. set blendMode(blendMode: number);
  90735. /** Disables writing to the depth buffer when rendering the sprites.
  90736. * It can be handy to disable depth writing when using textures without alpha channel
  90737. * and setting some specific blend modes.
  90738. */
  90739. disableDepthWrite: boolean;
  90740. /**
  90741. * Creates a new sprite manager
  90742. * @param name defines the manager's name
  90743. * @param imgUrl defines the sprite sheet url
  90744. * @param capacity defines the maximum allowed number of sprites
  90745. * @param cellSize defines the size of a sprite cell
  90746. * @param scene defines the hosting scene
  90747. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  90748. * @param samplingMode defines the smapling mode to use with spritesheet
  90749. * @param fromPacked set to false; do not alter
  90750. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  90751. */
  90752. constructor(
  90753. /** defines the manager's name */
  90754. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  90755. /**
  90756. * Returns the string "SpriteManager"
  90757. * @returns "SpriteManager"
  90758. */
  90759. getClassName(): string;
  90760. private _makePacked;
  90761. private _appendSpriteVertex;
  90762. private _checkTextureAlpha;
  90763. /**
  90764. * Intersects the sprites with a ray
  90765. * @param ray defines the ray to intersect with
  90766. * @param camera defines the current active camera
  90767. * @param predicate defines a predicate used to select candidate sprites
  90768. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  90769. * @returns null if no hit or a PickingInfo
  90770. */
  90771. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90772. /**
  90773. * Intersects the sprites with a ray
  90774. * @param ray defines the ray to intersect with
  90775. * @param camera defines the current active camera
  90776. * @param predicate defines a predicate used to select candidate sprites
  90777. * @returns null if no hit or a PickingInfo array
  90778. */
  90779. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90780. /**
  90781. * Render all child sprites
  90782. */
  90783. render(): void;
  90784. /**
  90785. * Release associated resources
  90786. */
  90787. dispose(): void;
  90788. /**
  90789. * Serializes the sprite manager to a JSON object
  90790. * @param serializeTexture defines if the texture must be serialized as well
  90791. * @returns the JSON object
  90792. */
  90793. serialize(serializeTexture?: boolean): any;
  90794. /**
  90795. * Parses a JSON object to create a new sprite manager.
  90796. * @param parsedManager The JSON object to parse
  90797. * @param scene The scene to create the sprite managerin
  90798. * @param rootUrl The root url to use to load external dependencies like texture
  90799. * @returns the new sprite manager
  90800. */
  90801. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  90802. /**
  90803. * Creates a sprite manager from a snippet saved in a remote file
  90804. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  90805. * @param url defines the url to load from
  90806. * @param scene defines the hosting scene
  90807. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90808. * @returns a promise that will resolve to the new sprite manager
  90809. */
  90810. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90811. /**
  90812. * Creates a sprite manager from a snippet saved by the sprite editor
  90813. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  90814. * @param scene defines the hosting scene
  90815. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90816. * @returns a promise that will resolve to the new sprite manager
  90817. */
  90818. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90819. }
  90820. }
  90821. declare module BABYLON {
  90822. /** Interface used by value gradients (color, factor, ...) */
  90823. export interface IValueGradient {
  90824. /**
  90825. * Gets or sets the gradient value (between 0 and 1)
  90826. */
  90827. gradient: number;
  90828. }
  90829. /** Class used to store color4 gradient */
  90830. export class ColorGradient implements IValueGradient {
  90831. /**
  90832. * Gets or sets the gradient value (between 0 and 1)
  90833. */
  90834. gradient: number;
  90835. /**
  90836. * Gets or sets first associated color
  90837. */
  90838. color1: Color4;
  90839. /**
  90840. * Gets or sets second associated color
  90841. */
  90842. color2?: Color4 | undefined;
  90843. /**
  90844. * Creates a new color4 gradient
  90845. * @param gradient gets or sets the gradient value (between 0 and 1)
  90846. * @param color1 gets or sets first associated color
  90847. * @param color2 gets or sets first second 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 first associated color
  90856. */
  90857. color1: Color4,
  90858. /**
  90859. * Gets or sets second associated color
  90860. */
  90861. color2?: Color4 | undefined);
  90862. /**
  90863. * Will get a color picked randomly between color1 and color2.
  90864. * If color2 is undefined then color1 will be used
  90865. * @param result defines the target Color4 to store the result in
  90866. */
  90867. getColorToRef(result: Color4): void;
  90868. }
  90869. /** Class used to store color 3 gradient */
  90870. export class Color3Gradient implements IValueGradient {
  90871. /**
  90872. * Gets or sets the gradient value (between 0 and 1)
  90873. */
  90874. gradient: number;
  90875. /**
  90876. * Gets or sets the associated color
  90877. */
  90878. color: Color3;
  90879. /**
  90880. * Creates a new color3 gradient
  90881. * @param gradient gets or sets the gradient value (between 0 and 1)
  90882. * @param color gets or sets associated color
  90883. */
  90884. constructor(
  90885. /**
  90886. * Gets or sets the gradient value (between 0 and 1)
  90887. */
  90888. gradient: number,
  90889. /**
  90890. * Gets or sets the associated color
  90891. */
  90892. color: Color3);
  90893. }
  90894. /** Class used to store factor gradient */
  90895. export class FactorGradient implements IValueGradient {
  90896. /**
  90897. * Gets or sets the gradient value (between 0 and 1)
  90898. */
  90899. gradient: number;
  90900. /**
  90901. * Gets or sets first associated factor
  90902. */
  90903. factor1: number;
  90904. /**
  90905. * Gets or sets second associated factor
  90906. */
  90907. factor2?: number | undefined;
  90908. /**
  90909. * Creates a new factor gradient
  90910. * @param gradient gets or sets the gradient value (between 0 and 1)
  90911. * @param factor1 gets or sets first associated factor
  90912. * @param factor2 gets or sets second associated factor
  90913. */
  90914. constructor(
  90915. /**
  90916. * Gets or sets the gradient value (between 0 and 1)
  90917. */
  90918. gradient: number,
  90919. /**
  90920. * Gets or sets first associated factor
  90921. */
  90922. factor1: number,
  90923. /**
  90924. * Gets or sets second associated factor
  90925. */
  90926. factor2?: number | undefined);
  90927. /**
  90928. * Will get a number picked randomly between factor1 and factor2.
  90929. * If factor2 is undefined then factor1 will be used
  90930. * @returns the picked number
  90931. */
  90932. getFactor(): number;
  90933. }
  90934. /**
  90935. * Helper used to simplify some generic gradient tasks
  90936. */
  90937. export class GradientHelper {
  90938. /**
  90939. * Gets the current gradient from an array of IValueGradient
  90940. * @param ratio defines the current ratio to get
  90941. * @param gradients defines the array of IValueGradient
  90942. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  90943. */
  90944. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  90945. }
  90946. }
  90947. declare module BABYLON {
  90948. interface ThinEngine {
  90949. /**
  90950. * Creates a raw texture
  90951. * @param data defines the data to store in the texture
  90952. * @param width defines the width of the texture
  90953. * @param height defines the height of the texture
  90954. * @param format defines the format of the data
  90955. * @param generateMipMaps defines if the engine should generate the mip levels
  90956. * @param invertY defines if data must be stored with Y axis inverted
  90957. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  90958. * @param compression defines the compression used (null by default)
  90959. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90960. * @returns the raw texture inside an InternalTexture
  90961. */
  90962. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  90963. /**
  90964. * Update a raw texture
  90965. * @param texture defines the texture to update
  90966. * @param data defines the data to store in the texture
  90967. * @param format defines the format of the data
  90968. * @param invertY defines if data must be stored with Y axis inverted
  90969. */
  90970. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90971. /**
  90972. * Update a raw texture
  90973. * @param texture defines the texture to update
  90974. * @param data defines the data to store in the texture
  90975. * @param format defines the format of the data
  90976. * @param invertY defines if data must be stored with Y axis inverted
  90977. * @param compression defines the compression used (null by default)
  90978. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90979. */
  90980. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  90981. /**
  90982. * Creates a new raw cube texture
  90983. * @param data defines the array of data to use to create each face
  90984. * @param size defines the size of the textures
  90985. * @param format defines the format of the data
  90986. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90987. * @param generateMipMaps defines if the engine should generate the mip levels
  90988. * @param invertY defines if data must be stored with Y axis inverted
  90989. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90990. * @param compression defines the compression used (null by default)
  90991. * @returns the cube texture as an InternalTexture
  90992. */
  90993. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  90994. /**
  90995. * Update a raw cube texture
  90996. * @param texture defines the texture to udpdate
  90997. * @param data defines the data to store
  90998. * @param format defines the data format
  90999. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91000. * @param invertY defines if data must be stored with Y axis inverted
  91001. */
  91002. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  91003. /**
  91004. * Update a raw cube texture
  91005. * @param texture defines the texture to udpdate
  91006. * @param data defines the data to store
  91007. * @param format defines the data format
  91008. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91009. * @param invertY defines if data must be stored with Y axis inverted
  91010. * @param compression defines the compression used (null by default)
  91011. */
  91012. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  91013. /**
  91014. * Update a raw cube texture
  91015. * @param texture defines the texture to udpdate
  91016. * @param data defines the data to store
  91017. * @param format defines the data format
  91018. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91019. * @param invertY defines if data must be stored with Y axis inverted
  91020. * @param compression defines the compression used (null by default)
  91021. * @param level defines which level of the texture to update
  91022. */
  91023. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  91024. /**
  91025. * Creates a new raw cube texture from a specified url
  91026. * @param url defines the url where the data is located
  91027. * @param scene defines the current scene
  91028. * @param size defines the size of the textures
  91029. * @param format defines the format of the data
  91030. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91031. * @param noMipmap defines if the engine should avoid generating the mip levels
  91032. * @param callback defines a callback used to extract texture data from loaded data
  91033. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91034. * @param onLoad defines a callback called when texture is loaded
  91035. * @param onError defines a callback called if there is an error
  91036. * @returns the cube texture as an InternalTexture
  91037. */
  91038. 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;
  91039. /**
  91040. * Creates a new raw cube texture from a specified url
  91041. * @param url defines the url where the data is located
  91042. * @param scene defines the current scene
  91043. * @param size defines the size of the textures
  91044. * @param format defines the format of the data
  91045. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91046. * @param noMipmap defines if the engine should avoid generating the mip levels
  91047. * @param callback defines a callback used to extract texture data from loaded data
  91048. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91049. * @param onLoad defines a callback called when texture is loaded
  91050. * @param onError defines a callback called if there is an error
  91051. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91052. * @param invertY defines if data must be stored with Y axis inverted
  91053. * @returns the cube texture as an InternalTexture
  91054. */
  91055. 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;
  91056. /**
  91057. * Creates a new raw 3D texture
  91058. * @param data defines the data used to create the texture
  91059. * @param width defines the width of the texture
  91060. * @param height defines the height of the texture
  91061. * @param depth defines the depth of the texture
  91062. * @param format defines the format of the texture
  91063. * @param generateMipMaps defines if the engine must generate mip levels
  91064. * @param invertY defines if data must be stored with Y axis inverted
  91065. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91066. * @param compression defines the compressed used (can be null)
  91067. * @param textureType defines the compressed used (can be null)
  91068. * @returns a new raw 3D texture (stored in an InternalTexture)
  91069. */
  91070. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91071. /**
  91072. * Update a raw 3D texture
  91073. * @param texture defines the texture to update
  91074. * @param data defines the data to store
  91075. * @param format defines the data format
  91076. * @param invertY defines if data must be stored with Y axis inverted
  91077. */
  91078. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91079. /**
  91080. * Update a raw 3D texture
  91081. * @param texture defines the texture to update
  91082. * @param data defines the data to store
  91083. * @param format defines the data format
  91084. * @param invertY defines if data must be stored with Y axis inverted
  91085. * @param compression defines the used compression (can be null)
  91086. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91087. */
  91088. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91089. /**
  91090. * Creates a new raw 2D array texture
  91091. * @param data defines the data used to create the texture
  91092. * @param width defines the width of the texture
  91093. * @param height defines the height of the texture
  91094. * @param depth defines the number of layers of the texture
  91095. * @param format defines the format of the texture
  91096. * @param generateMipMaps defines if the engine must generate mip levels
  91097. * @param invertY defines if data must be stored with Y axis inverted
  91098. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91099. * @param compression defines the compressed used (can be null)
  91100. * @param textureType defines the compressed used (can be null)
  91101. * @returns a new raw 2D array texture (stored in an InternalTexture)
  91102. */
  91103. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91104. /**
  91105. * Update a raw 2D array texture
  91106. * @param texture defines the texture to update
  91107. * @param data defines the data to store
  91108. * @param format defines the data format
  91109. * @param invertY defines if data must be stored with Y axis inverted
  91110. */
  91111. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91112. /**
  91113. * Update a raw 2D array texture
  91114. * @param texture defines the texture to update
  91115. * @param data defines the data to store
  91116. * @param format defines the data format
  91117. * @param invertY defines if data must be stored with Y axis inverted
  91118. * @param compression defines the used compression (can be null)
  91119. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91120. */
  91121. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91122. }
  91123. }
  91124. declare module BABYLON {
  91125. /**
  91126. * Raw texture can help creating a texture directly from an array of data.
  91127. * This can be super useful if you either get the data from an uncompressed source or
  91128. * if you wish to create your texture pixel by pixel.
  91129. */
  91130. export class RawTexture extends Texture {
  91131. /**
  91132. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91133. */
  91134. format: number;
  91135. /**
  91136. * Instantiates a new RawTexture.
  91137. * Raw texture can help creating a texture directly from an array of data.
  91138. * This can be super useful if you either get the data from an uncompressed source or
  91139. * if you wish to create your texture pixel by pixel.
  91140. * @param data define the array of data to use to create the texture
  91141. * @param width define the width of the texture
  91142. * @param height define the height of the texture
  91143. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91144. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91145. * @param generateMipMaps define whether mip maps should be generated or not
  91146. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91147. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91148. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91149. */
  91150. constructor(data: ArrayBufferView, width: number, height: number,
  91151. /**
  91152. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91153. */
  91154. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  91155. /**
  91156. * Updates the texture underlying data.
  91157. * @param data Define the new data of the texture
  91158. */
  91159. update(data: ArrayBufferView): void;
  91160. /**
  91161. * Creates a luminance texture from some data.
  91162. * @param data Define the texture data
  91163. * @param width Define the width of the texture
  91164. * @param height Define the height of the texture
  91165. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91166. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91167. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91168. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91169. * @returns the luminance texture
  91170. */
  91171. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91172. /**
  91173. * Creates a luminance alpha texture from some data.
  91174. * @param data Define the texture data
  91175. * @param width Define the width of the texture
  91176. * @param height Define the height of the texture
  91177. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91178. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91179. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91180. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91181. * @returns the luminance alpha texture
  91182. */
  91183. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91184. /**
  91185. * Creates an alpha texture from some data.
  91186. * @param data Define the texture data
  91187. * @param width Define the width of the texture
  91188. * @param height Define the height of the texture
  91189. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91190. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91191. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91192. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91193. * @returns the alpha texture
  91194. */
  91195. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91196. /**
  91197. * Creates a RGB texture from some data.
  91198. * @param data Define the texture data
  91199. * @param width Define the width of the texture
  91200. * @param height Define the height of the texture
  91201. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91202. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91203. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91204. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91205. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91206. * @returns the RGB alpha texture
  91207. */
  91208. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91209. /**
  91210. * Creates a RGBA texture from some data.
  91211. * @param data Define the texture data
  91212. * @param width Define the width of the texture
  91213. * @param height Define the height of the texture
  91214. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91215. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91216. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91217. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91218. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91219. * @returns the RGBA texture
  91220. */
  91221. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91222. /**
  91223. * Creates a R texture from some data.
  91224. * @param data Define the texture data
  91225. * @param width Define the width of the texture
  91226. * @param height Define the height of the texture
  91227. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91228. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91229. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91230. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91231. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91232. * @returns the R texture
  91233. */
  91234. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91235. }
  91236. }
  91237. declare module BABYLON {
  91238. interface ThinEngine {
  91239. /**
  91240. * Update a dynamic index buffer
  91241. * @param indexBuffer defines the target index buffer
  91242. * @param indices defines the data to update
  91243. * @param offset defines the offset in the target index buffer where update should start
  91244. */
  91245. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  91246. /**
  91247. * Updates a dynamic vertex buffer.
  91248. * @param vertexBuffer the vertex buffer to update
  91249. * @param data the data used to update the vertex buffer
  91250. * @param byteOffset the byte offset of the data
  91251. * @param byteLength the byte length of the data
  91252. */
  91253. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  91254. }
  91255. }
  91256. declare module BABYLON {
  91257. interface AbstractScene {
  91258. /**
  91259. * The list of procedural textures added to the scene
  91260. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91261. */
  91262. proceduralTextures: Array<ProceduralTexture>;
  91263. }
  91264. /**
  91265. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  91266. * in a given scene.
  91267. */
  91268. export class ProceduralTextureSceneComponent implements ISceneComponent {
  91269. /**
  91270. * The component name helpfull to identify the component in the list of scene components.
  91271. */
  91272. readonly name: string;
  91273. /**
  91274. * The scene the component belongs to.
  91275. */
  91276. scene: Scene;
  91277. /**
  91278. * Creates a new instance of the component for the given scene
  91279. * @param scene Defines the scene to register the component in
  91280. */
  91281. constructor(scene: Scene);
  91282. /**
  91283. * Registers the component in a given scene
  91284. */
  91285. register(): void;
  91286. /**
  91287. * Rebuilds the elements related to this component in case of
  91288. * context lost for instance.
  91289. */
  91290. rebuild(): void;
  91291. /**
  91292. * Disposes the component and the associated ressources.
  91293. */
  91294. dispose(): void;
  91295. private _beforeClear;
  91296. }
  91297. }
  91298. declare module BABYLON {
  91299. interface ThinEngine {
  91300. /**
  91301. * Creates a new render target cube texture
  91302. * @param size defines the size of the texture
  91303. * @param options defines the options used to create the texture
  91304. * @returns a new render target cube texture stored in an InternalTexture
  91305. */
  91306. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  91307. }
  91308. }
  91309. declare module BABYLON {
  91310. /** @hidden */
  91311. export var proceduralVertexShader: {
  91312. name: string;
  91313. shader: string;
  91314. };
  91315. }
  91316. declare module BABYLON {
  91317. /**
  91318. * 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.
  91319. * This is the base class of any Procedural texture and contains most of the shareable code.
  91320. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91321. */
  91322. export class ProceduralTexture extends Texture {
  91323. /**
  91324. * Define if the texture is enabled or not (disabled texture will not render)
  91325. */
  91326. isEnabled: boolean;
  91327. /**
  91328. * Define if the texture must be cleared before rendering (default is true)
  91329. */
  91330. autoClear: boolean;
  91331. /**
  91332. * Callback called when the texture is generated
  91333. */
  91334. onGenerated: () => void;
  91335. /**
  91336. * Event raised when the texture is generated
  91337. */
  91338. onGeneratedObservable: Observable<ProceduralTexture>;
  91339. /** @hidden */
  91340. _generateMipMaps: boolean;
  91341. /** @hidden **/
  91342. _effect: Effect;
  91343. /** @hidden */
  91344. _textures: {
  91345. [key: string]: Texture;
  91346. };
  91347. /** @hidden */
  91348. protected _fallbackTexture: Nullable<Texture>;
  91349. private _size;
  91350. private _currentRefreshId;
  91351. private _frameId;
  91352. private _refreshRate;
  91353. private _vertexBuffers;
  91354. private _indexBuffer;
  91355. private _uniforms;
  91356. private _samplers;
  91357. private _fragment;
  91358. private _floats;
  91359. private _ints;
  91360. private _floatsArrays;
  91361. private _colors3;
  91362. private _colors4;
  91363. private _vectors2;
  91364. private _vectors3;
  91365. private _matrices;
  91366. private _fallbackTextureUsed;
  91367. private _fullEngine;
  91368. private _cachedDefines;
  91369. private _contentUpdateId;
  91370. private _contentData;
  91371. /**
  91372. * Instantiates a new procedural texture.
  91373. * 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.
  91374. * This is the base class of any Procedural texture and contains most of the shareable code.
  91375. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91376. * @param name Define the name of the texture
  91377. * @param size Define the size of the texture to create
  91378. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  91379. * @param scene Define the scene the texture belongs to
  91380. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  91381. * @param generateMipMaps Define if the texture should creates mip maps or not
  91382. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  91383. */
  91384. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  91385. /**
  91386. * The effect that is created when initializing the post process.
  91387. * @returns The created effect corresponding the the postprocess.
  91388. */
  91389. getEffect(): Effect;
  91390. /**
  91391. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  91392. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  91393. */
  91394. getContent(): Nullable<ArrayBufferView>;
  91395. private _createIndexBuffer;
  91396. /** @hidden */
  91397. _rebuild(): void;
  91398. /**
  91399. * Resets the texture in order to recreate its associated resources.
  91400. * This can be called in case of context loss
  91401. */
  91402. reset(): void;
  91403. protected _getDefines(): string;
  91404. /**
  91405. * Is the texture ready to be used ? (rendered at least once)
  91406. * @returns true if ready, otherwise, false.
  91407. */
  91408. isReady(): boolean;
  91409. /**
  91410. * Resets the refresh counter of the texture and start bak from scratch.
  91411. * Could be useful to regenerate the texture if it is setup to render only once.
  91412. */
  91413. resetRefreshCounter(): void;
  91414. /**
  91415. * Set the fragment shader to use in order to render the texture.
  91416. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  91417. */
  91418. setFragment(fragment: any): void;
  91419. /**
  91420. * Define the refresh rate of the texture or the rendering frequency.
  91421. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  91422. */
  91423. get refreshRate(): number;
  91424. set refreshRate(value: number);
  91425. /** @hidden */
  91426. _shouldRender(): boolean;
  91427. /**
  91428. * Get the size the texture is rendering at.
  91429. * @returns the size (texture is always squared)
  91430. */
  91431. getRenderSize(): number;
  91432. /**
  91433. * Resize the texture to new value.
  91434. * @param size Define the new size the texture should have
  91435. * @param generateMipMaps Define whether the new texture should create mip maps
  91436. */
  91437. resize(size: number, generateMipMaps: boolean): void;
  91438. private _checkUniform;
  91439. /**
  91440. * Set a texture in the shader program used to render.
  91441. * @param name Define the name of the uniform samplers as defined in the shader
  91442. * @param texture Define the texture to bind to this sampler
  91443. * @return the texture itself allowing "fluent" like uniform updates
  91444. */
  91445. setTexture(name: string, texture: Texture): ProceduralTexture;
  91446. /**
  91447. * Set a float in the shader.
  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. setFloat(name: string, value: number): ProceduralTexture;
  91453. /**
  91454. * Set a int in the shader.
  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. setInt(name: string, value: number): ProceduralTexture;
  91460. /**
  91461. * Set an array of floats in the shader.
  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. setFloats(name: string, value: number[]): ProceduralTexture;
  91467. /**
  91468. * Set a vec3 in the shader from a Color3.
  91469. * @param name Define the name of the uniform as defined in the shader
  91470. * @param value Define the value to give to the uniform
  91471. * @return the texture itself allowing "fluent" like uniform updates
  91472. */
  91473. setColor3(name: string, value: Color3): ProceduralTexture;
  91474. /**
  91475. * Set a vec4 in the shader from a Color4.
  91476. * @param name Define the name of the uniform as defined in the shader
  91477. * @param value Define the value to give to the uniform
  91478. * @return the texture itself allowing "fluent" like uniform updates
  91479. */
  91480. setColor4(name: string, value: Color4): ProceduralTexture;
  91481. /**
  91482. * Set a vec2 in the shader from a Vector2.
  91483. * @param name Define the name of the uniform as defined in the shader
  91484. * @param value Define the value to give to the uniform
  91485. * @return the texture itself allowing "fluent" like uniform updates
  91486. */
  91487. setVector2(name: string, value: Vector2): ProceduralTexture;
  91488. /**
  91489. * Set a vec3 in the shader from a Vector3.
  91490. * @param name Define the name of the uniform as defined in the shader
  91491. * @param value Define the value to give to the uniform
  91492. * @return the texture itself allowing "fluent" like uniform updates
  91493. */
  91494. setVector3(name: string, value: Vector3): ProceduralTexture;
  91495. /**
  91496. * Set a mat4 in the shader from a MAtrix.
  91497. * @param name Define the name of the uniform as defined in the shader
  91498. * @param value Define the value to give to the uniform
  91499. * @return the texture itself allowing "fluent" like uniform updates
  91500. */
  91501. setMatrix(name: string, value: Matrix): ProceduralTexture;
  91502. /**
  91503. * Render the texture to its associated render target.
  91504. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  91505. */
  91506. render(useCameraPostProcess?: boolean): void;
  91507. /**
  91508. * Clone the texture.
  91509. * @returns the cloned texture
  91510. */
  91511. clone(): ProceduralTexture;
  91512. /**
  91513. * Dispose the texture and release its asoociated resources.
  91514. */
  91515. dispose(): void;
  91516. }
  91517. }
  91518. declare module BABYLON {
  91519. /**
  91520. * This represents the base class for particle system in Babylon.
  91521. * 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.
  91522. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91523. * @example https://doc.babylonjs.com/babylon101/particles
  91524. */
  91525. export class BaseParticleSystem {
  91526. /**
  91527. * Source color is added to the destination color without alpha affecting the result
  91528. */
  91529. static BLENDMODE_ONEONE: number;
  91530. /**
  91531. * Blend current color and particle color using particle’s alpha
  91532. */
  91533. static BLENDMODE_STANDARD: number;
  91534. /**
  91535. * Add current color and particle color multiplied by particle’s alpha
  91536. */
  91537. static BLENDMODE_ADD: number;
  91538. /**
  91539. * Multiply current color with particle color
  91540. */
  91541. static BLENDMODE_MULTIPLY: number;
  91542. /**
  91543. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  91544. */
  91545. static BLENDMODE_MULTIPLYADD: number;
  91546. /**
  91547. * List of animations used by the particle system.
  91548. */
  91549. animations: Animation[];
  91550. /**
  91551. * Gets or sets the unique id of the particle system
  91552. */
  91553. uniqueId: number;
  91554. /**
  91555. * The id of the Particle system.
  91556. */
  91557. id: string;
  91558. /**
  91559. * The friendly name of the Particle system.
  91560. */
  91561. name: string;
  91562. /**
  91563. * Snippet ID if the particle system was created from the snippet server
  91564. */
  91565. snippetId: string;
  91566. /**
  91567. * The rendering group used by the Particle system to chose when to render.
  91568. */
  91569. renderingGroupId: number;
  91570. /**
  91571. * The emitter represents the Mesh or position we are attaching the particle system to.
  91572. */
  91573. emitter: Nullable<AbstractMesh | Vector3>;
  91574. /**
  91575. * The maximum number of particles to emit per frame
  91576. */
  91577. emitRate: number;
  91578. /**
  91579. * If you want to launch only a few particles at once, that can be done, as well.
  91580. */
  91581. manualEmitCount: number;
  91582. /**
  91583. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  91584. */
  91585. updateSpeed: number;
  91586. /**
  91587. * The amount of time the particle system is running (depends of the overall update speed).
  91588. */
  91589. targetStopDuration: number;
  91590. /**
  91591. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  91592. */
  91593. disposeOnStop: boolean;
  91594. /**
  91595. * Minimum power of emitting particles.
  91596. */
  91597. minEmitPower: number;
  91598. /**
  91599. * Maximum power of emitting particles.
  91600. */
  91601. maxEmitPower: number;
  91602. /**
  91603. * Minimum life time of emitting particles.
  91604. */
  91605. minLifeTime: number;
  91606. /**
  91607. * Maximum life time of emitting particles.
  91608. */
  91609. maxLifeTime: number;
  91610. /**
  91611. * Minimum Size of emitting particles.
  91612. */
  91613. minSize: number;
  91614. /**
  91615. * Maximum Size of emitting particles.
  91616. */
  91617. maxSize: number;
  91618. /**
  91619. * Minimum scale of emitting particles on X axis.
  91620. */
  91621. minScaleX: number;
  91622. /**
  91623. * Maximum scale of emitting particles on X axis.
  91624. */
  91625. maxScaleX: number;
  91626. /**
  91627. * Minimum scale of emitting particles on Y axis.
  91628. */
  91629. minScaleY: number;
  91630. /**
  91631. * Maximum scale of emitting particles on Y axis.
  91632. */
  91633. maxScaleY: number;
  91634. /**
  91635. * Gets or sets the minimal initial rotation in radians.
  91636. */
  91637. minInitialRotation: number;
  91638. /**
  91639. * Gets or sets the maximal initial rotation in radians.
  91640. */
  91641. maxInitialRotation: number;
  91642. /**
  91643. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  91644. */
  91645. minAngularSpeed: number;
  91646. /**
  91647. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  91648. */
  91649. maxAngularSpeed: number;
  91650. /**
  91651. * The texture used to render each particle. (this can be a spritesheet)
  91652. */
  91653. particleTexture: Nullable<BaseTexture>;
  91654. /**
  91655. * The layer mask we are rendering the particles through.
  91656. */
  91657. layerMask: number;
  91658. /**
  91659. * This can help using your own shader to render the particle system.
  91660. * The according effect will be created
  91661. */
  91662. customShader: any;
  91663. /**
  91664. * By default particle system starts as soon as they are created. This prevents the
  91665. * automatic start to happen and let you decide when to start emitting particles.
  91666. */
  91667. preventAutoStart: boolean;
  91668. private _noiseTexture;
  91669. /**
  91670. * Gets or sets a texture used to add random noise to particle positions
  91671. */
  91672. get noiseTexture(): Nullable<ProceduralTexture>;
  91673. set noiseTexture(value: Nullable<ProceduralTexture>);
  91674. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  91675. noiseStrength: Vector3;
  91676. /**
  91677. * Callback triggered when the particle animation is ending.
  91678. */
  91679. onAnimationEnd: Nullable<() => void>;
  91680. /**
  91681. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  91682. */
  91683. blendMode: number;
  91684. /**
  91685. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  91686. * to override the particles.
  91687. */
  91688. forceDepthWrite: boolean;
  91689. /** 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 */
  91690. preWarmCycles: number;
  91691. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  91692. preWarmStepOffset: number;
  91693. /**
  91694. * 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)
  91695. */
  91696. spriteCellChangeSpeed: number;
  91697. /**
  91698. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  91699. */
  91700. startSpriteCellID: number;
  91701. /**
  91702. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  91703. */
  91704. endSpriteCellID: number;
  91705. /**
  91706. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  91707. */
  91708. spriteCellWidth: number;
  91709. /**
  91710. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  91711. */
  91712. spriteCellHeight: number;
  91713. /**
  91714. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  91715. */
  91716. spriteRandomStartCell: boolean;
  91717. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  91718. translationPivot: Vector2;
  91719. /** @hidden */
  91720. protected _isAnimationSheetEnabled: boolean;
  91721. /**
  91722. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  91723. */
  91724. beginAnimationOnStart: boolean;
  91725. /**
  91726. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  91727. */
  91728. beginAnimationFrom: number;
  91729. /**
  91730. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  91731. */
  91732. beginAnimationTo: number;
  91733. /**
  91734. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  91735. */
  91736. beginAnimationLoop: boolean;
  91737. /**
  91738. * Gets or sets a world offset applied to all particles
  91739. */
  91740. worldOffset: Vector3;
  91741. /**
  91742. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  91743. */
  91744. get isAnimationSheetEnabled(): boolean;
  91745. set isAnimationSheetEnabled(value: boolean);
  91746. /**
  91747. * Get hosting scene
  91748. * @returns the scene
  91749. */
  91750. getScene(): Nullable<Scene>;
  91751. /**
  91752. * You can use gravity if you want to give an orientation to your particles.
  91753. */
  91754. gravity: Vector3;
  91755. protected _colorGradients: Nullable<Array<ColorGradient>>;
  91756. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  91757. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  91758. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  91759. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  91760. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  91761. protected _dragGradients: Nullable<Array<FactorGradient>>;
  91762. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  91763. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  91764. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  91765. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  91766. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  91767. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  91768. /**
  91769. * Defines the delay in milliseconds before starting the system (0 by default)
  91770. */
  91771. startDelay: number;
  91772. /**
  91773. * Gets the current list of drag gradients.
  91774. * You must use addDragGradient and removeDragGradient to udpate this list
  91775. * @returns the list of drag gradients
  91776. */
  91777. getDragGradients(): Nullable<Array<FactorGradient>>;
  91778. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  91779. limitVelocityDamping: number;
  91780. /**
  91781. * Gets the current list of limit velocity gradients.
  91782. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  91783. * @returns the list of limit velocity gradients
  91784. */
  91785. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  91786. /**
  91787. * Gets the current list of color gradients.
  91788. * You must use addColorGradient and removeColorGradient to udpate this list
  91789. * @returns the list of color gradients
  91790. */
  91791. getColorGradients(): Nullable<Array<ColorGradient>>;
  91792. /**
  91793. * Gets the current list of size gradients.
  91794. * You must use addSizeGradient and removeSizeGradient to udpate this list
  91795. * @returns the list of size gradients
  91796. */
  91797. getSizeGradients(): Nullable<Array<FactorGradient>>;
  91798. /**
  91799. * Gets the current list of color remap gradients.
  91800. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  91801. * @returns the list of color remap gradients
  91802. */
  91803. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  91804. /**
  91805. * Gets the current list of alpha remap gradients.
  91806. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  91807. * @returns the list of alpha remap gradients
  91808. */
  91809. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  91810. /**
  91811. * Gets the current list of life time gradients.
  91812. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  91813. * @returns the list of life time gradients
  91814. */
  91815. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  91816. /**
  91817. * Gets the current list of angular speed gradients.
  91818. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  91819. * @returns the list of angular speed gradients
  91820. */
  91821. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  91822. /**
  91823. * Gets the current list of velocity gradients.
  91824. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  91825. * @returns the list of velocity gradients
  91826. */
  91827. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  91828. /**
  91829. * Gets the current list of start size gradients.
  91830. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  91831. * @returns the list of start size gradients
  91832. */
  91833. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  91834. /**
  91835. * Gets the current list of emit rate gradients.
  91836. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  91837. * @returns the list of emit rate gradients
  91838. */
  91839. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  91840. /**
  91841. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91842. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91843. */
  91844. get direction1(): Vector3;
  91845. set direction1(value: Vector3);
  91846. /**
  91847. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91848. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91849. */
  91850. get direction2(): Vector3;
  91851. set direction2(value: Vector3);
  91852. /**
  91853. * 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.
  91854. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91855. */
  91856. get minEmitBox(): Vector3;
  91857. set minEmitBox(value: Vector3);
  91858. /**
  91859. * 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.
  91860. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91861. */
  91862. get maxEmitBox(): Vector3;
  91863. set maxEmitBox(value: Vector3);
  91864. /**
  91865. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91866. */
  91867. color1: Color4;
  91868. /**
  91869. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91870. */
  91871. color2: Color4;
  91872. /**
  91873. * Color the particle will have at the end of its lifetime
  91874. */
  91875. colorDead: Color4;
  91876. /**
  91877. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  91878. */
  91879. textureMask: Color4;
  91880. /**
  91881. * The particle emitter type defines the emitter used by the particle system.
  91882. * It can be for example box, sphere, or cone...
  91883. */
  91884. particleEmitterType: IParticleEmitterType;
  91885. /** @hidden */
  91886. _isSubEmitter: boolean;
  91887. /**
  91888. * Gets or sets the billboard mode to use when isBillboardBased = true.
  91889. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  91890. */
  91891. billboardMode: number;
  91892. protected _isBillboardBased: boolean;
  91893. /**
  91894. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  91895. */
  91896. get isBillboardBased(): boolean;
  91897. set isBillboardBased(value: boolean);
  91898. /**
  91899. * The scene the particle system belongs to.
  91900. */
  91901. protected _scene: Nullable<Scene>;
  91902. /**
  91903. * The engine the particle system belongs to.
  91904. */
  91905. protected _engine: ThinEngine;
  91906. /**
  91907. * Local cache of defines for image processing.
  91908. */
  91909. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  91910. /**
  91911. * Default configuration related to image processing available in the standard Material.
  91912. */
  91913. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  91914. /**
  91915. * Gets the image processing configuration used either in this material.
  91916. */
  91917. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  91918. /**
  91919. * Sets the Default image processing configuration used either in the this material.
  91920. *
  91921. * If sets to null, the scene one is in use.
  91922. */
  91923. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  91924. /**
  91925. * Attaches a new image processing configuration to the Standard Material.
  91926. * @param configuration
  91927. */
  91928. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  91929. /** @hidden */
  91930. protected _reset(): void;
  91931. /** @hidden */
  91932. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  91933. /**
  91934. * Instantiates a particle system.
  91935. * 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.
  91936. * @param name The name of the particle system
  91937. */
  91938. constructor(name: string);
  91939. /**
  91940. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  91941. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91942. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91943. * @returns the emitter
  91944. */
  91945. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  91946. /**
  91947. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  91948. * @param radius The radius of the hemisphere to emit from
  91949. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91950. * @returns the emitter
  91951. */
  91952. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  91953. /**
  91954. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  91955. * @param radius The radius of the sphere to emit from
  91956. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91957. * @returns the emitter
  91958. */
  91959. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  91960. /**
  91961. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  91962. * @param radius The radius of the sphere to emit from
  91963. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  91964. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  91965. * @returns the emitter
  91966. */
  91967. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  91968. /**
  91969. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  91970. * @param radius The radius of the emission cylinder
  91971. * @param height The height of the emission cylinder
  91972. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  91973. * @param directionRandomizer How much to randomize the particle direction [0-1]
  91974. * @returns the emitter
  91975. */
  91976. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  91977. /**
  91978. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  91979. * @param radius The radius of the cylinder to emit from
  91980. * @param height The height of the emission cylinder
  91981. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91982. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  91983. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  91984. * @returns the emitter
  91985. */
  91986. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  91987. /**
  91988. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  91989. * @param radius The radius of the cone to emit from
  91990. * @param angle The base angle of the cone
  91991. * @returns the emitter
  91992. */
  91993. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  91994. /**
  91995. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  91996. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91997. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91998. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91999. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92000. * @returns the emitter
  92001. */
  92002. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  92003. }
  92004. }
  92005. declare module BABYLON {
  92006. /**
  92007. * Type of sub emitter
  92008. */
  92009. export enum SubEmitterType {
  92010. /**
  92011. * Attached to the particle over it's lifetime
  92012. */
  92013. ATTACHED = 0,
  92014. /**
  92015. * Created when the particle dies
  92016. */
  92017. END = 1
  92018. }
  92019. /**
  92020. * Sub emitter class used to emit particles from an existing particle
  92021. */
  92022. export class SubEmitter {
  92023. /**
  92024. * the particle system to be used by the sub emitter
  92025. */
  92026. particleSystem: ParticleSystem;
  92027. /**
  92028. * Type of the submitter (Default: END)
  92029. */
  92030. type: SubEmitterType;
  92031. /**
  92032. * 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)
  92033. * Note: This only is supported when using an emitter of type Mesh
  92034. */
  92035. inheritDirection: boolean;
  92036. /**
  92037. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  92038. */
  92039. inheritedVelocityAmount: number;
  92040. /**
  92041. * Creates a sub emitter
  92042. * @param particleSystem the particle system to be used by the sub emitter
  92043. */
  92044. constructor(
  92045. /**
  92046. * the particle system to be used by the sub emitter
  92047. */
  92048. particleSystem: ParticleSystem);
  92049. /**
  92050. * Clones the sub emitter
  92051. * @returns the cloned sub emitter
  92052. */
  92053. clone(): SubEmitter;
  92054. /**
  92055. * Serialize current object to a JSON object
  92056. * @returns the serialized object
  92057. */
  92058. serialize(): any;
  92059. /** @hidden */
  92060. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  92061. /**
  92062. * Creates a new SubEmitter from a serialized JSON version
  92063. * @param serializationObject defines the JSON object to read from
  92064. * @param sceneOrEngine defines the hosting scene or the hosting engine
  92065. * @param rootUrl defines the rootUrl for data loading
  92066. * @returns a new SubEmitter
  92067. */
  92068. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  92069. /** Release associated resources */
  92070. dispose(): void;
  92071. }
  92072. }
  92073. declare module BABYLON {
  92074. /** @hidden */
  92075. export var imageProcessingDeclaration: {
  92076. name: string;
  92077. shader: string;
  92078. };
  92079. }
  92080. declare module BABYLON {
  92081. /** @hidden */
  92082. export var imageProcessingFunctions: {
  92083. name: string;
  92084. shader: string;
  92085. };
  92086. }
  92087. declare module BABYLON {
  92088. /** @hidden */
  92089. export var particlesPixelShader: {
  92090. name: string;
  92091. shader: string;
  92092. };
  92093. }
  92094. declare module BABYLON {
  92095. /** @hidden */
  92096. export var particlesVertexShader: {
  92097. name: string;
  92098. shader: string;
  92099. };
  92100. }
  92101. declare module BABYLON {
  92102. /**
  92103. * Interface used to define entities containing multiple clip planes
  92104. */
  92105. export interface IClipPlanesHolder {
  92106. /**
  92107. * Gets or sets the active clipplane 1
  92108. */
  92109. clipPlane: Nullable<Plane>;
  92110. /**
  92111. * Gets or sets the active clipplane 2
  92112. */
  92113. clipPlane2: Nullable<Plane>;
  92114. /**
  92115. * Gets or sets the active clipplane 3
  92116. */
  92117. clipPlane3: Nullable<Plane>;
  92118. /**
  92119. * Gets or sets the active clipplane 4
  92120. */
  92121. clipPlane4: Nullable<Plane>;
  92122. /**
  92123. * Gets or sets the active clipplane 5
  92124. */
  92125. clipPlane5: Nullable<Plane>;
  92126. /**
  92127. * Gets or sets the active clipplane 6
  92128. */
  92129. clipPlane6: Nullable<Plane>;
  92130. }
  92131. }
  92132. declare module BABYLON {
  92133. /**
  92134. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  92135. *
  92136. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  92137. *
  92138. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  92139. */
  92140. export class ThinMaterialHelper {
  92141. /**
  92142. * Binds the clip plane information from the holder to the effect.
  92143. * @param effect The effect we are binding the data to
  92144. * @param holder The entity containing the clip plane information
  92145. */
  92146. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  92147. }
  92148. }
  92149. declare module BABYLON {
  92150. interface ThinEngine {
  92151. /**
  92152. * Sets alpha constants used by some alpha blending modes
  92153. * @param r defines the red component
  92154. * @param g defines the green component
  92155. * @param b defines the blue component
  92156. * @param a defines the alpha component
  92157. */
  92158. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  92159. /**
  92160. * Sets the current alpha mode
  92161. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  92162. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  92163. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92164. */
  92165. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  92166. /**
  92167. * Gets the current alpha mode
  92168. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92169. * @returns the current alpha mode
  92170. */
  92171. getAlphaMode(): number;
  92172. /**
  92173. * Sets the current alpha equation
  92174. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  92175. */
  92176. setAlphaEquation(equation: number): void;
  92177. /**
  92178. * Gets the current alpha equation.
  92179. * @returns the current alpha equation
  92180. */
  92181. getAlphaEquation(): number;
  92182. }
  92183. }
  92184. declare module BABYLON {
  92185. /**
  92186. * This represents a particle system in Babylon.
  92187. * 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.
  92188. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92189. * @example https://doc.babylonjs.com/babylon101/particles
  92190. */
  92191. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  92192. /**
  92193. * Billboard mode will only apply to Y axis
  92194. */
  92195. static readonly BILLBOARDMODE_Y: number;
  92196. /**
  92197. * Billboard mode will apply to all axes
  92198. */
  92199. static readonly BILLBOARDMODE_ALL: number;
  92200. /**
  92201. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  92202. */
  92203. static readonly BILLBOARDMODE_STRETCHED: number;
  92204. /**
  92205. * This function can be defined to provide custom update for active particles.
  92206. * This function will be called instead of regular update (age, position, color, etc.).
  92207. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  92208. */
  92209. updateFunction: (particles: Particle[]) => void;
  92210. private _emitterWorldMatrix;
  92211. /**
  92212. * This function can be defined to specify initial direction for every new particle.
  92213. * It by default use the emitterType defined function
  92214. */
  92215. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92216. /**
  92217. * This function can be defined to specify initial position for every new particle.
  92218. * It by default use the emitterType defined function
  92219. */
  92220. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92221. /**
  92222. * @hidden
  92223. */
  92224. _inheritedVelocityOffset: Vector3;
  92225. /**
  92226. * An event triggered when the system is disposed
  92227. */
  92228. onDisposeObservable: Observable<IParticleSystem>;
  92229. private _onDisposeObserver;
  92230. /**
  92231. * Sets a callback that will be triggered when the system is disposed
  92232. */
  92233. set onDispose(callback: () => void);
  92234. private _particles;
  92235. private _epsilon;
  92236. private _capacity;
  92237. private _stockParticles;
  92238. private _newPartsExcess;
  92239. private _vertexData;
  92240. private _vertexBuffer;
  92241. private _vertexBuffers;
  92242. private _spriteBuffer;
  92243. private _indexBuffer;
  92244. private _effect;
  92245. private _customEffect;
  92246. private _cachedDefines;
  92247. private _scaledColorStep;
  92248. private _colorDiff;
  92249. private _scaledDirection;
  92250. private _scaledGravity;
  92251. private _currentRenderId;
  92252. private _alive;
  92253. private _useInstancing;
  92254. private _started;
  92255. private _stopped;
  92256. private _actualFrame;
  92257. private _scaledUpdateSpeed;
  92258. private _vertexBufferSize;
  92259. /** @hidden */
  92260. _currentEmitRateGradient: Nullable<FactorGradient>;
  92261. /** @hidden */
  92262. _currentEmitRate1: number;
  92263. /** @hidden */
  92264. _currentEmitRate2: number;
  92265. /** @hidden */
  92266. _currentStartSizeGradient: Nullable<FactorGradient>;
  92267. /** @hidden */
  92268. _currentStartSize1: number;
  92269. /** @hidden */
  92270. _currentStartSize2: number;
  92271. private readonly _rawTextureWidth;
  92272. private _rampGradientsTexture;
  92273. private _useRampGradients;
  92274. /** Gets or sets a matrix to use to compute projection */
  92275. defaultProjectionMatrix: Matrix;
  92276. /** Gets or sets a matrix to use to compute view */
  92277. defaultViewMatrix: Matrix;
  92278. /** Gets or sets a boolean indicating that ramp gradients must be used
  92279. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92280. */
  92281. get useRampGradients(): boolean;
  92282. set useRampGradients(value: boolean);
  92283. /**
  92284. * 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.
  92285. * 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: [])
  92286. */
  92287. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  92288. private _subEmitters;
  92289. /**
  92290. * @hidden
  92291. * If the particle systems emitter should be disposed when the particle system is disposed
  92292. */
  92293. _disposeEmitterOnDispose: boolean;
  92294. /**
  92295. * The current active Sub-systems, this property is used by the root particle system only.
  92296. */
  92297. activeSubSystems: Array<ParticleSystem>;
  92298. /**
  92299. * Specifies if the particles are updated in emitter local space or world space
  92300. */
  92301. isLocal: boolean;
  92302. private _rootParticleSystem;
  92303. /**
  92304. * Gets the current list of active particles
  92305. */
  92306. get particles(): Particle[];
  92307. /**
  92308. * Gets the number of particles active at the same time.
  92309. * @returns The number of active particles.
  92310. */
  92311. getActiveCount(): number;
  92312. /**
  92313. * Returns the string "ParticleSystem"
  92314. * @returns a string containing the class name
  92315. */
  92316. getClassName(): string;
  92317. /**
  92318. * Gets a boolean indicating that the system is stopping
  92319. * @returns true if the system is currently stopping
  92320. */
  92321. isStopping(): boolean;
  92322. /**
  92323. * Gets the custom effect used to render the particles
  92324. * @param blendMode Blend mode for which the effect should be retrieved
  92325. * @returns The effect
  92326. */
  92327. getCustomEffect(blendMode?: number): Nullable<Effect>;
  92328. /**
  92329. * Sets the custom effect used to render the particles
  92330. * @param effect The effect to set
  92331. * @param blendMode Blend mode for which the effect should be set
  92332. */
  92333. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  92334. /** @hidden */
  92335. private _onBeforeDrawParticlesObservable;
  92336. /**
  92337. * Observable that will be called just before the particles are drawn
  92338. */
  92339. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  92340. /**
  92341. * Gets the name of the particle vertex shader
  92342. */
  92343. get vertexShaderName(): string;
  92344. /**
  92345. * Instantiates a particle system.
  92346. * 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.
  92347. * @param name The name of the particle system
  92348. * @param capacity The max number of particles alive at the same time
  92349. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  92350. * @param customEffect a custom effect used to change the way particles are rendered by default
  92351. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  92352. * @param epsilon Offset used to render the particles
  92353. */
  92354. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  92355. private _addFactorGradient;
  92356. private _removeFactorGradient;
  92357. /**
  92358. * Adds a new life time gradient
  92359. * @param gradient defines the gradient to use (between 0 and 1)
  92360. * @param factor defines the life time factor to affect to the specified gradient
  92361. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92362. * @returns the current particle system
  92363. */
  92364. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92365. /**
  92366. * Remove a specific life time gradient
  92367. * @param gradient defines the gradient to remove
  92368. * @returns the current particle system
  92369. */
  92370. removeLifeTimeGradient(gradient: number): IParticleSystem;
  92371. /**
  92372. * Adds a new size gradient
  92373. * @param gradient defines the gradient to use (between 0 and 1)
  92374. * @param factor defines the size factor to affect to the specified gradient
  92375. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92376. * @returns the current particle system
  92377. */
  92378. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92379. /**
  92380. * Remove a specific size gradient
  92381. * @param gradient defines the gradient to remove
  92382. * @returns the current particle system
  92383. */
  92384. removeSizeGradient(gradient: number): IParticleSystem;
  92385. /**
  92386. * Adds a new color remap gradient
  92387. * @param gradient defines the gradient to use (between 0 and 1)
  92388. * @param min defines the color remap minimal range
  92389. * @param max defines the color remap maximal range
  92390. * @returns the current particle system
  92391. */
  92392. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92393. /**
  92394. * Remove a specific color remap gradient
  92395. * @param gradient defines the gradient to remove
  92396. * @returns the current particle system
  92397. */
  92398. removeColorRemapGradient(gradient: number): IParticleSystem;
  92399. /**
  92400. * Adds a new alpha remap gradient
  92401. * @param gradient defines the gradient to use (between 0 and 1)
  92402. * @param min defines the alpha remap minimal range
  92403. * @param max defines the alpha remap maximal range
  92404. * @returns the current particle system
  92405. */
  92406. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92407. /**
  92408. * Remove a specific alpha remap gradient
  92409. * @param gradient defines the gradient to remove
  92410. * @returns the current particle system
  92411. */
  92412. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  92413. /**
  92414. * Adds a new angular speed gradient
  92415. * @param gradient defines the gradient to use (between 0 and 1)
  92416. * @param factor defines the angular speed to affect to the specified gradient
  92417. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92418. * @returns the current particle system
  92419. */
  92420. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92421. /**
  92422. * Remove a specific angular speed gradient
  92423. * @param gradient defines the gradient to remove
  92424. * @returns the current particle system
  92425. */
  92426. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  92427. /**
  92428. * Adds a new velocity gradient
  92429. * @param gradient defines the gradient to use (between 0 and 1)
  92430. * @param factor defines the velocity to affect to the specified gradient
  92431. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92432. * @returns the current particle system
  92433. */
  92434. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92435. /**
  92436. * Remove a specific velocity gradient
  92437. * @param gradient defines the gradient to remove
  92438. * @returns the current particle system
  92439. */
  92440. removeVelocityGradient(gradient: number): IParticleSystem;
  92441. /**
  92442. * Adds a new limit velocity gradient
  92443. * @param gradient defines the gradient to use (between 0 and 1)
  92444. * @param factor defines the limit velocity value to affect to the specified gradient
  92445. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92446. * @returns the current particle system
  92447. */
  92448. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92449. /**
  92450. * Remove a specific limit velocity gradient
  92451. * @param gradient defines the gradient to remove
  92452. * @returns the current particle system
  92453. */
  92454. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92455. /**
  92456. * Adds a new drag gradient
  92457. * @param gradient defines the gradient to use (between 0 and 1)
  92458. * @param factor defines the drag value to affect to the specified gradient
  92459. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92460. * @returns the current particle system
  92461. */
  92462. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92463. /**
  92464. * Remove a specific drag gradient
  92465. * @param gradient defines the gradient to remove
  92466. * @returns the current particle system
  92467. */
  92468. removeDragGradient(gradient: number): IParticleSystem;
  92469. /**
  92470. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92471. * @param gradient defines the gradient to use (between 0 and 1)
  92472. * @param factor defines the emit rate value to affect to the specified gradient
  92473. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92474. * @returns the current particle system
  92475. */
  92476. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92477. /**
  92478. * Remove a specific emit rate gradient
  92479. * @param gradient defines the gradient to remove
  92480. * @returns the current particle system
  92481. */
  92482. removeEmitRateGradient(gradient: number): IParticleSystem;
  92483. /**
  92484. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92485. * @param gradient defines the gradient to use (between 0 and 1)
  92486. * @param factor defines the start size value to affect to the specified gradient
  92487. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92488. * @returns the current particle system
  92489. */
  92490. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92491. /**
  92492. * Remove a specific start size gradient
  92493. * @param gradient defines the gradient to remove
  92494. * @returns the current particle system
  92495. */
  92496. removeStartSizeGradient(gradient: number): IParticleSystem;
  92497. private _createRampGradientTexture;
  92498. /**
  92499. * Gets the current list of ramp gradients.
  92500. * You must use addRampGradient and removeRampGradient to udpate this list
  92501. * @returns the list of ramp gradients
  92502. */
  92503. getRampGradients(): Nullable<Array<Color3Gradient>>;
  92504. /** Force the system to rebuild all gradients that need to be resync */
  92505. forceRefreshGradients(): void;
  92506. private _syncRampGradientTexture;
  92507. /**
  92508. * Adds a new ramp gradient used to remap particle colors
  92509. * @param gradient defines the gradient to use (between 0 and 1)
  92510. * @param color defines the color to affect to the specified gradient
  92511. * @returns the current particle system
  92512. */
  92513. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  92514. /**
  92515. * Remove a specific ramp gradient
  92516. * @param gradient defines the gradient to remove
  92517. * @returns the current particle system
  92518. */
  92519. removeRampGradient(gradient: number): ParticleSystem;
  92520. /**
  92521. * Adds a new color gradient
  92522. * @param gradient defines the gradient to use (between 0 and 1)
  92523. * @param color1 defines the color to affect to the specified gradient
  92524. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  92525. * @returns this particle system
  92526. */
  92527. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  92528. /**
  92529. * Remove a specific color gradient
  92530. * @param gradient defines the gradient to remove
  92531. * @returns this particle system
  92532. */
  92533. removeColorGradient(gradient: number): IParticleSystem;
  92534. private _fetchR;
  92535. protected _reset(): void;
  92536. private _resetEffect;
  92537. private _createVertexBuffers;
  92538. private _createIndexBuffer;
  92539. /**
  92540. * Gets the maximum number of particles active at the same time.
  92541. * @returns The max number of active particles.
  92542. */
  92543. getCapacity(): number;
  92544. /**
  92545. * Gets whether there are still active particles in the system.
  92546. * @returns True if it is alive, otherwise false.
  92547. */
  92548. isAlive(): boolean;
  92549. /**
  92550. * Gets if the system has been started. (Note: this will still be true after stop is called)
  92551. * @returns True if it has been started, otherwise false.
  92552. */
  92553. isStarted(): boolean;
  92554. private _prepareSubEmitterInternalArray;
  92555. /**
  92556. * Starts the particle system and begins to emit
  92557. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  92558. */
  92559. start(delay?: number): void;
  92560. /**
  92561. * Stops the particle system.
  92562. * @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.
  92563. */
  92564. stop(stopSubEmitters?: boolean): void;
  92565. /**
  92566. * Remove all active particles
  92567. */
  92568. reset(): void;
  92569. /**
  92570. * @hidden (for internal use only)
  92571. */
  92572. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  92573. /**
  92574. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  92575. * Its lifetime will start back at 0.
  92576. */
  92577. recycleParticle: (particle: Particle) => void;
  92578. private _stopSubEmitters;
  92579. private _createParticle;
  92580. private _removeFromRoot;
  92581. private _emitFromParticle;
  92582. private _update;
  92583. /** @hidden */
  92584. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  92585. /** @hidden */
  92586. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  92587. /**
  92588. * Fill the defines array according to the current settings of the particle system
  92589. * @param defines Array to be updated
  92590. * @param blendMode blend mode to take into account when updating the array
  92591. */
  92592. fillDefines(defines: Array<string>, blendMode: number): void;
  92593. /**
  92594. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  92595. * @param uniforms Uniforms array to fill
  92596. * @param attributes Attributes array to fill
  92597. * @param samplers Samplers array to fill
  92598. */
  92599. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  92600. /** @hidden */
  92601. private _getEffect;
  92602. /**
  92603. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  92604. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  92605. */
  92606. animate(preWarmOnly?: boolean): void;
  92607. private _appendParticleVertices;
  92608. /**
  92609. * Rebuilds the particle system.
  92610. */
  92611. rebuild(): void;
  92612. /**
  92613. * Is this system ready to be used/rendered
  92614. * @return true if the system is ready
  92615. */
  92616. isReady(): boolean;
  92617. private _render;
  92618. /**
  92619. * Renders the particle system in its current state.
  92620. * @returns the current number of particles
  92621. */
  92622. render(): number;
  92623. /**
  92624. * Disposes the particle system and free the associated resources
  92625. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  92626. */
  92627. dispose(disposeTexture?: boolean): void;
  92628. /**
  92629. * Clones the particle system.
  92630. * @param name The name of the cloned object
  92631. * @param newEmitter The new emitter to use
  92632. * @returns the cloned particle system
  92633. */
  92634. clone(name: string, newEmitter: any): ParticleSystem;
  92635. /**
  92636. * Serializes the particle system to a JSON object
  92637. * @param serializeTexture defines if the texture must be serialized as well
  92638. * @returns the JSON object
  92639. */
  92640. serialize(serializeTexture?: boolean): any;
  92641. /** @hidden */
  92642. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  92643. /** @hidden */
  92644. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  92645. /**
  92646. * Parses a JSON object to create a particle system.
  92647. * @param parsedParticleSystem The JSON object to parse
  92648. * @param sceneOrEngine The scene or the engine to create the particle system in
  92649. * @param rootUrl The root url to use to load external dependencies like texture
  92650. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  92651. * @returns the Parsed particle system
  92652. */
  92653. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  92654. }
  92655. }
  92656. declare module BABYLON {
  92657. /**
  92658. * A particle represents one of the element emitted by a particle system.
  92659. * This is mainly define by its coordinates, direction, velocity and age.
  92660. */
  92661. export class Particle {
  92662. /**
  92663. * The particle system the particle belongs to.
  92664. */
  92665. particleSystem: ParticleSystem;
  92666. private static _Count;
  92667. /**
  92668. * Unique ID of the particle
  92669. */
  92670. id: number;
  92671. /**
  92672. * The world position of the particle in the scene.
  92673. */
  92674. position: Vector3;
  92675. /**
  92676. * The world direction of the particle in the scene.
  92677. */
  92678. direction: Vector3;
  92679. /**
  92680. * The color of the particle.
  92681. */
  92682. color: Color4;
  92683. /**
  92684. * The color change of the particle per step.
  92685. */
  92686. colorStep: Color4;
  92687. /**
  92688. * Defines how long will the life of the particle be.
  92689. */
  92690. lifeTime: number;
  92691. /**
  92692. * The current age of the particle.
  92693. */
  92694. age: number;
  92695. /**
  92696. * The current size of the particle.
  92697. */
  92698. size: number;
  92699. /**
  92700. * The current scale of the particle.
  92701. */
  92702. scale: Vector2;
  92703. /**
  92704. * The current angle of the particle.
  92705. */
  92706. angle: number;
  92707. /**
  92708. * Defines how fast is the angle changing.
  92709. */
  92710. angularSpeed: number;
  92711. /**
  92712. * Defines the cell index used by the particle to be rendered from a sprite.
  92713. */
  92714. cellIndex: number;
  92715. /**
  92716. * The information required to support color remapping
  92717. */
  92718. remapData: Vector4;
  92719. /** @hidden */
  92720. _randomCellOffset?: number;
  92721. /** @hidden */
  92722. _initialDirection: Nullable<Vector3>;
  92723. /** @hidden */
  92724. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  92725. /** @hidden */
  92726. _initialStartSpriteCellID: number;
  92727. /** @hidden */
  92728. _initialEndSpriteCellID: number;
  92729. /** @hidden */
  92730. _currentColorGradient: Nullable<ColorGradient>;
  92731. /** @hidden */
  92732. _currentColor1: Color4;
  92733. /** @hidden */
  92734. _currentColor2: Color4;
  92735. /** @hidden */
  92736. _currentSizeGradient: Nullable<FactorGradient>;
  92737. /** @hidden */
  92738. _currentSize1: number;
  92739. /** @hidden */
  92740. _currentSize2: number;
  92741. /** @hidden */
  92742. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  92743. /** @hidden */
  92744. _currentAngularSpeed1: number;
  92745. /** @hidden */
  92746. _currentAngularSpeed2: number;
  92747. /** @hidden */
  92748. _currentVelocityGradient: Nullable<FactorGradient>;
  92749. /** @hidden */
  92750. _currentVelocity1: number;
  92751. /** @hidden */
  92752. _currentVelocity2: number;
  92753. /** @hidden */
  92754. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  92755. /** @hidden */
  92756. _currentLimitVelocity1: number;
  92757. /** @hidden */
  92758. _currentLimitVelocity2: number;
  92759. /** @hidden */
  92760. _currentDragGradient: Nullable<FactorGradient>;
  92761. /** @hidden */
  92762. _currentDrag1: number;
  92763. /** @hidden */
  92764. _currentDrag2: number;
  92765. /** @hidden */
  92766. _randomNoiseCoordinates1: Vector3;
  92767. /** @hidden */
  92768. _randomNoiseCoordinates2: Vector3;
  92769. /** @hidden */
  92770. _localPosition?: Vector3;
  92771. /**
  92772. * Creates a new instance Particle
  92773. * @param particleSystem the particle system the particle belongs to
  92774. */
  92775. constructor(
  92776. /**
  92777. * The particle system the particle belongs to.
  92778. */
  92779. particleSystem: ParticleSystem);
  92780. private updateCellInfoFromSystem;
  92781. /**
  92782. * Defines how the sprite cell index is updated for the particle
  92783. */
  92784. updateCellIndex(): void;
  92785. /** @hidden */
  92786. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  92787. /** @hidden */
  92788. _inheritParticleInfoToSubEmitters(): void;
  92789. /** @hidden */
  92790. _reset(): void;
  92791. /**
  92792. * Copy the properties of particle to another one.
  92793. * @param other the particle to copy the information to.
  92794. */
  92795. copyTo(other: Particle): void;
  92796. }
  92797. }
  92798. declare module BABYLON {
  92799. /**
  92800. * Particle emitter represents a volume emitting particles.
  92801. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  92802. */
  92803. export interface IParticleEmitterType {
  92804. /**
  92805. * Called by the particle System when the direction is computed for the created particle.
  92806. * @param worldMatrix is the world matrix of the particle system
  92807. * @param directionToUpdate is the direction vector to update with the result
  92808. * @param particle is the particle we are computed the direction for
  92809. * @param isLocal defines if the direction should be set in local space
  92810. */
  92811. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92812. /**
  92813. * Called by the particle System when the position is computed for the created particle.
  92814. * @param worldMatrix is the world matrix of the particle system
  92815. * @param positionToUpdate is the position vector to update with the result
  92816. * @param particle is the particle we are computed the position for
  92817. * @param isLocal defines if the position should be set in local space
  92818. */
  92819. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92820. /**
  92821. * Clones the current emitter and returns a copy of it
  92822. * @returns the new emitter
  92823. */
  92824. clone(): IParticleEmitterType;
  92825. /**
  92826. * Called by the GPUParticleSystem to setup the update shader
  92827. * @param effect defines the update shader
  92828. */
  92829. applyToShader(effect: Effect): void;
  92830. /**
  92831. * Returns a string to use to update the GPU particles update shader
  92832. * @returns the effect defines string
  92833. */
  92834. getEffectDefines(): string;
  92835. /**
  92836. * Returns a string representing the class name
  92837. * @returns a string containing the class name
  92838. */
  92839. getClassName(): string;
  92840. /**
  92841. * Serializes the particle system to a JSON object.
  92842. * @returns the JSON object
  92843. */
  92844. serialize(): any;
  92845. /**
  92846. * Parse properties from a JSON object
  92847. * @param serializationObject defines the JSON object
  92848. * @param scene defines the hosting scene
  92849. */
  92850. parse(serializationObject: any, scene: Nullable<Scene>): void;
  92851. }
  92852. }
  92853. declare module BABYLON {
  92854. /**
  92855. * Particle emitter emitting particles from the inside of a box.
  92856. * It emits the particles randomly between 2 given directions.
  92857. */
  92858. export class BoxParticleEmitter implements IParticleEmitterType {
  92859. /**
  92860. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92861. */
  92862. direction1: Vector3;
  92863. /**
  92864. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92865. */
  92866. direction2: Vector3;
  92867. /**
  92868. * 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.
  92869. */
  92870. minEmitBox: Vector3;
  92871. /**
  92872. * 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.
  92873. */
  92874. maxEmitBox: Vector3;
  92875. /**
  92876. * Creates a new instance BoxParticleEmitter
  92877. */
  92878. constructor();
  92879. /**
  92880. * Called by the particle System when the direction is computed for the created particle.
  92881. * @param worldMatrix is the world matrix of the particle system
  92882. * @param directionToUpdate is the direction vector to update with the result
  92883. * @param particle is the particle we are computed the direction for
  92884. * @param isLocal defines if the direction should be set in local space
  92885. */
  92886. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92887. /**
  92888. * Called by the particle System when the position is computed for the created particle.
  92889. * @param worldMatrix is the world matrix of the particle system
  92890. * @param positionToUpdate is the position vector to update with the result
  92891. * @param particle is the particle we are computed the position for
  92892. * @param isLocal defines if the position should be set in local space
  92893. */
  92894. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92895. /**
  92896. * Clones the current emitter and returns a copy of it
  92897. * @returns the new emitter
  92898. */
  92899. clone(): BoxParticleEmitter;
  92900. /**
  92901. * Called by the GPUParticleSystem to setup the update shader
  92902. * @param effect defines the update shader
  92903. */
  92904. applyToShader(effect: Effect): void;
  92905. /**
  92906. * Returns a string to use to update the GPU particles update shader
  92907. * @returns a string containng the defines string
  92908. */
  92909. getEffectDefines(): string;
  92910. /**
  92911. * Returns the string "BoxParticleEmitter"
  92912. * @returns a string containing the class name
  92913. */
  92914. getClassName(): string;
  92915. /**
  92916. * Serializes the particle system to a JSON object.
  92917. * @returns the JSON object
  92918. */
  92919. serialize(): any;
  92920. /**
  92921. * Parse properties from a JSON object
  92922. * @param serializationObject defines the JSON object
  92923. */
  92924. parse(serializationObject: any): void;
  92925. }
  92926. }
  92927. declare module BABYLON {
  92928. /**
  92929. * Particle emitter emitting particles from the inside of a cone.
  92930. * It emits the particles alongside the cone volume from the base to the particle.
  92931. * The emission direction might be randomized.
  92932. */
  92933. export class ConeParticleEmitter implements IParticleEmitterType {
  92934. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92935. directionRandomizer: number;
  92936. private _radius;
  92937. private _angle;
  92938. private _height;
  92939. /**
  92940. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  92941. */
  92942. radiusRange: number;
  92943. /**
  92944. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  92945. */
  92946. heightRange: number;
  92947. /**
  92948. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  92949. */
  92950. emitFromSpawnPointOnly: boolean;
  92951. /**
  92952. * Gets or sets the radius of the emission cone
  92953. */
  92954. get radius(): number;
  92955. set radius(value: number);
  92956. /**
  92957. * Gets or sets the angle of the emission cone
  92958. */
  92959. get angle(): number;
  92960. set angle(value: number);
  92961. private _buildHeight;
  92962. /**
  92963. * Creates a new instance ConeParticleEmitter
  92964. * @param radius the radius of the emission cone (1 by default)
  92965. * @param angle the cone base angle (PI by default)
  92966. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  92967. */
  92968. constructor(radius?: number, angle?: number,
  92969. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92970. directionRandomizer?: number);
  92971. /**
  92972. * Called by the particle System when the direction is computed for the created particle.
  92973. * @param worldMatrix is the world matrix of the particle system
  92974. * @param directionToUpdate is the direction vector to update with the result
  92975. * @param particle is the particle we are computed the direction for
  92976. * @param isLocal defines if the direction should be set in local space
  92977. */
  92978. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92979. /**
  92980. * Called by the particle System when the position is computed for the created particle.
  92981. * @param worldMatrix is the world matrix of the particle system
  92982. * @param positionToUpdate is the position vector to update with the result
  92983. * @param particle is the particle we are computed the position for
  92984. * @param isLocal defines if the position should be set in local space
  92985. */
  92986. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92987. /**
  92988. * Clones the current emitter and returns a copy of it
  92989. * @returns the new emitter
  92990. */
  92991. clone(): ConeParticleEmitter;
  92992. /**
  92993. * Called by the GPUParticleSystem to setup the update shader
  92994. * @param effect defines the update shader
  92995. */
  92996. applyToShader(effect: Effect): void;
  92997. /**
  92998. * Returns a string to use to update the GPU particles update shader
  92999. * @returns a string containng the defines string
  93000. */
  93001. getEffectDefines(): string;
  93002. /**
  93003. * Returns the string "ConeParticleEmitter"
  93004. * @returns a string containing the class name
  93005. */
  93006. getClassName(): string;
  93007. /**
  93008. * Serializes the particle system to a JSON object.
  93009. * @returns the JSON object
  93010. */
  93011. serialize(): any;
  93012. /**
  93013. * Parse properties from a JSON object
  93014. * @param serializationObject defines the JSON object
  93015. */
  93016. parse(serializationObject: any): void;
  93017. }
  93018. }
  93019. declare module BABYLON {
  93020. /**
  93021. * Particle emitter emitting particles from the inside of a cylinder.
  93022. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  93023. */
  93024. export class CylinderParticleEmitter implements IParticleEmitterType {
  93025. /**
  93026. * The radius of the emission cylinder.
  93027. */
  93028. radius: number;
  93029. /**
  93030. * The height of the emission cylinder.
  93031. */
  93032. height: number;
  93033. /**
  93034. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93035. */
  93036. radiusRange: number;
  93037. /**
  93038. * How much to randomize the particle direction [0-1].
  93039. */
  93040. directionRandomizer: number;
  93041. /**
  93042. * Creates a new instance CylinderParticleEmitter
  93043. * @param radius the radius of the emission cylinder (1 by default)
  93044. * @param height the height of the emission cylinder (1 by default)
  93045. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93046. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93047. */
  93048. constructor(
  93049. /**
  93050. * The radius of the emission cylinder.
  93051. */
  93052. radius?: number,
  93053. /**
  93054. * The height of the emission cylinder.
  93055. */
  93056. height?: number,
  93057. /**
  93058. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93059. */
  93060. radiusRange?: number,
  93061. /**
  93062. * How much to randomize the particle direction [0-1].
  93063. */
  93064. directionRandomizer?: number);
  93065. /**
  93066. * Called by the particle System when the direction is computed for the created particle.
  93067. * @param worldMatrix is the world matrix of the particle system
  93068. * @param directionToUpdate is the direction vector to update with the result
  93069. * @param particle is the particle we are computed the direction for
  93070. * @param isLocal defines if the direction should be set in local space
  93071. */
  93072. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93073. /**
  93074. * Called by the particle System when the position is computed for the created particle.
  93075. * @param worldMatrix is the world matrix of the particle system
  93076. * @param positionToUpdate is the position vector to update with the result
  93077. * @param particle is the particle we are computed the position for
  93078. * @param isLocal defines if the position should be set in local space
  93079. */
  93080. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93081. /**
  93082. * Clones the current emitter and returns a copy of it
  93083. * @returns the new emitter
  93084. */
  93085. clone(): CylinderParticleEmitter;
  93086. /**
  93087. * Called by the GPUParticleSystem to setup the update shader
  93088. * @param effect defines the update shader
  93089. */
  93090. applyToShader(effect: Effect): void;
  93091. /**
  93092. * Returns a string to use to update the GPU particles update shader
  93093. * @returns a string containng the defines string
  93094. */
  93095. getEffectDefines(): string;
  93096. /**
  93097. * Returns the string "CylinderParticleEmitter"
  93098. * @returns a string containing the class name
  93099. */
  93100. getClassName(): string;
  93101. /**
  93102. * Serializes the particle system to a JSON object.
  93103. * @returns the JSON object
  93104. */
  93105. serialize(): any;
  93106. /**
  93107. * Parse properties from a JSON object
  93108. * @param serializationObject defines the JSON object
  93109. */
  93110. parse(serializationObject: any): void;
  93111. }
  93112. /**
  93113. * Particle emitter emitting particles from the inside of a cylinder.
  93114. * It emits the particles randomly between two vectors.
  93115. */
  93116. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  93117. /**
  93118. * The min limit of the emission direction.
  93119. */
  93120. direction1: Vector3;
  93121. /**
  93122. * The max limit of the emission direction.
  93123. */
  93124. direction2: Vector3;
  93125. /**
  93126. * Creates a new instance CylinderDirectedParticleEmitter
  93127. * @param radius the radius of the emission cylinder (1 by default)
  93128. * @param height the height of the emission cylinder (1 by default)
  93129. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93130. * @param direction1 the min limit of the emission direction (up vector by default)
  93131. * @param direction2 the max limit of the emission direction (up vector by default)
  93132. */
  93133. constructor(radius?: number, height?: number, radiusRange?: number,
  93134. /**
  93135. * The min limit of the emission direction.
  93136. */
  93137. direction1?: Vector3,
  93138. /**
  93139. * The max limit of the emission direction.
  93140. */
  93141. direction2?: Vector3);
  93142. /**
  93143. * Called by the particle System when the direction is computed for the created particle.
  93144. * @param worldMatrix is the world matrix of the particle system
  93145. * @param directionToUpdate is the direction vector to update with the result
  93146. * @param particle is the particle we are computed the direction for
  93147. */
  93148. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93149. /**
  93150. * Clones the current emitter and returns a copy of it
  93151. * @returns the new emitter
  93152. */
  93153. clone(): CylinderDirectedParticleEmitter;
  93154. /**
  93155. * Called by the GPUParticleSystem to setup the update shader
  93156. * @param effect defines the update shader
  93157. */
  93158. applyToShader(effect: Effect): void;
  93159. /**
  93160. * Returns a string to use to update the GPU particles update shader
  93161. * @returns a string containng the defines string
  93162. */
  93163. getEffectDefines(): string;
  93164. /**
  93165. * Returns the string "CylinderDirectedParticleEmitter"
  93166. * @returns a string containing the class name
  93167. */
  93168. getClassName(): string;
  93169. /**
  93170. * Serializes the particle system to a JSON object.
  93171. * @returns the JSON object
  93172. */
  93173. serialize(): any;
  93174. /**
  93175. * Parse properties from a JSON object
  93176. * @param serializationObject defines the JSON object
  93177. */
  93178. parse(serializationObject: any): void;
  93179. }
  93180. }
  93181. declare module BABYLON {
  93182. /**
  93183. * Particle emitter emitting particles from the inside of a hemisphere.
  93184. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  93185. */
  93186. export class HemisphericParticleEmitter implements IParticleEmitterType {
  93187. /**
  93188. * The radius of the emission hemisphere.
  93189. */
  93190. radius: number;
  93191. /**
  93192. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93193. */
  93194. radiusRange: number;
  93195. /**
  93196. * How much to randomize the particle direction [0-1].
  93197. */
  93198. directionRandomizer: number;
  93199. /**
  93200. * Creates a new instance HemisphericParticleEmitter
  93201. * @param radius the radius of the emission hemisphere (1 by default)
  93202. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93203. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93204. */
  93205. constructor(
  93206. /**
  93207. * The radius of the emission hemisphere.
  93208. */
  93209. radius?: number,
  93210. /**
  93211. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93212. */
  93213. radiusRange?: number,
  93214. /**
  93215. * How much to randomize the particle direction [0-1].
  93216. */
  93217. directionRandomizer?: number);
  93218. /**
  93219. * Called by the particle System when the direction is computed for the created particle.
  93220. * @param worldMatrix is the world matrix of the particle system
  93221. * @param directionToUpdate is the direction vector to update with the result
  93222. * @param particle is the particle we are computed the direction for
  93223. * @param isLocal defines if the direction should be set in local space
  93224. */
  93225. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93226. /**
  93227. * Called by the particle System when the position is computed for the created particle.
  93228. * @param worldMatrix is the world matrix of the particle system
  93229. * @param positionToUpdate is the position vector to update with the result
  93230. * @param particle is the particle we are computed the position for
  93231. * @param isLocal defines if the position should be set in local space
  93232. */
  93233. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93234. /**
  93235. * Clones the current emitter and returns a copy of it
  93236. * @returns the new emitter
  93237. */
  93238. clone(): HemisphericParticleEmitter;
  93239. /**
  93240. * Called by the GPUParticleSystem to setup the update shader
  93241. * @param effect defines the update shader
  93242. */
  93243. applyToShader(effect: Effect): void;
  93244. /**
  93245. * Returns a string to use to update the GPU particles update shader
  93246. * @returns a string containng the defines string
  93247. */
  93248. getEffectDefines(): string;
  93249. /**
  93250. * Returns the string "HemisphericParticleEmitter"
  93251. * @returns a string containing the class name
  93252. */
  93253. getClassName(): string;
  93254. /**
  93255. * Serializes the particle system to a JSON object.
  93256. * @returns the JSON object
  93257. */
  93258. serialize(): any;
  93259. /**
  93260. * Parse properties from a JSON object
  93261. * @param serializationObject defines the JSON object
  93262. */
  93263. parse(serializationObject: any): void;
  93264. }
  93265. }
  93266. declare module BABYLON {
  93267. /**
  93268. * Particle emitter emitting particles from a point.
  93269. * It emits the particles randomly between 2 given directions.
  93270. */
  93271. export class PointParticleEmitter implements IParticleEmitterType {
  93272. /**
  93273. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93274. */
  93275. direction1: Vector3;
  93276. /**
  93277. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93278. */
  93279. direction2: Vector3;
  93280. /**
  93281. * Creates a new instance PointParticleEmitter
  93282. */
  93283. constructor();
  93284. /**
  93285. * Called by the particle System when the direction is computed for the created particle.
  93286. * @param worldMatrix is the world matrix of the particle system
  93287. * @param directionToUpdate is the direction vector to update with the result
  93288. * @param particle is the particle we are computed the direction for
  93289. * @param isLocal defines if the direction should be set in local space
  93290. */
  93291. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93292. /**
  93293. * Called by the particle System when the position is computed for the created particle.
  93294. * @param worldMatrix is the world matrix of the particle system
  93295. * @param positionToUpdate is the position vector to update with the result
  93296. * @param particle is the particle we are computed the position for
  93297. * @param isLocal defines if the position should be set in local space
  93298. */
  93299. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93300. /**
  93301. * Clones the current emitter and returns a copy of it
  93302. * @returns the new emitter
  93303. */
  93304. clone(): PointParticleEmitter;
  93305. /**
  93306. * Called by the GPUParticleSystem to setup the update shader
  93307. * @param effect defines the update shader
  93308. */
  93309. applyToShader(effect: Effect): void;
  93310. /**
  93311. * Returns a string to use to update the GPU particles update shader
  93312. * @returns a string containng the defines string
  93313. */
  93314. getEffectDefines(): string;
  93315. /**
  93316. * Returns the string "PointParticleEmitter"
  93317. * @returns a string containing the class name
  93318. */
  93319. getClassName(): string;
  93320. /**
  93321. * Serializes the particle system to a JSON object.
  93322. * @returns the JSON object
  93323. */
  93324. serialize(): any;
  93325. /**
  93326. * Parse properties from a JSON object
  93327. * @param serializationObject defines the JSON object
  93328. */
  93329. parse(serializationObject: any): void;
  93330. }
  93331. }
  93332. declare module BABYLON {
  93333. /**
  93334. * Particle emitter emitting particles from the inside of a sphere.
  93335. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  93336. */
  93337. export class SphereParticleEmitter implements IParticleEmitterType {
  93338. /**
  93339. * The radius of the emission sphere.
  93340. */
  93341. radius: number;
  93342. /**
  93343. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93344. */
  93345. radiusRange: number;
  93346. /**
  93347. * How much to randomize the particle direction [0-1].
  93348. */
  93349. directionRandomizer: number;
  93350. /**
  93351. * Creates a new instance SphereParticleEmitter
  93352. * @param radius the radius of the emission sphere (1 by default)
  93353. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93354. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93355. */
  93356. constructor(
  93357. /**
  93358. * The radius of the emission sphere.
  93359. */
  93360. radius?: number,
  93361. /**
  93362. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93363. */
  93364. radiusRange?: number,
  93365. /**
  93366. * How much to randomize the particle direction [0-1].
  93367. */
  93368. directionRandomizer?: number);
  93369. /**
  93370. * Called by the particle System when the direction is computed for the created particle.
  93371. * @param worldMatrix is the world matrix of the particle system
  93372. * @param directionToUpdate is the direction vector to update with the result
  93373. * @param particle is the particle we are computed the direction for
  93374. * @param isLocal defines if the direction should be set in local space
  93375. */
  93376. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93377. /**
  93378. * Called by the particle System when the position is computed for the created particle.
  93379. * @param worldMatrix is the world matrix of the particle system
  93380. * @param positionToUpdate is the position vector to update with the result
  93381. * @param particle is the particle we are computed the position for
  93382. * @param isLocal defines if the position should be set in local space
  93383. */
  93384. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93385. /**
  93386. * Clones the current emitter and returns a copy of it
  93387. * @returns the new emitter
  93388. */
  93389. clone(): SphereParticleEmitter;
  93390. /**
  93391. * Called by the GPUParticleSystem to setup the update shader
  93392. * @param effect defines the update shader
  93393. */
  93394. applyToShader(effect: Effect): void;
  93395. /**
  93396. * Returns a string to use to update the GPU particles update shader
  93397. * @returns a string containng the defines string
  93398. */
  93399. getEffectDefines(): string;
  93400. /**
  93401. * Returns the string "SphereParticleEmitter"
  93402. * @returns a string containing the class name
  93403. */
  93404. getClassName(): string;
  93405. /**
  93406. * Serializes the particle system to a JSON object.
  93407. * @returns the JSON object
  93408. */
  93409. serialize(): any;
  93410. /**
  93411. * Parse properties from a JSON object
  93412. * @param serializationObject defines the JSON object
  93413. */
  93414. parse(serializationObject: any): void;
  93415. }
  93416. /**
  93417. * Particle emitter emitting particles from the inside of a sphere.
  93418. * It emits the particles randomly between two vectors.
  93419. */
  93420. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  93421. /**
  93422. * The min limit of the emission direction.
  93423. */
  93424. direction1: Vector3;
  93425. /**
  93426. * The max limit of the emission direction.
  93427. */
  93428. direction2: Vector3;
  93429. /**
  93430. * Creates a new instance SphereDirectedParticleEmitter
  93431. * @param radius the radius of the emission sphere (1 by default)
  93432. * @param direction1 the min limit of the emission direction (up vector by default)
  93433. * @param direction2 the max limit of the emission direction (up vector by default)
  93434. */
  93435. constructor(radius?: number,
  93436. /**
  93437. * The min limit of the emission direction.
  93438. */
  93439. direction1?: Vector3,
  93440. /**
  93441. * The max limit of the emission direction.
  93442. */
  93443. direction2?: Vector3);
  93444. /**
  93445. * Called by the particle System when the direction is computed for the created particle.
  93446. * @param worldMatrix is the world matrix of the particle system
  93447. * @param directionToUpdate is the direction vector to update with the result
  93448. * @param particle is the particle we are computed the direction for
  93449. */
  93450. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93451. /**
  93452. * Clones the current emitter and returns a copy of it
  93453. * @returns the new emitter
  93454. */
  93455. clone(): SphereDirectedParticleEmitter;
  93456. /**
  93457. * Called by the GPUParticleSystem to setup the update shader
  93458. * @param effect defines the update shader
  93459. */
  93460. applyToShader(effect: Effect): void;
  93461. /**
  93462. * Returns a string to use to update the GPU particles update shader
  93463. * @returns a string containng the defines string
  93464. */
  93465. getEffectDefines(): string;
  93466. /**
  93467. * Returns the string "SphereDirectedParticleEmitter"
  93468. * @returns a string containing the class name
  93469. */
  93470. getClassName(): string;
  93471. /**
  93472. * Serializes the particle system to a JSON object.
  93473. * @returns the JSON object
  93474. */
  93475. serialize(): any;
  93476. /**
  93477. * Parse properties from a JSON object
  93478. * @param serializationObject defines the JSON object
  93479. */
  93480. parse(serializationObject: any): void;
  93481. }
  93482. }
  93483. declare module BABYLON {
  93484. /**
  93485. * Particle emitter emitting particles from a custom list of positions.
  93486. */
  93487. export class CustomParticleEmitter implements IParticleEmitterType {
  93488. /**
  93489. * Gets or sets the position generator that will create the inital position of each particle.
  93490. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93491. */
  93492. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  93493. /**
  93494. * Gets or sets the destination generator that will create the final destination of each particle.
  93495. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93496. */
  93497. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  93498. /**
  93499. * Creates a new instance CustomParticleEmitter
  93500. */
  93501. constructor();
  93502. /**
  93503. * Called by the particle System when the direction is computed for the created particle.
  93504. * @param worldMatrix is the world matrix of the particle system
  93505. * @param directionToUpdate is the direction vector to update with the result
  93506. * @param particle is the particle we are computed the direction for
  93507. * @param isLocal defines if the direction should be set in local space
  93508. */
  93509. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93510. /**
  93511. * Called by the particle System when the position is computed for the created particle.
  93512. * @param worldMatrix is the world matrix of the particle system
  93513. * @param positionToUpdate is the position vector to update with the result
  93514. * @param particle is the particle we are computed the position for
  93515. * @param isLocal defines if the position should be set in local space
  93516. */
  93517. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93518. /**
  93519. * Clones the current emitter and returns a copy of it
  93520. * @returns the new emitter
  93521. */
  93522. clone(): CustomParticleEmitter;
  93523. /**
  93524. * Called by the GPUParticleSystem to setup the update shader
  93525. * @param effect defines the update shader
  93526. */
  93527. applyToShader(effect: Effect): void;
  93528. /**
  93529. * Returns a string to use to update the GPU particles update shader
  93530. * @returns a string containng the defines string
  93531. */
  93532. getEffectDefines(): string;
  93533. /**
  93534. * Returns the string "PointParticleEmitter"
  93535. * @returns a string containing the class name
  93536. */
  93537. getClassName(): string;
  93538. /**
  93539. * Serializes the particle system to a JSON object.
  93540. * @returns the JSON object
  93541. */
  93542. serialize(): any;
  93543. /**
  93544. * Parse properties from a JSON object
  93545. * @param serializationObject defines the JSON object
  93546. */
  93547. parse(serializationObject: any): void;
  93548. }
  93549. }
  93550. declare module BABYLON {
  93551. /**
  93552. * Particle emitter emitting particles from the inside of a box.
  93553. * It emits the particles randomly between 2 given directions.
  93554. */
  93555. export class MeshParticleEmitter implements IParticleEmitterType {
  93556. private _indices;
  93557. private _positions;
  93558. private _normals;
  93559. private _storedNormal;
  93560. private _mesh;
  93561. /**
  93562. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93563. */
  93564. direction1: Vector3;
  93565. /**
  93566. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93567. */
  93568. direction2: Vector3;
  93569. /**
  93570. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  93571. */
  93572. useMeshNormalsForDirection: boolean;
  93573. /** Defines the mesh to use as source */
  93574. get mesh(): Nullable<AbstractMesh>;
  93575. set mesh(value: Nullable<AbstractMesh>);
  93576. /**
  93577. * Creates a new instance MeshParticleEmitter
  93578. * @param mesh defines the mesh to use as source
  93579. */
  93580. constructor(mesh?: Nullable<AbstractMesh>);
  93581. /**
  93582. * Called by the particle System when the direction is computed for the created particle.
  93583. * @param worldMatrix is the world matrix of the particle system
  93584. * @param directionToUpdate is the direction vector to update with the result
  93585. * @param particle is the particle we are computed the direction for
  93586. * @param isLocal defines if the direction should be set in local space
  93587. */
  93588. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93589. /**
  93590. * Called by the particle System when the position is computed for the created particle.
  93591. * @param worldMatrix is the world matrix of the particle system
  93592. * @param positionToUpdate is the position vector to update with the result
  93593. * @param particle is the particle we are computed the position for
  93594. * @param isLocal defines if the position should be set in local space
  93595. */
  93596. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93597. /**
  93598. * Clones the current emitter and returns a copy of it
  93599. * @returns the new emitter
  93600. */
  93601. clone(): MeshParticleEmitter;
  93602. /**
  93603. * Called by the GPUParticleSystem to setup the update shader
  93604. * @param effect defines the update shader
  93605. */
  93606. applyToShader(effect: Effect): void;
  93607. /**
  93608. * Returns a string to use to update the GPU particles update shader
  93609. * @returns a string containng the defines string
  93610. */
  93611. getEffectDefines(): string;
  93612. /**
  93613. * Returns the string "BoxParticleEmitter"
  93614. * @returns a string containing the class name
  93615. */
  93616. getClassName(): string;
  93617. /**
  93618. * Serializes the particle system to a JSON object.
  93619. * @returns the JSON object
  93620. */
  93621. serialize(): any;
  93622. /**
  93623. * Parse properties from a JSON object
  93624. * @param serializationObject defines the JSON object
  93625. * @param scene defines the hosting scene
  93626. */
  93627. parse(serializationObject: any, scene: Nullable<Scene>): void;
  93628. }
  93629. }
  93630. declare module BABYLON {
  93631. /**
  93632. * Interface representing a particle system in Babylon.js.
  93633. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  93634. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  93635. */
  93636. export interface IParticleSystem {
  93637. /**
  93638. * List of animations used by the particle system.
  93639. */
  93640. animations: Animation[];
  93641. /**
  93642. * The id of the Particle system.
  93643. */
  93644. id: string;
  93645. /**
  93646. * The name of the Particle system.
  93647. */
  93648. name: string;
  93649. /**
  93650. * The emitter represents the Mesh or position we are attaching the particle system to.
  93651. */
  93652. emitter: Nullable<AbstractMesh | Vector3>;
  93653. /**
  93654. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  93655. */
  93656. isBillboardBased: boolean;
  93657. /**
  93658. * The rendering group used by the Particle system to chose when to render.
  93659. */
  93660. renderingGroupId: number;
  93661. /**
  93662. * The layer mask we are rendering the particles through.
  93663. */
  93664. layerMask: number;
  93665. /**
  93666. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  93667. */
  93668. updateSpeed: number;
  93669. /**
  93670. * The amount of time the particle system is running (depends of the overall update speed).
  93671. */
  93672. targetStopDuration: number;
  93673. /**
  93674. * The texture used to render each particle. (this can be a spritesheet)
  93675. */
  93676. particleTexture: Nullable<BaseTexture>;
  93677. /**
  93678. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  93679. */
  93680. blendMode: number;
  93681. /**
  93682. * Minimum life time of emitting particles.
  93683. */
  93684. minLifeTime: number;
  93685. /**
  93686. * Maximum life time of emitting particles.
  93687. */
  93688. maxLifeTime: number;
  93689. /**
  93690. * Minimum Size of emitting particles.
  93691. */
  93692. minSize: number;
  93693. /**
  93694. * Maximum Size of emitting particles.
  93695. */
  93696. maxSize: number;
  93697. /**
  93698. * Minimum scale of emitting particles on X axis.
  93699. */
  93700. minScaleX: number;
  93701. /**
  93702. * Maximum scale of emitting particles on X axis.
  93703. */
  93704. maxScaleX: number;
  93705. /**
  93706. * Minimum scale of emitting particles on Y axis.
  93707. */
  93708. minScaleY: number;
  93709. /**
  93710. * Maximum scale of emitting particles on Y axis.
  93711. */
  93712. maxScaleY: number;
  93713. /**
  93714. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93715. */
  93716. color1: Color4;
  93717. /**
  93718. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93719. */
  93720. color2: Color4;
  93721. /**
  93722. * Color the particle will have at the end of its lifetime.
  93723. */
  93724. colorDead: Color4;
  93725. /**
  93726. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  93727. */
  93728. emitRate: number;
  93729. /**
  93730. * You can use gravity if you want to give an orientation to your particles.
  93731. */
  93732. gravity: Vector3;
  93733. /**
  93734. * Minimum power of emitting particles.
  93735. */
  93736. minEmitPower: number;
  93737. /**
  93738. * Maximum power of emitting particles.
  93739. */
  93740. maxEmitPower: number;
  93741. /**
  93742. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  93743. */
  93744. minAngularSpeed: number;
  93745. /**
  93746. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  93747. */
  93748. maxAngularSpeed: number;
  93749. /**
  93750. * Gets or sets the minimal initial rotation in radians.
  93751. */
  93752. minInitialRotation: number;
  93753. /**
  93754. * Gets or sets the maximal initial rotation in radians.
  93755. */
  93756. maxInitialRotation: number;
  93757. /**
  93758. * The particle emitter type defines the emitter used by the particle system.
  93759. * It can be for example box, sphere, or cone...
  93760. */
  93761. particleEmitterType: Nullable<IParticleEmitterType>;
  93762. /**
  93763. * Defines the delay in milliseconds before starting the system (0 by default)
  93764. */
  93765. startDelay: number;
  93766. /**
  93767. * 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
  93768. */
  93769. preWarmCycles: number;
  93770. /**
  93771. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  93772. */
  93773. preWarmStepOffset: number;
  93774. /**
  93775. * 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)
  93776. */
  93777. spriteCellChangeSpeed: number;
  93778. /**
  93779. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  93780. */
  93781. startSpriteCellID: number;
  93782. /**
  93783. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  93784. */
  93785. endSpriteCellID: number;
  93786. /**
  93787. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  93788. */
  93789. spriteCellWidth: number;
  93790. /**
  93791. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  93792. */
  93793. spriteCellHeight: number;
  93794. /**
  93795. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  93796. */
  93797. spriteRandomStartCell: boolean;
  93798. /**
  93799. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  93800. */
  93801. isAnimationSheetEnabled: boolean;
  93802. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  93803. translationPivot: Vector2;
  93804. /**
  93805. * Gets or sets a texture used to add random noise to particle positions
  93806. */
  93807. noiseTexture: Nullable<BaseTexture>;
  93808. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  93809. noiseStrength: Vector3;
  93810. /**
  93811. * Gets or sets the billboard mode to use when isBillboardBased = true.
  93812. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  93813. */
  93814. billboardMode: number;
  93815. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  93816. limitVelocityDamping: number;
  93817. /**
  93818. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  93819. */
  93820. beginAnimationOnStart: boolean;
  93821. /**
  93822. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  93823. */
  93824. beginAnimationFrom: number;
  93825. /**
  93826. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  93827. */
  93828. beginAnimationTo: number;
  93829. /**
  93830. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  93831. */
  93832. beginAnimationLoop: boolean;
  93833. /**
  93834. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  93835. */
  93836. disposeOnStop: boolean;
  93837. /**
  93838. * Specifies if the particles are updated in emitter local space or world space
  93839. */
  93840. isLocal: boolean;
  93841. /** Snippet ID if the particle system was created from the snippet server */
  93842. snippetId: string;
  93843. /** Gets or sets a matrix to use to compute projection */
  93844. defaultProjectionMatrix: Matrix;
  93845. /**
  93846. * Gets the maximum number of particles active at the same time.
  93847. * @returns The max number of active particles.
  93848. */
  93849. getCapacity(): number;
  93850. /**
  93851. * Gets the number of particles active at the same time.
  93852. * @returns The number of active particles.
  93853. */
  93854. getActiveCount(): number;
  93855. /**
  93856. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93857. * @returns True if it has been started, otherwise false.
  93858. */
  93859. isStarted(): boolean;
  93860. /**
  93861. * Animates the particle system for this frame.
  93862. */
  93863. animate(): void;
  93864. /**
  93865. * Renders the particle system in its current state.
  93866. * @returns the current number of particles
  93867. */
  93868. render(): number;
  93869. /**
  93870. * Dispose the particle system and frees its associated resources.
  93871. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93872. */
  93873. dispose(disposeTexture?: boolean): void;
  93874. /**
  93875. * An event triggered when the system is disposed
  93876. */
  93877. onDisposeObservable: Observable<IParticleSystem>;
  93878. /**
  93879. * Clones the particle system.
  93880. * @param name The name of the cloned object
  93881. * @param newEmitter The new emitter to use
  93882. * @returns the cloned particle system
  93883. */
  93884. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  93885. /**
  93886. * Serializes the particle system to a JSON object
  93887. * @param serializeTexture defines if the texture must be serialized as well
  93888. * @returns the JSON object
  93889. */
  93890. serialize(serializeTexture: boolean): any;
  93891. /**
  93892. * Rebuild the particle system
  93893. */
  93894. rebuild(): void;
  93895. /** Force the system to rebuild all gradients that need to be resync */
  93896. forceRefreshGradients(): void;
  93897. /**
  93898. * Starts the particle system and begins to emit
  93899. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  93900. */
  93901. start(delay?: number): void;
  93902. /**
  93903. * Stops the particle system.
  93904. */
  93905. stop(): void;
  93906. /**
  93907. * Remove all active particles
  93908. */
  93909. reset(): void;
  93910. /**
  93911. * Gets a boolean indicating that the system is stopping
  93912. * @returns true if the system is currently stopping
  93913. */
  93914. isStopping(): boolean;
  93915. /**
  93916. * Is this system ready to be used/rendered
  93917. * @return true if the system is ready
  93918. */
  93919. isReady(): boolean;
  93920. /**
  93921. * Returns the string "ParticleSystem"
  93922. * @returns a string containing the class name
  93923. */
  93924. getClassName(): string;
  93925. /**
  93926. * Gets the custom effect used to render the particles
  93927. * @param blendMode Blend mode for which the effect should be retrieved
  93928. * @returns The effect
  93929. */
  93930. getCustomEffect(blendMode: number): Nullable<Effect>;
  93931. /**
  93932. * Sets the custom effect used to render the particles
  93933. * @param effect The effect to set
  93934. * @param blendMode Blend mode for which the effect should be set
  93935. */
  93936. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  93937. /**
  93938. * Fill the defines array according to the current settings of the particle system
  93939. * @param defines Array to be updated
  93940. * @param blendMode blend mode to take into account when updating the array
  93941. */
  93942. fillDefines(defines: Array<string>, blendMode: number): void;
  93943. /**
  93944. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  93945. * @param uniforms Uniforms array to fill
  93946. * @param attributes Attributes array to fill
  93947. * @param samplers Samplers array to fill
  93948. */
  93949. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  93950. /**
  93951. * Observable that will be called just before the particles are drawn
  93952. */
  93953. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  93954. /**
  93955. * Gets the name of the particle vertex shader
  93956. */
  93957. vertexShaderName: string;
  93958. /**
  93959. * Adds a new color gradient
  93960. * @param gradient defines the gradient to use (between 0 and 1)
  93961. * @param color1 defines the color to affect to the specified gradient
  93962. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  93963. * @returns the current particle system
  93964. */
  93965. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  93966. /**
  93967. * Remove a specific color gradient
  93968. * @param gradient defines the gradient to remove
  93969. * @returns the current particle system
  93970. */
  93971. removeColorGradient(gradient: number): IParticleSystem;
  93972. /**
  93973. * Adds a new size gradient
  93974. * @param gradient defines the gradient to use (between 0 and 1)
  93975. * @param factor defines the size factor to affect to the specified gradient
  93976. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93977. * @returns the current particle system
  93978. */
  93979. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93980. /**
  93981. * Remove a specific size gradient
  93982. * @param gradient defines the gradient to remove
  93983. * @returns the current particle system
  93984. */
  93985. removeSizeGradient(gradient: number): IParticleSystem;
  93986. /**
  93987. * Gets the current list of color gradients.
  93988. * You must use addColorGradient and removeColorGradient to udpate this list
  93989. * @returns the list of color gradients
  93990. */
  93991. getColorGradients(): Nullable<Array<ColorGradient>>;
  93992. /**
  93993. * Gets the current list of size gradients.
  93994. * You must use addSizeGradient and removeSizeGradient to udpate this list
  93995. * @returns the list of size gradients
  93996. */
  93997. getSizeGradients(): Nullable<Array<FactorGradient>>;
  93998. /**
  93999. * Gets the current list of angular speed gradients.
  94000. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  94001. * @returns the list of angular speed gradients
  94002. */
  94003. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  94004. /**
  94005. * Adds a new angular speed gradient
  94006. * @param gradient defines the gradient to use (between 0 and 1)
  94007. * @param factor defines the angular speed to affect to the specified gradient
  94008. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94009. * @returns the current particle system
  94010. */
  94011. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94012. /**
  94013. * Remove a specific angular speed gradient
  94014. * @param gradient defines the gradient to remove
  94015. * @returns the current particle system
  94016. */
  94017. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  94018. /**
  94019. * Gets the current list of velocity gradients.
  94020. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  94021. * @returns the list of velocity gradients
  94022. */
  94023. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  94024. /**
  94025. * Adds a new velocity gradient
  94026. * @param gradient defines the gradient to use (between 0 and 1)
  94027. * @param factor defines the velocity to affect to the specified gradient
  94028. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94029. * @returns the current particle system
  94030. */
  94031. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94032. /**
  94033. * Remove a specific velocity gradient
  94034. * @param gradient defines the gradient to remove
  94035. * @returns the current particle system
  94036. */
  94037. removeVelocityGradient(gradient: number): IParticleSystem;
  94038. /**
  94039. * Gets the current list of limit velocity gradients.
  94040. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  94041. * @returns the list of limit velocity gradients
  94042. */
  94043. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  94044. /**
  94045. * Adds a new limit velocity gradient
  94046. * @param gradient defines the gradient to use (between 0 and 1)
  94047. * @param factor defines the limit velocity to affect to the specified gradient
  94048. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94049. * @returns the current particle system
  94050. */
  94051. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94052. /**
  94053. * Remove a specific limit velocity gradient
  94054. * @param gradient defines the gradient to remove
  94055. * @returns the current particle system
  94056. */
  94057. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  94058. /**
  94059. * Adds a new drag gradient
  94060. * @param gradient defines the gradient to use (between 0 and 1)
  94061. * @param factor defines the drag to affect to the specified gradient
  94062. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94063. * @returns the current particle system
  94064. */
  94065. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94066. /**
  94067. * Remove a specific drag gradient
  94068. * @param gradient defines the gradient to remove
  94069. * @returns the current particle system
  94070. */
  94071. removeDragGradient(gradient: number): IParticleSystem;
  94072. /**
  94073. * Gets the current list of drag gradients.
  94074. * You must use addDragGradient and removeDragGradient to udpate this list
  94075. * @returns the list of drag gradients
  94076. */
  94077. getDragGradients(): Nullable<Array<FactorGradient>>;
  94078. /**
  94079. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  94080. * @param gradient defines the gradient to use (between 0 and 1)
  94081. * @param factor defines the emit rate to affect to the specified gradient
  94082. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94083. * @returns the current particle system
  94084. */
  94085. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94086. /**
  94087. * Remove a specific emit rate gradient
  94088. * @param gradient defines the gradient to remove
  94089. * @returns the current particle system
  94090. */
  94091. removeEmitRateGradient(gradient: number): IParticleSystem;
  94092. /**
  94093. * Gets the current list of emit rate gradients.
  94094. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  94095. * @returns the list of emit rate gradients
  94096. */
  94097. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  94098. /**
  94099. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  94100. * @param gradient defines the gradient to use (between 0 and 1)
  94101. * @param factor defines the start size to affect to the specified gradient
  94102. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94103. * @returns the current particle system
  94104. */
  94105. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94106. /**
  94107. * Remove a specific start size gradient
  94108. * @param gradient defines the gradient to remove
  94109. * @returns the current particle system
  94110. */
  94111. removeStartSizeGradient(gradient: number): IParticleSystem;
  94112. /**
  94113. * Gets the current list of start size gradients.
  94114. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  94115. * @returns the list of start size gradients
  94116. */
  94117. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  94118. /**
  94119. * Adds a new life time gradient
  94120. * @param gradient defines the gradient to use (between 0 and 1)
  94121. * @param factor defines the life time factor to affect to the specified gradient
  94122. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94123. * @returns the current particle system
  94124. */
  94125. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94126. /**
  94127. * Remove a specific life time gradient
  94128. * @param gradient defines the gradient to remove
  94129. * @returns the current particle system
  94130. */
  94131. removeLifeTimeGradient(gradient: number): IParticleSystem;
  94132. /**
  94133. * Gets the current list of life time gradients.
  94134. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  94135. * @returns the list of life time gradients
  94136. */
  94137. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  94138. /**
  94139. * Gets the current list of color gradients.
  94140. * You must use addColorGradient and removeColorGradient to udpate this list
  94141. * @returns the list of color gradients
  94142. */
  94143. getColorGradients(): Nullable<Array<ColorGradient>>;
  94144. /**
  94145. * Adds a new ramp gradient used to remap particle colors
  94146. * @param gradient defines the gradient to use (between 0 and 1)
  94147. * @param color defines the color to affect to the specified gradient
  94148. * @returns the current particle system
  94149. */
  94150. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  94151. /**
  94152. * Gets the current list of ramp gradients.
  94153. * You must use addRampGradient and removeRampGradient to udpate this list
  94154. * @returns the list of ramp gradients
  94155. */
  94156. getRampGradients(): Nullable<Array<Color3Gradient>>;
  94157. /** Gets or sets a boolean indicating that ramp gradients must be used
  94158. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  94159. */
  94160. useRampGradients: boolean;
  94161. /**
  94162. * Adds a new color remap gradient
  94163. * @param gradient defines the gradient to use (between 0 and 1)
  94164. * @param min defines the color remap minimal range
  94165. * @param max defines the color remap maximal range
  94166. * @returns the current particle system
  94167. */
  94168. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94169. /**
  94170. * Gets the current list of color remap gradients.
  94171. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  94172. * @returns the list of color remap gradients
  94173. */
  94174. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  94175. /**
  94176. * Adds a new alpha remap gradient
  94177. * @param gradient defines the gradient to use (between 0 and 1)
  94178. * @param min defines the alpha remap minimal range
  94179. * @param max defines the alpha remap maximal range
  94180. * @returns the current particle system
  94181. */
  94182. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94183. /**
  94184. * Gets the current list of alpha remap gradients.
  94185. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  94186. * @returns the list of alpha remap gradients
  94187. */
  94188. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  94189. /**
  94190. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  94191. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94192. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94193. * @returns the emitter
  94194. */
  94195. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  94196. /**
  94197. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  94198. * @param radius The radius of the hemisphere to emit from
  94199. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94200. * @returns the emitter
  94201. */
  94202. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  94203. /**
  94204. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  94205. * @param radius The radius of the sphere to emit from
  94206. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94207. * @returns the emitter
  94208. */
  94209. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  94210. /**
  94211. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  94212. * @param radius The radius of the sphere to emit from
  94213. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  94214. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  94215. * @returns the emitter
  94216. */
  94217. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94218. /**
  94219. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  94220. * @param radius The radius of the emission cylinder
  94221. * @param height The height of the emission cylinder
  94222. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  94223. * @param directionRandomizer How much to randomize the particle direction [0-1]
  94224. * @returns the emitter
  94225. */
  94226. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  94227. /**
  94228. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  94229. * @param radius The radius of the cylinder to emit from
  94230. * @param height The height of the emission cylinder
  94231. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94232. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  94233. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  94234. * @returns the emitter
  94235. */
  94236. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94237. /**
  94238. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  94239. * @param radius The radius of the cone to emit from
  94240. * @param angle The base angle of the cone
  94241. * @returns the emitter
  94242. */
  94243. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  94244. /**
  94245. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  94246. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94247. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94248. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94249. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94250. * @returns the emitter
  94251. */
  94252. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  94253. /**
  94254. * Get hosting scene
  94255. * @returns the scene
  94256. */
  94257. getScene(): Nullable<Scene>;
  94258. }
  94259. }
  94260. declare module BABYLON {
  94261. /**
  94262. * 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.
  94263. * @see https://doc.babylonjs.com/how_to/transformnode
  94264. */
  94265. export class TransformNode extends Node {
  94266. /**
  94267. * Object will not rotate to face the camera
  94268. */
  94269. static BILLBOARDMODE_NONE: number;
  94270. /**
  94271. * Object will rotate to face the camera but only on the x axis
  94272. */
  94273. static BILLBOARDMODE_X: number;
  94274. /**
  94275. * Object will rotate to face the camera but only on the y axis
  94276. */
  94277. static BILLBOARDMODE_Y: number;
  94278. /**
  94279. * Object will rotate to face the camera but only on the z axis
  94280. */
  94281. static BILLBOARDMODE_Z: number;
  94282. /**
  94283. * Object will rotate to face the camera
  94284. */
  94285. static BILLBOARDMODE_ALL: number;
  94286. /**
  94287. * Object will rotate to face the camera's position instead of orientation
  94288. */
  94289. static BILLBOARDMODE_USE_POSITION: number;
  94290. private static _TmpRotation;
  94291. private static _TmpScaling;
  94292. private static _TmpTranslation;
  94293. private _forward;
  94294. private _forwardInverted;
  94295. private _up;
  94296. private _right;
  94297. private _rightInverted;
  94298. private _position;
  94299. private _rotation;
  94300. private _rotationQuaternion;
  94301. protected _scaling: Vector3;
  94302. protected _isDirty: boolean;
  94303. private _transformToBoneReferal;
  94304. private _isAbsoluteSynced;
  94305. private _billboardMode;
  94306. /**
  94307. * Gets or sets the billboard mode. Default is 0.
  94308. *
  94309. * | Value | Type | Description |
  94310. * | --- | --- | --- |
  94311. * | 0 | BILLBOARDMODE_NONE | |
  94312. * | 1 | BILLBOARDMODE_X | |
  94313. * | 2 | BILLBOARDMODE_Y | |
  94314. * | 4 | BILLBOARDMODE_Z | |
  94315. * | 7 | BILLBOARDMODE_ALL | |
  94316. *
  94317. */
  94318. get billboardMode(): number;
  94319. set billboardMode(value: number);
  94320. private _preserveParentRotationForBillboard;
  94321. /**
  94322. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  94323. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  94324. */
  94325. get preserveParentRotationForBillboard(): boolean;
  94326. set preserveParentRotationForBillboard(value: boolean);
  94327. /**
  94328. * 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
  94329. */
  94330. scalingDeterminant: number;
  94331. private _infiniteDistance;
  94332. /**
  94333. * Gets or sets the distance of the object to max, often used by skybox
  94334. */
  94335. get infiniteDistance(): boolean;
  94336. set infiniteDistance(value: boolean);
  94337. /**
  94338. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  94339. * By default the system will update normals to compensate
  94340. */
  94341. ignoreNonUniformScaling: boolean;
  94342. /**
  94343. * 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
  94344. */
  94345. reIntegrateRotationIntoRotationQuaternion: boolean;
  94346. /** @hidden */
  94347. _poseMatrix: Nullable<Matrix>;
  94348. /** @hidden */
  94349. _localMatrix: Matrix;
  94350. private _usePivotMatrix;
  94351. private _absolutePosition;
  94352. private _absoluteScaling;
  94353. private _absoluteRotationQuaternion;
  94354. private _pivotMatrix;
  94355. private _pivotMatrixInverse;
  94356. protected _postMultiplyPivotMatrix: boolean;
  94357. protected _isWorldMatrixFrozen: boolean;
  94358. /** @hidden */
  94359. _indexInSceneTransformNodesArray: number;
  94360. /**
  94361. * An event triggered after the world matrix is updated
  94362. */
  94363. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  94364. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  94365. /**
  94366. * Gets a string identifying the name of the class
  94367. * @returns "TransformNode" string
  94368. */
  94369. getClassName(): string;
  94370. /**
  94371. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  94372. */
  94373. get position(): Vector3;
  94374. set position(newPosition: Vector3);
  94375. /**
  94376. * 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)).
  94377. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  94378. */
  94379. get rotation(): Vector3;
  94380. set rotation(newRotation: Vector3);
  94381. /**
  94382. * 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)).
  94383. */
  94384. get scaling(): Vector3;
  94385. set scaling(newScaling: Vector3);
  94386. /**
  94387. * 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).
  94388. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  94389. */
  94390. get rotationQuaternion(): Nullable<Quaternion>;
  94391. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  94392. /**
  94393. * The forward direction of that transform in world space.
  94394. */
  94395. get forward(): Vector3;
  94396. /**
  94397. * The up direction of that transform in world space.
  94398. */
  94399. get up(): Vector3;
  94400. /**
  94401. * The right direction of that transform in world space.
  94402. */
  94403. get right(): Vector3;
  94404. /**
  94405. * Copies the parameter passed Matrix into the mesh Pose matrix.
  94406. * @param matrix the matrix to copy the pose from
  94407. * @returns this TransformNode.
  94408. */
  94409. updatePoseMatrix(matrix: Matrix): TransformNode;
  94410. /**
  94411. * Returns the mesh Pose matrix.
  94412. * @returns the pose matrix
  94413. */
  94414. getPoseMatrix(): Matrix;
  94415. /** @hidden */
  94416. _isSynchronized(): boolean;
  94417. /** @hidden */
  94418. _initCache(): void;
  94419. /**
  94420. * Flag the transform node as dirty (Forcing it to update everything)
  94421. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  94422. * @returns this transform node
  94423. */
  94424. markAsDirty(property: string): TransformNode;
  94425. /**
  94426. * Returns the current mesh absolute position.
  94427. * Returns a Vector3.
  94428. */
  94429. get absolutePosition(): Vector3;
  94430. /**
  94431. * Returns the current mesh absolute scaling.
  94432. * Returns a Vector3.
  94433. */
  94434. get absoluteScaling(): Vector3;
  94435. /**
  94436. * Returns the current mesh absolute rotation.
  94437. * Returns a Quaternion.
  94438. */
  94439. get absoluteRotationQuaternion(): Quaternion;
  94440. /**
  94441. * Sets a new matrix to apply before all other transformation
  94442. * @param matrix defines the transform matrix
  94443. * @returns the current TransformNode
  94444. */
  94445. setPreTransformMatrix(matrix: Matrix): TransformNode;
  94446. /**
  94447. * Sets a new pivot matrix to the current node
  94448. * @param matrix defines the new pivot matrix to use
  94449. * @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
  94450. * @returns the current TransformNode
  94451. */
  94452. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  94453. /**
  94454. * Returns the mesh pivot matrix.
  94455. * Default : Identity.
  94456. * @returns the matrix
  94457. */
  94458. getPivotMatrix(): Matrix;
  94459. /**
  94460. * Instantiate (when possible) or clone that node with its hierarchy
  94461. * @param newParent defines the new parent to use for the instance (or clone)
  94462. * @param options defines options to configure how copy is done
  94463. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  94464. * @returns an instance (or a clone) of the current node with its hiearchy
  94465. */
  94466. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  94467. doNotInstantiate: boolean;
  94468. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  94469. /**
  94470. * Prevents the World matrix to be computed any longer
  94471. * @param newWorldMatrix defines an optional matrix to use as world matrix
  94472. * @returns the TransformNode.
  94473. */
  94474. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  94475. /**
  94476. * Allows back the World matrix computation.
  94477. * @returns the TransformNode.
  94478. */
  94479. unfreezeWorldMatrix(): this;
  94480. /**
  94481. * True if the World matrix has been frozen.
  94482. */
  94483. get isWorldMatrixFrozen(): boolean;
  94484. /**
  94485. * Retuns the mesh absolute position in the World.
  94486. * @returns a Vector3.
  94487. */
  94488. getAbsolutePosition(): Vector3;
  94489. /**
  94490. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  94491. * @param absolutePosition the absolute position to set
  94492. * @returns the TransformNode.
  94493. */
  94494. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  94495. /**
  94496. * Sets the mesh position in its local space.
  94497. * @param vector3 the position to set in localspace
  94498. * @returns the TransformNode.
  94499. */
  94500. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  94501. /**
  94502. * Returns the mesh position in the local space from the current World matrix values.
  94503. * @returns a new Vector3.
  94504. */
  94505. getPositionExpressedInLocalSpace(): Vector3;
  94506. /**
  94507. * Translates the mesh along the passed Vector3 in its local space.
  94508. * @param vector3 the distance to translate in localspace
  94509. * @returns the TransformNode.
  94510. */
  94511. locallyTranslate(vector3: Vector3): TransformNode;
  94512. private static _lookAtVectorCache;
  94513. /**
  94514. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  94515. * @param targetPoint the position (must be in same space as current mesh) to look at
  94516. * @param yawCor optional yaw (y-axis) correction in radians
  94517. * @param pitchCor optional pitch (x-axis) correction in radians
  94518. * @param rollCor optional roll (z-axis) correction in radians
  94519. * @param space the choosen space of the target
  94520. * @returns the TransformNode.
  94521. */
  94522. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  94523. /**
  94524. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94525. * This Vector3 is expressed in the World space.
  94526. * @param localAxis axis to rotate
  94527. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94528. */
  94529. getDirection(localAxis: Vector3): Vector3;
  94530. /**
  94531. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  94532. * localAxis is expressed in the mesh local space.
  94533. * result is computed in the Wordl space from the mesh World matrix.
  94534. * @param localAxis axis to rotate
  94535. * @param result the resulting transformnode
  94536. * @returns this TransformNode.
  94537. */
  94538. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  94539. /**
  94540. * Sets this transform node rotation to the given local axis.
  94541. * @param localAxis the axis in local space
  94542. * @param yawCor optional yaw (y-axis) correction in radians
  94543. * @param pitchCor optional pitch (x-axis) correction in radians
  94544. * @param rollCor optional roll (z-axis) correction in radians
  94545. * @returns this TransformNode
  94546. */
  94547. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  94548. /**
  94549. * Sets a new pivot point to the current node
  94550. * @param point defines the new pivot point to use
  94551. * @param space defines if the point is in world or local space (local by default)
  94552. * @returns the current TransformNode
  94553. */
  94554. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  94555. /**
  94556. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  94557. * @returns the pivot point
  94558. */
  94559. getPivotPoint(): Vector3;
  94560. /**
  94561. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  94562. * @param result the vector3 to store the result
  94563. * @returns this TransformNode.
  94564. */
  94565. getPivotPointToRef(result: Vector3): TransformNode;
  94566. /**
  94567. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  94568. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  94569. */
  94570. getAbsolutePivotPoint(): Vector3;
  94571. /**
  94572. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  94573. * @param result vector3 to store the result
  94574. * @returns this TransformNode.
  94575. */
  94576. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  94577. /**
  94578. * Defines the passed node as the parent of the current node.
  94579. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  94580. * @see https://doc.babylonjs.com/how_to/parenting
  94581. * @param node the node ot set as the parent
  94582. * @returns this TransformNode.
  94583. */
  94584. setParent(node: Nullable<Node>): TransformNode;
  94585. private _nonUniformScaling;
  94586. /**
  94587. * True if the scaling property of this object is non uniform eg. (1,2,1)
  94588. */
  94589. get nonUniformScaling(): boolean;
  94590. /** @hidden */
  94591. _updateNonUniformScalingState(value: boolean): boolean;
  94592. /**
  94593. * Attach the current TransformNode to another TransformNode associated with a bone
  94594. * @param bone Bone affecting the TransformNode
  94595. * @param affectedTransformNode TransformNode associated with the bone
  94596. * @returns this object
  94597. */
  94598. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  94599. /**
  94600. * Detach the transform node if its associated with a bone
  94601. * @returns this object
  94602. */
  94603. detachFromBone(): TransformNode;
  94604. private static _rotationAxisCache;
  94605. /**
  94606. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  94607. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94608. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94609. * The passed axis is also normalized.
  94610. * @param axis the axis to rotate around
  94611. * @param amount the amount to rotate in radians
  94612. * @param space Space to rotate in (Default: local)
  94613. * @returns the TransformNode.
  94614. */
  94615. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  94616. /**
  94617. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  94618. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94619. * The passed axis is also normalized. .
  94620. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  94621. * @param point the point to rotate around
  94622. * @param axis the axis to rotate around
  94623. * @param amount the amount to rotate in radians
  94624. * @returns the TransformNode
  94625. */
  94626. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  94627. /**
  94628. * Translates the mesh along the axis vector for the passed distance in the given space.
  94629. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94630. * @param axis the axis to translate in
  94631. * @param distance the distance to translate
  94632. * @param space Space to rotate in (Default: local)
  94633. * @returns the TransformNode.
  94634. */
  94635. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  94636. /**
  94637. * Adds a rotation step to the mesh current rotation.
  94638. * x, y, z are Euler angles expressed in radians.
  94639. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  94640. * This means this rotation is made in the mesh local space only.
  94641. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  94642. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  94643. * ```javascript
  94644. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  94645. * ```
  94646. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  94647. * 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.
  94648. * @param x Rotation to add
  94649. * @param y Rotation to add
  94650. * @param z Rotation to add
  94651. * @returns the TransformNode.
  94652. */
  94653. addRotation(x: number, y: number, z: number): TransformNode;
  94654. /**
  94655. * @hidden
  94656. */
  94657. protected _getEffectiveParent(): Nullable<Node>;
  94658. /**
  94659. * Computes the world matrix of the node
  94660. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  94661. * @returns the world matrix
  94662. */
  94663. computeWorldMatrix(force?: boolean): Matrix;
  94664. /**
  94665. * Resets this nodeTransform's local matrix to Matrix.Identity().
  94666. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  94667. */
  94668. resetLocalMatrix(independentOfChildren?: boolean): void;
  94669. protected _afterComputeWorldMatrix(): void;
  94670. /**
  94671. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  94672. * @param func callback function to add
  94673. *
  94674. * @returns the TransformNode.
  94675. */
  94676. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94677. /**
  94678. * Removes a registered callback function.
  94679. * @param func callback function to remove
  94680. * @returns the TransformNode.
  94681. */
  94682. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94683. /**
  94684. * Gets the position of the current mesh in camera space
  94685. * @param camera defines the camera to use
  94686. * @returns a position
  94687. */
  94688. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  94689. /**
  94690. * Returns the distance from the mesh to the active camera
  94691. * @param camera defines the camera to use
  94692. * @returns the distance
  94693. */
  94694. getDistanceToCamera(camera?: Nullable<Camera>): number;
  94695. /**
  94696. * Clone the current transform node
  94697. * @param name Name of the new clone
  94698. * @param newParent New parent for the clone
  94699. * @param doNotCloneChildren Do not clone children hierarchy
  94700. * @returns the new transform node
  94701. */
  94702. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  94703. /**
  94704. * Serializes the objects information.
  94705. * @param currentSerializationObject defines the object to serialize in
  94706. * @returns the serialized object
  94707. */
  94708. serialize(currentSerializationObject?: any): any;
  94709. /**
  94710. * Returns a new TransformNode object parsed from the source provided.
  94711. * @param parsedTransformNode is the source.
  94712. * @param scene the scne the object belongs to
  94713. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  94714. * @returns a new TransformNode object parsed from the source provided.
  94715. */
  94716. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  94717. /**
  94718. * Get all child-transformNodes of this node
  94719. * @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
  94720. * @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
  94721. * @returns an array of TransformNode
  94722. */
  94723. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  94724. /**
  94725. * Releases resources associated with this transform node.
  94726. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94727. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94728. */
  94729. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94730. /**
  94731. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94732. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94733. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94734. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94735. * @returns the current mesh
  94736. */
  94737. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  94738. private _syncAbsoluteScalingAndRotation;
  94739. }
  94740. }
  94741. declare module BABYLON {
  94742. /**
  94743. * Class used to override all child animations of a given target
  94744. */
  94745. export class AnimationPropertiesOverride {
  94746. /**
  94747. * Gets or sets a value indicating if animation blending must be used
  94748. */
  94749. enableBlending: boolean;
  94750. /**
  94751. * Gets or sets the blending speed to use when enableBlending is true
  94752. */
  94753. blendingSpeed: number;
  94754. /**
  94755. * Gets or sets the default loop mode to use
  94756. */
  94757. loopMode: number;
  94758. }
  94759. }
  94760. declare module BABYLON {
  94761. /**
  94762. * Class used to store bone information
  94763. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94764. */
  94765. export class Bone extends Node {
  94766. /**
  94767. * defines the bone name
  94768. */
  94769. name: string;
  94770. private static _tmpVecs;
  94771. private static _tmpQuat;
  94772. private static _tmpMats;
  94773. /**
  94774. * Gets the list of child bones
  94775. */
  94776. children: Bone[];
  94777. /** Gets the animations associated with this bone */
  94778. animations: Animation[];
  94779. /**
  94780. * Gets or sets bone length
  94781. */
  94782. length: number;
  94783. /**
  94784. * @hidden Internal only
  94785. * Set this value to map this bone to a different index in the transform matrices
  94786. * Set this value to -1 to exclude the bone from the transform matrices
  94787. */
  94788. _index: Nullable<number>;
  94789. private _skeleton;
  94790. private _localMatrix;
  94791. private _restPose;
  94792. private _bindPose;
  94793. private _baseMatrix;
  94794. private _absoluteTransform;
  94795. private _invertedAbsoluteTransform;
  94796. private _parent;
  94797. private _scalingDeterminant;
  94798. private _worldTransform;
  94799. private _localScaling;
  94800. private _localRotation;
  94801. private _localPosition;
  94802. private _needToDecompose;
  94803. private _needToCompose;
  94804. /** @hidden */
  94805. _linkedTransformNode: Nullable<TransformNode>;
  94806. /** @hidden */
  94807. _waitingTransformNodeId: Nullable<string>;
  94808. /** @hidden */
  94809. get _matrix(): Matrix;
  94810. /** @hidden */
  94811. set _matrix(value: Matrix);
  94812. /**
  94813. * Create a new bone
  94814. * @param name defines the bone name
  94815. * @param skeleton defines the parent skeleton
  94816. * @param parentBone defines the parent (can be null if the bone is the root)
  94817. * @param localMatrix defines the local matrix
  94818. * @param restPose defines the rest pose matrix
  94819. * @param baseMatrix defines the base matrix
  94820. * @param index defines index of the bone in the hiearchy
  94821. */
  94822. constructor(
  94823. /**
  94824. * defines the bone name
  94825. */
  94826. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  94827. /**
  94828. * Gets the current object class name.
  94829. * @return the class name
  94830. */
  94831. getClassName(): string;
  94832. /**
  94833. * Gets the parent skeleton
  94834. * @returns a skeleton
  94835. */
  94836. getSkeleton(): Skeleton;
  94837. /**
  94838. * Gets parent bone
  94839. * @returns a bone or null if the bone is the root of the bone hierarchy
  94840. */
  94841. getParent(): Nullable<Bone>;
  94842. /**
  94843. * Returns an array containing the root bones
  94844. * @returns an array containing the root bones
  94845. */
  94846. getChildren(): Array<Bone>;
  94847. /**
  94848. * Gets the node index in matrix array generated for rendering
  94849. * @returns the node index
  94850. */
  94851. getIndex(): number;
  94852. /**
  94853. * Sets the parent bone
  94854. * @param parent defines the parent (can be null if the bone is the root)
  94855. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94856. */
  94857. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  94858. /**
  94859. * Gets the local matrix
  94860. * @returns a matrix
  94861. */
  94862. getLocalMatrix(): Matrix;
  94863. /**
  94864. * Gets the base matrix (initial matrix which remains unchanged)
  94865. * @returns a matrix
  94866. */
  94867. getBaseMatrix(): Matrix;
  94868. /**
  94869. * Gets the rest pose matrix
  94870. * @returns a matrix
  94871. */
  94872. getRestPose(): Matrix;
  94873. /**
  94874. * Sets the rest pose matrix
  94875. * @param matrix the local-space rest pose to set for this bone
  94876. */
  94877. setRestPose(matrix: Matrix): void;
  94878. /**
  94879. * Gets the bind pose matrix
  94880. * @returns the bind pose matrix
  94881. */
  94882. getBindPose(): Matrix;
  94883. /**
  94884. * Sets the bind pose matrix
  94885. * @param matrix the local-space bind pose to set for this bone
  94886. */
  94887. setBindPose(matrix: Matrix): void;
  94888. /**
  94889. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  94890. */
  94891. getWorldMatrix(): Matrix;
  94892. /**
  94893. * Sets the local matrix to rest pose matrix
  94894. */
  94895. returnToRest(): void;
  94896. /**
  94897. * Gets the inverse of the absolute transform matrix.
  94898. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  94899. * @returns a matrix
  94900. */
  94901. getInvertedAbsoluteTransform(): Matrix;
  94902. /**
  94903. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  94904. * @returns a matrix
  94905. */
  94906. getAbsoluteTransform(): Matrix;
  94907. /**
  94908. * Links with the given transform node.
  94909. * The local matrix of this bone is copied from the transform node every frame.
  94910. * @param transformNode defines the transform node to link to
  94911. */
  94912. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  94913. /**
  94914. * Gets the node used to drive the bone's transformation
  94915. * @returns a transform node or null
  94916. */
  94917. getTransformNode(): Nullable<TransformNode>;
  94918. /** Gets or sets current position (in local space) */
  94919. get position(): Vector3;
  94920. set position(newPosition: Vector3);
  94921. /** Gets or sets current rotation (in local space) */
  94922. get rotation(): Vector3;
  94923. set rotation(newRotation: Vector3);
  94924. /** Gets or sets current rotation quaternion (in local space) */
  94925. get rotationQuaternion(): Quaternion;
  94926. set rotationQuaternion(newRotation: Quaternion);
  94927. /** Gets or sets current scaling (in local space) */
  94928. get scaling(): Vector3;
  94929. set scaling(newScaling: Vector3);
  94930. /**
  94931. * Gets the animation properties override
  94932. */
  94933. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  94934. private _decompose;
  94935. private _compose;
  94936. /**
  94937. * Update the base and local matrices
  94938. * @param matrix defines the new base or local matrix
  94939. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94940. * @param updateLocalMatrix defines if the local matrix should be updated
  94941. */
  94942. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  94943. /** @hidden */
  94944. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  94945. /**
  94946. * Flag the bone as dirty (Forcing it to update everything)
  94947. */
  94948. markAsDirty(): void;
  94949. /** @hidden */
  94950. _markAsDirtyAndCompose(): void;
  94951. private _markAsDirtyAndDecompose;
  94952. /**
  94953. * Translate the bone in local or world space
  94954. * @param vec The amount to translate the bone
  94955. * @param space The space that the translation is in
  94956. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94957. */
  94958. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94959. /**
  94960. * Set the postion of the bone in local or world space
  94961. * @param position The position to set the bone
  94962. * @param space The space that the position is in
  94963. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94964. */
  94965. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94966. /**
  94967. * Set the absolute position of the bone (world space)
  94968. * @param position The position to set the bone
  94969. * @param mesh The mesh that this bone is attached to
  94970. */
  94971. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  94972. /**
  94973. * Scale the bone on the x, y and z axes (in local space)
  94974. * @param x The amount to scale the bone on the x axis
  94975. * @param y The amount to scale the bone on the y axis
  94976. * @param z The amount to scale the bone on the z axis
  94977. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  94978. */
  94979. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  94980. /**
  94981. * Set the bone scaling in local space
  94982. * @param scale defines the scaling vector
  94983. */
  94984. setScale(scale: Vector3): void;
  94985. /**
  94986. * Gets the current scaling in local space
  94987. * @returns the current scaling vector
  94988. */
  94989. getScale(): Vector3;
  94990. /**
  94991. * Gets the current scaling in local space and stores it in a target vector
  94992. * @param result defines the target vector
  94993. */
  94994. getScaleToRef(result: Vector3): void;
  94995. /**
  94996. * Set the yaw, pitch, and roll of the bone in local or world space
  94997. * @param yaw The rotation of the bone on the y axis
  94998. * @param pitch The rotation of the bone on the x axis
  94999. * @param roll The rotation of the bone on the z axis
  95000. * @param space The space that the axes of rotation are in
  95001. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95002. */
  95003. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  95004. /**
  95005. * Add a rotation to the bone on an axis in local or world space
  95006. * @param axis The axis to rotate the bone on
  95007. * @param amount The amount to rotate the bone
  95008. * @param space The space that the axis is in
  95009. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95010. */
  95011. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  95012. /**
  95013. * Set the rotation of the bone to a particular axis angle in local or world space
  95014. * @param axis The axis to rotate the bone on
  95015. * @param angle The angle that the bone should be rotated to
  95016. * @param space The space that the axis is in
  95017. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95018. */
  95019. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  95020. /**
  95021. * Set the euler rotation of the bone in local of world space
  95022. * @param rotation The euler rotation that the bone should be set to
  95023. * @param space The space that the rotation is in
  95024. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95025. */
  95026. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95027. /**
  95028. * Set the quaternion rotation of the bone in local of world space
  95029. * @param quat The quaternion rotation that the bone should be set to
  95030. * @param space The space that the rotation is in
  95031. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95032. */
  95033. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  95034. /**
  95035. * Set the rotation matrix of the bone in local of world space
  95036. * @param rotMat The rotation matrix that the bone should be set to
  95037. * @param space The space that the rotation is in
  95038. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95039. */
  95040. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  95041. private _rotateWithMatrix;
  95042. private _getNegativeRotationToRef;
  95043. /**
  95044. * Get the position of the bone in local or world space
  95045. * @param space The space that the returned position is in
  95046. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95047. * @returns The position of the bone
  95048. */
  95049. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95050. /**
  95051. * Copy the position of the bone to a vector3 in local or world space
  95052. * @param space The space that the returned position is in
  95053. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95054. * @param result The vector3 to copy the position to
  95055. */
  95056. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  95057. /**
  95058. * Get the absolute position of the bone (world space)
  95059. * @param mesh The mesh that this bone is attached to
  95060. * @returns The absolute position of the bone
  95061. */
  95062. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  95063. /**
  95064. * Copy the absolute position of the bone (world space) to the result param
  95065. * @param mesh The mesh that this bone is attached to
  95066. * @param result The vector3 to copy the absolute position to
  95067. */
  95068. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  95069. /**
  95070. * Compute the absolute transforms of this bone and its children
  95071. */
  95072. computeAbsoluteTransforms(): void;
  95073. /**
  95074. * Get the world direction from an axis that is in the local space of the bone
  95075. * @param localAxis The local direction that is used to compute the world direction
  95076. * @param mesh The mesh that this bone is attached to
  95077. * @returns The world direction
  95078. */
  95079. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95080. /**
  95081. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  95082. * @param localAxis The local direction that is used to compute the world direction
  95083. * @param mesh The mesh that this bone is attached to
  95084. * @param result The vector3 that the world direction will be copied to
  95085. */
  95086. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95087. /**
  95088. * Get the euler rotation of the bone in 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. * @returns The euler rotation
  95092. */
  95093. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95094. /**
  95095. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  95096. * @param space The space that the rotation should be in
  95097. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95098. * @param result The vector3 that the rotation should be copied to
  95099. */
  95100. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95101. /**
  95102. * Get the quaternion rotation of the bone in either local or world space
  95103. * @param space The space that the rotation should be in
  95104. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95105. * @returns The quaternion rotation
  95106. */
  95107. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  95108. /**
  95109. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  95110. * @param space The space that the rotation should be in
  95111. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95112. * @param result The quaternion that the rotation should be copied to
  95113. */
  95114. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  95115. /**
  95116. * Get the rotation matrix of the bone in local or world space
  95117. * @param space The space that the rotation should be in
  95118. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95119. * @returns The rotation matrix
  95120. */
  95121. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  95122. /**
  95123. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  95124. * @param space The space that the rotation should be in
  95125. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95126. * @param result The quaternion that the rotation should be copied to
  95127. */
  95128. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  95129. /**
  95130. * Get the world position of a point that is in the local space of the bone
  95131. * @param position The local position
  95132. * @param mesh The mesh that this bone is attached to
  95133. * @returns The world position
  95134. */
  95135. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95136. /**
  95137. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  95138. * @param position The local position
  95139. * @param mesh The mesh that this bone is attached to
  95140. * @param result The vector3 that the world position should be copied to
  95141. */
  95142. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95143. /**
  95144. * Get the local position of a point that is in world space
  95145. * @param position The world position
  95146. * @param mesh The mesh that this bone is attached to
  95147. * @returns The local position
  95148. */
  95149. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95150. /**
  95151. * Get the local position of a point that is in world space and copy it to the result param
  95152. * @param position The world position
  95153. * @param mesh The mesh that this bone is attached to
  95154. * @param result The vector3 that the local position should be copied to
  95155. */
  95156. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95157. }
  95158. }
  95159. declare module BABYLON {
  95160. /**
  95161. * Defines a runtime animation
  95162. */
  95163. export class RuntimeAnimation {
  95164. private _events;
  95165. /**
  95166. * The current frame of the runtime animation
  95167. */
  95168. private _currentFrame;
  95169. /**
  95170. * The animation used by the runtime animation
  95171. */
  95172. private _animation;
  95173. /**
  95174. * The target of the runtime animation
  95175. */
  95176. private _target;
  95177. /**
  95178. * The initiating animatable
  95179. */
  95180. private _host;
  95181. /**
  95182. * The original value of the runtime animation
  95183. */
  95184. private _originalValue;
  95185. /**
  95186. * The original blend value of the runtime animation
  95187. */
  95188. private _originalBlendValue;
  95189. /**
  95190. * The offsets cache of the runtime animation
  95191. */
  95192. private _offsetsCache;
  95193. /**
  95194. * The high limits cache of the runtime animation
  95195. */
  95196. private _highLimitsCache;
  95197. /**
  95198. * Specifies if the runtime animation has been stopped
  95199. */
  95200. private _stopped;
  95201. /**
  95202. * The blending factor of the runtime animation
  95203. */
  95204. private _blendingFactor;
  95205. /**
  95206. * The BabylonJS scene
  95207. */
  95208. private _scene;
  95209. /**
  95210. * The current value of the runtime animation
  95211. */
  95212. private _currentValue;
  95213. /** @hidden */
  95214. _animationState: _IAnimationState;
  95215. /**
  95216. * The active target of the runtime animation
  95217. */
  95218. private _activeTargets;
  95219. private _currentActiveTarget;
  95220. private _directTarget;
  95221. /**
  95222. * The target path of the runtime animation
  95223. */
  95224. private _targetPath;
  95225. /**
  95226. * The weight of the runtime animation
  95227. */
  95228. private _weight;
  95229. /**
  95230. * The ratio offset of the runtime animation
  95231. */
  95232. private _ratioOffset;
  95233. /**
  95234. * The previous delay of the runtime animation
  95235. */
  95236. private _previousDelay;
  95237. /**
  95238. * The previous ratio of the runtime animation
  95239. */
  95240. private _previousRatio;
  95241. private _enableBlending;
  95242. private _keys;
  95243. private _minFrame;
  95244. private _maxFrame;
  95245. private _minValue;
  95246. private _maxValue;
  95247. private _targetIsArray;
  95248. /**
  95249. * Gets the current frame of the runtime animation
  95250. */
  95251. get currentFrame(): number;
  95252. /**
  95253. * Gets the weight of the runtime animation
  95254. */
  95255. get weight(): number;
  95256. /**
  95257. * Gets the current value of the runtime animation
  95258. */
  95259. get currentValue(): any;
  95260. /**
  95261. * Gets the target path of the runtime animation
  95262. */
  95263. get targetPath(): string;
  95264. /**
  95265. * Gets the actual target of the runtime animation
  95266. */
  95267. get target(): any;
  95268. /**
  95269. * Gets the additive state of the runtime animation
  95270. */
  95271. get isAdditive(): boolean;
  95272. /** @hidden */
  95273. _onLoop: () => void;
  95274. /**
  95275. * Create a new RuntimeAnimation object
  95276. * @param target defines the target of the animation
  95277. * @param animation defines the source animation object
  95278. * @param scene defines the hosting scene
  95279. * @param host defines the initiating Animatable
  95280. */
  95281. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  95282. private _preparePath;
  95283. /**
  95284. * Gets the animation from the runtime animation
  95285. */
  95286. get animation(): Animation;
  95287. /**
  95288. * Resets the runtime animation to the beginning
  95289. * @param restoreOriginal defines whether to restore the target property to the original value
  95290. */
  95291. reset(restoreOriginal?: boolean): void;
  95292. /**
  95293. * Specifies if the runtime animation is stopped
  95294. * @returns Boolean specifying if the runtime animation is stopped
  95295. */
  95296. isStopped(): boolean;
  95297. /**
  95298. * Disposes of the runtime animation
  95299. */
  95300. dispose(): void;
  95301. /**
  95302. * Apply the interpolated value to the target
  95303. * @param currentValue defines the value computed by the animation
  95304. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  95305. */
  95306. setValue(currentValue: any, weight: number): void;
  95307. private _getOriginalValues;
  95308. private _setValue;
  95309. /**
  95310. * Gets the loop pmode of the runtime animation
  95311. * @returns Loop Mode
  95312. */
  95313. private _getCorrectLoopMode;
  95314. /**
  95315. * Move the current animation to a given frame
  95316. * @param frame defines the frame to move to
  95317. */
  95318. goToFrame(frame: number): void;
  95319. /**
  95320. * @hidden Internal use only
  95321. */
  95322. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  95323. /**
  95324. * Execute the current animation
  95325. * @param delay defines the delay to add to the current frame
  95326. * @param from defines the lower bound of the animation range
  95327. * @param to defines the upper bound of the animation range
  95328. * @param loop defines if the current animation must loop
  95329. * @param speedRatio defines the current speed ratio
  95330. * @param weight defines the weight of the animation (default is -1 so no weight)
  95331. * @param onLoop optional callback called when animation loops
  95332. * @returns a boolean indicating if the animation is running
  95333. */
  95334. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  95335. }
  95336. }
  95337. declare module BABYLON {
  95338. /**
  95339. * Class used to store an actual running animation
  95340. */
  95341. export class Animatable {
  95342. /** defines the target object */
  95343. target: any;
  95344. /** defines the starting frame number (default is 0) */
  95345. fromFrame: number;
  95346. /** defines the ending frame number (default is 100) */
  95347. toFrame: number;
  95348. /** defines if the animation must loop (default is false) */
  95349. loopAnimation: boolean;
  95350. /** defines a callback to call when animation ends if it is not looping */
  95351. onAnimationEnd?: (() => void) | null | undefined;
  95352. /** defines a callback to call when animation loops */
  95353. onAnimationLoop?: (() => void) | null | undefined;
  95354. /** defines whether the animation should be evaluated additively */
  95355. isAdditive: boolean;
  95356. private _localDelayOffset;
  95357. private _pausedDelay;
  95358. private _runtimeAnimations;
  95359. private _paused;
  95360. private _scene;
  95361. private _speedRatio;
  95362. private _weight;
  95363. private _syncRoot;
  95364. /**
  95365. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  95366. * This will only apply for non looping animation (default is true)
  95367. */
  95368. disposeOnEnd: boolean;
  95369. /**
  95370. * Gets a boolean indicating if the animation has started
  95371. */
  95372. animationStarted: boolean;
  95373. /**
  95374. * Observer raised when the animation ends
  95375. */
  95376. onAnimationEndObservable: Observable<Animatable>;
  95377. /**
  95378. * Observer raised when the animation loops
  95379. */
  95380. onAnimationLoopObservable: Observable<Animatable>;
  95381. /**
  95382. * Gets the root Animatable used to synchronize and normalize animations
  95383. */
  95384. get syncRoot(): Nullable<Animatable>;
  95385. /**
  95386. * Gets the current frame of the first RuntimeAnimation
  95387. * Used to synchronize Animatables
  95388. */
  95389. get masterFrame(): number;
  95390. /**
  95391. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  95392. */
  95393. get weight(): number;
  95394. set weight(value: number);
  95395. /**
  95396. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  95397. */
  95398. get speedRatio(): number;
  95399. set speedRatio(value: number);
  95400. /**
  95401. * Creates a new Animatable
  95402. * @param scene defines the hosting scene
  95403. * @param target defines the target object
  95404. * @param fromFrame defines the starting frame number (default is 0)
  95405. * @param toFrame defines the ending frame number (default is 100)
  95406. * @param loopAnimation defines if the animation must loop (default is false)
  95407. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  95408. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  95409. * @param animations defines a group of animation to add to the new Animatable
  95410. * @param onAnimationLoop defines a callback to call when animation loops
  95411. * @param isAdditive defines whether the animation should be evaluated additively
  95412. */
  95413. constructor(scene: Scene,
  95414. /** defines the target object */
  95415. target: any,
  95416. /** defines the starting frame number (default is 0) */
  95417. fromFrame?: number,
  95418. /** defines the ending frame number (default is 100) */
  95419. toFrame?: number,
  95420. /** defines if the animation must loop (default is false) */
  95421. loopAnimation?: boolean, speedRatio?: number,
  95422. /** defines a callback to call when animation ends if it is not looping */
  95423. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  95424. /** defines a callback to call when animation loops */
  95425. onAnimationLoop?: (() => void) | null | undefined,
  95426. /** defines whether the animation should be evaluated additively */
  95427. isAdditive?: boolean);
  95428. /**
  95429. * Synchronize and normalize current Animatable with a source Animatable
  95430. * This is useful when using animation weights and when animations are not of the same length
  95431. * @param root defines the root Animatable to synchronize with
  95432. * @returns the current Animatable
  95433. */
  95434. syncWith(root: Animatable): Animatable;
  95435. /**
  95436. * Gets the list of runtime animations
  95437. * @returns an array of RuntimeAnimation
  95438. */
  95439. getAnimations(): RuntimeAnimation[];
  95440. /**
  95441. * Adds more animations to the current animatable
  95442. * @param target defines the target of the animations
  95443. * @param animations defines the new animations to add
  95444. */
  95445. appendAnimations(target: any, animations: Animation[]): void;
  95446. /**
  95447. * Gets the source animation for a specific property
  95448. * @param property defines the propertyu to look for
  95449. * @returns null or the source animation for the given property
  95450. */
  95451. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  95452. /**
  95453. * Gets the runtime animation for a specific property
  95454. * @param property defines the propertyu to look for
  95455. * @returns null or the runtime animation for the given property
  95456. */
  95457. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  95458. /**
  95459. * Resets the animatable to its original state
  95460. */
  95461. reset(): void;
  95462. /**
  95463. * Allows the animatable to blend with current running animations
  95464. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95465. * @param blendingSpeed defines the blending speed to use
  95466. */
  95467. enableBlending(blendingSpeed: number): void;
  95468. /**
  95469. * Disable animation blending
  95470. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95471. */
  95472. disableBlending(): void;
  95473. /**
  95474. * Jump directly to a given frame
  95475. * @param frame defines the frame to jump to
  95476. */
  95477. goToFrame(frame: number): void;
  95478. /**
  95479. * Pause the animation
  95480. */
  95481. pause(): void;
  95482. /**
  95483. * Restart the animation
  95484. */
  95485. restart(): void;
  95486. private _raiseOnAnimationEnd;
  95487. /**
  95488. * Stop and delete the current animation
  95489. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  95490. * @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)
  95491. */
  95492. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  95493. /**
  95494. * Wait asynchronously for the animation to end
  95495. * @returns a promise which will be fullfilled when the animation ends
  95496. */
  95497. waitAsync(): Promise<Animatable>;
  95498. /** @hidden */
  95499. _animate(delay: number): boolean;
  95500. }
  95501. interface Scene {
  95502. /** @hidden */
  95503. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  95504. /** @hidden */
  95505. _processLateAnimationBindingsForMatrices(holder: {
  95506. totalWeight: number;
  95507. totalAdditiveWeight: number;
  95508. animations: RuntimeAnimation[];
  95509. additiveAnimations: RuntimeAnimation[];
  95510. originalValue: Matrix;
  95511. }): any;
  95512. /** @hidden */
  95513. _processLateAnimationBindingsForQuaternions(holder: {
  95514. totalWeight: number;
  95515. totalAdditiveWeight: number;
  95516. animations: RuntimeAnimation[];
  95517. additiveAnimations: RuntimeAnimation[];
  95518. originalValue: Quaternion;
  95519. }, refQuaternion: Quaternion): Quaternion;
  95520. /** @hidden */
  95521. _processLateAnimationBindings(): void;
  95522. /**
  95523. * Will start the animation sequence of a given target
  95524. * @param target defines the target
  95525. * @param from defines from which frame should animation start
  95526. * @param to defines until which frame should animation run.
  95527. * @param weight defines the weight to apply to the animation (1.0 by default)
  95528. * @param loop defines if the animation loops
  95529. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95530. * @param onAnimationEnd defines the function to be executed when the animation ends
  95531. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95532. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95533. * @param onAnimationLoop defines the callback to call when an animation loops
  95534. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95535. * @returns the animatable object created for this animation
  95536. */
  95537. 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;
  95538. /**
  95539. * Will start the animation sequence of a given target
  95540. * @param target defines the target
  95541. * @param from defines from which frame should animation start
  95542. * @param to defines until which frame should animation run.
  95543. * @param loop defines if the animation loops
  95544. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95545. * @param onAnimationEnd defines the function to be executed when the animation ends
  95546. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95547. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95548. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  95549. * @param onAnimationLoop defines the callback to call when an animation loops
  95550. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95551. * @returns the animatable object created for this animation
  95552. */
  95553. 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;
  95554. /**
  95555. * Will start the animation sequence of a given target and its hierarchy
  95556. * @param target defines the target
  95557. * @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.
  95558. * @param from defines from which frame should animation start
  95559. * @param to defines until which frame should animation run.
  95560. * @param loop defines if the animation loops
  95561. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95562. * @param onAnimationEnd defines the function to be executed when the animation ends
  95563. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95564. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95565. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95566. * @param onAnimationLoop defines the callback to call when an animation loops
  95567. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95568. * @returns the list of created animatables
  95569. */
  95570. 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[];
  95571. /**
  95572. * Begin a new animation on a given node
  95573. * @param target defines the target where the animation will take place
  95574. * @param animations defines the list of animations to start
  95575. * @param from defines the initial value
  95576. * @param to defines the final value
  95577. * @param loop defines if you want animation to loop (off by default)
  95578. * @param speedRatio defines the speed ratio to apply to all animations
  95579. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95580. * @param onAnimationLoop defines the callback to call when an animation loops
  95581. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95582. * @returns the list of created animatables
  95583. */
  95584. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  95585. /**
  95586. * Begin a new animation on a given node and its hierarchy
  95587. * @param target defines the root node where the animation will take place
  95588. * @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.
  95589. * @param animations defines the list of animations to start
  95590. * @param from defines the initial value
  95591. * @param to defines the final value
  95592. * @param loop defines if you want animation to loop (off by default)
  95593. * @param speedRatio defines the speed ratio to apply to all animations
  95594. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95595. * @param onAnimationLoop defines the callback to call when an animation loops
  95596. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95597. * @returns the list of animatables created for all nodes
  95598. */
  95599. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  95600. /**
  95601. * Gets the animatable associated with a specific target
  95602. * @param target defines the target of the animatable
  95603. * @returns the required animatable if found
  95604. */
  95605. getAnimatableByTarget(target: any): Nullable<Animatable>;
  95606. /**
  95607. * Gets all animatables associated with a given target
  95608. * @param target defines the target to look animatables for
  95609. * @returns an array of Animatables
  95610. */
  95611. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  95612. /**
  95613. * Stops and removes all animations that have been applied to the scene
  95614. */
  95615. stopAllAnimations(): void;
  95616. /**
  95617. * Gets the current delta time used by animation engine
  95618. */
  95619. deltaTime: number;
  95620. }
  95621. interface Bone {
  95622. /**
  95623. * Copy an animation range from another bone
  95624. * @param source defines the source bone
  95625. * @param rangeName defines the range name to copy
  95626. * @param frameOffset defines the frame offset
  95627. * @param rescaleAsRequired defines if rescaling must be applied if required
  95628. * @param skelDimensionsRatio defines the scaling ratio
  95629. * @returns true if operation was successful
  95630. */
  95631. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  95632. }
  95633. }
  95634. declare module BABYLON {
  95635. /**
  95636. * Class used to handle skinning animations
  95637. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95638. */
  95639. export class Skeleton implements IAnimatable {
  95640. /** defines the skeleton name */
  95641. name: string;
  95642. /** defines the skeleton Id */
  95643. id: string;
  95644. /**
  95645. * Defines the list of child bones
  95646. */
  95647. bones: Bone[];
  95648. /**
  95649. * Defines an estimate of the dimension of the skeleton at rest
  95650. */
  95651. dimensionsAtRest: Vector3;
  95652. /**
  95653. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  95654. */
  95655. needInitialSkinMatrix: boolean;
  95656. /**
  95657. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  95658. */
  95659. overrideMesh: Nullable<AbstractMesh>;
  95660. /**
  95661. * Gets the list of animations attached to this skeleton
  95662. */
  95663. animations: Array<Animation>;
  95664. private _scene;
  95665. private _isDirty;
  95666. private _transformMatrices;
  95667. private _transformMatrixTexture;
  95668. private _meshesWithPoseMatrix;
  95669. private _animatables;
  95670. private _identity;
  95671. private _synchronizedWithMesh;
  95672. private _ranges;
  95673. private _lastAbsoluteTransformsUpdateId;
  95674. private _canUseTextureForBones;
  95675. private _uniqueId;
  95676. /** @hidden */
  95677. _numBonesWithLinkedTransformNode: number;
  95678. /** @hidden */
  95679. _hasWaitingData: Nullable<boolean>;
  95680. /** @hidden */
  95681. _waitingOverrideMeshId: Nullable<string>;
  95682. /**
  95683. * Specifies if the skeleton should be serialized
  95684. */
  95685. doNotSerialize: boolean;
  95686. private _useTextureToStoreBoneMatrices;
  95687. /**
  95688. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  95689. * Please note that this option is not available if the hardware does not support it
  95690. */
  95691. get useTextureToStoreBoneMatrices(): boolean;
  95692. set useTextureToStoreBoneMatrices(value: boolean);
  95693. private _animationPropertiesOverride;
  95694. /**
  95695. * Gets or sets the animation properties override
  95696. */
  95697. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95698. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  95699. /**
  95700. * List of inspectable custom properties (used by the Inspector)
  95701. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95702. */
  95703. inspectableCustomProperties: IInspectable[];
  95704. /**
  95705. * An observable triggered before computing the skeleton's matrices
  95706. */
  95707. onBeforeComputeObservable: Observable<Skeleton>;
  95708. /**
  95709. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  95710. */
  95711. get isUsingTextureForMatrices(): boolean;
  95712. /**
  95713. * Gets the unique ID of this skeleton
  95714. */
  95715. get uniqueId(): number;
  95716. /**
  95717. * Creates a new skeleton
  95718. * @param name defines the skeleton name
  95719. * @param id defines the skeleton Id
  95720. * @param scene defines the hosting scene
  95721. */
  95722. constructor(
  95723. /** defines the skeleton name */
  95724. name: string,
  95725. /** defines the skeleton Id */
  95726. id: string, scene: Scene);
  95727. /**
  95728. * Gets the current object class name.
  95729. * @return the class name
  95730. */
  95731. getClassName(): string;
  95732. /**
  95733. * Returns an array containing the root bones
  95734. * @returns an array containing the root bones
  95735. */
  95736. getChildren(): Array<Bone>;
  95737. /**
  95738. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  95739. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95740. * @returns a Float32Array containing matrices data
  95741. */
  95742. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  95743. /**
  95744. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  95745. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95746. * @returns a raw texture containing the data
  95747. */
  95748. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  95749. /**
  95750. * Gets the current hosting scene
  95751. * @returns a scene object
  95752. */
  95753. getScene(): Scene;
  95754. /**
  95755. * Gets a string representing the current skeleton data
  95756. * @param fullDetails defines a boolean indicating if we want a verbose version
  95757. * @returns a string representing the current skeleton data
  95758. */
  95759. toString(fullDetails?: boolean): string;
  95760. /**
  95761. * Get bone's index searching by name
  95762. * @param name defines bone's name to search for
  95763. * @return the indice of the bone. Returns -1 if not found
  95764. */
  95765. getBoneIndexByName(name: string): number;
  95766. /**
  95767. * Creater a new animation range
  95768. * @param name defines the name of the range
  95769. * @param from defines the start key
  95770. * @param to defines the end key
  95771. */
  95772. createAnimationRange(name: string, from: number, to: number): void;
  95773. /**
  95774. * Delete a specific animation range
  95775. * @param name defines the name of the range
  95776. * @param deleteFrames defines if frames must be removed as well
  95777. */
  95778. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95779. /**
  95780. * Gets a specific animation range
  95781. * @param name defines the name of the range to look for
  95782. * @returns the requested animation range or null if not found
  95783. */
  95784. getAnimationRange(name: string): Nullable<AnimationRange>;
  95785. /**
  95786. * Gets the list of all animation ranges defined on this skeleton
  95787. * @returns an array
  95788. */
  95789. getAnimationRanges(): Nullable<AnimationRange>[];
  95790. /**
  95791. * Copy animation range from a source skeleton.
  95792. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  95793. * @param source defines the source skeleton
  95794. * @param name defines the name of the range to copy
  95795. * @param rescaleAsRequired defines if rescaling must be applied if required
  95796. * @returns true if operation was successful
  95797. */
  95798. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  95799. /**
  95800. * Forces the skeleton to go to rest pose
  95801. */
  95802. returnToRest(): void;
  95803. private _getHighestAnimationFrame;
  95804. /**
  95805. * Begin a specific animation range
  95806. * @param name defines the name of the range to start
  95807. * @param loop defines if looping must be turned on (false by default)
  95808. * @param speedRatio defines the speed ratio to apply (1 by default)
  95809. * @param onAnimationEnd defines a callback which will be called when animation will end
  95810. * @returns a new animatable
  95811. */
  95812. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95813. /**
  95814. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  95815. * @param skeleton defines the Skeleton containing the animation range to convert
  95816. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  95817. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  95818. * @returns the original skeleton
  95819. */
  95820. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  95821. /** @hidden */
  95822. _markAsDirty(): void;
  95823. /** @hidden */
  95824. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95825. /** @hidden */
  95826. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95827. private _computeTransformMatrices;
  95828. /**
  95829. * Build all resources required to render a skeleton
  95830. */
  95831. prepare(): void;
  95832. /**
  95833. * Gets the list of animatables currently running for this skeleton
  95834. * @returns an array of animatables
  95835. */
  95836. getAnimatables(): IAnimatable[];
  95837. /**
  95838. * Clone the current skeleton
  95839. * @param name defines the name of the new skeleton
  95840. * @param id defines the id of the new skeleton
  95841. * @returns the new skeleton
  95842. */
  95843. clone(name: string, id?: string): Skeleton;
  95844. /**
  95845. * Enable animation blending for this skeleton
  95846. * @param blendingSpeed defines the blending speed to apply
  95847. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95848. */
  95849. enableBlending(blendingSpeed?: number): void;
  95850. /**
  95851. * Releases all resources associated with the current skeleton
  95852. */
  95853. dispose(): void;
  95854. /**
  95855. * Serialize the skeleton in a JSON object
  95856. * @returns a JSON object
  95857. */
  95858. serialize(): any;
  95859. /**
  95860. * Creates a new skeleton from serialized data
  95861. * @param parsedSkeleton defines the serialized data
  95862. * @param scene defines the hosting scene
  95863. * @returns a new skeleton
  95864. */
  95865. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  95866. /**
  95867. * Compute all node absolute transforms
  95868. * @param forceUpdate defines if computation must be done even if cache is up to date
  95869. */
  95870. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  95871. /**
  95872. * Gets the root pose matrix
  95873. * @returns a matrix
  95874. */
  95875. getPoseMatrix(): Nullable<Matrix>;
  95876. /**
  95877. * Sorts bones per internal index
  95878. */
  95879. sortBones(): void;
  95880. private _sortBones;
  95881. }
  95882. }
  95883. declare module BABYLON {
  95884. /**
  95885. * Creates an instance based on a source mesh.
  95886. */
  95887. export class InstancedMesh extends AbstractMesh {
  95888. private _sourceMesh;
  95889. private _currentLOD;
  95890. /** @hidden */
  95891. _indexInSourceMeshInstanceArray: number;
  95892. constructor(name: string, source: Mesh);
  95893. /**
  95894. * Returns the string "InstancedMesh".
  95895. */
  95896. getClassName(): string;
  95897. /** Gets the list of lights affecting that mesh */
  95898. get lightSources(): Light[];
  95899. _resyncLightSources(): void;
  95900. _resyncLightSource(light: Light): void;
  95901. _removeLightSource(light: Light, dispose: boolean): void;
  95902. /**
  95903. * If the source mesh receives shadows
  95904. */
  95905. get receiveShadows(): boolean;
  95906. /**
  95907. * The material of the source mesh
  95908. */
  95909. get material(): Nullable<Material>;
  95910. /**
  95911. * Visibility of the source mesh
  95912. */
  95913. get visibility(): number;
  95914. /**
  95915. * Skeleton of the source mesh
  95916. */
  95917. get skeleton(): Nullable<Skeleton>;
  95918. /**
  95919. * Rendering ground id of the source mesh
  95920. */
  95921. get renderingGroupId(): number;
  95922. set renderingGroupId(value: number);
  95923. /**
  95924. * Returns the total number of vertices (integer).
  95925. */
  95926. getTotalVertices(): number;
  95927. /**
  95928. * Returns a positive integer : the total number of indices in this mesh geometry.
  95929. * @returns the numner of indices or zero if the mesh has no geometry.
  95930. */
  95931. getTotalIndices(): number;
  95932. /**
  95933. * The source mesh of the instance
  95934. */
  95935. get sourceMesh(): Mesh;
  95936. /**
  95937. * Creates a new InstancedMesh object from the mesh model.
  95938. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  95939. * @param name defines the name of the new instance
  95940. * @returns a new InstancedMesh
  95941. */
  95942. createInstance(name: string): InstancedMesh;
  95943. /**
  95944. * Is this node ready to be used/rendered
  95945. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  95946. * @return {boolean} is it ready
  95947. */
  95948. isReady(completeCheck?: boolean): boolean;
  95949. /**
  95950. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  95951. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  95952. * @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.
  95953. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  95954. */
  95955. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  95956. /**
  95957. * Sets the vertex data of the mesh geometry for the requested `kind`.
  95958. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  95959. * The `data` are either a numeric array either a Float32Array.
  95960. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  95961. * 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).
  95962. * Note that a new underlying VertexBuffer object is created each call.
  95963. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  95964. *
  95965. * Possible `kind` values :
  95966. * - VertexBuffer.PositionKind
  95967. * - VertexBuffer.UVKind
  95968. * - VertexBuffer.UV2Kind
  95969. * - VertexBuffer.UV3Kind
  95970. * - VertexBuffer.UV4Kind
  95971. * - VertexBuffer.UV5Kind
  95972. * - VertexBuffer.UV6Kind
  95973. * - VertexBuffer.ColorKind
  95974. * - VertexBuffer.MatricesIndicesKind
  95975. * - VertexBuffer.MatricesIndicesExtraKind
  95976. * - VertexBuffer.MatricesWeightsKind
  95977. * - VertexBuffer.MatricesWeightsExtraKind
  95978. *
  95979. * Returns the Mesh.
  95980. */
  95981. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  95982. /**
  95983. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  95984. * If the mesh has no geometry, it is simply returned as it is.
  95985. * The `data` are either a numeric array either a Float32Array.
  95986. * No new underlying VertexBuffer object is created.
  95987. * 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.
  95988. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  95989. *
  95990. * Possible `kind` values :
  95991. * - VertexBuffer.PositionKind
  95992. * - VertexBuffer.UVKind
  95993. * - VertexBuffer.UV2Kind
  95994. * - VertexBuffer.UV3Kind
  95995. * - VertexBuffer.UV4Kind
  95996. * - VertexBuffer.UV5Kind
  95997. * - VertexBuffer.UV6Kind
  95998. * - VertexBuffer.ColorKind
  95999. * - VertexBuffer.MatricesIndicesKind
  96000. * - VertexBuffer.MatricesIndicesExtraKind
  96001. * - VertexBuffer.MatricesWeightsKind
  96002. * - VertexBuffer.MatricesWeightsExtraKind
  96003. *
  96004. * Returns the Mesh.
  96005. */
  96006. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  96007. /**
  96008. * Sets the mesh indices.
  96009. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  96010. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  96011. * This method creates a new index buffer each call.
  96012. * Returns the Mesh.
  96013. */
  96014. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  96015. /**
  96016. * Boolean : True if the mesh owns the requested kind of data.
  96017. */
  96018. isVerticesDataPresent(kind: string): boolean;
  96019. /**
  96020. * Returns an array of indices (IndicesArray).
  96021. */
  96022. getIndices(): Nullable<IndicesArray>;
  96023. get _positions(): Nullable<Vector3[]>;
  96024. /**
  96025. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  96026. * This means the mesh underlying bounding box and sphere are recomputed.
  96027. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  96028. * @returns the current mesh
  96029. */
  96030. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  96031. /** @hidden */
  96032. _preActivate(): InstancedMesh;
  96033. /** @hidden */
  96034. _activate(renderId: number, intermediateRendering: boolean): boolean;
  96035. /** @hidden */
  96036. _postActivate(): void;
  96037. getWorldMatrix(): Matrix;
  96038. get isAnInstance(): boolean;
  96039. /**
  96040. * Returns the current associated LOD AbstractMesh.
  96041. */
  96042. getLOD(camera: Camera): AbstractMesh;
  96043. /** @hidden */
  96044. _preActivateForIntermediateRendering(renderId: number): Mesh;
  96045. /** @hidden */
  96046. _syncSubMeshes(): InstancedMesh;
  96047. /** @hidden */
  96048. _generatePointsArray(): boolean;
  96049. /** @hidden */
  96050. _updateBoundingInfo(): AbstractMesh;
  96051. /**
  96052. * Creates a new InstancedMesh from the current mesh.
  96053. * - name (string) : the cloned mesh name
  96054. * - newParent (optional Node) : the optional Node to parent the clone to.
  96055. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  96056. *
  96057. * Returns the clone.
  96058. */
  96059. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  96060. /**
  96061. * Disposes the InstancedMesh.
  96062. * Returns nothing.
  96063. */
  96064. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  96065. }
  96066. interface Mesh {
  96067. /**
  96068. * Register a custom buffer that will be instanced
  96069. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96070. * @param kind defines the buffer kind
  96071. * @param stride defines the stride in floats
  96072. */
  96073. registerInstancedBuffer(kind: string, stride: number): void;
  96074. /**
  96075. * true to use the edge renderer for all instances of this mesh
  96076. */
  96077. edgesShareWithInstances: boolean;
  96078. /** @hidden */
  96079. _userInstancedBuffersStorage: {
  96080. data: {
  96081. [key: string]: Float32Array;
  96082. };
  96083. sizes: {
  96084. [key: string]: number;
  96085. };
  96086. vertexBuffers: {
  96087. [key: string]: Nullable<VertexBuffer>;
  96088. };
  96089. strides: {
  96090. [key: string]: number;
  96091. };
  96092. };
  96093. }
  96094. interface AbstractMesh {
  96095. /**
  96096. * Object used to store instanced buffers defined by user
  96097. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96098. */
  96099. instancedBuffers: {
  96100. [key: string]: any;
  96101. };
  96102. }
  96103. }
  96104. declare module BABYLON {
  96105. /**
  96106. * Defines the options associated with the creation of a shader material.
  96107. */
  96108. export interface IShaderMaterialOptions {
  96109. /**
  96110. * Does the material work in alpha blend mode
  96111. */
  96112. needAlphaBlending: boolean;
  96113. /**
  96114. * Does the material work in alpha test mode
  96115. */
  96116. needAlphaTesting: boolean;
  96117. /**
  96118. * The list of attribute names used in the shader
  96119. */
  96120. attributes: string[];
  96121. /**
  96122. * The list of unifrom names used in the shader
  96123. */
  96124. uniforms: string[];
  96125. /**
  96126. * The list of UBO names used in the shader
  96127. */
  96128. uniformBuffers: string[];
  96129. /**
  96130. * The list of sampler names used in the shader
  96131. */
  96132. samplers: string[];
  96133. /**
  96134. * The list of defines used in the shader
  96135. */
  96136. defines: string[];
  96137. }
  96138. /**
  96139. * 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.
  96140. *
  96141. * This returned material effects how the mesh will look based on the code in the shaders.
  96142. *
  96143. * @see https://doc.babylonjs.com/how_to/shader_material
  96144. */
  96145. export class ShaderMaterial extends Material {
  96146. private _shaderPath;
  96147. private _options;
  96148. private _textures;
  96149. private _textureArrays;
  96150. private _floats;
  96151. private _ints;
  96152. private _floatsArrays;
  96153. private _colors3;
  96154. private _colors3Arrays;
  96155. private _colors4;
  96156. private _colors4Arrays;
  96157. private _vectors2;
  96158. private _vectors3;
  96159. private _vectors4;
  96160. private _matrices;
  96161. private _matrixArrays;
  96162. private _matrices3x3;
  96163. private _matrices2x2;
  96164. private _vectors2Arrays;
  96165. private _vectors3Arrays;
  96166. private _vectors4Arrays;
  96167. private _cachedWorldViewMatrix;
  96168. private _cachedWorldViewProjectionMatrix;
  96169. private _renderId;
  96170. private _multiview;
  96171. private _cachedDefines;
  96172. /** Define the Url to load snippets */
  96173. static SnippetUrl: string;
  96174. /** Snippet ID if the material was created from the snippet server */
  96175. snippetId: string;
  96176. /**
  96177. * Instantiate a new shader material.
  96178. * 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.
  96179. * This returned material effects how the mesh will look based on the code in the shaders.
  96180. * @see https://doc.babylonjs.com/how_to/shader_material
  96181. * @param name Define the name of the material in the scene
  96182. * @param scene Define the scene the material belongs to
  96183. * @param shaderPath Defines the route to the shader code in one of three ways:
  96184. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  96185. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  96186. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  96187. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  96188. * @param options Define the options used to create the shader
  96189. */
  96190. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  96191. /**
  96192. * Gets the shader path used to define the shader code
  96193. * It can be modified to trigger a new compilation
  96194. */
  96195. get shaderPath(): any;
  96196. /**
  96197. * Sets the shader path used to define the shader code
  96198. * It can be modified to trigger a new compilation
  96199. */
  96200. set shaderPath(shaderPath: any);
  96201. /**
  96202. * Gets the options used to compile the shader.
  96203. * They can be modified to trigger a new compilation
  96204. */
  96205. get options(): IShaderMaterialOptions;
  96206. /**
  96207. * Gets the current class name of the material e.g. "ShaderMaterial"
  96208. * Mainly use in serialization.
  96209. * @returns the class name
  96210. */
  96211. getClassName(): string;
  96212. /**
  96213. * Specifies if the material will require alpha blending
  96214. * @returns a boolean specifying if alpha blending is needed
  96215. */
  96216. needAlphaBlending(): boolean;
  96217. /**
  96218. * Specifies if this material should be rendered in alpha test mode
  96219. * @returns a boolean specifying if an alpha test is needed.
  96220. */
  96221. needAlphaTesting(): boolean;
  96222. private _checkUniform;
  96223. /**
  96224. * Set a texture in the shader.
  96225. * @param name Define the name of the uniform samplers as defined in the shader
  96226. * @param texture Define the texture to bind to this sampler
  96227. * @return the material itself allowing "fluent" like uniform updates
  96228. */
  96229. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  96230. /**
  96231. * Set a texture array in the shader.
  96232. * @param name Define the name of the uniform sampler array as defined in the shader
  96233. * @param textures Define the list of textures to bind to this sampler
  96234. * @return the material itself allowing "fluent" like uniform updates
  96235. */
  96236. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  96237. /**
  96238. * Set a float in the shader.
  96239. * @param name Define the name of the uniform as defined in the shader
  96240. * @param value Define the value to give to the uniform
  96241. * @return the material itself allowing "fluent" like uniform updates
  96242. */
  96243. setFloat(name: string, value: number): ShaderMaterial;
  96244. /**
  96245. * Set a int in the shader.
  96246. * @param name Define the name of the uniform as defined in the shader
  96247. * @param value Define the value to give to the uniform
  96248. * @return the material itself allowing "fluent" like uniform updates
  96249. */
  96250. setInt(name: string, value: number): ShaderMaterial;
  96251. /**
  96252. * Set an array of floats in the shader.
  96253. * @param name Define the name of the uniform as defined in the shader
  96254. * @param value Define the value to give to the uniform
  96255. * @return the material itself allowing "fluent" like uniform updates
  96256. */
  96257. setFloats(name: string, value: number[]): ShaderMaterial;
  96258. /**
  96259. * Set a vec3 in the shader from a Color3.
  96260. * @param name Define the name of the uniform as defined in the shader
  96261. * @param value Define the value to give to the uniform
  96262. * @return the material itself allowing "fluent" like uniform updates
  96263. */
  96264. setColor3(name: string, value: Color3): ShaderMaterial;
  96265. /**
  96266. * Set a vec3 array in the shader from a Color3 array.
  96267. * @param name Define the name of the uniform as defined in the shader
  96268. * @param value Define the value to give to the uniform
  96269. * @return the material itself allowing "fluent" like uniform updates
  96270. */
  96271. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  96272. /**
  96273. * Set a vec4 in the shader from a Color4.
  96274. * @param name Define the name of the uniform as defined in the shader
  96275. * @param value Define the value to give to the uniform
  96276. * @return the material itself allowing "fluent" like uniform updates
  96277. */
  96278. setColor4(name: string, value: Color4): ShaderMaterial;
  96279. /**
  96280. * Set a vec4 array in the shader from a Color4 array.
  96281. * @param name Define the name of the uniform as defined in the shader
  96282. * @param value Define the value to give to the uniform
  96283. * @return the material itself allowing "fluent" like uniform updates
  96284. */
  96285. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  96286. /**
  96287. * Set a vec2 in the shader from a Vector2.
  96288. * @param name Define the name of the uniform as defined in the shader
  96289. * @param value Define the value to give to the uniform
  96290. * @return the material itself allowing "fluent" like uniform updates
  96291. */
  96292. setVector2(name: string, value: Vector2): ShaderMaterial;
  96293. /**
  96294. * Set a vec3 in the shader from a Vector3.
  96295. * @param name Define the name of the uniform as defined in the shader
  96296. * @param value Define the value to give to the uniform
  96297. * @return the material itself allowing "fluent" like uniform updates
  96298. */
  96299. setVector3(name: string, value: Vector3): ShaderMaterial;
  96300. /**
  96301. * Set a vec4 in the shader from a Vector4.
  96302. * @param name Define the name of the uniform as defined in the shader
  96303. * @param value Define the value to give to the uniform
  96304. * @return the material itself allowing "fluent" like uniform updates
  96305. */
  96306. setVector4(name: string, value: Vector4): ShaderMaterial;
  96307. /**
  96308. * Set a mat4 in the shader from a Matrix.
  96309. * @param name Define the name of the uniform as defined in the shader
  96310. * @param value Define the value to give to the uniform
  96311. * @return the material itself allowing "fluent" like uniform updates
  96312. */
  96313. setMatrix(name: string, value: Matrix): ShaderMaterial;
  96314. /**
  96315. * Set a float32Array in the shader from a matrix array.
  96316. * @param name Define the name of the uniform as defined in the shader
  96317. * @param value Define the value to give to the uniform
  96318. * @return the material itself allowing "fluent" like uniform updates
  96319. */
  96320. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  96321. /**
  96322. * Set a mat3 in the shader from a Float32Array.
  96323. * @param name Define the name of the uniform as defined in the shader
  96324. * @param value Define the value to give to the uniform
  96325. * @return the material itself allowing "fluent" like uniform updates
  96326. */
  96327. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96328. /**
  96329. * Set a mat2 in the shader from a Float32Array.
  96330. * @param name Define the name of the uniform as defined in the shader
  96331. * @param value Define the value to give to the uniform
  96332. * @return the material itself allowing "fluent" like uniform updates
  96333. */
  96334. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96335. /**
  96336. * Set a vec2 array in the shader from a number array.
  96337. * @param name Define the name of the uniform as defined in the shader
  96338. * @param value Define the value to give to the uniform
  96339. * @return the material itself allowing "fluent" like uniform updates
  96340. */
  96341. setArray2(name: string, value: number[]): ShaderMaterial;
  96342. /**
  96343. * Set a vec3 array in the shader from a number array.
  96344. * @param name Define the name of the uniform as defined in the shader
  96345. * @param value Define the value to give to the uniform
  96346. * @return the material itself allowing "fluent" like uniform updates
  96347. */
  96348. setArray3(name: string, value: number[]): ShaderMaterial;
  96349. /**
  96350. * Set a vec4 array in the shader from a number array.
  96351. * @param name Define the name of the uniform as defined in the shader
  96352. * @param value Define the value to give to the uniform
  96353. * @return the material itself allowing "fluent" like uniform updates
  96354. */
  96355. setArray4(name: string, value: number[]): ShaderMaterial;
  96356. private _checkCache;
  96357. /**
  96358. * Specifies that the submesh is ready to be used
  96359. * @param mesh defines the mesh to check
  96360. * @param subMesh defines which submesh to check
  96361. * @param useInstances specifies that instances should be used
  96362. * @returns a boolean indicating that the submesh is ready or not
  96363. */
  96364. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  96365. /**
  96366. * Checks if the material is ready to render the requested mesh
  96367. * @param mesh Define the mesh to render
  96368. * @param useInstances Define whether or not the material is used with instances
  96369. * @returns true if ready, otherwise false
  96370. */
  96371. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  96372. /**
  96373. * Binds the world matrix to the material
  96374. * @param world defines the world transformation matrix
  96375. * @param effectOverride - If provided, use this effect instead of internal effect
  96376. */
  96377. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  96378. /**
  96379. * Binds the submesh to this material by preparing the effect and shader to draw
  96380. * @param world defines the world transformation matrix
  96381. * @param mesh defines the mesh containing the submesh
  96382. * @param subMesh defines the submesh to bind the material to
  96383. */
  96384. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  96385. /**
  96386. * Binds the material to the mesh
  96387. * @param world defines the world transformation matrix
  96388. * @param mesh defines the mesh to bind the material to
  96389. * @param effectOverride - If provided, use this effect instead of internal effect
  96390. */
  96391. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  96392. protected _afterBind(mesh?: Mesh): void;
  96393. /**
  96394. * Gets the active textures from the material
  96395. * @returns an array of textures
  96396. */
  96397. getActiveTextures(): BaseTexture[];
  96398. /**
  96399. * Specifies if the material uses a texture
  96400. * @param texture defines the texture to check against the material
  96401. * @returns a boolean specifying if the material uses the texture
  96402. */
  96403. hasTexture(texture: BaseTexture): boolean;
  96404. /**
  96405. * Makes a duplicate of the material, and gives it a new name
  96406. * @param name defines the new name for the duplicated material
  96407. * @returns the cloned material
  96408. */
  96409. clone(name: string): ShaderMaterial;
  96410. /**
  96411. * Disposes the material
  96412. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  96413. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  96414. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  96415. */
  96416. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  96417. /**
  96418. * Serializes this material in a JSON representation
  96419. * @returns the serialized material object
  96420. */
  96421. serialize(): any;
  96422. /**
  96423. * Creates a shader material from parsed shader material data
  96424. * @param source defines the JSON represnetation of the material
  96425. * @param scene defines the hosting scene
  96426. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96427. * @returns a new material
  96428. */
  96429. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  96430. /**
  96431. * Creates a new ShaderMaterial from a snippet saved in a remote file
  96432. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  96433. * @param url defines the url to load from
  96434. * @param scene defines the hosting scene
  96435. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96436. * @returns a promise that will resolve to the new ShaderMaterial
  96437. */
  96438. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96439. /**
  96440. * Creates a ShaderMaterial from a snippet saved by the Inspector
  96441. * @param snippetId defines the snippet to load
  96442. * @param scene defines the hosting scene
  96443. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96444. * @returns a promise that will resolve to the new ShaderMaterial
  96445. */
  96446. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96447. }
  96448. }
  96449. declare module BABYLON {
  96450. /** @hidden */
  96451. export var colorPixelShader: {
  96452. name: string;
  96453. shader: string;
  96454. };
  96455. }
  96456. declare module BABYLON {
  96457. /** @hidden */
  96458. export var colorVertexShader: {
  96459. name: string;
  96460. shader: string;
  96461. };
  96462. }
  96463. declare module BABYLON {
  96464. /**
  96465. * Line mesh
  96466. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  96467. */
  96468. export class LinesMesh extends Mesh {
  96469. /**
  96470. * If vertex color should be applied to the mesh
  96471. */
  96472. readonly useVertexColor?: boolean | undefined;
  96473. /**
  96474. * If vertex alpha should be applied to the mesh
  96475. */
  96476. readonly useVertexAlpha?: boolean | undefined;
  96477. /**
  96478. * Color of the line (Default: White)
  96479. */
  96480. color: Color3;
  96481. /**
  96482. * Alpha of the line (Default: 1)
  96483. */
  96484. alpha: number;
  96485. /**
  96486. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96487. * This margin is expressed in world space coordinates, so its value may vary.
  96488. * Default value is 0.1
  96489. */
  96490. intersectionThreshold: number;
  96491. private _colorShader;
  96492. private color4;
  96493. /**
  96494. * Creates a new LinesMesh
  96495. * @param name defines the name
  96496. * @param scene defines the hosting scene
  96497. * @param parent defines the parent mesh if any
  96498. * @param source defines the optional source LinesMesh used to clone data from
  96499. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  96500. * When false, achieved by calling a clone(), also passing False.
  96501. * This will make creation of children, recursive.
  96502. * @param useVertexColor defines if this LinesMesh supports vertex color
  96503. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  96504. */
  96505. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  96506. /**
  96507. * If vertex color should be applied to the mesh
  96508. */
  96509. useVertexColor?: boolean | undefined,
  96510. /**
  96511. * If vertex alpha should be applied to the mesh
  96512. */
  96513. useVertexAlpha?: boolean | undefined);
  96514. private _addClipPlaneDefine;
  96515. private _removeClipPlaneDefine;
  96516. isReady(): boolean;
  96517. /**
  96518. * Returns the string "LineMesh"
  96519. */
  96520. getClassName(): string;
  96521. /**
  96522. * @hidden
  96523. */
  96524. get material(): Material;
  96525. /**
  96526. * @hidden
  96527. */
  96528. set material(value: Material);
  96529. /**
  96530. * @hidden
  96531. */
  96532. get checkCollisions(): boolean;
  96533. /** @hidden */
  96534. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  96535. /** @hidden */
  96536. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  96537. /**
  96538. * Disposes of the line mesh
  96539. * @param doNotRecurse If children should be disposed
  96540. */
  96541. dispose(doNotRecurse?: boolean): void;
  96542. /**
  96543. * Returns a new LineMesh object cloned from the current one.
  96544. */
  96545. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  96546. /**
  96547. * Creates a new InstancedLinesMesh object from the mesh model.
  96548. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96549. * @param name defines the name of the new instance
  96550. * @returns a new InstancedLinesMesh
  96551. */
  96552. createInstance(name: string): InstancedLinesMesh;
  96553. }
  96554. /**
  96555. * Creates an instance based on a source LinesMesh
  96556. */
  96557. export class InstancedLinesMesh extends InstancedMesh {
  96558. /**
  96559. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96560. * This margin is expressed in world space coordinates, so its value may vary.
  96561. * Initilized with the intersectionThreshold value of the source LinesMesh
  96562. */
  96563. intersectionThreshold: number;
  96564. constructor(name: string, source: LinesMesh);
  96565. /**
  96566. * Returns the string "InstancedLinesMesh".
  96567. */
  96568. getClassName(): string;
  96569. }
  96570. }
  96571. declare module BABYLON {
  96572. /** @hidden */
  96573. export var linePixelShader: {
  96574. name: string;
  96575. shader: string;
  96576. };
  96577. }
  96578. declare module BABYLON {
  96579. /** @hidden */
  96580. export var lineVertexShader: {
  96581. name: string;
  96582. shader: string;
  96583. };
  96584. }
  96585. declare module BABYLON {
  96586. interface Scene {
  96587. /** @hidden */
  96588. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  96589. }
  96590. interface AbstractMesh {
  96591. /**
  96592. * Gets the edgesRenderer associated with the mesh
  96593. */
  96594. edgesRenderer: Nullable<EdgesRenderer>;
  96595. }
  96596. interface LinesMesh {
  96597. /**
  96598. * Enables the edge rendering mode on the mesh.
  96599. * This mode makes the mesh edges visible
  96600. * @param epsilon defines the maximal distance between two angles to detect a face
  96601. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96602. * @returns the currentAbstractMesh
  96603. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96604. */
  96605. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  96606. }
  96607. interface InstancedLinesMesh {
  96608. /**
  96609. * Enables the edge rendering mode on the mesh.
  96610. * This mode makes the mesh edges visible
  96611. * @param epsilon defines the maximal distance between two angles to detect a face
  96612. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96613. * @returns the current InstancedLinesMesh
  96614. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96615. */
  96616. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  96617. }
  96618. /**
  96619. * Defines the minimum contract an Edges renderer should follow.
  96620. */
  96621. export interface IEdgesRenderer extends IDisposable {
  96622. /**
  96623. * Gets or sets a boolean indicating if the edgesRenderer is active
  96624. */
  96625. isEnabled: boolean;
  96626. /**
  96627. * Renders the edges of the attached mesh,
  96628. */
  96629. render(): void;
  96630. /**
  96631. * Checks wether or not the edges renderer is ready to render.
  96632. * @return true if ready, otherwise false.
  96633. */
  96634. isReady(): boolean;
  96635. /**
  96636. * List of instances to render in case the source mesh has instances
  96637. */
  96638. customInstances: SmartArray<Matrix>;
  96639. }
  96640. /**
  96641. * Defines the additional options of the edges renderer
  96642. */
  96643. export interface IEdgesRendererOptions {
  96644. /**
  96645. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  96646. * If not defined, the default value is true
  96647. */
  96648. useAlternateEdgeFinder?: boolean;
  96649. /**
  96650. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  96651. * If not defined, the default value is true.
  96652. * 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)
  96653. * This option is used only if useAlternateEdgeFinder = true
  96654. */
  96655. useFastVertexMerger?: boolean;
  96656. /**
  96657. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  96658. * The default value is 1e-6
  96659. * This option is used only if useAlternateEdgeFinder = true
  96660. */
  96661. epsilonVertexMerge?: number;
  96662. /**
  96663. * 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
  96664. * 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.
  96665. * This option is used only if useAlternateEdgeFinder = true
  96666. */
  96667. applyTessellation?: boolean;
  96668. /**
  96669. * 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
  96670. * The default value is 1e-6
  96671. * This option is used only if useAlternateEdgeFinder = true
  96672. */
  96673. epsilonVertexAligned?: number;
  96674. }
  96675. /**
  96676. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  96677. */
  96678. export class EdgesRenderer implements IEdgesRenderer {
  96679. /**
  96680. * Define the size of the edges with an orthographic camera
  96681. */
  96682. edgesWidthScalerForOrthographic: number;
  96683. /**
  96684. * Define the size of the edges with a perspective camera
  96685. */
  96686. edgesWidthScalerForPerspective: number;
  96687. protected _source: AbstractMesh;
  96688. protected _linesPositions: number[];
  96689. protected _linesNormals: number[];
  96690. protected _linesIndices: number[];
  96691. protected _epsilon: number;
  96692. protected _indicesCount: number;
  96693. protected _lineShader: ShaderMaterial;
  96694. protected _ib: DataBuffer;
  96695. protected _buffers: {
  96696. [key: string]: Nullable<VertexBuffer>;
  96697. };
  96698. protected _buffersForInstances: {
  96699. [key: string]: Nullable<VertexBuffer>;
  96700. };
  96701. protected _checkVerticesInsteadOfIndices: boolean;
  96702. protected _options: Nullable<IEdgesRendererOptions>;
  96703. private _meshRebuildObserver;
  96704. private _meshDisposeObserver;
  96705. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  96706. isEnabled: boolean;
  96707. /**
  96708. * List of instances to render in case the source mesh has instances
  96709. */
  96710. customInstances: SmartArray<Matrix>;
  96711. private static GetShader;
  96712. /**
  96713. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  96714. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  96715. * @param source Mesh used to create edges
  96716. * @param epsilon sum of angles in adjacency to check for edge
  96717. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  96718. * @param generateEdgesLines - should generate Lines or only prepare resources.
  96719. * @param options The options to apply when generating the edges
  96720. */
  96721. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  96722. protected _prepareRessources(): void;
  96723. /** @hidden */
  96724. _rebuild(): void;
  96725. /**
  96726. * Releases the required resources for the edges renderer
  96727. */
  96728. dispose(): void;
  96729. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  96730. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  96731. /**
  96732. * Checks if the pair of p0 and p1 is en edge
  96733. * @param faceIndex
  96734. * @param edge
  96735. * @param faceNormals
  96736. * @param p0
  96737. * @param p1
  96738. * @private
  96739. */
  96740. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  96741. /**
  96742. * push line into the position, normal and index buffer
  96743. * @protected
  96744. */
  96745. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  96746. /**
  96747. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  96748. */
  96749. private _tessellateTriangle;
  96750. private _generateEdgesLinesAlternate;
  96751. /**
  96752. * Generates lines edges from adjacencjes
  96753. * @private
  96754. */
  96755. _generateEdgesLines(): void;
  96756. /**
  96757. * Checks wether or not the edges renderer is ready to render.
  96758. * @return true if ready, otherwise false.
  96759. */
  96760. isReady(): boolean;
  96761. /**
  96762. * Renders the edges of the attached mesh,
  96763. */
  96764. render(): void;
  96765. }
  96766. /**
  96767. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  96768. */
  96769. export class LineEdgesRenderer extends EdgesRenderer {
  96770. /**
  96771. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  96772. * @param source LineMesh used to generate edges
  96773. * @param epsilon not important (specified angle for edge detection)
  96774. * @param checkVerticesInsteadOfIndices not important for LineMesh
  96775. */
  96776. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  96777. /**
  96778. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  96779. */
  96780. _generateEdgesLines(): void;
  96781. }
  96782. }
  96783. declare module BABYLON {
  96784. /**
  96785. * This represents the object necessary to create a rendering group.
  96786. * This is exclusively used and created by the rendering manager.
  96787. * To modify the behavior, you use the available helpers in your scene or meshes.
  96788. * @hidden
  96789. */
  96790. export class RenderingGroup {
  96791. index: number;
  96792. private static _zeroVector;
  96793. private _scene;
  96794. private _opaqueSubMeshes;
  96795. private _transparentSubMeshes;
  96796. private _alphaTestSubMeshes;
  96797. private _depthOnlySubMeshes;
  96798. private _particleSystems;
  96799. private _spriteManagers;
  96800. private _opaqueSortCompareFn;
  96801. private _alphaTestSortCompareFn;
  96802. private _transparentSortCompareFn;
  96803. private _renderOpaque;
  96804. private _renderAlphaTest;
  96805. private _renderTransparent;
  96806. /** @hidden */
  96807. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  96808. onBeforeTransparentRendering: () => void;
  96809. /**
  96810. * Set the opaque sort comparison function.
  96811. * If null the sub meshes will be render in the order they were created
  96812. */
  96813. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96814. /**
  96815. * Set the alpha test sort comparison function.
  96816. * If null the sub meshes will be render in the order they were created
  96817. */
  96818. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96819. /**
  96820. * Set the transparent sort comparison function.
  96821. * If null the sub meshes will be render in the order they were created
  96822. */
  96823. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96824. /**
  96825. * Creates a new rendering group.
  96826. * @param index The rendering group index
  96827. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  96828. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  96829. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  96830. */
  96831. 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>);
  96832. /**
  96833. * Render all the sub meshes contained in the group.
  96834. * @param customRenderFunction Used to override the default render behaviour of the group.
  96835. * @returns true if rendered some submeshes.
  96836. */
  96837. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  96838. /**
  96839. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  96840. * @param subMeshes The submeshes to render
  96841. */
  96842. private renderOpaqueSorted;
  96843. /**
  96844. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  96845. * @param subMeshes The submeshes to render
  96846. */
  96847. private renderAlphaTestSorted;
  96848. /**
  96849. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  96850. * @param subMeshes The submeshes to render
  96851. */
  96852. private renderTransparentSorted;
  96853. /**
  96854. * Renders the submeshes in a specified order.
  96855. * @param subMeshes The submeshes to sort before render
  96856. * @param sortCompareFn The comparison function use to sort
  96857. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  96858. * @param transparent Specifies to activate blending if true
  96859. */
  96860. private static renderSorted;
  96861. /**
  96862. * Renders the submeshes in the order they were dispatched (no sort applied).
  96863. * @param subMeshes The submeshes to render
  96864. */
  96865. private static renderUnsorted;
  96866. /**
  96867. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96868. * are rendered back to front if in the same alpha index.
  96869. *
  96870. * @param a The first submesh
  96871. * @param b The second submesh
  96872. * @returns The result of the comparison
  96873. */
  96874. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  96875. /**
  96876. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96877. * are rendered back to front.
  96878. *
  96879. * @param a The first submesh
  96880. * @param b The second submesh
  96881. * @returns The result of the comparison
  96882. */
  96883. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  96884. /**
  96885. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96886. * are rendered front to back (prevent overdraw).
  96887. *
  96888. * @param a The first submesh
  96889. * @param b The second submesh
  96890. * @returns The result of the comparison
  96891. */
  96892. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  96893. /**
  96894. * Resets the different lists of submeshes to prepare a new frame.
  96895. */
  96896. prepare(): void;
  96897. dispose(): void;
  96898. /**
  96899. * Inserts the submesh in its correct queue depending on its material.
  96900. * @param subMesh The submesh to dispatch
  96901. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96902. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96903. */
  96904. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96905. dispatchSprites(spriteManager: ISpriteManager): void;
  96906. dispatchParticles(particleSystem: IParticleSystem): void;
  96907. private _renderParticles;
  96908. private _renderSprites;
  96909. }
  96910. }
  96911. declare module BABYLON {
  96912. /**
  96913. * Interface describing the different options available in the rendering manager
  96914. * regarding Auto Clear between groups.
  96915. */
  96916. export interface IRenderingManagerAutoClearSetup {
  96917. /**
  96918. * Defines whether or not autoclear is enable.
  96919. */
  96920. autoClear: boolean;
  96921. /**
  96922. * Defines whether or not to autoclear the depth buffer.
  96923. */
  96924. depth: boolean;
  96925. /**
  96926. * Defines whether or not to autoclear the stencil buffer.
  96927. */
  96928. stencil: boolean;
  96929. }
  96930. /**
  96931. * This class is used by the onRenderingGroupObservable
  96932. */
  96933. export class RenderingGroupInfo {
  96934. /**
  96935. * The Scene that being rendered
  96936. */
  96937. scene: Scene;
  96938. /**
  96939. * The camera currently used for the rendering pass
  96940. */
  96941. camera: Nullable<Camera>;
  96942. /**
  96943. * The ID of the renderingGroup being processed
  96944. */
  96945. renderingGroupId: number;
  96946. }
  96947. /**
  96948. * This is the manager responsible of all the rendering for meshes sprites and particles.
  96949. * It is enable to manage the different groups as well as the different necessary sort functions.
  96950. * This should not be used directly aside of the few static configurations
  96951. */
  96952. export class RenderingManager {
  96953. /**
  96954. * The max id used for rendering groups (not included)
  96955. */
  96956. static MAX_RENDERINGGROUPS: number;
  96957. /**
  96958. * The min id used for rendering groups (included)
  96959. */
  96960. static MIN_RENDERINGGROUPS: number;
  96961. /**
  96962. * Used to globally prevent autoclearing scenes.
  96963. */
  96964. static AUTOCLEAR: boolean;
  96965. /**
  96966. * @hidden
  96967. */
  96968. _useSceneAutoClearSetup: boolean;
  96969. private _scene;
  96970. private _renderingGroups;
  96971. private _depthStencilBufferAlreadyCleaned;
  96972. private _autoClearDepthStencil;
  96973. private _customOpaqueSortCompareFn;
  96974. private _customAlphaTestSortCompareFn;
  96975. private _customTransparentSortCompareFn;
  96976. private _renderingGroupInfo;
  96977. /**
  96978. * Instantiates a new rendering group for a particular scene
  96979. * @param scene Defines the scene the groups belongs to
  96980. */
  96981. constructor(scene: Scene);
  96982. private _clearDepthStencilBuffer;
  96983. /**
  96984. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  96985. * @hidden
  96986. */
  96987. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  96988. /**
  96989. * Resets the different information of the group to prepare a new frame
  96990. * @hidden
  96991. */
  96992. reset(): void;
  96993. /**
  96994. * Dispose and release the group and its associated resources.
  96995. * @hidden
  96996. */
  96997. dispose(): void;
  96998. /**
  96999. * Clear the info related to rendering groups preventing retention points during dispose.
  97000. */
  97001. freeRenderingGroups(): void;
  97002. private _prepareRenderingGroup;
  97003. /**
  97004. * Add a sprite manager to the rendering manager in order to render it this frame.
  97005. * @param spriteManager Define the sprite manager to render
  97006. */
  97007. dispatchSprites(spriteManager: ISpriteManager): void;
  97008. /**
  97009. * Add a particle system to the rendering manager in order to render it this frame.
  97010. * @param particleSystem Define the particle system to render
  97011. */
  97012. dispatchParticles(particleSystem: IParticleSystem): void;
  97013. /**
  97014. * Add a submesh to the manager in order to render it this frame
  97015. * @param subMesh The submesh to dispatch
  97016. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  97017. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  97018. */
  97019. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  97020. /**
  97021. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  97022. * This allowed control for front to back rendering or reversly depending of the special needs.
  97023. *
  97024. * @param renderingGroupId The rendering group id corresponding to its index
  97025. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  97026. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  97027. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  97028. */
  97029. 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;
  97030. /**
  97031. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  97032. *
  97033. * @param renderingGroupId The rendering group id corresponding to its index
  97034. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  97035. * @param depth Automatically clears depth between groups if true and autoClear is true.
  97036. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  97037. */
  97038. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  97039. /**
  97040. * Gets the current auto clear configuration for one rendering group of the rendering
  97041. * manager.
  97042. * @param index the rendering group index to get the information for
  97043. * @returns The auto clear setup for the requested rendering group
  97044. */
  97045. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  97046. }
  97047. }
  97048. declare module BABYLON {
  97049. /**
  97050. * Defines the options associated with the creation of a custom shader for a shadow generator.
  97051. */
  97052. export interface ICustomShaderOptions {
  97053. /**
  97054. * Gets or sets the custom shader name to use
  97055. */
  97056. shaderName: string;
  97057. /**
  97058. * The list of attribute names used in the shader
  97059. */
  97060. attributes?: string[];
  97061. /**
  97062. * The list of unifrom names used in the shader
  97063. */
  97064. uniforms?: string[];
  97065. /**
  97066. * The list of sampler names used in the shader
  97067. */
  97068. samplers?: string[];
  97069. /**
  97070. * The list of defines used in the shader
  97071. */
  97072. defines?: string[];
  97073. }
  97074. /**
  97075. * Interface to implement to create a shadow generator compatible with BJS.
  97076. */
  97077. export interface IShadowGenerator {
  97078. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97079. id: string;
  97080. /**
  97081. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97082. * @returns The render target texture if present otherwise, null
  97083. */
  97084. getShadowMap(): Nullable<RenderTargetTexture>;
  97085. /**
  97086. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97087. * @param subMesh The submesh we want to render in the shadow map
  97088. * @param useInstances Defines wether will draw in the map using instances
  97089. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97090. * @returns true if ready otherwise, false
  97091. */
  97092. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97093. /**
  97094. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97095. * @param defines Defines of the material we want to update
  97096. * @param lightIndex Index of the light in the enabled light list of the material
  97097. */
  97098. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  97099. /**
  97100. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97101. * defined in the generator but impacting the effect).
  97102. * It implies the unifroms available on the materials are the standard BJS ones.
  97103. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97104. * @param effect The effect we are binfing the information for
  97105. */
  97106. bindShadowLight(lightIndex: string, effect: Effect): void;
  97107. /**
  97108. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97109. * (eq to shadow prjection matrix * light transform matrix)
  97110. * @returns The transform matrix used to create the shadow map
  97111. */
  97112. getTransformMatrix(): Matrix;
  97113. /**
  97114. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97115. * Cube and 2D textures for instance.
  97116. */
  97117. recreateShadowMap(): void;
  97118. /**
  97119. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97120. * @param onCompiled Callback triggered at the and of the effects compilation
  97121. * @param options Sets of optional options forcing the compilation with different modes
  97122. */
  97123. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97124. useInstances: boolean;
  97125. }>): void;
  97126. /**
  97127. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97128. * @param options Sets of optional options forcing the compilation with different modes
  97129. * @returns A promise that resolves when the compilation completes
  97130. */
  97131. forceCompilationAsync(options?: Partial<{
  97132. useInstances: boolean;
  97133. }>): Promise<void>;
  97134. /**
  97135. * Serializes the shadow generator setup to a json object.
  97136. * @returns The serialized JSON object
  97137. */
  97138. serialize(): any;
  97139. /**
  97140. * Disposes the Shadow map and related Textures and effects.
  97141. */
  97142. dispose(): void;
  97143. }
  97144. /**
  97145. * Default implementation IShadowGenerator.
  97146. * This is the main object responsible of generating shadows in the framework.
  97147. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  97148. */
  97149. export class ShadowGenerator implements IShadowGenerator {
  97150. /**
  97151. * Name of the shadow generator class
  97152. */
  97153. static CLASSNAME: string;
  97154. /**
  97155. * Shadow generator mode None: no filtering applied.
  97156. */
  97157. static readonly FILTER_NONE: number;
  97158. /**
  97159. * Shadow generator mode ESM: Exponential Shadow Mapping.
  97160. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97161. */
  97162. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  97163. /**
  97164. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  97165. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  97166. */
  97167. static readonly FILTER_POISSONSAMPLING: number;
  97168. /**
  97169. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  97170. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97171. */
  97172. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  97173. /**
  97174. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  97175. * edge artifacts on steep falloff.
  97176. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97177. */
  97178. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  97179. /**
  97180. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  97181. * edge artifacts on steep falloff.
  97182. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97183. */
  97184. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  97185. /**
  97186. * Shadow generator mode PCF: Percentage Closer Filtering
  97187. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97188. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  97189. */
  97190. static readonly FILTER_PCF: number;
  97191. /**
  97192. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  97193. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97194. * Contact Hardening
  97195. */
  97196. static readonly FILTER_PCSS: number;
  97197. /**
  97198. * Reserved for PCF and PCSS
  97199. * Highest Quality.
  97200. *
  97201. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  97202. *
  97203. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  97204. */
  97205. static readonly QUALITY_HIGH: number;
  97206. /**
  97207. * Reserved for PCF and PCSS
  97208. * Good tradeoff for quality/perf cross devices
  97209. *
  97210. * Execute PCF on a 3*3 kernel.
  97211. *
  97212. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  97213. */
  97214. static readonly QUALITY_MEDIUM: number;
  97215. /**
  97216. * Reserved for PCF and PCSS
  97217. * The lowest quality but the fastest.
  97218. *
  97219. * Execute PCF on a 1*1 kernel.
  97220. *
  97221. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  97222. */
  97223. static readonly QUALITY_LOW: number;
  97224. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97225. id: string;
  97226. /** Gets or sets the custom shader name to use */
  97227. customShaderOptions: ICustomShaderOptions;
  97228. /**
  97229. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  97230. */
  97231. onBeforeShadowMapRenderObservable: Observable<Effect>;
  97232. /**
  97233. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  97234. */
  97235. onAfterShadowMapRenderObservable: Observable<Effect>;
  97236. /**
  97237. * Observable triggered before a mesh is rendered in the shadow map.
  97238. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  97239. */
  97240. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  97241. /**
  97242. * Observable triggered after a mesh is rendered in the shadow map.
  97243. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  97244. */
  97245. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  97246. protected _bias: number;
  97247. /**
  97248. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  97249. */
  97250. get bias(): number;
  97251. /**
  97252. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  97253. */
  97254. set bias(bias: number);
  97255. protected _normalBias: number;
  97256. /**
  97257. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97258. */
  97259. get normalBias(): number;
  97260. /**
  97261. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97262. */
  97263. set normalBias(normalBias: number);
  97264. protected _blurBoxOffset: number;
  97265. /**
  97266. * Gets the blur box offset: offset applied during the blur pass.
  97267. * Only useful if useKernelBlur = false
  97268. */
  97269. get blurBoxOffset(): number;
  97270. /**
  97271. * Sets the blur box offset: offset applied during the blur pass.
  97272. * Only useful if useKernelBlur = false
  97273. */
  97274. set blurBoxOffset(value: number);
  97275. protected _blurScale: number;
  97276. /**
  97277. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  97278. * 2 means half of the size.
  97279. */
  97280. get blurScale(): number;
  97281. /**
  97282. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  97283. * 2 means half of the size.
  97284. */
  97285. set blurScale(value: number);
  97286. protected _blurKernel: number;
  97287. /**
  97288. * Gets the blur kernel: kernel size of the blur pass.
  97289. * Only useful if useKernelBlur = true
  97290. */
  97291. get blurKernel(): number;
  97292. /**
  97293. * Sets the blur kernel: kernel size of the blur pass.
  97294. * Only useful if useKernelBlur = true
  97295. */
  97296. set blurKernel(value: number);
  97297. protected _useKernelBlur: boolean;
  97298. /**
  97299. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  97300. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97301. */
  97302. get useKernelBlur(): boolean;
  97303. /**
  97304. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  97305. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97306. */
  97307. set useKernelBlur(value: boolean);
  97308. protected _depthScale: number;
  97309. /**
  97310. * Gets the depth scale used in ESM mode.
  97311. */
  97312. get depthScale(): number;
  97313. /**
  97314. * Sets the depth scale used in ESM mode.
  97315. * This can override the scale stored on the light.
  97316. */
  97317. set depthScale(value: number);
  97318. protected _validateFilter(filter: number): number;
  97319. protected _filter: number;
  97320. /**
  97321. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  97322. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97323. */
  97324. get filter(): number;
  97325. /**
  97326. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  97327. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97328. */
  97329. set filter(value: number);
  97330. /**
  97331. * Gets if the current filter is set to Poisson Sampling.
  97332. */
  97333. get usePoissonSampling(): boolean;
  97334. /**
  97335. * Sets the current filter to Poisson Sampling.
  97336. */
  97337. set usePoissonSampling(value: boolean);
  97338. /**
  97339. * Gets if the current filter is set to ESM.
  97340. */
  97341. get useExponentialShadowMap(): boolean;
  97342. /**
  97343. * Sets the current filter is to ESM.
  97344. */
  97345. set useExponentialShadowMap(value: boolean);
  97346. /**
  97347. * Gets if the current filter is set to filtered ESM.
  97348. */
  97349. get useBlurExponentialShadowMap(): boolean;
  97350. /**
  97351. * Gets if the current filter is set to filtered ESM.
  97352. */
  97353. set useBlurExponentialShadowMap(value: boolean);
  97354. /**
  97355. * Gets if the current filter is set to "close ESM" (using the inverse of the
  97356. * exponential to prevent steep falloff artifacts).
  97357. */
  97358. get useCloseExponentialShadowMap(): boolean;
  97359. /**
  97360. * Sets the current filter to "close ESM" (using the inverse of the
  97361. * exponential to prevent steep falloff artifacts).
  97362. */
  97363. set useCloseExponentialShadowMap(value: boolean);
  97364. /**
  97365. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  97366. * exponential to prevent steep falloff artifacts).
  97367. */
  97368. get useBlurCloseExponentialShadowMap(): boolean;
  97369. /**
  97370. * Sets the current filter to filtered "close ESM" (using the inverse of the
  97371. * exponential to prevent steep falloff artifacts).
  97372. */
  97373. set useBlurCloseExponentialShadowMap(value: boolean);
  97374. /**
  97375. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  97376. */
  97377. get usePercentageCloserFiltering(): boolean;
  97378. /**
  97379. * Sets the current filter to "PCF" (percentage closer filtering).
  97380. */
  97381. set usePercentageCloserFiltering(value: boolean);
  97382. protected _filteringQuality: number;
  97383. /**
  97384. * Gets the PCF or PCSS Quality.
  97385. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97386. */
  97387. get filteringQuality(): number;
  97388. /**
  97389. * Sets the PCF or PCSS Quality.
  97390. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97391. */
  97392. set filteringQuality(filteringQuality: number);
  97393. /**
  97394. * Gets if the current filter is set to "PCSS" (contact hardening).
  97395. */
  97396. get useContactHardeningShadow(): boolean;
  97397. /**
  97398. * Sets the current filter to "PCSS" (contact hardening).
  97399. */
  97400. set useContactHardeningShadow(value: boolean);
  97401. protected _contactHardeningLightSizeUVRatio: number;
  97402. /**
  97403. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97404. * Using a ratio helps keeping shape stability independently of the map size.
  97405. *
  97406. * It does not account for the light projection as it was having too much
  97407. * instability during the light setup or during light position changes.
  97408. *
  97409. * Only valid if useContactHardeningShadow is true.
  97410. */
  97411. get contactHardeningLightSizeUVRatio(): number;
  97412. /**
  97413. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97414. * Using a ratio helps keeping shape stability independently of the map size.
  97415. *
  97416. * It does not account for the light projection as it was having too much
  97417. * instability during the light setup or during light position changes.
  97418. *
  97419. * Only valid if useContactHardeningShadow is true.
  97420. */
  97421. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  97422. protected _darkness: number;
  97423. /** Gets or sets the actual darkness of a shadow */
  97424. get darkness(): number;
  97425. set darkness(value: number);
  97426. /**
  97427. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  97428. * 0 means strongest and 1 would means no shadow.
  97429. * @returns the darkness.
  97430. */
  97431. getDarkness(): number;
  97432. /**
  97433. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  97434. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  97435. * @returns the shadow generator allowing fluent coding.
  97436. */
  97437. setDarkness(darkness: number): ShadowGenerator;
  97438. protected _transparencyShadow: boolean;
  97439. /** Gets or sets the ability to have transparent shadow */
  97440. get transparencyShadow(): boolean;
  97441. set transparencyShadow(value: boolean);
  97442. /**
  97443. * Sets the ability to have transparent shadow (boolean).
  97444. * @param transparent True if transparent else False
  97445. * @returns the shadow generator allowing fluent coding
  97446. */
  97447. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  97448. /**
  97449. * Enables or disables shadows with varying strength based on the transparency
  97450. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  97451. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  97452. * mesh.visibility * alphaTexture.a
  97453. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  97454. */
  97455. enableSoftTransparentShadow: boolean;
  97456. protected _shadowMap: Nullable<RenderTargetTexture>;
  97457. protected _shadowMap2: Nullable<RenderTargetTexture>;
  97458. /**
  97459. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97460. * @returns The render target texture if present otherwise, null
  97461. */
  97462. getShadowMap(): Nullable<RenderTargetTexture>;
  97463. /**
  97464. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  97465. * @returns The render target texture if the shadow map is present otherwise, null
  97466. */
  97467. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  97468. /**
  97469. * Gets the class name of that object
  97470. * @returns "ShadowGenerator"
  97471. */
  97472. getClassName(): string;
  97473. /**
  97474. * Helper function to add a mesh and its descendants to the list of shadow casters.
  97475. * @param mesh Mesh to add
  97476. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  97477. * @returns the Shadow Generator itself
  97478. */
  97479. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97480. /**
  97481. * Helper function to remove a mesh and its descendants from the list of shadow casters
  97482. * @param mesh Mesh to remove
  97483. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  97484. * @returns the Shadow Generator itself
  97485. */
  97486. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97487. /**
  97488. * Controls the extent to which the shadows fade out at the edge of the frustum
  97489. */
  97490. frustumEdgeFalloff: number;
  97491. protected _light: IShadowLight;
  97492. /**
  97493. * Returns the associated light object.
  97494. * @returns the light generating the shadow
  97495. */
  97496. getLight(): IShadowLight;
  97497. /**
  97498. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  97499. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  97500. * It might on the other hand introduce peter panning.
  97501. */
  97502. forceBackFacesOnly: boolean;
  97503. protected _scene: Scene;
  97504. protected _lightDirection: Vector3;
  97505. protected _effect: Effect;
  97506. protected _viewMatrix: Matrix;
  97507. protected _projectionMatrix: Matrix;
  97508. protected _transformMatrix: Matrix;
  97509. protected _cachedPosition: Vector3;
  97510. protected _cachedDirection: Vector3;
  97511. protected _cachedDefines: string;
  97512. protected _currentRenderID: number;
  97513. protected _boxBlurPostprocess: Nullable<PostProcess>;
  97514. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  97515. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  97516. protected _blurPostProcesses: PostProcess[];
  97517. protected _mapSize: number;
  97518. protected _currentFaceIndex: number;
  97519. protected _currentFaceIndexCache: number;
  97520. protected _textureType: number;
  97521. protected _defaultTextureMatrix: Matrix;
  97522. protected _storedUniqueId: Nullable<number>;
  97523. /** @hidden */
  97524. static _SceneComponentInitialization: (scene: Scene) => void;
  97525. /**
  97526. * Creates a ShadowGenerator object.
  97527. * A ShadowGenerator is the required tool to use the shadows.
  97528. * Each light casting shadows needs to use its own ShadowGenerator.
  97529. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  97530. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  97531. * @param light The light object generating the shadows.
  97532. * @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.
  97533. */
  97534. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  97535. protected _initializeGenerator(): void;
  97536. protected _createTargetRenderTexture(): void;
  97537. protected _initializeShadowMap(): void;
  97538. protected _initializeBlurRTTAndPostProcesses(): void;
  97539. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  97540. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  97541. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  97542. protected _applyFilterValues(): void;
  97543. /**
  97544. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97545. * @param onCompiled Callback triggered at the and of the effects compilation
  97546. * @param options Sets of optional options forcing the compilation with different modes
  97547. */
  97548. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97549. useInstances: boolean;
  97550. }>): void;
  97551. /**
  97552. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97553. * @param options Sets of optional options forcing the compilation with different modes
  97554. * @returns A promise that resolves when the compilation completes
  97555. */
  97556. forceCompilationAsync(options?: Partial<{
  97557. useInstances: boolean;
  97558. }>): Promise<void>;
  97559. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  97560. private _prepareShadowDefines;
  97561. /**
  97562. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97563. * @param subMesh The submesh we want to render in the shadow map
  97564. * @param useInstances Defines wether will draw in the map using instances
  97565. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97566. * @returns true if ready otherwise, false
  97567. */
  97568. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97569. /**
  97570. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97571. * @param defines Defines of the material we want to update
  97572. * @param lightIndex Index of the light in the enabled light list of the material
  97573. */
  97574. prepareDefines(defines: any, lightIndex: number): void;
  97575. /**
  97576. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97577. * defined in the generator but impacting the effect).
  97578. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97579. * @param effect The effect we are binfing the information for
  97580. */
  97581. bindShadowLight(lightIndex: string, effect: Effect): void;
  97582. /**
  97583. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97584. * (eq to shadow prjection matrix * light transform matrix)
  97585. * @returns The transform matrix used to create the shadow map
  97586. */
  97587. getTransformMatrix(): Matrix;
  97588. /**
  97589. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97590. * Cube and 2D textures for instance.
  97591. */
  97592. recreateShadowMap(): void;
  97593. protected _disposeBlurPostProcesses(): void;
  97594. protected _disposeRTTandPostProcesses(): void;
  97595. /**
  97596. * Disposes the ShadowGenerator.
  97597. * Returns nothing.
  97598. */
  97599. dispose(): void;
  97600. /**
  97601. * Serializes the shadow generator setup to a json object.
  97602. * @returns The serialized JSON object
  97603. */
  97604. serialize(): any;
  97605. /**
  97606. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  97607. * @param parsedShadowGenerator The JSON object to parse
  97608. * @param scene The scene to create the shadow map for
  97609. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  97610. * @returns The parsed shadow generator
  97611. */
  97612. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  97613. }
  97614. }
  97615. declare module BABYLON {
  97616. /**
  97617. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  97618. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  97619. * 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.
  97620. */
  97621. export abstract class Light extends Node {
  97622. /**
  97623. * Falloff Default: light is falling off following the material specification:
  97624. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  97625. */
  97626. static readonly FALLOFF_DEFAULT: number;
  97627. /**
  97628. * Falloff Physical: light is falling off following the inverse squared distance law.
  97629. */
  97630. static readonly FALLOFF_PHYSICAL: number;
  97631. /**
  97632. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  97633. * to enhance interoperability with other engines.
  97634. */
  97635. static readonly FALLOFF_GLTF: number;
  97636. /**
  97637. * Falloff Standard: light is falling off like in the standard material
  97638. * to enhance interoperability with other materials.
  97639. */
  97640. static readonly FALLOFF_STANDARD: number;
  97641. /**
  97642. * If every light affecting the material is in this lightmapMode,
  97643. * material.lightmapTexture adds or multiplies
  97644. * (depends on material.useLightmapAsShadowmap)
  97645. * after every other light calculations.
  97646. */
  97647. static readonly LIGHTMAP_DEFAULT: number;
  97648. /**
  97649. * material.lightmapTexture as only diffuse lighting from this light
  97650. * adds only specular lighting from this light
  97651. * adds dynamic shadows
  97652. */
  97653. static readonly LIGHTMAP_SPECULAR: number;
  97654. /**
  97655. * material.lightmapTexture as only lighting
  97656. * no light calculation from this light
  97657. * only adds dynamic shadows from this light
  97658. */
  97659. static readonly LIGHTMAP_SHADOWSONLY: number;
  97660. /**
  97661. * Each light type uses the default quantity according to its type:
  97662. * point/spot lights use luminous intensity
  97663. * directional lights use illuminance
  97664. */
  97665. static readonly INTENSITYMODE_AUTOMATIC: number;
  97666. /**
  97667. * lumen (lm)
  97668. */
  97669. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  97670. /**
  97671. * candela (lm/sr)
  97672. */
  97673. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  97674. /**
  97675. * lux (lm/m^2)
  97676. */
  97677. static readonly INTENSITYMODE_ILLUMINANCE: number;
  97678. /**
  97679. * nit (cd/m^2)
  97680. */
  97681. static readonly INTENSITYMODE_LUMINANCE: number;
  97682. /**
  97683. * Light type const id of the point light.
  97684. */
  97685. static readonly LIGHTTYPEID_POINTLIGHT: number;
  97686. /**
  97687. * Light type const id of the directional light.
  97688. */
  97689. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  97690. /**
  97691. * Light type const id of the spot light.
  97692. */
  97693. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  97694. /**
  97695. * Light type const id of the hemispheric light.
  97696. */
  97697. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  97698. /**
  97699. * Diffuse gives the basic color to an object.
  97700. */
  97701. diffuse: Color3;
  97702. /**
  97703. * Specular produces a highlight color on an object.
  97704. * Note: This is note affecting PBR materials.
  97705. */
  97706. specular: Color3;
  97707. /**
  97708. * Defines the falloff type for this light. This lets overrriding how punctual light are
  97709. * falling off base on range or angle.
  97710. * This can be set to any values in Light.FALLOFF_x.
  97711. *
  97712. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  97713. * other types of materials.
  97714. */
  97715. falloffType: number;
  97716. /**
  97717. * Strength of the light.
  97718. * Note: By default it is define in the framework own unit.
  97719. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  97720. */
  97721. intensity: number;
  97722. private _range;
  97723. protected _inverseSquaredRange: number;
  97724. /**
  97725. * Defines how far from the source the light is impacting in scene units.
  97726. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97727. */
  97728. get range(): number;
  97729. /**
  97730. * Defines how far from the source the light is impacting in scene units.
  97731. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97732. */
  97733. set range(value: number);
  97734. /**
  97735. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  97736. * of light.
  97737. */
  97738. private _photometricScale;
  97739. private _intensityMode;
  97740. /**
  97741. * Gets the photometric scale used to interpret the intensity.
  97742. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97743. */
  97744. get intensityMode(): number;
  97745. /**
  97746. * Sets the photometric scale used to interpret the intensity.
  97747. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97748. */
  97749. set intensityMode(value: number);
  97750. private _radius;
  97751. /**
  97752. * Gets the light radius used by PBR Materials to simulate soft area lights.
  97753. */
  97754. get radius(): number;
  97755. /**
  97756. * sets the light radius used by PBR Materials to simulate soft area lights.
  97757. */
  97758. set radius(value: number);
  97759. private _renderPriority;
  97760. /**
  97761. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  97762. * exceeding the number allowed of the materials.
  97763. */
  97764. renderPriority: number;
  97765. private _shadowEnabled;
  97766. /**
  97767. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97768. * the current shadow generator.
  97769. */
  97770. get shadowEnabled(): boolean;
  97771. /**
  97772. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97773. * the current shadow generator.
  97774. */
  97775. set shadowEnabled(value: boolean);
  97776. private _includedOnlyMeshes;
  97777. /**
  97778. * Gets the only meshes impacted by this light.
  97779. */
  97780. get includedOnlyMeshes(): AbstractMesh[];
  97781. /**
  97782. * Sets the only meshes impacted by this light.
  97783. */
  97784. set includedOnlyMeshes(value: AbstractMesh[]);
  97785. private _excludedMeshes;
  97786. /**
  97787. * Gets the meshes not impacted by this light.
  97788. */
  97789. get excludedMeshes(): AbstractMesh[];
  97790. /**
  97791. * Sets the meshes not impacted by this light.
  97792. */
  97793. set excludedMeshes(value: AbstractMesh[]);
  97794. private _excludeWithLayerMask;
  97795. /**
  97796. * Gets the layer id use to find what meshes are not impacted by the light.
  97797. * Inactive if 0
  97798. */
  97799. get excludeWithLayerMask(): number;
  97800. /**
  97801. * Sets the layer id use to find what meshes are not impacted by the light.
  97802. * Inactive if 0
  97803. */
  97804. set excludeWithLayerMask(value: number);
  97805. private _includeOnlyWithLayerMask;
  97806. /**
  97807. * Gets the layer id use to find what meshes are impacted by the light.
  97808. * Inactive if 0
  97809. */
  97810. get includeOnlyWithLayerMask(): number;
  97811. /**
  97812. * Sets the layer id use to find what meshes are impacted by the light.
  97813. * Inactive if 0
  97814. */
  97815. set includeOnlyWithLayerMask(value: number);
  97816. private _lightmapMode;
  97817. /**
  97818. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97819. */
  97820. get lightmapMode(): number;
  97821. /**
  97822. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97823. */
  97824. set lightmapMode(value: number);
  97825. /**
  97826. * Shadow generator associted to the light.
  97827. * @hidden Internal use only.
  97828. */
  97829. _shadowGenerator: Nullable<IShadowGenerator>;
  97830. /**
  97831. * @hidden Internal use only.
  97832. */
  97833. _excludedMeshesIds: string[];
  97834. /**
  97835. * @hidden Internal use only.
  97836. */
  97837. _includedOnlyMeshesIds: string[];
  97838. /**
  97839. * The current light unifom buffer.
  97840. * @hidden Internal use only.
  97841. */
  97842. _uniformBuffer: UniformBuffer;
  97843. /** @hidden */
  97844. _renderId: number;
  97845. /**
  97846. * Creates a Light object in the scene.
  97847. * Documentation : https://doc.babylonjs.com/babylon101/lights
  97848. * @param name The firendly name of the light
  97849. * @param scene The scene the light belongs too
  97850. */
  97851. constructor(name: string, scene: Scene);
  97852. protected abstract _buildUniformLayout(): void;
  97853. /**
  97854. * Sets the passed Effect "effect" with the Light information.
  97855. * @param effect The effect to update
  97856. * @param lightIndex The index of the light in the effect to update
  97857. * @returns The light
  97858. */
  97859. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  97860. /**
  97861. * Sets the passed Effect "effect" with the Light textures.
  97862. * @param effect The effect to update
  97863. * @param lightIndex The index of the light in the effect to update
  97864. * @returns The light
  97865. */
  97866. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  97867. /**
  97868. * Binds the lights information from the scene to the effect for the given mesh.
  97869. * @param lightIndex Light index
  97870. * @param scene The scene where the light belongs to
  97871. * @param effect The effect we are binding the data to
  97872. * @param useSpecular Defines if specular is supported
  97873. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  97874. */
  97875. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  97876. /**
  97877. * Sets the passed Effect "effect" with the Light information.
  97878. * @param effect The effect to update
  97879. * @param lightDataUniformName The uniform used to store light data (position or direction)
  97880. * @returns The light
  97881. */
  97882. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  97883. /**
  97884. * Returns the string "Light".
  97885. * @returns the class name
  97886. */
  97887. getClassName(): string;
  97888. /** @hidden */
  97889. readonly _isLight: boolean;
  97890. /**
  97891. * Converts the light information to a readable string for debug purpose.
  97892. * @param fullDetails Supports for multiple levels of logging within scene loading
  97893. * @returns the human readable light info
  97894. */
  97895. toString(fullDetails?: boolean): string;
  97896. /** @hidden */
  97897. protected _syncParentEnabledState(): void;
  97898. /**
  97899. * Set the enabled state of this node.
  97900. * @param value - the new enabled state
  97901. */
  97902. setEnabled(value: boolean): void;
  97903. /**
  97904. * Returns the Light associated shadow generator if any.
  97905. * @return the associated shadow generator.
  97906. */
  97907. getShadowGenerator(): Nullable<IShadowGenerator>;
  97908. /**
  97909. * Returns a Vector3, the absolute light position in the World.
  97910. * @returns the world space position of the light
  97911. */
  97912. getAbsolutePosition(): Vector3;
  97913. /**
  97914. * Specifies if the light will affect the passed mesh.
  97915. * @param mesh The mesh to test against the light
  97916. * @return true the mesh is affected otherwise, false.
  97917. */
  97918. canAffectMesh(mesh: AbstractMesh): boolean;
  97919. /**
  97920. * Sort function to order lights for rendering.
  97921. * @param a First Light object to compare to second.
  97922. * @param b Second Light object to compare first.
  97923. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  97924. */
  97925. static CompareLightsPriority(a: Light, b: Light): number;
  97926. /**
  97927. * Releases resources associated with this node.
  97928. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  97929. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  97930. */
  97931. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  97932. /**
  97933. * Returns the light type ID (integer).
  97934. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  97935. */
  97936. getTypeID(): number;
  97937. /**
  97938. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  97939. * @returns the scaled intensity in intensity mode unit
  97940. */
  97941. getScaledIntensity(): number;
  97942. /**
  97943. * Returns a new Light object, named "name", from the current one.
  97944. * @param name The name of the cloned light
  97945. * @param newParent The parent of this light, if it has one
  97946. * @returns the new created light
  97947. */
  97948. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  97949. /**
  97950. * Serializes the current light into a Serialization object.
  97951. * @returns the serialized object.
  97952. */
  97953. serialize(): any;
  97954. /**
  97955. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  97956. * This new light is named "name" and added to the passed scene.
  97957. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  97958. * @param name The friendly name of the light
  97959. * @param scene The scene the new light will belong to
  97960. * @returns the constructor function
  97961. */
  97962. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  97963. /**
  97964. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  97965. * @param parsedLight The JSON representation of the light
  97966. * @param scene The scene to create the parsed light in
  97967. * @returns the created light after parsing
  97968. */
  97969. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  97970. private _hookArrayForExcluded;
  97971. private _hookArrayForIncludedOnly;
  97972. private _resyncMeshes;
  97973. /**
  97974. * Forces the meshes to update their light related information in their rendering used effects
  97975. * @hidden Internal Use Only
  97976. */
  97977. _markMeshesAsLightDirty(): void;
  97978. /**
  97979. * Recomputes the cached photometric scale if needed.
  97980. */
  97981. private _computePhotometricScale;
  97982. /**
  97983. * Returns the Photometric Scale according to the light type and intensity mode.
  97984. */
  97985. private _getPhotometricScale;
  97986. /**
  97987. * Reorder the light in the scene according to their defined priority.
  97988. * @hidden Internal Use Only
  97989. */
  97990. _reorderLightsInScene(): void;
  97991. /**
  97992. * Prepares the list of defines specific to the light type.
  97993. * @param defines the list of defines
  97994. * @param lightIndex defines the index of the light for the effect
  97995. */
  97996. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  97997. }
  97998. }
  97999. declare module BABYLON {
  98000. /**
  98001. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  98002. * This is the base of the follow, arc rotate cameras and Free camera
  98003. * @see https://doc.babylonjs.com/features/cameras
  98004. */
  98005. export class TargetCamera extends Camera {
  98006. private static _RigCamTransformMatrix;
  98007. private static _TargetTransformMatrix;
  98008. private static _TargetFocalPoint;
  98009. private _tmpUpVector;
  98010. private _tmpTargetVector;
  98011. /**
  98012. * Define the current direction the camera is moving to
  98013. */
  98014. cameraDirection: Vector3;
  98015. /**
  98016. * Define the current rotation the camera is rotating to
  98017. */
  98018. cameraRotation: Vector2;
  98019. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  98020. ignoreParentScaling: boolean;
  98021. /**
  98022. * When set, the up vector of the camera will be updated by the rotation of the camera
  98023. */
  98024. updateUpVectorFromRotation: boolean;
  98025. private _tmpQuaternion;
  98026. /**
  98027. * Define the current rotation of the camera
  98028. */
  98029. rotation: Vector3;
  98030. /**
  98031. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  98032. */
  98033. rotationQuaternion: Quaternion;
  98034. /**
  98035. * Define the current speed of the camera
  98036. */
  98037. speed: number;
  98038. /**
  98039. * Add constraint to the camera to prevent it to move freely in all directions and
  98040. * around all axis.
  98041. */
  98042. noRotationConstraint: boolean;
  98043. /**
  98044. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  98045. * panning
  98046. */
  98047. invertRotation: boolean;
  98048. /**
  98049. * Speed multiplier for inverse camera panning
  98050. */
  98051. inverseRotationSpeed: number;
  98052. /**
  98053. * Define the current target of the camera as an object or a position.
  98054. */
  98055. lockedTarget: any;
  98056. /** @hidden */
  98057. _currentTarget: Vector3;
  98058. /** @hidden */
  98059. _initialFocalDistance: number;
  98060. /** @hidden */
  98061. _viewMatrix: Matrix;
  98062. /** @hidden */
  98063. _camMatrix: Matrix;
  98064. /** @hidden */
  98065. _cameraTransformMatrix: Matrix;
  98066. /** @hidden */
  98067. _cameraRotationMatrix: Matrix;
  98068. /** @hidden */
  98069. _referencePoint: Vector3;
  98070. /** @hidden */
  98071. _transformedReferencePoint: Vector3;
  98072. /** @hidden */
  98073. _reset: () => void;
  98074. private _defaultUp;
  98075. /**
  98076. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  98077. * This is the base of the follow, arc rotate cameras and Free camera
  98078. * @see https://doc.babylonjs.com/features/cameras
  98079. * @param name Defines the name of the camera in the scene
  98080. * @param position Defines the start position of the camera in the scene
  98081. * @param scene Defines the scene the camera belongs to
  98082. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98083. */
  98084. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98085. /**
  98086. * Gets the position in front of the camera at a given distance.
  98087. * @param distance The distance from the camera we want the position to be
  98088. * @returns the position
  98089. */
  98090. getFrontPosition(distance: number): Vector3;
  98091. /** @hidden */
  98092. _getLockedTargetPosition(): Nullable<Vector3>;
  98093. private _storedPosition;
  98094. private _storedRotation;
  98095. private _storedRotationQuaternion;
  98096. /**
  98097. * Store current camera state of the camera (fov, position, rotation, etc..)
  98098. * @returns the camera
  98099. */
  98100. storeState(): Camera;
  98101. /**
  98102. * Restored camera state. You must call storeState() first
  98103. * @returns whether it was successful or not
  98104. * @hidden
  98105. */
  98106. _restoreStateValues(): boolean;
  98107. /** @hidden */
  98108. _initCache(): void;
  98109. /** @hidden */
  98110. _updateCache(ignoreParentClass?: boolean): void;
  98111. /** @hidden */
  98112. _isSynchronizedViewMatrix(): boolean;
  98113. /** @hidden */
  98114. _computeLocalCameraSpeed(): number;
  98115. /**
  98116. * Defines the target the camera should look at.
  98117. * @param target Defines the new target as a Vector or a mesh
  98118. */
  98119. setTarget(target: Vector3): void;
  98120. /**
  98121. * Defines the target point of the camera.
  98122. * The camera looks towards it form the radius distance.
  98123. */
  98124. get target(): Vector3;
  98125. set target(value: Vector3);
  98126. /**
  98127. * Return the current target position of the camera. This value is expressed in local space.
  98128. * @returns the target position
  98129. */
  98130. getTarget(): Vector3;
  98131. /** @hidden */
  98132. _decideIfNeedsToMove(): boolean;
  98133. /** @hidden */
  98134. _updatePosition(): void;
  98135. /** @hidden */
  98136. _checkInputs(): void;
  98137. protected _updateCameraRotationMatrix(): void;
  98138. /**
  98139. * 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)
  98140. * @returns the current camera
  98141. */
  98142. private _rotateUpVectorWithCameraRotationMatrix;
  98143. private _cachedRotationZ;
  98144. private _cachedQuaternionRotationZ;
  98145. /** @hidden */
  98146. _getViewMatrix(): Matrix;
  98147. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  98148. /**
  98149. * @hidden
  98150. */
  98151. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  98152. /**
  98153. * @hidden
  98154. */
  98155. _updateRigCameras(): void;
  98156. private _getRigCamPositionAndTarget;
  98157. /**
  98158. * Gets the current object class name.
  98159. * @return the class name
  98160. */
  98161. getClassName(): string;
  98162. }
  98163. }
  98164. declare module BABYLON {
  98165. /**
  98166. * Gather the list of keyboard event types as constants.
  98167. */
  98168. export class KeyboardEventTypes {
  98169. /**
  98170. * The keydown event is fired when a key becomes active (pressed).
  98171. */
  98172. static readonly KEYDOWN: number;
  98173. /**
  98174. * The keyup event is fired when a key has been released.
  98175. */
  98176. static readonly KEYUP: number;
  98177. }
  98178. /**
  98179. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98180. */
  98181. export class KeyboardInfo {
  98182. /**
  98183. * Defines the type of event (KeyboardEventTypes)
  98184. */
  98185. type: number;
  98186. /**
  98187. * Defines the related dom event
  98188. */
  98189. event: KeyboardEvent;
  98190. /**
  98191. * Instantiates a new keyboard info.
  98192. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98193. * @param type Defines the type of event (KeyboardEventTypes)
  98194. * @param event Defines the related dom event
  98195. */
  98196. constructor(
  98197. /**
  98198. * Defines the type of event (KeyboardEventTypes)
  98199. */
  98200. type: number,
  98201. /**
  98202. * Defines the related dom event
  98203. */
  98204. event: KeyboardEvent);
  98205. }
  98206. /**
  98207. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98208. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  98209. */
  98210. export class KeyboardInfoPre extends KeyboardInfo {
  98211. /**
  98212. * Defines the type of event (KeyboardEventTypes)
  98213. */
  98214. type: number;
  98215. /**
  98216. * Defines the related dom event
  98217. */
  98218. event: KeyboardEvent;
  98219. /**
  98220. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  98221. */
  98222. skipOnPointerObservable: boolean;
  98223. /**
  98224. * Instantiates a new keyboard pre info.
  98225. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98226. * @param type Defines the type of event (KeyboardEventTypes)
  98227. * @param event Defines the related dom event
  98228. */
  98229. constructor(
  98230. /**
  98231. * Defines the type of event (KeyboardEventTypes)
  98232. */
  98233. type: number,
  98234. /**
  98235. * Defines the related dom event
  98236. */
  98237. event: KeyboardEvent);
  98238. }
  98239. }
  98240. declare module BABYLON {
  98241. /**
  98242. * Manage the keyboard inputs to control the movement of a free camera.
  98243. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98244. */
  98245. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  98246. /**
  98247. * Defines the camera the input is attached to.
  98248. */
  98249. camera: FreeCamera;
  98250. /**
  98251. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98252. */
  98253. keysUp: number[];
  98254. /**
  98255. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98256. */
  98257. keysUpward: number[];
  98258. /**
  98259. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98260. */
  98261. keysDown: number[];
  98262. /**
  98263. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98264. */
  98265. keysDownward: number[];
  98266. /**
  98267. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98268. */
  98269. keysLeft: number[];
  98270. /**
  98271. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98272. */
  98273. keysRight: number[];
  98274. private _keys;
  98275. private _onCanvasBlurObserver;
  98276. private _onKeyboardObserver;
  98277. private _engine;
  98278. private _scene;
  98279. /**
  98280. * Attach the input controls to a specific dom element to get the input from.
  98281. * @param element Defines the element the controls should be listened from
  98282. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98283. */
  98284. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98285. /**
  98286. * Detach the current controls from the specified dom element.
  98287. * @param element Defines the element to stop listening the inputs from
  98288. */
  98289. detachControl(element: Nullable<HTMLElement>): void;
  98290. /**
  98291. * Update the current camera state depending on the inputs that have been used this frame.
  98292. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98293. */
  98294. checkInputs(): void;
  98295. /**
  98296. * Gets the class name of the current intput.
  98297. * @returns the class name
  98298. */
  98299. getClassName(): string;
  98300. /** @hidden */
  98301. _onLostFocus(): void;
  98302. /**
  98303. * Get the friendly name associated with the input class.
  98304. * @returns the input friendly name
  98305. */
  98306. getSimpleName(): string;
  98307. }
  98308. }
  98309. declare module BABYLON {
  98310. /**
  98311. * Gather the list of pointer event types as constants.
  98312. */
  98313. export class PointerEventTypes {
  98314. /**
  98315. * 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.
  98316. */
  98317. static readonly POINTERDOWN: number;
  98318. /**
  98319. * The pointerup event is fired when a pointer is no longer active.
  98320. */
  98321. static readonly POINTERUP: number;
  98322. /**
  98323. * The pointermove event is fired when a pointer changes coordinates.
  98324. */
  98325. static readonly POINTERMOVE: number;
  98326. /**
  98327. * The pointerwheel event is fired when a mouse wheel has been rotated.
  98328. */
  98329. static readonly POINTERWHEEL: number;
  98330. /**
  98331. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  98332. */
  98333. static readonly POINTERPICK: number;
  98334. /**
  98335. * The pointertap event is fired when a the object has been touched and released without drag.
  98336. */
  98337. static readonly POINTERTAP: number;
  98338. /**
  98339. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  98340. */
  98341. static readonly POINTERDOUBLETAP: number;
  98342. }
  98343. /**
  98344. * Base class of pointer info types.
  98345. */
  98346. export class PointerInfoBase {
  98347. /**
  98348. * Defines the type of event (PointerEventTypes)
  98349. */
  98350. type: number;
  98351. /**
  98352. * Defines the related dom event
  98353. */
  98354. event: PointerEvent | MouseWheelEvent;
  98355. /**
  98356. * Instantiates the base class of pointers info.
  98357. * @param type Defines the type of event (PointerEventTypes)
  98358. * @param event Defines the related dom event
  98359. */
  98360. constructor(
  98361. /**
  98362. * Defines the type of event (PointerEventTypes)
  98363. */
  98364. type: number,
  98365. /**
  98366. * Defines the related dom event
  98367. */
  98368. event: PointerEvent | MouseWheelEvent);
  98369. }
  98370. /**
  98371. * This class is used to store pointer related info for the onPrePointerObservable event.
  98372. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  98373. */
  98374. export class PointerInfoPre extends PointerInfoBase {
  98375. /**
  98376. * Ray from a pointer if availible (eg. 6dof controller)
  98377. */
  98378. ray: Nullable<Ray>;
  98379. /**
  98380. * Defines the local position of the pointer on the canvas.
  98381. */
  98382. localPosition: Vector2;
  98383. /**
  98384. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  98385. */
  98386. skipOnPointerObservable: boolean;
  98387. /**
  98388. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  98389. * @param type Defines the type of event (PointerEventTypes)
  98390. * @param event Defines the related dom event
  98391. * @param localX Defines the local x coordinates of the pointer when the event occured
  98392. * @param localY Defines the local y coordinates of the pointer when the event occured
  98393. */
  98394. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  98395. }
  98396. /**
  98397. * This type contains all the data related to a pointer event in Babylon.js.
  98398. * 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.
  98399. */
  98400. export class PointerInfo extends PointerInfoBase {
  98401. /**
  98402. * Defines the picking info associated to the info (if any)\
  98403. */
  98404. pickInfo: Nullable<PickingInfo>;
  98405. /**
  98406. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  98407. * @param type Defines the type of event (PointerEventTypes)
  98408. * @param event Defines the related dom event
  98409. * @param pickInfo Defines the picking info associated to the info (if any)\
  98410. */
  98411. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  98412. /**
  98413. * Defines the picking info associated to the info (if any)\
  98414. */
  98415. pickInfo: Nullable<PickingInfo>);
  98416. }
  98417. /**
  98418. * Data relating to a touch event on the screen.
  98419. */
  98420. export interface PointerTouch {
  98421. /**
  98422. * X coordinate of touch.
  98423. */
  98424. x: number;
  98425. /**
  98426. * Y coordinate of touch.
  98427. */
  98428. y: number;
  98429. /**
  98430. * Id of touch. Unique for each finger.
  98431. */
  98432. pointerId: number;
  98433. /**
  98434. * Event type passed from DOM.
  98435. */
  98436. type: any;
  98437. }
  98438. }
  98439. declare module BABYLON {
  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. */
  98444. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  98445. /**
  98446. * Define if touch is enabled in the mouse input
  98447. */
  98448. touchEnabled: boolean;
  98449. /**
  98450. * Defines the camera the input is attached to.
  98451. */
  98452. camera: FreeCamera;
  98453. /**
  98454. * Defines the buttons associated with the input to handle camera move.
  98455. */
  98456. buttons: number[];
  98457. /**
  98458. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  98459. */
  98460. angularSensibility: number;
  98461. private _pointerInput;
  98462. private _onMouseMove;
  98463. private _observer;
  98464. private previousPosition;
  98465. /**
  98466. * Observable for when a pointer move event occurs containing the move offset
  98467. */
  98468. onPointerMovedObservable: Observable<{
  98469. offsetX: number;
  98470. offsetY: number;
  98471. }>;
  98472. /**
  98473. * @hidden
  98474. * If the camera should be rotated automatically based on pointer movement
  98475. */
  98476. _allowCameraRotation: boolean;
  98477. /**
  98478. * Manage the mouse inputs to control the movement of a free camera.
  98479. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98480. * @param touchEnabled Defines if touch is enabled or not
  98481. */
  98482. constructor(
  98483. /**
  98484. * Define if touch is enabled in the mouse input
  98485. */
  98486. touchEnabled?: boolean);
  98487. /**
  98488. * Attach the input controls to a specific dom element to get the input from.
  98489. * @param element Defines the element the controls should be listened from
  98490. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98491. */
  98492. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98493. /**
  98494. * Called on JS contextmenu event.
  98495. * Override this method to provide functionality.
  98496. */
  98497. protected onContextMenu(evt: PointerEvent): void;
  98498. /**
  98499. * Detach the current controls from the specified dom element.
  98500. * @param element Defines the element to stop listening the inputs from
  98501. */
  98502. detachControl(element: Nullable<HTMLElement>): void;
  98503. /**
  98504. * Gets the class name of the current intput.
  98505. * @returns the class name
  98506. */
  98507. getClassName(): string;
  98508. /**
  98509. * Get the friendly name associated with the input class.
  98510. * @returns the input friendly name
  98511. */
  98512. getSimpleName(): string;
  98513. }
  98514. }
  98515. declare module BABYLON {
  98516. /**
  98517. * Manage the touch inputs to control the movement of a free camera.
  98518. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98519. */
  98520. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  98521. /**
  98522. * Define if mouse events can be treated as touch events
  98523. */
  98524. allowMouse: boolean;
  98525. /**
  98526. * Defines the camera the input is attached to.
  98527. */
  98528. camera: FreeCamera;
  98529. /**
  98530. * Defines the touch sensibility for rotation.
  98531. * The higher the faster.
  98532. */
  98533. touchAngularSensibility: number;
  98534. /**
  98535. * Defines the touch sensibility for move.
  98536. * The higher the faster.
  98537. */
  98538. touchMoveSensibility: number;
  98539. private _offsetX;
  98540. private _offsetY;
  98541. private _pointerPressed;
  98542. private _pointerInput;
  98543. private _observer;
  98544. private _onLostFocus;
  98545. /**
  98546. * Manage the touch inputs to control the movement of a free camera.
  98547. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98548. * @param allowMouse Defines if mouse events can be treated as touch events
  98549. */
  98550. constructor(
  98551. /**
  98552. * Define if mouse events can be treated as touch events
  98553. */
  98554. allowMouse?: boolean);
  98555. /**
  98556. * Attach the input controls to a specific dom element to get the input from.
  98557. * @param element Defines the element the controls should be listened from
  98558. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98559. */
  98560. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98561. /**
  98562. * Detach the current controls from the specified dom element.
  98563. * @param element Defines the element to stop listening the inputs from
  98564. */
  98565. detachControl(element: Nullable<HTMLElement>): void;
  98566. /**
  98567. * Update the current camera state depending on the inputs that have been used this frame.
  98568. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98569. */
  98570. checkInputs(): void;
  98571. /**
  98572. * Gets the class name of the current intput.
  98573. * @returns the class name
  98574. */
  98575. getClassName(): string;
  98576. /**
  98577. * Get the friendly name associated with the input class.
  98578. * @returns the input friendly name
  98579. */
  98580. getSimpleName(): string;
  98581. }
  98582. }
  98583. declare module BABYLON {
  98584. /**
  98585. * Default Inputs manager for the FreeCamera.
  98586. * It groups all the default supported inputs for ease of use.
  98587. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98588. */
  98589. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  98590. /**
  98591. * @hidden
  98592. */
  98593. _mouseInput: Nullable<FreeCameraMouseInput>;
  98594. /**
  98595. * Instantiates a new FreeCameraInputsManager.
  98596. * @param camera Defines the camera the inputs belong to
  98597. */
  98598. constructor(camera: FreeCamera);
  98599. /**
  98600. * Add keyboard input support to the input manager.
  98601. * @returns the current input manager
  98602. */
  98603. addKeyboard(): FreeCameraInputsManager;
  98604. /**
  98605. * Add mouse input support to the input manager.
  98606. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  98607. * @returns the current input manager
  98608. */
  98609. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  98610. /**
  98611. * Removes the mouse input support from the manager
  98612. * @returns the current input manager
  98613. */
  98614. removeMouse(): FreeCameraInputsManager;
  98615. /**
  98616. * Add touch input support to the input manager.
  98617. * @returns the current input manager
  98618. */
  98619. addTouch(): FreeCameraInputsManager;
  98620. /**
  98621. * Remove all attached input methods from a camera
  98622. */
  98623. clear(): void;
  98624. }
  98625. }
  98626. declare module BABYLON {
  98627. /**
  98628. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98629. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  98630. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98631. */
  98632. export class FreeCamera extends TargetCamera {
  98633. /**
  98634. * Define the collision ellipsoid of the camera.
  98635. * This is helpful to simulate a camera body like the player body around the camera
  98636. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  98637. */
  98638. ellipsoid: Vector3;
  98639. /**
  98640. * Define an offset for the position of the ellipsoid around the camera.
  98641. * This can be helpful to determine the center of the body near the gravity center of the body
  98642. * instead of its head.
  98643. */
  98644. ellipsoidOffset: Vector3;
  98645. /**
  98646. * Enable or disable collisions of the camera with the rest of the scene objects.
  98647. */
  98648. checkCollisions: boolean;
  98649. /**
  98650. * Enable or disable gravity on the camera.
  98651. */
  98652. applyGravity: boolean;
  98653. /**
  98654. * Define the input manager associated to the camera.
  98655. */
  98656. inputs: FreeCameraInputsManager;
  98657. /**
  98658. * Gets the input sensibility for a mouse input. (default is 2000.0)
  98659. * Higher values reduce sensitivity.
  98660. */
  98661. get angularSensibility(): number;
  98662. /**
  98663. * Sets the input sensibility for a mouse input. (default is 2000.0)
  98664. * Higher values reduce sensitivity.
  98665. */
  98666. set angularSensibility(value: number);
  98667. /**
  98668. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98669. */
  98670. get keysUp(): number[];
  98671. set keysUp(value: number[]);
  98672. /**
  98673. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98674. */
  98675. get keysUpward(): number[];
  98676. set keysUpward(value: number[]);
  98677. /**
  98678. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98679. */
  98680. get keysDown(): number[];
  98681. set keysDown(value: number[]);
  98682. /**
  98683. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98684. */
  98685. get keysDownward(): number[];
  98686. set keysDownward(value: number[]);
  98687. /**
  98688. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98689. */
  98690. get keysLeft(): number[];
  98691. set keysLeft(value: number[]);
  98692. /**
  98693. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98694. */
  98695. get keysRight(): number[];
  98696. set keysRight(value: number[]);
  98697. /**
  98698. * Event raised when the camera collide with a mesh in the scene.
  98699. */
  98700. onCollide: (collidedMesh: AbstractMesh) => void;
  98701. private _collider;
  98702. private _needMoveForGravity;
  98703. private _oldPosition;
  98704. private _diffPosition;
  98705. private _newPosition;
  98706. /** @hidden */
  98707. _localDirection: Vector3;
  98708. /** @hidden */
  98709. _transformedDirection: Vector3;
  98710. /**
  98711. * Instantiates a Free Camera.
  98712. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98713. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  98714. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98715. * @param name Define the name of the camera in the scene
  98716. * @param position Define the start position of the camera in the scene
  98717. * @param scene Define the scene the camera belongs to
  98718. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98719. */
  98720. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98721. /**
  98722. * Attached controls to the current camera.
  98723. * @param element Defines the element the controls should be listened from
  98724. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98725. */
  98726. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98727. /**
  98728. * Detach the current controls from the camera.
  98729. * The camera will stop reacting to inputs.
  98730. * @param element Defines the element to stop listening the inputs from
  98731. */
  98732. detachControl(element: HTMLElement): void;
  98733. private _collisionMask;
  98734. /**
  98735. * Define a collision mask to limit the list of object the camera can collide with
  98736. */
  98737. get collisionMask(): number;
  98738. set collisionMask(mask: number);
  98739. /** @hidden */
  98740. _collideWithWorld(displacement: Vector3): void;
  98741. private _onCollisionPositionChange;
  98742. /** @hidden */
  98743. _checkInputs(): void;
  98744. /** @hidden */
  98745. _decideIfNeedsToMove(): boolean;
  98746. /** @hidden */
  98747. _updatePosition(): void;
  98748. /**
  98749. * Destroy the camera and release the current resources hold by it.
  98750. */
  98751. dispose(): void;
  98752. /**
  98753. * Gets the current object class name.
  98754. * @return the class name
  98755. */
  98756. getClassName(): string;
  98757. }
  98758. }
  98759. declare module BABYLON {
  98760. /**
  98761. * Represents a gamepad control stick position
  98762. */
  98763. export class StickValues {
  98764. /**
  98765. * The x component of the control stick
  98766. */
  98767. x: number;
  98768. /**
  98769. * The y component of the control stick
  98770. */
  98771. y: number;
  98772. /**
  98773. * Initializes the gamepad x and y control stick values
  98774. * @param x The x component of the gamepad control stick value
  98775. * @param y The y component of the gamepad control stick value
  98776. */
  98777. constructor(
  98778. /**
  98779. * The x component of the control stick
  98780. */
  98781. x: number,
  98782. /**
  98783. * The y component of the control stick
  98784. */
  98785. y: number);
  98786. }
  98787. /**
  98788. * An interface which manages callbacks for gamepad button changes
  98789. */
  98790. export interface GamepadButtonChanges {
  98791. /**
  98792. * Called when a gamepad has been changed
  98793. */
  98794. changed: boolean;
  98795. /**
  98796. * Called when a gamepad press event has been triggered
  98797. */
  98798. pressChanged: boolean;
  98799. /**
  98800. * Called when a touch event has been triggered
  98801. */
  98802. touchChanged: boolean;
  98803. /**
  98804. * Called when a value has changed
  98805. */
  98806. valueChanged: boolean;
  98807. }
  98808. /**
  98809. * Represents a gamepad
  98810. */
  98811. export class Gamepad {
  98812. /**
  98813. * The id of the gamepad
  98814. */
  98815. id: string;
  98816. /**
  98817. * The index of the gamepad
  98818. */
  98819. index: number;
  98820. /**
  98821. * The browser gamepad
  98822. */
  98823. browserGamepad: any;
  98824. /**
  98825. * Specifies what type of gamepad this represents
  98826. */
  98827. type: number;
  98828. private _leftStick;
  98829. private _rightStick;
  98830. /** @hidden */
  98831. _isConnected: boolean;
  98832. private _leftStickAxisX;
  98833. private _leftStickAxisY;
  98834. private _rightStickAxisX;
  98835. private _rightStickAxisY;
  98836. /**
  98837. * Triggered when the left control stick has been changed
  98838. */
  98839. private _onleftstickchanged;
  98840. /**
  98841. * Triggered when the right control stick has been changed
  98842. */
  98843. private _onrightstickchanged;
  98844. /**
  98845. * Represents a gamepad controller
  98846. */
  98847. static GAMEPAD: number;
  98848. /**
  98849. * Represents a generic controller
  98850. */
  98851. static GENERIC: number;
  98852. /**
  98853. * Represents an XBox controller
  98854. */
  98855. static XBOX: number;
  98856. /**
  98857. * Represents a pose-enabled controller
  98858. */
  98859. static POSE_ENABLED: number;
  98860. /**
  98861. * Represents an Dual Shock controller
  98862. */
  98863. static DUALSHOCK: number;
  98864. /**
  98865. * Specifies whether the left control stick should be Y-inverted
  98866. */
  98867. protected _invertLeftStickY: boolean;
  98868. /**
  98869. * Specifies if the gamepad has been connected
  98870. */
  98871. get isConnected(): boolean;
  98872. /**
  98873. * Initializes the gamepad
  98874. * @param id The id of the gamepad
  98875. * @param index The index of the gamepad
  98876. * @param browserGamepad The browser gamepad
  98877. * @param leftStickX The x component of the left joystick
  98878. * @param leftStickY The y component of the left joystick
  98879. * @param rightStickX The x component of the right joystick
  98880. * @param rightStickY The y component of the right joystick
  98881. */
  98882. constructor(
  98883. /**
  98884. * The id of the gamepad
  98885. */
  98886. id: string,
  98887. /**
  98888. * The index of the gamepad
  98889. */
  98890. index: number,
  98891. /**
  98892. * The browser gamepad
  98893. */
  98894. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  98895. /**
  98896. * Callback triggered when the left joystick has changed
  98897. * @param callback
  98898. */
  98899. onleftstickchanged(callback: (values: StickValues) => void): void;
  98900. /**
  98901. * Callback triggered when the right joystick has changed
  98902. * @param callback
  98903. */
  98904. onrightstickchanged(callback: (values: StickValues) => void): void;
  98905. /**
  98906. * Gets the left joystick
  98907. */
  98908. get leftStick(): StickValues;
  98909. /**
  98910. * Sets the left joystick values
  98911. */
  98912. set leftStick(newValues: StickValues);
  98913. /**
  98914. * Gets the right joystick
  98915. */
  98916. get rightStick(): StickValues;
  98917. /**
  98918. * Sets the right joystick value
  98919. */
  98920. set rightStick(newValues: StickValues);
  98921. /**
  98922. * Updates the gamepad joystick positions
  98923. */
  98924. update(): void;
  98925. /**
  98926. * Disposes the gamepad
  98927. */
  98928. dispose(): void;
  98929. }
  98930. /**
  98931. * Represents a generic gamepad
  98932. */
  98933. export class GenericPad extends Gamepad {
  98934. private _buttons;
  98935. private _onbuttondown;
  98936. private _onbuttonup;
  98937. /**
  98938. * Observable triggered when a button has been pressed
  98939. */
  98940. onButtonDownObservable: Observable<number>;
  98941. /**
  98942. * Observable triggered when a button has been released
  98943. */
  98944. onButtonUpObservable: Observable<number>;
  98945. /**
  98946. * Callback triggered when a button has been pressed
  98947. * @param callback Called when a button has been pressed
  98948. */
  98949. onbuttondown(callback: (buttonPressed: number) => void): void;
  98950. /**
  98951. * Callback triggered when a button has been released
  98952. * @param callback Called when a button has been released
  98953. */
  98954. onbuttonup(callback: (buttonReleased: number) => void): void;
  98955. /**
  98956. * Initializes the generic gamepad
  98957. * @param id The id of the generic gamepad
  98958. * @param index The index of the generic gamepad
  98959. * @param browserGamepad The browser gamepad
  98960. */
  98961. constructor(id: string, index: number, browserGamepad: any);
  98962. private _setButtonValue;
  98963. /**
  98964. * Updates the generic gamepad
  98965. */
  98966. update(): void;
  98967. /**
  98968. * Disposes the generic gamepad
  98969. */
  98970. dispose(): void;
  98971. }
  98972. }
  98973. declare module BABYLON {
  98974. /**
  98975. * Defines the types of pose enabled controllers that are supported
  98976. */
  98977. export enum PoseEnabledControllerType {
  98978. /**
  98979. * HTC Vive
  98980. */
  98981. VIVE = 0,
  98982. /**
  98983. * Oculus Rift
  98984. */
  98985. OCULUS = 1,
  98986. /**
  98987. * Windows mixed reality
  98988. */
  98989. WINDOWS = 2,
  98990. /**
  98991. * Samsung gear VR
  98992. */
  98993. GEAR_VR = 3,
  98994. /**
  98995. * Google Daydream
  98996. */
  98997. DAYDREAM = 4,
  98998. /**
  98999. * Generic
  99000. */
  99001. GENERIC = 5
  99002. }
  99003. /**
  99004. * Defines the MutableGamepadButton interface for the state of a gamepad button
  99005. */
  99006. export interface MutableGamepadButton {
  99007. /**
  99008. * Value of the button/trigger
  99009. */
  99010. value: number;
  99011. /**
  99012. * If the button/trigger is currently touched
  99013. */
  99014. touched: boolean;
  99015. /**
  99016. * If the button/trigger is currently pressed
  99017. */
  99018. pressed: boolean;
  99019. }
  99020. /**
  99021. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  99022. * @hidden
  99023. */
  99024. export interface ExtendedGamepadButton extends GamepadButton {
  99025. /**
  99026. * If the button/trigger is currently pressed
  99027. */
  99028. readonly pressed: boolean;
  99029. /**
  99030. * If the button/trigger is currently touched
  99031. */
  99032. readonly touched: boolean;
  99033. /**
  99034. * Value of the button/trigger
  99035. */
  99036. readonly value: number;
  99037. }
  99038. /** @hidden */
  99039. export interface _GamePadFactory {
  99040. /**
  99041. * Returns whether or not the current gamepad can be created for this type of controller.
  99042. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99043. * @returns true if it can be created, otherwise false
  99044. */
  99045. canCreate(gamepadInfo: any): boolean;
  99046. /**
  99047. * Creates a new instance of the Gamepad.
  99048. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99049. * @returns the new gamepad instance
  99050. */
  99051. create(gamepadInfo: any): Gamepad;
  99052. }
  99053. /**
  99054. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99055. */
  99056. export class PoseEnabledControllerHelper {
  99057. /** @hidden */
  99058. static _ControllerFactories: _GamePadFactory[];
  99059. /** @hidden */
  99060. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  99061. /**
  99062. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99063. * @param vrGamepad the gamepad to initialized
  99064. * @returns a vr controller of the type the gamepad identified as
  99065. */
  99066. static InitiateController(vrGamepad: any): Gamepad;
  99067. }
  99068. /**
  99069. * Defines the PoseEnabledController object that contains state of a vr capable controller
  99070. */
  99071. export class PoseEnabledController extends Gamepad implements PoseControlled {
  99072. /**
  99073. * If the controller is used in a webXR session
  99074. */
  99075. isXR: boolean;
  99076. private _deviceRoomPosition;
  99077. private _deviceRoomRotationQuaternion;
  99078. /**
  99079. * The device position in babylon space
  99080. */
  99081. devicePosition: Vector3;
  99082. /**
  99083. * The device rotation in babylon space
  99084. */
  99085. deviceRotationQuaternion: Quaternion;
  99086. /**
  99087. * The scale factor of the device in babylon space
  99088. */
  99089. deviceScaleFactor: number;
  99090. /**
  99091. * (Likely devicePosition should be used instead) The device position in its room space
  99092. */
  99093. position: Vector3;
  99094. /**
  99095. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  99096. */
  99097. rotationQuaternion: Quaternion;
  99098. /**
  99099. * The type of controller (Eg. Windows mixed reality)
  99100. */
  99101. controllerType: PoseEnabledControllerType;
  99102. protected _calculatedPosition: Vector3;
  99103. private _calculatedRotation;
  99104. /**
  99105. * The raw pose from the device
  99106. */
  99107. rawPose: DevicePose;
  99108. private _trackPosition;
  99109. private _maxRotationDistFromHeadset;
  99110. private _draggedRoomRotation;
  99111. /**
  99112. * @hidden
  99113. */
  99114. _disableTrackPosition(fixedPosition: Vector3): void;
  99115. /**
  99116. * Internal, the mesh attached to the controller
  99117. * @hidden
  99118. */
  99119. _mesh: Nullable<AbstractMesh>;
  99120. private _poseControlledCamera;
  99121. private _leftHandSystemQuaternion;
  99122. /**
  99123. * Internal, matrix used to convert room space to babylon space
  99124. * @hidden
  99125. */
  99126. _deviceToWorld: Matrix;
  99127. /**
  99128. * Node to be used when casting a ray from the controller
  99129. * @hidden
  99130. */
  99131. _pointingPoseNode: Nullable<TransformNode>;
  99132. /**
  99133. * Name of the child mesh that can be used to cast a ray from the controller
  99134. */
  99135. static readonly POINTING_POSE: string;
  99136. /**
  99137. * Creates a new PoseEnabledController from a gamepad
  99138. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  99139. */
  99140. constructor(browserGamepad: any);
  99141. private _workingMatrix;
  99142. /**
  99143. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  99144. */
  99145. update(): void;
  99146. /**
  99147. * Updates only the pose device and mesh without doing any button event checking
  99148. */
  99149. protected _updatePoseAndMesh(): void;
  99150. /**
  99151. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  99152. * @param poseData raw pose fromthe device
  99153. */
  99154. updateFromDevice(poseData: DevicePose): void;
  99155. /**
  99156. * @hidden
  99157. */
  99158. _meshAttachedObservable: Observable<AbstractMesh>;
  99159. /**
  99160. * Attaches a mesh to the controller
  99161. * @param mesh the mesh to be attached
  99162. */
  99163. attachToMesh(mesh: AbstractMesh): void;
  99164. /**
  99165. * Attaches the controllers mesh to a camera
  99166. * @param camera the camera the mesh should be attached to
  99167. */
  99168. attachToPoseControlledCamera(camera: TargetCamera): void;
  99169. /**
  99170. * Disposes of the controller
  99171. */
  99172. dispose(): void;
  99173. /**
  99174. * The mesh that is attached to the controller
  99175. */
  99176. get mesh(): Nullable<AbstractMesh>;
  99177. /**
  99178. * Gets the ray of the controller in the direction the controller is pointing
  99179. * @param length the length the resulting ray should be
  99180. * @returns a ray in the direction the controller is pointing
  99181. */
  99182. getForwardRay(length?: number): Ray;
  99183. }
  99184. }
  99185. declare module BABYLON {
  99186. /**
  99187. * Defines the WebVRController object that represents controllers tracked in 3D space
  99188. */
  99189. export abstract class WebVRController extends PoseEnabledController {
  99190. /**
  99191. * Internal, the default controller model for the controller
  99192. */
  99193. protected _defaultModel: Nullable<AbstractMesh>;
  99194. /**
  99195. * Fired when the trigger state has changed
  99196. */
  99197. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  99198. /**
  99199. * Fired when the main button state has changed
  99200. */
  99201. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99202. /**
  99203. * Fired when the secondary button state has changed
  99204. */
  99205. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99206. /**
  99207. * Fired when the pad state has changed
  99208. */
  99209. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  99210. /**
  99211. * Fired when controllers stick values have changed
  99212. */
  99213. onPadValuesChangedObservable: Observable<StickValues>;
  99214. /**
  99215. * Array of button availible on the controller
  99216. */
  99217. protected _buttons: Array<MutableGamepadButton>;
  99218. private _onButtonStateChange;
  99219. /**
  99220. * Fired when a controller button's state has changed
  99221. * @param callback the callback containing the button that was modified
  99222. */
  99223. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  99224. /**
  99225. * X and Y axis corresponding to the controllers joystick
  99226. */
  99227. pad: StickValues;
  99228. /**
  99229. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  99230. */
  99231. hand: string;
  99232. /**
  99233. * The default controller model for the controller
  99234. */
  99235. get defaultModel(): Nullable<AbstractMesh>;
  99236. /**
  99237. * Creates a new WebVRController from a gamepad
  99238. * @param vrGamepad the gamepad that the WebVRController should be created from
  99239. */
  99240. constructor(vrGamepad: any);
  99241. /**
  99242. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  99243. */
  99244. update(): void;
  99245. /**
  99246. * Function to be called when a button is modified
  99247. */
  99248. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  99249. /**
  99250. * Loads a mesh and attaches it to the controller
  99251. * @param scene the scene the mesh should be added to
  99252. * @param meshLoaded callback for when the mesh has been loaded
  99253. */
  99254. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  99255. private _setButtonValue;
  99256. private _changes;
  99257. private _checkChanges;
  99258. /**
  99259. * Disposes of th webVRCOntroller
  99260. */
  99261. dispose(): void;
  99262. }
  99263. }
  99264. declare module BABYLON {
  99265. /**
  99266. * The HemisphericLight simulates the ambient environment light,
  99267. * so the passed direction is the light reflection direction, not the incoming direction.
  99268. */
  99269. export class HemisphericLight extends Light {
  99270. /**
  99271. * The groundColor is the light in the opposite direction to the one specified during creation.
  99272. * 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.
  99273. */
  99274. groundColor: Color3;
  99275. /**
  99276. * The light reflection direction, not the incoming direction.
  99277. */
  99278. direction: Vector3;
  99279. /**
  99280. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  99281. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  99282. * The HemisphericLight can't cast shadows.
  99283. * Documentation : https://doc.babylonjs.com/babylon101/lights
  99284. * @param name The friendly name of the light
  99285. * @param direction The direction of the light reflection
  99286. * @param scene The scene the light belongs to
  99287. */
  99288. constructor(name: string, direction: Vector3, scene: Scene);
  99289. protected _buildUniformLayout(): void;
  99290. /**
  99291. * Returns the string "HemisphericLight".
  99292. * @return The class name
  99293. */
  99294. getClassName(): string;
  99295. /**
  99296. * Sets the HemisphericLight direction towards the passed target (Vector3).
  99297. * Returns the updated direction.
  99298. * @param target The target the direction should point to
  99299. * @return The computed direction
  99300. */
  99301. setDirectionToTarget(target: Vector3): Vector3;
  99302. /**
  99303. * Returns the shadow generator associated to the light.
  99304. * @returns Always null for hemispheric lights because it does not support shadows.
  99305. */
  99306. getShadowGenerator(): Nullable<IShadowGenerator>;
  99307. /**
  99308. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  99309. * @param effect The effect to update
  99310. * @param lightIndex The index of the light in the effect to update
  99311. * @returns The hemispheric light
  99312. */
  99313. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  99314. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  99315. /**
  99316. * Computes the world matrix of the node
  99317. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  99318. * @param useWasUpdatedFlag defines a reserved property
  99319. * @returns the world matrix
  99320. */
  99321. computeWorldMatrix(): Matrix;
  99322. /**
  99323. * Returns the integer 3.
  99324. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  99325. */
  99326. getTypeID(): number;
  99327. /**
  99328. * Prepares the list of defines specific to the light type.
  99329. * @param defines the list of defines
  99330. * @param lightIndex defines the index of the light for the effect
  99331. */
  99332. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  99333. }
  99334. }
  99335. declare module BABYLON {
  99336. /** @hidden */
  99337. export var vrMultiviewToSingleviewPixelShader: {
  99338. name: string;
  99339. shader: string;
  99340. };
  99341. }
  99342. declare module BABYLON {
  99343. /**
  99344. * Renders to multiple views with a single draw call
  99345. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  99346. */
  99347. export class MultiviewRenderTarget extends RenderTargetTexture {
  99348. /**
  99349. * Creates a multiview render target
  99350. * @param scene scene used with the render target
  99351. * @param size the size of the render target (used for each view)
  99352. */
  99353. constructor(scene: Scene, size?: number | {
  99354. width: number;
  99355. height: number;
  99356. } | {
  99357. ratio: number;
  99358. });
  99359. /**
  99360. * @hidden
  99361. * @param faceIndex the face index, if its a cube texture
  99362. */
  99363. _bindFrameBuffer(faceIndex?: number): void;
  99364. /**
  99365. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  99366. * @returns the view count
  99367. */
  99368. getViewCount(): number;
  99369. }
  99370. }
  99371. declare module BABYLON {
  99372. interface Engine {
  99373. /**
  99374. * Creates a new multiview render target
  99375. * @param width defines the width of the texture
  99376. * @param height defines the height of the texture
  99377. * @returns the created multiview texture
  99378. */
  99379. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  99380. /**
  99381. * Binds a multiview framebuffer to be drawn to
  99382. * @param multiviewTexture texture to bind
  99383. */
  99384. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  99385. }
  99386. interface Camera {
  99387. /**
  99388. * @hidden
  99389. * 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)
  99390. */
  99391. _useMultiviewToSingleView: boolean;
  99392. /**
  99393. * @hidden
  99394. * 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)
  99395. */
  99396. _multiviewTexture: Nullable<RenderTargetTexture>;
  99397. /**
  99398. * @hidden
  99399. * ensures the multiview texture of the camera exists and has the specified width/height
  99400. * @param width height to set on the multiview texture
  99401. * @param height width to set on the multiview texture
  99402. */
  99403. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  99404. }
  99405. interface Scene {
  99406. /** @hidden */
  99407. _transformMatrixR: Matrix;
  99408. /** @hidden */
  99409. _multiviewSceneUbo: Nullable<UniformBuffer>;
  99410. /** @hidden */
  99411. _createMultiviewUbo(): void;
  99412. /** @hidden */
  99413. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  99414. /** @hidden */
  99415. _renderMultiviewToSingleView(camera: Camera): void;
  99416. }
  99417. }
  99418. declare module BABYLON {
  99419. /**
  99420. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  99421. * This will not be used for webXR as it supports displaying texture arrays directly
  99422. */
  99423. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  99424. /**
  99425. * Gets a string identifying the name of the class
  99426. * @returns "VRMultiviewToSingleviewPostProcess" string
  99427. */
  99428. getClassName(): string;
  99429. /**
  99430. * Initializes a VRMultiviewToSingleview
  99431. * @param name name of the post process
  99432. * @param camera camera to be applied to
  99433. * @param scaleFactor scaling factor to the size of the output texture
  99434. */
  99435. constructor(name: string, camera: Camera, scaleFactor: number);
  99436. }
  99437. }
  99438. declare module BABYLON {
  99439. /**
  99440. * Interface used to define additional presentation attributes
  99441. */
  99442. export interface IVRPresentationAttributes {
  99443. /**
  99444. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  99445. */
  99446. highRefreshRate: boolean;
  99447. /**
  99448. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  99449. */
  99450. foveationLevel: number;
  99451. }
  99452. interface Engine {
  99453. /** @hidden */
  99454. _vrDisplay: any;
  99455. /** @hidden */
  99456. _vrSupported: boolean;
  99457. /** @hidden */
  99458. _oldSize: Size;
  99459. /** @hidden */
  99460. _oldHardwareScaleFactor: number;
  99461. /** @hidden */
  99462. _vrExclusivePointerMode: boolean;
  99463. /** @hidden */
  99464. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  99465. /** @hidden */
  99466. _onVRDisplayPointerRestricted: () => void;
  99467. /** @hidden */
  99468. _onVRDisplayPointerUnrestricted: () => void;
  99469. /** @hidden */
  99470. _onVrDisplayConnect: Nullable<(display: any) => void>;
  99471. /** @hidden */
  99472. _onVrDisplayDisconnect: Nullable<() => void>;
  99473. /** @hidden */
  99474. _onVrDisplayPresentChange: Nullable<() => void>;
  99475. /**
  99476. * Observable signaled when VR display mode changes
  99477. */
  99478. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  99479. /**
  99480. * Observable signaled when VR request present is complete
  99481. */
  99482. onVRRequestPresentComplete: Observable<boolean>;
  99483. /**
  99484. * Observable signaled when VR request present starts
  99485. */
  99486. onVRRequestPresentStart: Observable<Engine>;
  99487. /**
  99488. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  99489. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  99490. */
  99491. isInVRExclusivePointerMode: boolean;
  99492. /**
  99493. * Gets a boolean indicating if a webVR device was detected
  99494. * @returns true if a webVR device was detected
  99495. */
  99496. isVRDevicePresent(): boolean;
  99497. /**
  99498. * Gets the current webVR device
  99499. * @returns the current webVR device (or null)
  99500. */
  99501. getVRDevice(): any;
  99502. /**
  99503. * Initializes a webVR display and starts listening to display change events
  99504. * The onVRDisplayChangedObservable will be notified upon these changes
  99505. * @returns A promise containing a VRDisplay and if vr is supported
  99506. */
  99507. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  99508. /** @hidden */
  99509. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  99510. /**
  99511. * Gets or sets the presentation attributes used to configure VR rendering
  99512. */
  99513. vrPresentationAttributes?: IVRPresentationAttributes;
  99514. /**
  99515. * Call this function to switch to webVR mode
  99516. * Will do nothing if webVR is not supported or if there is no webVR device
  99517. * @param options the webvr options provided to the camera. mainly used for multiview
  99518. * @see https://doc.babylonjs.com/how_to/webvr_camera
  99519. */
  99520. enableVR(options: WebVROptions): void;
  99521. /** @hidden */
  99522. _onVRFullScreenTriggered(): void;
  99523. }
  99524. }
  99525. declare module BABYLON {
  99526. /**
  99527. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  99528. * IMPORTANT!! The data is right-hand data.
  99529. * @export
  99530. * @interface DevicePose
  99531. */
  99532. export interface DevicePose {
  99533. /**
  99534. * The position of the device, values in array are [x,y,z].
  99535. */
  99536. readonly position: Nullable<Float32Array>;
  99537. /**
  99538. * The linearVelocity of the device, values in array are [x,y,z].
  99539. */
  99540. readonly linearVelocity: Nullable<Float32Array>;
  99541. /**
  99542. * The linearAcceleration of the device, values in array are [x,y,z].
  99543. */
  99544. readonly linearAcceleration: Nullable<Float32Array>;
  99545. /**
  99546. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  99547. */
  99548. readonly orientation: Nullable<Float32Array>;
  99549. /**
  99550. * The angularVelocity of the device, values in array are [x,y,z].
  99551. */
  99552. readonly angularVelocity: Nullable<Float32Array>;
  99553. /**
  99554. * The angularAcceleration of the device, values in array are [x,y,z].
  99555. */
  99556. readonly angularAcceleration: Nullable<Float32Array>;
  99557. }
  99558. /**
  99559. * Interface representing a pose controlled object in Babylon.
  99560. * A pose controlled object has both regular pose values as well as pose values
  99561. * from an external device such as a VR head mounted display
  99562. */
  99563. export interface PoseControlled {
  99564. /**
  99565. * The position of the object in babylon space.
  99566. */
  99567. position: Vector3;
  99568. /**
  99569. * The rotation quaternion of the object in babylon space.
  99570. */
  99571. rotationQuaternion: Quaternion;
  99572. /**
  99573. * The position of the device in babylon space.
  99574. */
  99575. devicePosition?: Vector3;
  99576. /**
  99577. * The rotation quaternion of the device in babylon space.
  99578. */
  99579. deviceRotationQuaternion: Quaternion;
  99580. /**
  99581. * The raw pose coming from the device.
  99582. */
  99583. rawPose: Nullable<DevicePose>;
  99584. /**
  99585. * The scale of the device to be used when translating from device space to babylon space.
  99586. */
  99587. deviceScaleFactor: number;
  99588. /**
  99589. * Updates the poseControlled values based on the input device pose.
  99590. * @param poseData the pose data to update the object with
  99591. */
  99592. updateFromDevice(poseData: DevicePose): void;
  99593. }
  99594. /**
  99595. * Set of options to customize the webVRCamera
  99596. */
  99597. export interface WebVROptions {
  99598. /**
  99599. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  99600. */
  99601. trackPosition?: boolean;
  99602. /**
  99603. * Sets the scale of the vrDevice in babylon space. (default: 1)
  99604. */
  99605. positionScale?: number;
  99606. /**
  99607. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  99608. */
  99609. displayName?: string;
  99610. /**
  99611. * Should the native controller meshes be initialized. (default: true)
  99612. */
  99613. controllerMeshes?: boolean;
  99614. /**
  99615. * Creating a default HemiLight only on controllers. (default: true)
  99616. */
  99617. defaultLightingOnControllers?: boolean;
  99618. /**
  99619. * If you don't want to use the default VR button of the helper. (default: false)
  99620. */
  99621. useCustomVRButton?: boolean;
  99622. /**
  99623. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  99624. */
  99625. customVRButton?: HTMLButtonElement;
  99626. /**
  99627. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  99628. */
  99629. rayLength?: number;
  99630. /**
  99631. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  99632. */
  99633. defaultHeight?: number;
  99634. /**
  99635. * If multiview should be used if availible (default: false)
  99636. */
  99637. useMultiview?: boolean;
  99638. }
  99639. /**
  99640. * This represents a WebVR camera.
  99641. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  99642. * @example https://doc.babylonjs.com/how_to/webvr_camera
  99643. */
  99644. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  99645. private webVROptions;
  99646. /**
  99647. * @hidden
  99648. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  99649. */
  99650. _vrDevice: any;
  99651. /**
  99652. * The rawPose of the vrDevice.
  99653. */
  99654. rawPose: Nullable<DevicePose>;
  99655. private _onVREnabled;
  99656. private _specsVersion;
  99657. private _attached;
  99658. private _frameData;
  99659. protected _descendants: Array<Node>;
  99660. private _deviceRoomPosition;
  99661. /** @hidden */
  99662. _deviceRoomRotationQuaternion: Quaternion;
  99663. private _standingMatrix;
  99664. /**
  99665. * Represents device position in babylon space.
  99666. */
  99667. devicePosition: Vector3;
  99668. /**
  99669. * Represents device rotation in babylon space.
  99670. */
  99671. deviceRotationQuaternion: Quaternion;
  99672. /**
  99673. * The scale of the device to be used when translating from device space to babylon space.
  99674. */
  99675. deviceScaleFactor: number;
  99676. private _deviceToWorld;
  99677. private _worldToDevice;
  99678. /**
  99679. * References to the webVR controllers for the vrDevice.
  99680. */
  99681. controllers: Array<WebVRController>;
  99682. /**
  99683. * Emits an event when a controller is attached.
  99684. */
  99685. onControllersAttachedObservable: Observable<WebVRController[]>;
  99686. /**
  99687. * Emits an event when a controller's mesh has been loaded;
  99688. */
  99689. onControllerMeshLoadedObservable: Observable<WebVRController>;
  99690. /**
  99691. * Emits an event when the HMD's pose has been updated.
  99692. */
  99693. onPoseUpdatedFromDeviceObservable: Observable<any>;
  99694. private _poseSet;
  99695. /**
  99696. * If the rig cameras be used as parent instead of this camera.
  99697. */
  99698. rigParenting: boolean;
  99699. private _lightOnControllers;
  99700. private _defaultHeight?;
  99701. /**
  99702. * Instantiates a WebVRFreeCamera.
  99703. * @param name The name of the WebVRFreeCamera
  99704. * @param position The starting anchor position for the camera
  99705. * @param scene The scene the camera belongs to
  99706. * @param webVROptions a set of customizable options for the webVRCamera
  99707. */
  99708. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  99709. /**
  99710. * Gets the device distance from the ground in meters.
  99711. * @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.
  99712. */
  99713. deviceDistanceToRoomGround(): number;
  99714. /**
  99715. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99716. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  99717. */
  99718. useStandingMatrix(callback?: (bool: boolean) => void): void;
  99719. /**
  99720. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99721. * @returns A promise with a boolean set to if the standing matrix is supported.
  99722. */
  99723. useStandingMatrixAsync(): Promise<boolean>;
  99724. /**
  99725. * Disposes the camera
  99726. */
  99727. dispose(): void;
  99728. /**
  99729. * Gets a vrController by name.
  99730. * @param name The name of the controller to retreive
  99731. * @returns the controller matching the name specified or null if not found
  99732. */
  99733. getControllerByName(name: string): Nullable<WebVRController>;
  99734. private _leftController;
  99735. /**
  99736. * The controller corresponding to the users left hand.
  99737. */
  99738. get leftController(): Nullable<WebVRController>;
  99739. private _rightController;
  99740. /**
  99741. * The controller corresponding to the users right hand.
  99742. */
  99743. get rightController(): Nullable<WebVRController>;
  99744. /**
  99745. * Casts a ray forward from the vrCamera's gaze.
  99746. * @param length Length of the ray (default: 100)
  99747. * @returns the ray corresponding to the gaze
  99748. */
  99749. getForwardRay(length?: number): Ray;
  99750. /**
  99751. * @hidden
  99752. * Updates the camera based on device's frame data
  99753. */
  99754. _checkInputs(): void;
  99755. /**
  99756. * Updates the poseControlled values based on the input device pose.
  99757. * @param poseData Pose coming from the device
  99758. */
  99759. updateFromDevice(poseData: DevicePose): void;
  99760. private _htmlElementAttached;
  99761. private _detachIfAttached;
  99762. /**
  99763. * WebVR's attach control will start broadcasting frames to the device.
  99764. * Note that in certain browsers (chrome for example) this function must be called
  99765. * within a user-interaction callback. Example:
  99766. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  99767. *
  99768. * @param element html element to attach the vrDevice to
  99769. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  99770. */
  99771. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99772. /**
  99773. * Detaches the camera from the html element and disables VR
  99774. *
  99775. * @param element html element to detach from
  99776. */
  99777. detachControl(element: HTMLElement): void;
  99778. /**
  99779. * @returns the name of this class
  99780. */
  99781. getClassName(): string;
  99782. /**
  99783. * Calls resetPose on the vrDisplay
  99784. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  99785. */
  99786. resetToCurrentRotation(): void;
  99787. /**
  99788. * @hidden
  99789. * Updates the rig cameras (left and right eye)
  99790. */
  99791. _updateRigCameras(): void;
  99792. private _workingVector;
  99793. private _oneVector;
  99794. private _workingMatrix;
  99795. private updateCacheCalled;
  99796. private _correctPositionIfNotTrackPosition;
  99797. /**
  99798. * @hidden
  99799. * Updates the cached values of the camera
  99800. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  99801. */
  99802. _updateCache(ignoreParentClass?: boolean): void;
  99803. /**
  99804. * @hidden
  99805. * Get current device position in babylon world
  99806. */
  99807. _computeDevicePosition(): void;
  99808. /**
  99809. * Updates the current device position and rotation in the babylon world
  99810. */
  99811. update(): void;
  99812. /**
  99813. * @hidden
  99814. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  99815. * @returns an identity matrix
  99816. */
  99817. _getViewMatrix(): Matrix;
  99818. private _tmpMatrix;
  99819. /**
  99820. * This function is called by the two RIG cameras.
  99821. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  99822. * @hidden
  99823. */
  99824. _getWebVRViewMatrix(): Matrix;
  99825. /** @hidden */
  99826. _getWebVRProjectionMatrix(): Matrix;
  99827. private _onGamepadConnectedObserver;
  99828. private _onGamepadDisconnectedObserver;
  99829. private _updateCacheWhenTrackingDisabledObserver;
  99830. /**
  99831. * Initializes the controllers and their meshes
  99832. */
  99833. initControllers(): void;
  99834. }
  99835. }
  99836. declare module BABYLON {
  99837. /**
  99838. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  99839. *
  99840. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  99841. *
  99842. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  99843. */
  99844. export class MaterialHelper {
  99845. /**
  99846. * Bind the current view position to an effect.
  99847. * @param effect The effect to be bound
  99848. * @param scene The scene the eyes position is used from
  99849. * @param variableName name of the shader variable that will hold the eye position
  99850. */
  99851. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  99852. /**
  99853. * Helps preparing the defines values about the UVs in used in the effect.
  99854. * UVs are shared as much as we can accross channels in the shaders.
  99855. * @param texture The texture we are preparing the UVs for
  99856. * @param defines The defines to update
  99857. * @param key The channel key "diffuse", "specular"... used in the shader
  99858. */
  99859. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  99860. /**
  99861. * Binds a texture matrix value to its corrsponding uniform
  99862. * @param texture The texture to bind the matrix for
  99863. * @param uniformBuffer The uniform buffer receivin the data
  99864. * @param key The channel key "diffuse", "specular"... used in the shader
  99865. */
  99866. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  99867. /**
  99868. * Gets the current status of the fog (should it be enabled?)
  99869. * @param mesh defines the mesh to evaluate for fog support
  99870. * @param scene defines the hosting scene
  99871. * @returns true if fog must be enabled
  99872. */
  99873. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  99874. /**
  99875. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  99876. * @param mesh defines the current mesh
  99877. * @param scene defines the current scene
  99878. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  99879. * @param pointsCloud defines if point cloud rendering has to be turned on
  99880. * @param fogEnabled defines if fog has to be turned on
  99881. * @param alphaTest defines if alpha testing has to be turned on
  99882. * @param defines defines the current list of defines
  99883. */
  99884. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  99885. /**
  99886. * Helper used to prepare the list of defines associated with frame values for shader compilation
  99887. * @param scene defines the current scene
  99888. * @param engine defines the current engine
  99889. * @param defines specifies the list of active defines
  99890. * @param useInstances defines if instances have to be turned on
  99891. * @param useClipPlane defines if clip plane have to be turned on
  99892. * @param useInstances defines if instances have to be turned on
  99893. * @param useThinInstances defines if thin instances have to be turned on
  99894. */
  99895. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  99896. /**
  99897. * Prepares the defines for bones
  99898. * @param mesh The mesh containing the geometry data we will draw
  99899. * @param defines The defines to update
  99900. */
  99901. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  99902. /**
  99903. * Prepares the defines for morph targets
  99904. * @param mesh The mesh containing the geometry data we will draw
  99905. * @param defines The defines to update
  99906. */
  99907. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  99908. /**
  99909. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  99910. * @param mesh The mesh containing the geometry data we will draw
  99911. * @param defines The defines to update
  99912. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  99913. * @param useBones Precise whether bones should be used or not (override mesh info)
  99914. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  99915. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  99916. * @returns false if defines are considered not dirty and have not been checked
  99917. */
  99918. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  99919. /**
  99920. * Prepares the defines related to multiview
  99921. * @param scene The scene we are intending to draw
  99922. * @param defines The defines to update
  99923. */
  99924. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  99925. /**
  99926. * Prepares the defines related to the prepass
  99927. * @param scene The scene we are intending to draw
  99928. * @param defines The defines to update
  99929. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  99930. */
  99931. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  99932. /**
  99933. * Prepares the defines related to the light information passed in parameter
  99934. * @param scene The scene we are intending to draw
  99935. * @param mesh The mesh the effect is compiling for
  99936. * @param light The light the effect is compiling for
  99937. * @param lightIndex The index of the light
  99938. * @param defines The defines to update
  99939. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99940. * @param state Defines the current state regarding what is needed (normals, etc...)
  99941. */
  99942. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  99943. needNormals: boolean;
  99944. needRebuild: boolean;
  99945. shadowEnabled: boolean;
  99946. specularEnabled: boolean;
  99947. lightmapMode: boolean;
  99948. }): void;
  99949. /**
  99950. * Prepares the defines related to the light information passed in parameter
  99951. * @param scene The scene we are intending to draw
  99952. * @param mesh The mesh the effect is compiling for
  99953. * @param defines The defines to update
  99954. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99955. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  99956. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  99957. * @returns true if normals will be required for the rest of the effect
  99958. */
  99959. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  99960. /**
  99961. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  99962. * @param lightIndex defines the light index
  99963. * @param uniformsList The uniform list
  99964. * @param samplersList The sampler list
  99965. * @param projectedLightTexture defines if projected texture must be used
  99966. * @param uniformBuffersList defines an optional list of uniform buffers
  99967. */
  99968. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  99969. /**
  99970. * Prepares the uniforms and samplers list to be used in the effect
  99971. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  99972. * @param samplersList The sampler list
  99973. * @param defines The defines helping in the list generation
  99974. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  99975. */
  99976. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  99977. /**
  99978. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  99979. * @param defines The defines to update while falling back
  99980. * @param fallbacks The authorized effect fallbacks
  99981. * @param maxSimultaneousLights The maximum number of lights allowed
  99982. * @param rank the current rank of the Effect
  99983. * @returns The newly affected rank
  99984. */
  99985. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  99986. private static _TmpMorphInfluencers;
  99987. /**
  99988. * Prepares the list of attributes required for morph targets according to the effect defines.
  99989. * @param attribs The current list of supported attribs
  99990. * @param mesh The mesh to prepare the morph targets attributes for
  99991. * @param influencers The number of influencers
  99992. */
  99993. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  99994. /**
  99995. * Prepares the list of attributes required for morph targets according to the effect defines.
  99996. * @param attribs The current list of supported attribs
  99997. * @param mesh The mesh to prepare the morph targets attributes for
  99998. * @param defines The current Defines of the effect
  99999. */
  100000. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  100001. /**
  100002. * Prepares the list of attributes required for bones according to the effect defines.
  100003. * @param attribs The current list of supported attribs
  100004. * @param mesh The mesh to prepare the bones attributes for
  100005. * @param defines The current Defines of the effect
  100006. * @param fallbacks The current efffect fallback strategy
  100007. */
  100008. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  100009. /**
  100010. * Check and prepare the list of attributes required for instances according to the effect defines.
  100011. * @param attribs The current list of supported attribs
  100012. * @param defines The current MaterialDefines of the effect
  100013. */
  100014. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  100015. /**
  100016. * Add the list of attributes required for instances to the attribs array.
  100017. * @param attribs The current list of supported attribs
  100018. */
  100019. static PushAttributesForInstances(attribs: string[]): void;
  100020. /**
  100021. * Binds the light information to the effect.
  100022. * @param light The light containing the generator
  100023. * @param effect The effect we are binding the data to
  100024. * @param lightIndex The light index in the effect used to render
  100025. */
  100026. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  100027. /**
  100028. * Binds the lights information from the scene to the effect for the given mesh.
  100029. * @param light Light to bind
  100030. * @param lightIndex Light index
  100031. * @param scene The scene where the light belongs to
  100032. * @param effect The effect we are binding the data to
  100033. * @param useSpecular Defines if specular is supported
  100034. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100035. */
  100036. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  100037. /**
  100038. * Binds the lights information from the scene to the effect for the given mesh.
  100039. * @param scene The scene the lights belongs to
  100040. * @param mesh The mesh we are binding the information to render
  100041. * @param effect The effect we are binding the data to
  100042. * @param defines The generated defines for the effect
  100043. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  100044. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100045. */
  100046. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  100047. private static _tempFogColor;
  100048. /**
  100049. * Binds the fog information from the scene to the effect for the given mesh.
  100050. * @param scene The scene the lights belongs to
  100051. * @param mesh The mesh we are binding the information to render
  100052. * @param effect The effect we are binding the data to
  100053. * @param linearSpace Defines if the fog effect is applied in linear space
  100054. */
  100055. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  100056. /**
  100057. * Binds the bones information from the mesh to the effect.
  100058. * @param mesh The mesh we are binding the information to render
  100059. * @param effect The effect we are binding the data to
  100060. */
  100061. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  100062. /**
  100063. * Binds the morph targets information from the mesh to the effect.
  100064. * @param abstractMesh The mesh we are binding the information to render
  100065. * @param effect The effect we are binding the data to
  100066. */
  100067. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  100068. /**
  100069. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  100070. * @param defines The generated defines used in the effect
  100071. * @param effect The effect we are binding the data to
  100072. * @param scene The scene we are willing to render with logarithmic scale for
  100073. */
  100074. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  100075. /**
  100076. * Binds the clip plane information from the scene to the effect.
  100077. * @param scene The scene the clip plane information are extracted from
  100078. * @param effect The effect we are binding the data to
  100079. */
  100080. static BindClipPlane(effect: Effect, scene: Scene): void;
  100081. }
  100082. }
  100083. declare module BABYLON {
  100084. /**
  100085. * Block used to expose an input value
  100086. */
  100087. export class InputBlock extends NodeMaterialBlock {
  100088. private _mode;
  100089. private _associatedVariableName;
  100090. private _storedValue;
  100091. private _valueCallback;
  100092. private _type;
  100093. private _animationType;
  100094. /** Gets or set a value used to limit the range of float values */
  100095. min: number;
  100096. /** Gets or set a value used to limit the range of float values */
  100097. max: number;
  100098. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  100099. isBoolean: boolean;
  100100. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  100101. matrixMode: number;
  100102. /** @hidden */
  100103. _systemValue: Nullable<NodeMaterialSystemValues>;
  100104. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  100105. visibleInInspector: boolean;
  100106. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  100107. isConstant: boolean;
  100108. /** Gets or sets the group to use to display this block in the Inspector */
  100109. groupInInspector: string;
  100110. /** Gets an observable raised when the value is changed */
  100111. onValueChangedObservable: Observable<InputBlock>;
  100112. /**
  100113. * Gets or sets the connection point type (default is float)
  100114. */
  100115. get type(): NodeMaterialBlockConnectionPointTypes;
  100116. /**
  100117. * Creates a new InputBlock
  100118. * @param name defines the block name
  100119. * @param target defines the target of that block (Vertex by default)
  100120. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  100121. */
  100122. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  100123. /**
  100124. * Validates if a name is a reserve word.
  100125. * @param newName the new name to be given to the node.
  100126. * @returns false if the name is a reserve word, else true.
  100127. */
  100128. validateBlockName(newName: string): boolean;
  100129. /**
  100130. * Gets the output component
  100131. */
  100132. get output(): NodeMaterialConnectionPoint;
  100133. /**
  100134. * Set the source of this connection point to a vertex attribute
  100135. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  100136. * @returns the current connection point
  100137. */
  100138. setAsAttribute(attributeName?: string): InputBlock;
  100139. /**
  100140. * Set the source of this connection point to a system value
  100141. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  100142. * @returns the current connection point
  100143. */
  100144. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  100145. /**
  100146. * Gets or sets the value of that point.
  100147. * Please note that this value will be ignored if valueCallback is defined
  100148. */
  100149. get value(): any;
  100150. set value(value: any);
  100151. /**
  100152. * Gets or sets a callback used to get the value of that point.
  100153. * Please note that setting this value will force the connection point to ignore the value property
  100154. */
  100155. get valueCallback(): () => any;
  100156. set valueCallback(value: () => any);
  100157. /**
  100158. * Gets or sets the associated variable name in the shader
  100159. */
  100160. get associatedVariableName(): string;
  100161. set associatedVariableName(value: string);
  100162. /** Gets or sets the type of animation applied to the input */
  100163. get animationType(): AnimatedInputBlockTypes;
  100164. set animationType(value: AnimatedInputBlockTypes);
  100165. /**
  100166. * Gets a boolean indicating that this connection point not defined yet
  100167. */
  100168. get isUndefined(): boolean;
  100169. /**
  100170. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  100171. * In this case the connection point name must be the name of the uniform to use.
  100172. * Can only be set on inputs
  100173. */
  100174. get isUniform(): boolean;
  100175. set isUniform(value: boolean);
  100176. /**
  100177. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  100178. * In this case the connection point name must be the name of the attribute to use
  100179. * Can only be set on inputs
  100180. */
  100181. get isAttribute(): boolean;
  100182. set isAttribute(value: boolean);
  100183. /**
  100184. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  100185. * Can only be set on exit points
  100186. */
  100187. get isVarying(): boolean;
  100188. set isVarying(value: boolean);
  100189. /**
  100190. * Gets a boolean indicating that the current connection point is a system value
  100191. */
  100192. get isSystemValue(): boolean;
  100193. /**
  100194. * Gets or sets the current well known value or null if not defined as a system value
  100195. */
  100196. get systemValue(): Nullable<NodeMaterialSystemValues>;
  100197. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  100198. /**
  100199. * Gets the current class name
  100200. * @returns the class name
  100201. */
  100202. getClassName(): string;
  100203. /**
  100204. * Animate the input if animationType !== None
  100205. * @param scene defines the rendering scene
  100206. */
  100207. animate(scene: Scene): void;
  100208. private _emitDefine;
  100209. initialize(state: NodeMaterialBuildState): void;
  100210. /**
  100211. * Set the input block to its default value (based on its type)
  100212. */
  100213. setDefaultValue(): void;
  100214. private _emitConstant;
  100215. /** @hidden */
  100216. get _noContextSwitch(): boolean;
  100217. private _emit;
  100218. /** @hidden */
  100219. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  100220. /** @hidden */
  100221. _transmit(effect: Effect, scene: Scene): void;
  100222. protected _buildBlock(state: NodeMaterialBuildState): void;
  100223. protected _dumpPropertiesCode(): string;
  100224. dispose(): void;
  100225. serialize(): any;
  100226. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100227. }
  100228. }
  100229. declare module BABYLON {
  100230. /**
  100231. * Enum used to define the compatibility state between two connection points
  100232. */
  100233. export enum NodeMaterialConnectionPointCompatibilityStates {
  100234. /** Points are compatibles */
  100235. Compatible = 0,
  100236. /** Points are incompatible because of their types */
  100237. TypeIncompatible = 1,
  100238. /** Points are incompatible because of their targets (vertex vs fragment) */
  100239. TargetIncompatible = 2
  100240. }
  100241. /**
  100242. * Defines the direction of a connection point
  100243. */
  100244. export enum NodeMaterialConnectionPointDirection {
  100245. /** Input */
  100246. Input = 0,
  100247. /** Output */
  100248. Output = 1
  100249. }
  100250. /**
  100251. * Defines a connection point for a block
  100252. */
  100253. export class NodeMaterialConnectionPoint {
  100254. /** @hidden */
  100255. _ownerBlock: NodeMaterialBlock;
  100256. /** @hidden */
  100257. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  100258. private _endpoints;
  100259. private _associatedVariableName;
  100260. private _direction;
  100261. /** @hidden */
  100262. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100263. /** @hidden */
  100264. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100265. private _type;
  100266. /** @hidden */
  100267. _enforceAssociatedVariableName: boolean;
  100268. /** Gets the direction of the point */
  100269. get direction(): NodeMaterialConnectionPointDirection;
  100270. /** Indicates that this connection point needs dual validation before being connected to another point */
  100271. needDualDirectionValidation: boolean;
  100272. /**
  100273. * Gets or sets the additional types supported by this connection point
  100274. */
  100275. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100276. /**
  100277. * Gets or sets the additional types excluded by this connection point
  100278. */
  100279. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100280. /**
  100281. * Observable triggered when this point is connected
  100282. */
  100283. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  100284. /**
  100285. * Gets or sets the associated variable name in the shader
  100286. */
  100287. get associatedVariableName(): string;
  100288. set associatedVariableName(value: string);
  100289. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  100290. get innerType(): NodeMaterialBlockConnectionPointTypes;
  100291. /**
  100292. * Gets or sets the connection point type (default is float)
  100293. */
  100294. get type(): NodeMaterialBlockConnectionPointTypes;
  100295. set type(value: NodeMaterialBlockConnectionPointTypes);
  100296. /**
  100297. * Gets or sets the connection point name
  100298. */
  100299. name: string;
  100300. /**
  100301. * Gets or sets the connection point name
  100302. */
  100303. displayName: string;
  100304. /**
  100305. * Gets or sets a boolean indicating that this connection point can be omitted
  100306. */
  100307. isOptional: boolean;
  100308. /**
  100309. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  100310. */
  100311. isExposedOnFrame: boolean;
  100312. /**
  100313. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  100314. */
  100315. define: string;
  100316. /** @hidden */
  100317. _prioritizeVertex: boolean;
  100318. private _target;
  100319. /** Gets or sets the target of that connection point */
  100320. get target(): NodeMaterialBlockTargets;
  100321. set target(value: NodeMaterialBlockTargets);
  100322. /**
  100323. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  100324. */
  100325. get isConnected(): boolean;
  100326. /**
  100327. * Gets a boolean indicating that the current point is connected to an input block
  100328. */
  100329. get isConnectedToInputBlock(): boolean;
  100330. /**
  100331. * Gets a the connected input block (if any)
  100332. */
  100333. get connectInputBlock(): Nullable<InputBlock>;
  100334. /** Get the other side of the connection (if any) */
  100335. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  100336. /** Get the block that owns this connection point */
  100337. get ownerBlock(): NodeMaterialBlock;
  100338. /** Get the block connected on the other side of this connection (if any) */
  100339. get sourceBlock(): Nullable<NodeMaterialBlock>;
  100340. /** Get the block connected on the endpoints of this connection (if any) */
  100341. get connectedBlocks(): Array<NodeMaterialBlock>;
  100342. /** Gets the list of connected endpoints */
  100343. get endpoints(): NodeMaterialConnectionPoint[];
  100344. /** Gets a boolean indicating if that output point is connected to at least one input */
  100345. get hasEndpoints(): boolean;
  100346. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  100347. get isConnectedInVertexShader(): boolean;
  100348. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  100349. get isConnectedInFragmentShader(): boolean;
  100350. /**
  100351. * Creates a block suitable to be used as an input for this input point.
  100352. * If null is returned, a block based on the point type will be created.
  100353. * @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
  100354. */
  100355. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100356. /**
  100357. * Creates a new connection point
  100358. * @param name defines the connection point name
  100359. * @param ownerBlock defines the block hosting this connection point
  100360. * @param direction defines the direction of the connection point
  100361. */
  100362. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  100363. /**
  100364. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  100365. * @returns the class name
  100366. */
  100367. getClassName(): string;
  100368. /**
  100369. * Gets a boolean indicating if the current point can be connected to another point
  100370. * @param connectionPoint defines the other connection point
  100371. * @returns a boolean
  100372. */
  100373. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  100374. /**
  100375. * Gets a number indicating if the current point can be connected to another point
  100376. * @param connectionPoint defines the other connection point
  100377. * @returns a number defining the compatibility state
  100378. */
  100379. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100380. /**
  100381. * Connect this point to another connection point
  100382. * @param connectionPoint defines the other connection point
  100383. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  100384. * @returns the current connection point
  100385. */
  100386. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  100387. /**
  100388. * Disconnect this point from one of his endpoint
  100389. * @param endpoint defines the other connection point
  100390. * @returns the current connection point
  100391. */
  100392. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  100393. /**
  100394. * Serializes this point in a JSON representation
  100395. * @param isInput defines if the connection point is an input (default is true)
  100396. * @returns the serialized point object
  100397. */
  100398. serialize(isInput?: boolean): any;
  100399. /**
  100400. * Release resources
  100401. */
  100402. dispose(): void;
  100403. }
  100404. }
  100405. declare module BABYLON {
  100406. /**
  100407. * Enum used to define the material modes
  100408. */
  100409. export enum NodeMaterialModes {
  100410. /** Regular material */
  100411. Material = 0,
  100412. /** For post process */
  100413. PostProcess = 1,
  100414. /** For particle system */
  100415. Particle = 2
  100416. }
  100417. }
  100418. declare module BABYLON {
  100419. /**
  100420. * Block used to read a texture from a sampler
  100421. */
  100422. export class TextureBlock extends NodeMaterialBlock {
  100423. private _defineName;
  100424. private _linearDefineName;
  100425. private _gammaDefineName;
  100426. private _tempTextureRead;
  100427. private _samplerName;
  100428. private _transformedUVName;
  100429. private _textureTransformName;
  100430. private _textureInfoName;
  100431. private _mainUVName;
  100432. private _mainUVDefineName;
  100433. private _fragmentOnly;
  100434. /**
  100435. * Gets or sets the texture associated with the node
  100436. */
  100437. texture: Nullable<Texture>;
  100438. /**
  100439. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100440. */
  100441. convertToGammaSpace: boolean;
  100442. /**
  100443. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100444. */
  100445. convertToLinearSpace: boolean;
  100446. /**
  100447. * Create a new TextureBlock
  100448. * @param name defines the block name
  100449. */
  100450. constructor(name: string, fragmentOnly?: boolean);
  100451. /**
  100452. * Gets the current class name
  100453. * @returns the class name
  100454. */
  100455. getClassName(): string;
  100456. /**
  100457. * Gets the uv input component
  100458. */
  100459. get uv(): NodeMaterialConnectionPoint;
  100460. /**
  100461. * Gets the rgba output component
  100462. */
  100463. get rgba(): NodeMaterialConnectionPoint;
  100464. /**
  100465. * Gets the rgb output component
  100466. */
  100467. get rgb(): NodeMaterialConnectionPoint;
  100468. /**
  100469. * Gets the r output component
  100470. */
  100471. get r(): NodeMaterialConnectionPoint;
  100472. /**
  100473. * Gets the g output component
  100474. */
  100475. get g(): NodeMaterialConnectionPoint;
  100476. /**
  100477. * Gets the b output component
  100478. */
  100479. get b(): NodeMaterialConnectionPoint;
  100480. /**
  100481. * Gets the a output component
  100482. */
  100483. get a(): NodeMaterialConnectionPoint;
  100484. get target(): NodeMaterialBlockTargets;
  100485. autoConfigure(material: NodeMaterial): void;
  100486. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  100487. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100488. isReady(): boolean;
  100489. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100490. private get _isMixed();
  100491. private _injectVertexCode;
  100492. private _writeTextureRead;
  100493. private _writeOutput;
  100494. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100495. protected _dumpPropertiesCode(): string;
  100496. serialize(): any;
  100497. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100498. }
  100499. }
  100500. declare module BABYLON {
  100501. /** @hidden */
  100502. export var reflectionFunction: {
  100503. name: string;
  100504. shader: string;
  100505. };
  100506. }
  100507. declare module BABYLON {
  100508. /**
  100509. * Base block used to read a reflection texture from a sampler
  100510. */
  100511. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  100512. /** @hidden */
  100513. _define3DName: string;
  100514. /** @hidden */
  100515. _defineCubicName: string;
  100516. /** @hidden */
  100517. _defineExplicitName: string;
  100518. /** @hidden */
  100519. _defineProjectionName: string;
  100520. /** @hidden */
  100521. _defineLocalCubicName: string;
  100522. /** @hidden */
  100523. _defineSphericalName: string;
  100524. /** @hidden */
  100525. _definePlanarName: string;
  100526. /** @hidden */
  100527. _defineEquirectangularName: string;
  100528. /** @hidden */
  100529. _defineMirroredEquirectangularFixedName: string;
  100530. /** @hidden */
  100531. _defineEquirectangularFixedName: string;
  100532. /** @hidden */
  100533. _defineSkyboxName: string;
  100534. /** @hidden */
  100535. _defineOppositeZ: string;
  100536. /** @hidden */
  100537. _cubeSamplerName: string;
  100538. /** @hidden */
  100539. _2DSamplerName: string;
  100540. protected _positionUVWName: string;
  100541. protected _directionWName: string;
  100542. protected _reflectionVectorName: string;
  100543. /** @hidden */
  100544. _reflectionCoordsName: string;
  100545. /** @hidden */
  100546. _reflectionMatrixName: string;
  100547. protected _reflectionColorName: string;
  100548. /**
  100549. * Gets or sets the texture associated with the node
  100550. */
  100551. texture: Nullable<BaseTexture>;
  100552. /**
  100553. * Create a new ReflectionTextureBaseBlock
  100554. * @param name defines the block name
  100555. */
  100556. constructor(name: string);
  100557. /**
  100558. * Gets the current class name
  100559. * @returns the class name
  100560. */
  100561. getClassName(): string;
  100562. /**
  100563. * Gets the world position input component
  100564. */
  100565. abstract get position(): NodeMaterialConnectionPoint;
  100566. /**
  100567. * Gets the world position input component
  100568. */
  100569. abstract get worldPosition(): NodeMaterialConnectionPoint;
  100570. /**
  100571. * Gets the world normal input component
  100572. */
  100573. abstract get worldNormal(): NodeMaterialConnectionPoint;
  100574. /**
  100575. * Gets the world input component
  100576. */
  100577. abstract get world(): NodeMaterialConnectionPoint;
  100578. /**
  100579. * Gets the camera (or eye) position component
  100580. */
  100581. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  100582. /**
  100583. * Gets the view input component
  100584. */
  100585. abstract get view(): NodeMaterialConnectionPoint;
  100586. protected _getTexture(): Nullable<BaseTexture>;
  100587. autoConfigure(material: NodeMaterial): void;
  100588. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100589. isReady(): boolean;
  100590. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100591. /**
  100592. * Gets the code to inject in the vertex shader
  100593. * @param state current state of the node material building
  100594. * @returns the shader code
  100595. */
  100596. handleVertexSide(state: NodeMaterialBuildState): string;
  100597. /**
  100598. * Handles the inits for the fragment code path
  100599. * @param state node material build state
  100600. */
  100601. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  100602. /**
  100603. * Generates the reflection coords code for the fragment code path
  100604. * @param worldNormalVarName name of the world normal variable
  100605. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  100606. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  100607. * @returns the shader code
  100608. */
  100609. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  100610. /**
  100611. * Generates the reflection color code for the fragment code path
  100612. * @param lodVarName name of the lod variable
  100613. * @param swizzleLookupTexture swizzle to use for the final color variable
  100614. * @returns the shader code
  100615. */
  100616. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  100617. /**
  100618. * Generates the code corresponding to the connected output points
  100619. * @param state node material build state
  100620. * @param varName name of the variable to output
  100621. * @returns the shader code
  100622. */
  100623. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  100624. protected _buildBlock(state: NodeMaterialBuildState): this;
  100625. protected _dumpPropertiesCode(): string;
  100626. serialize(): any;
  100627. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100628. }
  100629. }
  100630. declare module BABYLON {
  100631. /**
  100632. * Defines a connection point to be used for points with a custom object type
  100633. */
  100634. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  100635. private _blockType;
  100636. private _blockName;
  100637. private _nameForCheking?;
  100638. /**
  100639. * Creates a new connection point
  100640. * @param name defines the connection point name
  100641. * @param ownerBlock defines the block hosting this connection point
  100642. * @param direction defines the direction of the connection point
  100643. */
  100644. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  100645. /**
  100646. * Gets a number indicating if the current point can be connected to another point
  100647. * @param connectionPoint defines the other connection point
  100648. * @returns a number defining the compatibility state
  100649. */
  100650. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100651. /**
  100652. * Creates a block suitable to be used as an input for this input point.
  100653. * If null is returned, a block based on the point type will be created.
  100654. * @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
  100655. */
  100656. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100657. }
  100658. }
  100659. declare module BABYLON {
  100660. /**
  100661. * Enum defining the type of properties that can be edited in the property pages in the NME
  100662. */
  100663. export enum PropertyTypeForEdition {
  100664. /** property is a boolean */
  100665. Boolean = 0,
  100666. /** property is a float */
  100667. Float = 1,
  100668. /** property is a Vector2 */
  100669. Vector2 = 2,
  100670. /** property is a list of values */
  100671. List = 3
  100672. }
  100673. /**
  100674. * Interface that defines an option in a variable of type list
  100675. */
  100676. export interface IEditablePropertyListOption {
  100677. /** label of the option */
  100678. "label": string;
  100679. /** value of the option */
  100680. "value": number;
  100681. }
  100682. /**
  100683. * Interface that defines the options available for an editable property
  100684. */
  100685. export interface IEditablePropertyOption {
  100686. /** min value */
  100687. "min"?: number;
  100688. /** max value */
  100689. "max"?: number;
  100690. /** notifiers: indicates which actions to take when the property is changed */
  100691. "notifiers"?: {
  100692. /** the material should be rebuilt */
  100693. "rebuild"?: boolean;
  100694. /** the preview should be updated */
  100695. "update"?: boolean;
  100696. };
  100697. /** list of the options for a variable of type list */
  100698. "options"?: IEditablePropertyListOption[];
  100699. }
  100700. /**
  100701. * Interface that describes an editable property
  100702. */
  100703. export interface IPropertyDescriptionForEdition {
  100704. /** name of the property */
  100705. "propertyName": string;
  100706. /** display name of the property */
  100707. "displayName": string;
  100708. /** type of the property */
  100709. "type": PropertyTypeForEdition;
  100710. /** group of the property - all properties with the same group value will be displayed in a specific section */
  100711. "groupName": string;
  100712. /** options for the property */
  100713. "options": IEditablePropertyOption;
  100714. }
  100715. /**
  100716. * Decorator that flags a property in a node material block as being editable
  100717. */
  100718. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  100719. }
  100720. declare module BABYLON {
  100721. /**
  100722. * Block used to implement the refraction part of the sub surface module of the PBR material
  100723. */
  100724. export class RefractionBlock extends NodeMaterialBlock {
  100725. /** @hidden */
  100726. _define3DName: string;
  100727. /** @hidden */
  100728. _refractionMatrixName: string;
  100729. /** @hidden */
  100730. _defineLODRefractionAlpha: string;
  100731. /** @hidden */
  100732. _defineLinearSpecularRefraction: string;
  100733. /** @hidden */
  100734. _defineOppositeZ: string;
  100735. /** @hidden */
  100736. _cubeSamplerName: string;
  100737. /** @hidden */
  100738. _2DSamplerName: string;
  100739. /** @hidden */
  100740. _vRefractionMicrosurfaceInfosName: string;
  100741. /** @hidden */
  100742. _vRefractionInfosName: string;
  100743. private _scene;
  100744. /**
  100745. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  100746. * Materials half opaque for instance using refraction could benefit from this control.
  100747. */
  100748. linkRefractionWithTransparency: boolean;
  100749. /**
  100750. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  100751. */
  100752. invertRefractionY: boolean;
  100753. /**
  100754. * Gets or sets the texture associated with the node
  100755. */
  100756. texture: Nullable<BaseTexture>;
  100757. /**
  100758. * Create a new RefractionBlock
  100759. * @param name defines the block name
  100760. */
  100761. constructor(name: string);
  100762. /**
  100763. * Gets the current class name
  100764. * @returns the class name
  100765. */
  100766. getClassName(): string;
  100767. /**
  100768. * Gets the intensity input component
  100769. */
  100770. get intensity(): NodeMaterialConnectionPoint;
  100771. /**
  100772. * Gets the index of refraction input component
  100773. */
  100774. get indexOfRefraction(): NodeMaterialConnectionPoint;
  100775. /**
  100776. * Gets the tint at distance input component
  100777. */
  100778. get tintAtDistance(): NodeMaterialConnectionPoint;
  100779. /**
  100780. * Gets the view input component
  100781. */
  100782. get view(): NodeMaterialConnectionPoint;
  100783. /**
  100784. * Gets the refraction object output component
  100785. */
  100786. get refraction(): NodeMaterialConnectionPoint;
  100787. /**
  100788. * Returns true if the block has a texture
  100789. */
  100790. get hasTexture(): boolean;
  100791. protected _getTexture(): Nullable<BaseTexture>;
  100792. autoConfigure(material: NodeMaterial): void;
  100793. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100794. isReady(): boolean;
  100795. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  100796. /**
  100797. * Gets the main code of the block (fragment side)
  100798. * @param state current state of the node material building
  100799. * @returns the shader code
  100800. */
  100801. getCode(state: NodeMaterialBuildState): string;
  100802. protected _buildBlock(state: NodeMaterialBuildState): this;
  100803. protected _dumpPropertiesCode(): string;
  100804. serialize(): any;
  100805. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100806. }
  100807. }
  100808. declare module BABYLON {
  100809. /**
  100810. * Base block used as input for post process
  100811. */
  100812. export class CurrentScreenBlock extends NodeMaterialBlock {
  100813. private _samplerName;
  100814. private _linearDefineName;
  100815. private _gammaDefineName;
  100816. private _mainUVName;
  100817. private _tempTextureRead;
  100818. /**
  100819. * Gets or sets the texture associated with the node
  100820. */
  100821. texture: Nullable<BaseTexture>;
  100822. /**
  100823. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100824. */
  100825. convertToGammaSpace: boolean;
  100826. /**
  100827. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100828. */
  100829. convertToLinearSpace: boolean;
  100830. /**
  100831. * Create a new CurrentScreenBlock
  100832. * @param name defines the block name
  100833. */
  100834. constructor(name: string);
  100835. /**
  100836. * Gets the current class name
  100837. * @returns the class name
  100838. */
  100839. getClassName(): string;
  100840. /**
  100841. * Gets the uv input component
  100842. */
  100843. get uv(): NodeMaterialConnectionPoint;
  100844. /**
  100845. * Gets the rgba output component
  100846. */
  100847. get rgba(): NodeMaterialConnectionPoint;
  100848. /**
  100849. * Gets the rgb output component
  100850. */
  100851. get rgb(): NodeMaterialConnectionPoint;
  100852. /**
  100853. * Gets the r output component
  100854. */
  100855. get r(): NodeMaterialConnectionPoint;
  100856. /**
  100857. * Gets the g output component
  100858. */
  100859. get g(): NodeMaterialConnectionPoint;
  100860. /**
  100861. * Gets the b output component
  100862. */
  100863. get b(): NodeMaterialConnectionPoint;
  100864. /**
  100865. * Gets the a output component
  100866. */
  100867. get a(): NodeMaterialConnectionPoint;
  100868. /**
  100869. * Initialize the block and prepare the context for build
  100870. * @param state defines the state that will be used for the build
  100871. */
  100872. initialize(state: NodeMaterialBuildState): void;
  100873. get target(): NodeMaterialBlockTargets;
  100874. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100875. isReady(): boolean;
  100876. private _injectVertexCode;
  100877. private _writeTextureRead;
  100878. private _writeOutput;
  100879. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100880. serialize(): any;
  100881. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100882. }
  100883. }
  100884. declare module BABYLON {
  100885. /**
  100886. * Base block used for the particle texture
  100887. */
  100888. export class ParticleTextureBlock extends NodeMaterialBlock {
  100889. private _samplerName;
  100890. private _linearDefineName;
  100891. private _gammaDefineName;
  100892. private _tempTextureRead;
  100893. /**
  100894. * Gets or sets the texture associated with the node
  100895. */
  100896. texture: Nullable<BaseTexture>;
  100897. /**
  100898. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100899. */
  100900. convertToGammaSpace: boolean;
  100901. /**
  100902. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100903. */
  100904. convertToLinearSpace: boolean;
  100905. /**
  100906. * Create a new ParticleTextureBlock
  100907. * @param name defines the block name
  100908. */
  100909. constructor(name: string);
  100910. /**
  100911. * Gets the current class name
  100912. * @returns the class name
  100913. */
  100914. getClassName(): string;
  100915. /**
  100916. * Gets the uv input component
  100917. */
  100918. get uv(): NodeMaterialConnectionPoint;
  100919. /**
  100920. * Gets the rgba output component
  100921. */
  100922. get rgba(): NodeMaterialConnectionPoint;
  100923. /**
  100924. * Gets the rgb output component
  100925. */
  100926. get rgb(): NodeMaterialConnectionPoint;
  100927. /**
  100928. * Gets the r output component
  100929. */
  100930. get r(): NodeMaterialConnectionPoint;
  100931. /**
  100932. * Gets the g output component
  100933. */
  100934. get g(): NodeMaterialConnectionPoint;
  100935. /**
  100936. * Gets the b output component
  100937. */
  100938. get b(): NodeMaterialConnectionPoint;
  100939. /**
  100940. * Gets the a output component
  100941. */
  100942. get a(): NodeMaterialConnectionPoint;
  100943. /**
  100944. * Initialize the block and prepare the context for build
  100945. * @param state defines the state that will be used for the build
  100946. */
  100947. initialize(state: NodeMaterialBuildState): void;
  100948. autoConfigure(material: NodeMaterial): void;
  100949. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100950. isReady(): boolean;
  100951. private _writeOutput;
  100952. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100953. serialize(): any;
  100954. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100955. }
  100956. }
  100957. declare module BABYLON {
  100958. /**
  100959. * Class used to store shared data between 2 NodeMaterialBuildState
  100960. */
  100961. export class NodeMaterialBuildStateSharedData {
  100962. /**
  100963. * Gets the list of emitted varyings
  100964. */
  100965. temps: string[];
  100966. /**
  100967. * Gets the list of emitted varyings
  100968. */
  100969. varyings: string[];
  100970. /**
  100971. * Gets the varying declaration string
  100972. */
  100973. varyingDeclaration: string;
  100974. /**
  100975. * Input blocks
  100976. */
  100977. inputBlocks: InputBlock[];
  100978. /**
  100979. * Input blocks
  100980. */
  100981. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  100982. /**
  100983. * Bindable blocks (Blocks that need to set data to the effect)
  100984. */
  100985. bindableBlocks: NodeMaterialBlock[];
  100986. /**
  100987. * List of blocks that can provide a compilation fallback
  100988. */
  100989. blocksWithFallbacks: NodeMaterialBlock[];
  100990. /**
  100991. * List of blocks that can provide a define update
  100992. */
  100993. blocksWithDefines: NodeMaterialBlock[];
  100994. /**
  100995. * List of blocks that can provide a repeatable content
  100996. */
  100997. repeatableContentBlocks: NodeMaterialBlock[];
  100998. /**
  100999. * List of blocks that can provide a dynamic list of uniforms
  101000. */
  101001. dynamicUniformBlocks: NodeMaterialBlock[];
  101002. /**
  101003. * List of blocks that can block the isReady function for the material
  101004. */
  101005. blockingBlocks: NodeMaterialBlock[];
  101006. /**
  101007. * Gets the list of animated inputs
  101008. */
  101009. animatedInputs: InputBlock[];
  101010. /**
  101011. * Build Id used to avoid multiple recompilations
  101012. */
  101013. buildId: number;
  101014. /** List of emitted variables */
  101015. variableNames: {
  101016. [key: string]: number;
  101017. };
  101018. /** List of emitted defines */
  101019. defineNames: {
  101020. [key: string]: number;
  101021. };
  101022. /** Should emit comments? */
  101023. emitComments: boolean;
  101024. /** Emit build activity */
  101025. verbose: boolean;
  101026. /** Gets or sets the hosting scene */
  101027. scene: Scene;
  101028. /**
  101029. * Gets the compilation hints emitted at compilation time
  101030. */
  101031. hints: {
  101032. needWorldViewMatrix: boolean;
  101033. needWorldViewProjectionMatrix: boolean;
  101034. needAlphaBlending: boolean;
  101035. needAlphaTesting: boolean;
  101036. };
  101037. /**
  101038. * List of compilation checks
  101039. */
  101040. checks: {
  101041. emitVertex: boolean;
  101042. emitFragment: boolean;
  101043. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  101044. };
  101045. /**
  101046. * Is vertex program allowed to be empty?
  101047. */
  101048. allowEmptyVertexProgram: boolean;
  101049. /** Creates a new shared data */
  101050. constructor();
  101051. /**
  101052. * Emits console errors and exceptions if there is a failing check
  101053. */
  101054. emitErrors(): void;
  101055. }
  101056. }
  101057. declare module BABYLON {
  101058. /**
  101059. * Class used to store node based material build state
  101060. */
  101061. export class NodeMaterialBuildState {
  101062. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  101063. supportUniformBuffers: boolean;
  101064. /**
  101065. * Gets the list of emitted attributes
  101066. */
  101067. attributes: string[];
  101068. /**
  101069. * Gets the list of emitted uniforms
  101070. */
  101071. uniforms: string[];
  101072. /**
  101073. * Gets the list of emitted constants
  101074. */
  101075. constants: string[];
  101076. /**
  101077. * Gets the list of emitted samplers
  101078. */
  101079. samplers: string[];
  101080. /**
  101081. * Gets the list of emitted functions
  101082. */
  101083. functions: {
  101084. [key: string]: string;
  101085. };
  101086. /**
  101087. * Gets the list of emitted extensions
  101088. */
  101089. extensions: {
  101090. [key: string]: string;
  101091. };
  101092. /**
  101093. * Gets the target of the compilation state
  101094. */
  101095. target: NodeMaterialBlockTargets;
  101096. /**
  101097. * Gets the list of emitted counters
  101098. */
  101099. counters: {
  101100. [key: string]: number;
  101101. };
  101102. /**
  101103. * Shared data between multiple NodeMaterialBuildState instances
  101104. */
  101105. sharedData: NodeMaterialBuildStateSharedData;
  101106. /** @hidden */
  101107. _vertexState: NodeMaterialBuildState;
  101108. /** @hidden */
  101109. _attributeDeclaration: string;
  101110. /** @hidden */
  101111. _uniformDeclaration: string;
  101112. /** @hidden */
  101113. _constantDeclaration: string;
  101114. /** @hidden */
  101115. _samplerDeclaration: string;
  101116. /** @hidden */
  101117. _varyingTransfer: string;
  101118. /** @hidden */
  101119. _injectAtEnd: string;
  101120. private _repeatableContentAnchorIndex;
  101121. /** @hidden */
  101122. _builtCompilationString: string;
  101123. /**
  101124. * Gets the emitted compilation strings
  101125. */
  101126. compilationString: string;
  101127. /**
  101128. * Finalize the compilation strings
  101129. * @param state defines the current compilation state
  101130. */
  101131. finalize(state: NodeMaterialBuildState): void;
  101132. /** @hidden */
  101133. get _repeatableContentAnchor(): string;
  101134. /** @hidden */
  101135. _getFreeVariableName(prefix: string): string;
  101136. /** @hidden */
  101137. _getFreeDefineName(prefix: string): string;
  101138. /** @hidden */
  101139. _excludeVariableName(name: string): void;
  101140. /** @hidden */
  101141. _emit2DSampler(name: string): void;
  101142. /** @hidden */
  101143. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  101144. /** @hidden */
  101145. _emitExtension(name: string, extension: string, define?: string): void;
  101146. /** @hidden */
  101147. _emitFunction(name: string, code: string, comments: string): void;
  101148. /** @hidden */
  101149. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  101150. replaceStrings?: {
  101151. search: RegExp;
  101152. replace: string;
  101153. }[];
  101154. repeatKey?: string;
  101155. }): string;
  101156. /** @hidden */
  101157. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  101158. repeatKey?: string;
  101159. removeAttributes?: boolean;
  101160. removeUniforms?: boolean;
  101161. removeVaryings?: boolean;
  101162. removeIfDef?: boolean;
  101163. replaceStrings?: {
  101164. search: RegExp;
  101165. replace: string;
  101166. }[];
  101167. }, storeKey?: string): void;
  101168. /** @hidden */
  101169. _registerTempVariable(name: string): boolean;
  101170. /** @hidden */
  101171. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  101172. /** @hidden */
  101173. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  101174. /** @hidden */
  101175. _emitFloat(value: number): string;
  101176. }
  101177. }
  101178. declare module BABYLON {
  101179. /**
  101180. * Helper class used to generate session unique ID
  101181. */
  101182. export class UniqueIdGenerator {
  101183. private static _UniqueIdCounter;
  101184. /**
  101185. * Gets an unique (relatively to the current scene) Id
  101186. */
  101187. static get UniqueId(): number;
  101188. }
  101189. }
  101190. declare module BABYLON {
  101191. /**
  101192. * Defines a block that can be used inside a node based material
  101193. */
  101194. export class NodeMaterialBlock {
  101195. private _buildId;
  101196. private _buildTarget;
  101197. private _target;
  101198. private _isFinalMerger;
  101199. private _isInput;
  101200. private _name;
  101201. protected _isUnique: boolean;
  101202. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  101203. inputsAreExclusive: boolean;
  101204. /** @hidden */
  101205. _codeVariableName: string;
  101206. /** @hidden */
  101207. _inputs: NodeMaterialConnectionPoint[];
  101208. /** @hidden */
  101209. _outputs: NodeMaterialConnectionPoint[];
  101210. /** @hidden */
  101211. _preparationId: number;
  101212. /**
  101213. * Gets the name of the block
  101214. */
  101215. get name(): string;
  101216. /**
  101217. * Sets the name of the block. Will check if the name is valid.
  101218. */
  101219. set name(newName: string);
  101220. /**
  101221. * Gets or sets the unique id of the node
  101222. */
  101223. uniqueId: number;
  101224. /**
  101225. * Gets or sets the comments associated with this block
  101226. */
  101227. comments: string;
  101228. /**
  101229. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  101230. */
  101231. get isUnique(): boolean;
  101232. /**
  101233. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  101234. */
  101235. get isFinalMerger(): boolean;
  101236. /**
  101237. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  101238. */
  101239. get isInput(): boolean;
  101240. /**
  101241. * Gets or sets the build Id
  101242. */
  101243. get buildId(): number;
  101244. set buildId(value: number);
  101245. /**
  101246. * Gets or sets the target of the block
  101247. */
  101248. get target(): NodeMaterialBlockTargets;
  101249. set target(value: NodeMaterialBlockTargets);
  101250. /**
  101251. * Gets the list of input points
  101252. */
  101253. get inputs(): NodeMaterialConnectionPoint[];
  101254. /** Gets the list of output points */
  101255. get outputs(): NodeMaterialConnectionPoint[];
  101256. /**
  101257. * Find an input by its name
  101258. * @param name defines the name of the input to look for
  101259. * @returns the input or null if not found
  101260. */
  101261. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101262. /**
  101263. * Find an output by its name
  101264. * @param name defines the name of the outputto look for
  101265. * @returns the output or null if not found
  101266. */
  101267. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101268. /**
  101269. * Creates a new NodeMaterialBlock
  101270. * @param name defines the block name
  101271. * @param target defines the target of that block (Vertex by default)
  101272. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  101273. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  101274. */
  101275. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  101276. /**
  101277. * Initialize the block and prepare the context for build
  101278. * @param state defines the state that will be used for the build
  101279. */
  101280. initialize(state: NodeMaterialBuildState): void;
  101281. /**
  101282. * Bind data to effect. Will only be called for blocks with isBindable === true
  101283. * @param effect defines the effect to bind data to
  101284. * @param nodeMaterial defines the hosting NodeMaterial
  101285. * @param mesh defines the mesh that will be rendered
  101286. * @param subMesh defines the submesh that will be rendered
  101287. */
  101288. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101289. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  101290. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  101291. protected _writeFloat(value: number): string;
  101292. /**
  101293. * Gets the current class name e.g. "NodeMaterialBlock"
  101294. * @returns the class name
  101295. */
  101296. getClassName(): string;
  101297. /**
  101298. * Register a new input. Must be called inside a block constructor
  101299. * @param name defines the connection point name
  101300. * @param type defines the connection point type
  101301. * @param isOptional defines a boolean indicating that this input can be omitted
  101302. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101303. * @param point an already created connection point. If not provided, create a new one
  101304. * @returns the current block
  101305. */
  101306. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101307. /**
  101308. * Register a new output. Must be called inside a block constructor
  101309. * @param name defines the connection point name
  101310. * @param type defines the connection point type
  101311. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101312. * @param point an already created connection point. If not provided, create a new one
  101313. * @returns the current block
  101314. */
  101315. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101316. /**
  101317. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  101318. * @param forOutput defines an optional connection point to check compatibility with
  101319. * @returns the first available input or null
  101320. */
  101321. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  101322. /**
  101323. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  101324. * @param forBlock defines an optional block to check compatibility with
  101325. * @returns the first available input or null
  101326. */
  101327. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  101328. /**
  101329. * Gets the sibling of the given output
  101330. * @param current defines the current output
  101331. * @returns the next output in the list or null
  101332. */
  101333. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  101334. /**
  101335. * Connect current block with another block
  101336. * @param other defines the block to connect with
  101337. * @param options define the various options to help pick the right connections
  101338. * @returns the current block
  101339. */
  101340. connectTo(other: NodeMaterialBlock, options?: {
  101341. input?: string;
  101342. output?: string;
  101343. outputSwizzle?: string;
  101344. }): this | undefined;
  101345. protected _buildBlock(state: NodeMaterialBuildState): void;
  101346. /**
  101347. * Add uniforms, samplers and uniform buffers at compilation time
  101348. * @param state defines the state to update
  101349. * @param nodeMaterial defines the node material requesting the update
  101350. * @param defines defines the material defines to update
  101351. * @param uniformBuffers defines the list of uniform buffer names
  101352. */
  101353. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  101354. /**
  101355. * Add potential fallbacks if shader compilation fails
  101356. * @param mesh defines the mesh to be rendered
  101357. * @param fallbacks defines the current prioritized list of fallbacks
  101358. */
  101359. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  101360. /**
  101361. * Initialize defines for shader compilation
  101362. * @param mesh defines the mesh to be rendered
  101363. * @param nodeMaterial defines the node material requesting the update
  101364. * @param defines defines the material defines to update
  101365. * @param useInstances specifies that instances should be used
  101366. */
  101367. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101368. /**
  101369. * Update defines for shader compilation
  101370. * @param mesh defines the mesh to be rendered
  101371. * @param nodeMaterial defines the node material requesting the update
  101372. * @param defines defines the material defines to update
  101373. * @param useInstances specifies that instances should be used
  101374. * @param subMesh defines which submesh to render
  101375. */
  101376. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101377. /**
  101378. * Lets the block try to connect some inputs automatically
  101379. * @param material defines the hosting NodeMaterial
  101380. */
  101381. autoConfigure(material: NodeMaterial): void;
  101382. /**
  101383. * Function called when a block is declared as repeatable content generator
  101384. * @param vertexShaderState defines the current compilation state for the vertex shader
  101385. * @param fragmentShaderState defines the current compilation state for the fragment shader
  101386. * @param mesh defines the mesh to be rendered
  101387. * @param defines defines the material defines to update
  101388. */
  101389. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  101390. /**
  101391. * Checks if the block is ready
  101392. * @param mesh defines the mesh to be rendered
  101393. * @param nodeMaterial defines the node material requesting the update
  101394. * @param defines defines the material defines to update
  101395. * @param useInstances specifies that instances should be used
  101396. * @returns true if the block is ready
  101397. */
  101398. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  101399. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  101400. private _processBuild;
  101401. /**
  101402. * Validates the new name for the block node.
  101403. * @param newName the new name to be given to the node.
  101404. * @returns false if the name is a reserve word, else true.
  101405. */
  101406. validateBlockName(newName: string): boolean;
  101407. /**
  101408. * Compile the current node and generate the shader code
  101409. * @param state defines the current compilation state (uniforms, samplers, current string)
  101410. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  101411. * @returns true if already built
  101412. */
  101413. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  101414. protected _inputRename(name: string): string;
  101415. protected _outputRename(name: string): string;
  101416. protected _dumpPropertiesCode(): string;
  101417. /** @hidden */
  101418. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  101419. /** @hidden */
  101420. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  101421. /**
  101422. * Clone the current block to a new identical block
  101423. * @param scene defines the hosting scene
  101424. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101425. * @returns a copy of the current block
  101426. */
  101427. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  101428. /**
  101429. * Serializes this block in a JSON representation
  101430. * @returns the serialized block object
  101431. */
  101432. serialize(): any;
  101433. /** @hidden */
  101434. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101435. private _deserializePortDisplayNamesAndExposedOnFrame;
  101436. /**
  101437. * Release resources
  101438. */
  101439. dispose(): void;
  101440. }
  101441. }
  101442. declare module BABYLON {
  101443. /**
  101444. * Base class of materials working in push mode in babylon JS
  101445. * @hidden
  101446. */
  101447. export class PushMaterial extends Material {
  101448. protected _activeEffect: Effect;
  101449. protected _normalMatrix: Matrix;
  101450. constructor(name: string, scene: Scene);
  101451. getEffect(): Effect;
  101452. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  101453. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  101454. /**
  101455. * Binds the given world matrix to the active effect
  101456. *
  101457. * @param world the matrix to bind
  101458. */
  101459. bindOnlyWorldMatrix(world: Matrix): void;
  101460. /**
  101461. * Binds the given normal matrix to the active effect
  101462. *
  101463. * @param normalMatrix the matrix to bind
  101464. */
  101465. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  101466. bind(world: Matrix, mesh?: Mesh): void;
  101467. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  101468. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  101469. }
  101470. }
  101471. declare module BABYLON {
  101472. /**
  101473. * Root class for all node material optimizers
  101474. */
  101475. export class NodeMaterialOptimizer {
  101476. /**
  101477. * Function used to optimize a NodeMaterial graph
  101478. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  101479. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  101480. */
  101481. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  101482. }
  101483. }
  101484. declare module BABYLON {
  101485. /**
  101486. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  101487. */
  101488. export class TransformBlock extends NodeMaterialBlock {
  101489. /**
  101490. * Defines the value to use to complement W value to transform it to a Vector4
  101491. */
  101492. complementW: number;
  101493. /**
  101494. * Defines the value to use to complement z value to transform it to a Vector4
  101495. */
  101496. complementZ: number;
  101497. /**
  101498. * Creates a new TransformBlock
  101499. * @param name defines the block name
  101500. */
  101501. constructor(name: string);
  101502. /**
  101503. * Gets the current class name
  101504. * @returns the class name
  101505. */
  101506. getClassName(): string;
  101507. /**
  101508. * Gets the vector input
  101509. */
  101510. get vector(): NodeMaterialConnectionPoint;
  101511. /**
  101512. * Gets the output component
  101513. */
  101514. get output(): NodeMaterialConnectionPoint;
  101515. /**
  101516. * Gets the xyz output component
  101517. */
  101518. get xyz(): NodeMaterialConnectionPoint;
  101519. /**
  101520. * Gets the matrix transform input
  101521. */
  101522. get transform(): NodeMaterialConnectionPoint;
  101523. protected _buildBlock(state: NodeMaterialBuildState): this;
  101524. /**
  101525. * Update defines for shader compilation
  101526. * @param mesh defines the mesh to be rendered
  101527. * @param nodeMaterial defines the node material requesting the update
  101528. * @param defines defines the material defines to update
  101529. * @param useInstances specifies that instances should be used
  101530. * @param subMesh defines which submesh to render
  101531. */
  101532. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101533. serialize(): any;
  101534. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101535. protected _dumpPropertiesCode(): string;
  101536. }
  101537. }
  101538. declare module BABYLON {
  101539. /**
  101540. * Block used to output the vertex position
  101541. */
  101542. export class VertexOutputBlock extends NodeMaterialBlock {
  101543. /**
  101544. * Creates a new VertexOutputBlock
  101545. * @param name defines the block name
  101546. */
  101547. constructor(name: string);
  101548. /**
  101549. * Gets the current class name
  101550. * @returns the class name
  101551. */
  101552. getClassName(): string;
  101553. /**
  101554. * Gets the vector input component
  101555. */
  101556. get vector(): NodeMaterialConnectionPoint;
  101557. protected _buildBlock(state: NodeMaterialBuildState): this;
  101558. }
  101559. }
  101560. declare module BABYLON {
  101561. /**
  101562. * Block used to output the final color
  101563. */
  101564. export class FragmentOutputBlock extends NodeMaterialBlock {
  101565. /**
  101566. * Create a new FragmentOutputBlock
  101567. * @param name defines the block name
  101568. */
  101569. constructor(name: string);
  101570. /**
  101571. * Gets the current class name
  101572. * @returns the class name
  101573. */
  101574. getClassName(): string;
  101575. /**
  101576. * Gets the rgba input component
  101577. */
  101578. get rgba(): NodeMaterialConnectionPoint;
  101579. /**
  101580. * Gets the rgb input component
  101581. */
  101582. get rgb(): NodeMaterialConnectionPoint;
  101583. /**
  101584. * Gets the a input component
  101585. */
  101586. get a(): NodeMaterialConnectionPoint;
  101587. protected _buildBlock(state: NodeMaterialBuildState): this;
  101588. }
  101589. }
  101590. declare module BABYLON {
  101591. /**
  101592. * Block used for the particle ramp gradient section
  101593. */
  101594. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  101595. /**
  101596. * Create a new ParticleRampGradientBlock
  101597. * @param name defines the block name
  101598. */
  101599. constructor(name: string);
  101600. /**
  101601. * Gets the current class name
  101602. * @returns the class name
  101603. */
  101604. getClassName(): string;
  101605. /**
  101606. * Gets the color input component
  101607. */
  101608. get color(): NodeMaterialConnectionPoint;
  101609. /**
  101610. * Gets the rampColor output component
  101611. */
  101612. get rampColor(): NodeMaterialConnectionPoint;
  101613. /**
  101614. * Initialize the block and prepare the context for build
  101615. * @param state defines the state that will be used for the build
  101616. */
  101617. initialize(state: NodeMaterialBuildState): void;
  101618. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101619. }
  101620. }
  101621. declare module BABYLON {
  101622. /**
  101623. * Block used for the particle blend multiply section
  101624. */
  101625. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  101626. /**
  101627. * Create a new ParticleBlendMultiplyBlock
  101628. * @param name defines the block name
  101629. */
  101630. constructor(name: string);
  101631. /**
  101632. * Gets the current class name
  101633. * @returns the class name
  101634. */
  101635. getClassName(): string;
  101636. /**
  101637. * Gets the color input component
  101638. */
  101639. get color(): NodeMaterialConnectionPoint;
  101640. /**
  101641. * Gets the alphaTexture input component
  101642. */
  101643. get alphaTexture(): NodeMaterialConnectionPoint;
  101644. /**
  101645. * Gets the alphaColor input component
  101646. */
  101647. get alphaColor(): NodeMaterialConnectionPoint;
  101648. /**
  101649. * Gets the blendColor output component
  101650. */
  101651. get blendColor(): NodeMaterialConnectionPoint;
  101652. /**
  101653. * Initialize the block and prepare the context for build
  101654. * @param state defines the state that will be used for the build
  101655. */
  101656. initialize(state: NodeMaterialBuildState): void;
  101657. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101658. }
  101659. }
  101660. declare module BABYLON {
  101661. /**
  101662. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  101663. */
  101664. export class VectorMergerBlock extends NodeMaterialBlock {
  101665. /**
  101666. * Create a new VectorMergerBlock
  101667. * @param name defines the block name
  101668. */
  101669. constructor(name: string);
  101670. /**
  101671. * Gets the current class name
  101672. * @returns the class name
  101673. */
  101674. getClassName(): string;
  101675. /**
  101676. * Gets the xyz component (input)
  101677. */
  101678. get xyzIn(): NodeMaterialConnectionPoint;
  101679. /**
  101680. * Gets the xy component (input)
  101681. */
  101682. get xyIn(): NodeMaterialConnectionPoint;
  101683. /**
  101684. * Gets the x component (input)
  101685. */
  101686. get x(): NodeMaterialConnectionPoint;
  101687. /**
  101688. * Gets the y component (input)
  101689. */
  101690. get y(): NodeMaterialConnectionPoint;
  101691. /**
  101692. * Gets the z component (input)
  101693. */
  101694. get z(): NodeMaterialConnectionPoint;
  101695. /**
  101696. * Gets the w component (input)
  101697. */
  101698. get w(): NodeMaterialConnectionPoint;
  101699. /**
  101700. * Gets the xyzw component (output)
  101701. */
  101702. get xyzw(): NodeMaterialConnectionPoint;
  101703. /**
  101704. * Gets the xyz component (output)
  101705. */
  101706. get xyzOut(): NodeMaterialConnectionPoint;
  101707. /**
  101708. * Gets the xy component (output)
  101709. */
  101710. get xyOut(): NodeMaterialConnectionPoint;
  101711. /**
  101712. * Gets the xy component (output)
  101713. * @deprecated Please use xyOut instead.
  101714. */
  101715. get xy(): NodeMaterialConnectionPoint;
  101716. /**
  101717. * Gets the xyz component (output)
  101718. * @deprecated Please use xyzOut instead.
  101719. */
  101720. get xyz(): NodeMaterialConnectionPoint;
  101721. protected _buildBlock(state: NodeMaterialBuildState): this;
  101722. }
  101723. }
  101724. declare module BABYLON {
  101725. /**
  101726. * Block used to remap a float from a range to a new one
  101727. */
  101728. export class RemapBlock extends NodeMaterialBlock {
  101729. /**
  101730. * Gets or sets the source range
  101731. */
  101732. sourceRange: Vector2;
  101733. /**
  101734. * Gets or sets the target range
  101735. */
  101736. targetRange: Vector2;
  101737. /**
  101738. * Creates a new RemapBlock
  101739. * @param name defines the block name
  101740. */
  101741. constructor(name: string);
  101742. /**
  101743. * Gets the current class name
  101744. * @returns the class name
  101745. */
  101746. getClassName(): string;
  101747. /**
  101748. * Gets the input component
  101749. */
  101750. get input(): NodeMaterialConnectionPoint;
  101751. /**
  101752. * Gets the source min input component
  101753. */
  101754. get sourceMin(): NodeMaterialConnectionPoint;
  101755. /**
  101756. * Gets the source max input component
  101757. */
  101758. get sourceMax(): NodeMaterialConnectionPoint;
  101759. /**
  101760. * Gets the target min input component
  101761. */
  101762. get targetMin(): NodeMaterialConnectionPoint;
  101763. /**
  101764. * Gets the target max input component
  101765. */
  101766. get targetMax(): NodeMaterialConnectionPoint;
  101767. /**
  101768. * Gets the output component
  101769. */
  101770. get output(): NodeMaterialConnectionPoint;
  101771. protected _buildBlock(state: NodeMaterialBuildState): this;
  101772. protected _dumpPropertiesCode(): string;
  101773. serialize(): any;
  101774. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101775. }
  101776. }
  101777. declare module BABYLON {
  101778. /**
  101779. * Block used to multiply 2 values
  101780. */
  101781. export class MultiplyBlock extends NodeMaterialBlock {
  101782. /**
  101783. * Creates a new MultiplyBlock
  101784. * @param name defines the block name
  101785. */
  101786. constructor(name: string);
  101787. /**
  101788. * Gets the current class name
  101789. * @returns the class name
  101790. */
  101791. getClassName(): string;
  101792. /**
  101793. * Gets the left operand input component
  101794. */
  101795. get left(): NodeMaterialConnectionPoint;
  101796. /**
  101797. * Gets the right operand input component
  101798. */
  101799. get right(): NodeMaterialConnectionPoint;
  101800. /**
  101801. * Gets the output component
  101802. */
  101803. get output(): NodeMaterialConnectionPoint;
  101804. protected _buildBlock(state: NodeMaterialBuildState): this;
  101805. }
  101806. }
  101807. declare module BABYLON {
  101808. /**
  101809. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  101810. */
  101811. export class ColorSplitterBlock extends NodeMaterialBlock {
  101812. /**
  101813. * Create a new ColorSplitterBlock
  101814. * @param name defines the block name
  101815. */
  101816. constructor(name: string);
  101817. /**
  101818. * Gets the current class name
  101819. * @returns the class name
  101820. */
  101821. getClassName(): string;
  101822. /**
  101823. * Gets the rgba component (input)
  101824. */
  101825. get rgba(): NodeMaterialConnectionPoint;
  101826. /**
  101827. * Gets the rgb component (input)
  101828. */
  101829. get rgbIn(): NodeMaterialConnectionPoint;
  101830. /**
  101831. * Gets the rgb component (output)
  101832. */
  101833. get rgbOut(): NodeMaterialConnectionPoint;
  101834. /**
  101835. * Gets the r component (output)
  101836. */
  101837. get r(): NodeMaterialConnectionPoint;
  101838. /**
  101839. * Gets the g component (output)
  101840. */
  101841. get g(): NodeMaterialConnectionPoint;
  101842. /**
  101843. * Gets the b component (output)
  101844. */
  101845. get b(): NodeMaterialConnectionPoint;
  101846. /**
  101847. * Gets the a component (output)
  101848. */
  101849. get a(): NodeMaterialConnectionPoint;
  101850. protected _inputRename(name: string): string;
  101851. protected _outputRename(name: string): string;
  101852. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101853. }
  101854. }
  101855. declare module BABYLON {
  101856. /**
  101857. * Interface used to configure the node material editor
  101858. */
  101859. export interface INodeMaterialEditorOptions {
  101860. /** Define the URl to load node editor script */
  101861. editorURL?: string;
  101862. }
  101863. /** @hidden */
  101864. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  101865. NORMAL: boolean;
  101866. TANGENT: boolean;
  101867. UV1: boolean;
  101868. /** BONES */
  101869. NUM_BONE_INFLUENCERS: number;
  101870. BonesPerMesh: number;
  101871. BONETEXTURE: boolean;
  101872. /** MORPH TARGETS */
  101873. MORPHTARGETS: boolean;
  101874. MORPHTARGETS_NORMAL: boolean;
  101875. MORPHTARGETS_TANGENT: boolean;
  101876. MORPHTARGETS_UV: boolean;
  101877. NUM_MORPH_INFLUENCERS: number;
  101878. /** IMAGE PROCESSING */
  101879. IMAGEPROCESSING: boolean;
  101880. VIGNETTE: boolean;
  101881. VIGNETTEBLENDMODEMULTIPLY: boolean;
  101882. VIGNETTEBLENDMODEOPAQUE: boolean;
  101883. TONEMAPPING: boolean;
  101884. TONEMAPPING_ACES: boolean;
  101885. CONTRAST: boolean;
  101886. EXPOSURE: boolean;
  101887. COLORCURVES: boolean;
  101888. COLORGRADING: boolean;
  101889. COLORGRADING3D: boolean;
  101890. SAMPLER3DGREENDEPTH: boolean;
  101891. SAMPLER3DBGRMAP: boolean;
  101892. IMAGEPROCESSINGPOSTPROCESS: boolean;
  101893. /** MISC. */
  101894. BUMPDIRECTUV: number;
  101895. constructor();
  101896. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  101897. }
  101898. /**
  101899. * Class used to configure NodeMaterial
  101900. */
  101901. export interface INodeMaterialOptions {
  101902. /**
  101903. * Defines if blocks should emit comments
  101904. */
  101905. emitComments: boolean;
  101906. }
  101907. /**
  101908. * Class used to create a node based material built by assembling shader blocks
  101909. */
  101910. export class NodeMaterial extends PushMaterial {
  101911. private static _BuildIdGenerator;
  101912. private _options;
  101913. private _vertexCompilationState;
  101914. private _fragmentCompilationState;
  101915. private _sharedData;
  101916. private _buildId;
  101917. private _buildWasSuccessful;
  101918. private _cachedWorldViewMatrix;
  101919. private _cachedWorldViewProjectionMatrix;
  101920. private _optimizers;
  101921. private _animationFrame;
  101922. /** Define the Url to load node editor script */
  101923. static EditorURL: string;
  101924. /** Define the Url to load snippets */
  101925. static SnippetUrl: string;
  101926. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  101927. static IgnoreTexturesAtLoadTime: boolean;
  101928. private BJSNODEMATERIALEDITOR;
  101929. /** Get the inspector from bundle or global */
  101930. private _getGlobalNodeMaterialEditor;
  101931. /**
  101932. * Snippet ID if the material was created from the snippet server
  101933. */
  101934. snippetId: string;
  101935. /**
  101936. * Gets or sets data used by visual editor
  101937. * @see https://nme.babylonjs.com
  101938. */
  101939. editorData: any;
  101940. /**
  101941. * 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)
  101942. */
  101943. ignoreAlpha: boolean;
  101944. /**
  101945. * Defines the maximum number of lights that can be used in the material
  101946. */
  101947. maxSimultaneousLights: number;
  101948. /**
  101949. * Observable raised when the material is built
  101950. */
  101951. onBuildObservable: Observable<NodeMaterial>;
  101952. /**
  101953. * Gets or sets the root nodes of the material vertex shader
  101954. */
  101955. _vertexOutputNodes: NodeMaterialBlock[];
  101956. /**
  101957. * Gets or sets the root nodes of the material fragment (pixel) shader
  101958. */
  101959. _fragmentOutputNodes: NodeMaterialBlock[];
  101960. /** Gets or sets options to control the node material overall behavior */
  101961. get options(): INodeMaterialOptions;
  101962. set options(options: INodeMaterialOptions);
  101963. /**
  101964. * Default configuration related to image processing available in the standard Material.
  101965. */
  101966. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  101967. /**
  101968. * Gets the image processing configuration used either in this material.
  101969. */
  101970. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  101971. /**
  101972. * Sets the Default image processing configuration used either in the this material.
  101973. *
  101974. * If sets to null, the scene one is in use.
  101975. */
  101976. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  101977. /**
  101978. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  101979. */
  101980. attachedBlocks: NodeMaterialBlock[];
  101981. /**
  101982. * Specifies the mode of the node material
  101983. * @hidden
  101984. */
  101985. _mode: NodeMaterialModes;
  101986. /**
  101987. * Gets the mode property
  101988. */
  101989. get mode(): NodeMaterialModes;
  101990. /**
  101991. * Create a new node based material
  101992. * @param name defines the material name
  101993. * @param scene defines the hosting scene
  101994. * @param options defines creation option
  101995. */
  101996. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  101997. /**
  101998. * Gets the current class name of the material e.g. "NodeMaterial"
  101999. * @returns the class name
  102000. */
  102001. getClassName(): string;
  102002. /**
  102003. * Keep track of the image processing observer to allow dispose and replace.
  102004. */
  102005. private _imageProcessingObserver;
  102006. /**
  102007. * Attaches a new image processing configuration to the Standard Material.
  102008. * @param configuration
  102009. */
  102010. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  102011. /**
  102012. * Get a block by its name
  102013. * @param name defines the name of the block to retrieve
  102014. * @returns the required block or null if not found
  102015. */
  102016. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  102017. /**
  102018. * Get a block by its name
  102019. * @param predicate defines the predicate used to find the good candidate
  102020. * @returns the required block or null if not found
  102021. */
  102022. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  102023. /**
  102024. * Get an input block by its name
  102025. * @param predicate defines the predicate used to find the good candidate
  102026. * @returns the required input block or null if not found
  102027. */
  102028. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  102029. /**
  102030. * Gets the list of input blocks attached to this material
  102031. * @returns an array of InputBlocks
  102032. */
  102033. getInputBlocks(): InputBlock[];
  102034. /**
  102035. * Adds a new optimizer to the list of optimizers
  102036. * @param optimizer defines the optimizers to add
  102037. * @returns the current material
  102038. */
  102039. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102040. /**
  102041. * Remove an optimizer from the list of optimizers
  102042. * @param optimizer defines the optimizers to remove
  102043. * @returns the current material
  102044. */
  102045. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102046. /**
  102047. * Add a new block to the list of output nodes
  102048. * @param node defines the node to add
  102049. * @returns the current material
  102050. */
  102051. addOutputNode(node: NodeMaterialBlock): this;
  102052. /**
  102053. * Remove a block from the list of root nodes
  102054. * @param node defines the node to remove
  102055. * @returns the current material
  102056. */
  102057. removeOutputNode(node: NodeMaterialBlock): this;
  102058. private _addVertexOutputNode;
  102059. private _removeVertexOutputNode;
  102060. private _addFragmentOutputNode;
  102061. private _removeFragmentOutputNode;
  102062. /**
  102063. * Specifies if the material will require alpha blending
  102064. * @returns a boolean specifying if alpha blending is needed
  102065. */
  102066. needAlphaBlending(): boolean;
  102067. /**
  102068. * Specifies if this material should be rendered in alpha test mode
  102069. * @returns a boolean specifying if an alpha test is needed.
  102070. */
  102071. needAlphaTesting(): boolean;
  102072. private _initializeBlock;
  102073. private _resetDualBlocks;
  102074. /**
  102075. * Remove a block from the current node material
  102076. * @param block defines the block to remove
  102077. */
  102078. removeBlock(block: NodeMaterialBlock): void;
  102079. /**
  102080. * Build the material and generates the inner effect
  102081. * @param verbose defines if the build should log activity
  102082. */
  102083. build(verbose?: boolean): void;
  102084. /**
  102085. * Runs an otpimization phase to try to improve the shader code
  102086. */
  102087. optimize(): void;
  102088. private _prepareDefinesForAttributes;
  102089. /**
  102090. * Create a post process from the material
  102091. * @param camera The camera to apply the render pass to.
  102092. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102093. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102094. * @param engine The engine which the post process will be applied. (default: current engine)
  102095. * @param reusable If the post process can be reused on the same frame. (default: false)
  102096. * @param textureType Type of textures used when performing the post process. (default: 0)
  102097. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102098. * @returns the post process created
  102099. */
  102100. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  102101. /**
  102102. * Create the post process effect from the material
  102103. * @param postProcess The post process to create the effect for
  102104. */
  102105. createEffectForPostProcess(postProcess: PostProcess): void;
  102106. private _createEffectOrPostProcess;
  102107. private _createEffectForParticles;
  102108. /**
  102109. * Create the effect to be used as the custom effect for a particle system
  102110. * @param particleSystem Particle system to create the effect for
  102111. * @param onCompiled defines a function to call when the effect creation is successful
  102112. * @param onError defines a function to call when the effect creation has failed
  102113. */
  102114. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102115. private _processDefines;
  102116. /**
  102117. * Get if the submesh is ready to be used and all its information available.
  102118. * Child classes can use it to update shaders
  102119. * @param mesh defines the mesh to check
  102120. * @param subMesh defines which submesh to check
  102121. * @param useInstances specifies that instances should be used
  102122. * @returns a boolean indicating that the submesh is ready or not
  102123. */
  102124. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  102125. /**
  102126. * Get a string representing the shaders built by the current node graph
  102127. */
  102128. get compiledShaders(): string;
  102129. /**
  102130. * Binds the world matrix to the material
  102131. * @param world defines the world transformation matrix
  102132. */
  102133. bindOnlyWorldMatrix(world: Matrix): void;
  102134. /**
  102135. * Binds the submesh to this material by preparing the effect and shader to draw
  102136. * @param world defines the world transformation matrix
  102137. * @param mesh defines the mesh containing the submesh
  102138. * @param subMesh defines the submesh to bind the material to
  102139. */
  102140. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  102141. /**
  102142. * Gets the active textures from the material
  102143. * @returns an array of textures
  102144. */
  102145. getActiveTextures(): BaseTexture[];
  102146. /**
  102147. * Gets the list of texture blocks
  102148. * @returns an array of texture blocks
  102149. */
  102150. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  102151. /**
  102152. * Specifies if the material uses a texture
  102153. * @param texture defines the texture to check against the material
  102154. * @returns a boolean specifying if the material uses the texture
  102155. */
  102156. hasTexture(texture: BaseTexture): boolean;
  102157. /**
  102158. * Disposes the material
  102159. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  102160. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  102161. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  102162. */
  102163. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  102164. /** Creates the node editor window. */
  102165. private _createNodeEditor;
  102166. /**
  102167. * Launch the node material editor
  102168. * @param config Define the configuration of the editor
  102169. * @return a promise fulfilled when the node editor is visible
  102170. */
  102171. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  102172. /**
  102173. * Clear the current material
  102174. */
  102175. clear(): void;
  102176. /**
  102177. * Clear the current material and set it to a default state
  102178. */
  102179. setToDefault(): void;
  102180. /**
  102181. * Clear the current material and set it to a default state for post process
  102182. */
  102183. setToDefaultPostProcess(): void;
  102184. /**
  102185. * Clear the current material and set it to a default state for particle
  102186. */
  102187. setToDefaultParticle(): void;
  102188. /**
  102189. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  102190. * @param url defines the url to load from
  102191. * @returns a promise that will fullfil when the material is fully loaded
  102192. */
  102193. loadAsync(url: string): Promise<void>;
  102194. private _gatherBlocks;
  102195. /**
  102196. * Generate a string containing the code declaration required to create an equivalent of this material
  102197. * @returns a string
  102198. */
  102199. generateCode(): string;
  102200. /**
  102201. * Serializes this material in a JSON representation
  102202. * @returns the serialized material object
  102203. */
  102204. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  102205. private _restoreConnections;
  102206. /**
  102207. * Clear the current graph and load a new one from a serialization object
  102208. * @param source defines the JSON representation of the material
  102209. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102210. * @param merge defines whether or not the source must be merged or replace the current content
  102211. */
  102212. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  102213. /**
  102214. * Makes a duplicate of the current material.
  102215. * @param name - name to use for the new material.
  102216. */
  102217. clone(name: string): NodeMaterial;
  102218. /**
  102219. * Creates a node material from parsed material data
  102220. * @param source defines the JSON representation of the material
  102221. * @param scene defines the hosting scene
  102222. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102223. * @returns a new node material
  102224. */
  102225. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  102226. /**
  102227. * Creates a node material from a snippet saved in a remote file
  102228. * @param name defines the name of the material to create
  102229. * @param url defines the url to load from
  102230. * @param scene defines the hosting scene
  102231. * @returns a promise that will resolve to the new node material
  102232. */
  102233. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  102234. /**
  102235. * Creates a node material from a snippet saved by the node material editor
  102236. * @param snippetId defines the snippet to load
  102237. * @param scene defines the hosting scene
  102238. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102239. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  102240. * @returns a promise that will resolve to the new node material
  102241. */
  102242. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  102243. /**
  102244. * Creates a new node material set to default basic configuration
  102245. * @param name defines the name of the material
  102246. * @param scene defines the hosting scene
  102247. * @returns a new NodeMaterial
  102248. */
  102249. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  102250. }
  102251. }
  102252. declare module BABYLON {
  102253. /**
  102254. * Size options for a post process
  102255. */
  102256. export type PostProcessOptions = {
  102257. width: number;
  102258. height: number;
  102259. };
  102260. /**
  102261. * PostProcess can be used to apply a shader to a texture after it has been rendered
  102262. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  102263. */
  102264. export class PostProcess {
  102265. /**
  102266. * Gets or sets the unique id of the post process
  102267. */
  102268. uniqueId: number;
  102269. /** Name of the PostProcess. */
  102270. name: string;
  102271. /**
  102272. * Width of the texture to apply the post process on
  102273. */
  102274. width: number;
  102275. /**
  102276. * Height of the texture to apply the post process on
  102277. */
  102278. height: number;
  102279. /**
  102280. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  102281. */
  102282. nodeMaterialSource: Nullable<NodeMaterial>;
  102283. /**
  102284. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  102285. * @hidden
  102286. */
  102287. _outputTexture: Nullable<InternalTexture>;
  102288. /**
  102289. * Sampling mode used by the shader
  102290. * See https://doc.babylonjs.com/classes/3.1/texture
  102291. */
  102292. renderTargetSamplingMode: number;
  102293. /**
  102294. * Clear color to use when screen clearing
  102295. */
  102296. clearColor: Color4;
  102297. /**
  102298. * If the buffer needs to be cleared before applying the post process. (default: true)
  102299. * Should be set to false if shader will overwrite all previous pixels.
  102300. */
  102301. autoClear: boolean;
  102302. /**
  102303. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  102304. */
  102305. alphaMode: number;
  102306. /**
  102307. * Sets the setAlphaBlendConstants of the babylon engine
  102308. */
  102309. alphaConstants: Color4;
  102310. /**
  102311. * Animations to be used for the post processing
  102312. */
  102313. animations: Animation[];
  102314. /**
  102315. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  102316. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  102317. */
  102318. enablePixelPerfectMode: boolean;
  102319. /**
  102320. * Force the postprocess to be applied without taking in account viewport
  102321. */
  102322. forceFullscreenViewport: boolean;
  102323. /**
  102324. * List of inspectable custom properties (used by the Inspector)
  102325. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102326. */
  102327. inspectableCustomProperties: IInspectable[];
  102328. /**
  102329. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  102330. *
  102331. * | Value | Type | Description |
  102332. * | ----- | ----------------------------------- | ----------- |
  102333. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  102334. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  102335. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  102336. *
  102337. */
  102338. scaleMode: number;
  102339. /**
  102340. * Force textures to be a power of two (default: false)
  102341. */
  102342. alwaysForcePOT: boolean;
  102343. private _samples;
  102344. /**
  102345. * Number of sample textures (default: 1)
  102346. */
  102347. get samples(): number;
  102348. set samples(n: number);
  102349. /**
  102350. * Modify the scale of the post process to be the same as the viewport (default: false)
  102351. */
  102352. adaptScaleToCurrentViewport: boolean;
  102353. private _camera;
  102354. protected _scene: Scene;
  102355. private _engine;
  102356. private _options;
  102357. private _reusable;
  102358. private _textureType;
  102359. private _textureFormat;
  102360. /**
  102361. * Smart array of input and output textures for the post process.
  102362. * @hidden
  102363. */
  102364. _textures: SmartArray<InternalTexture>;
  102365. /**
  102366. * The index in _textures that corresponds to the output texture.
  102367. * @hidden
  102368. */
  102369. _currentRenderTextureInd: number;
  102370. private _effect;
  102371. private _samplers;
  102372. private _fragmentUrl;
  102373. private _vertexUrl;
  102374. private _parameters;
  102375. private _scaleRatio;
  102376. protected _indexParameters: any;
  102377. private _shareOutputWithPostProcess;
  102378. private _texelSize;
  102379. private _forcedOutputTexture;
  102380. /**
  102381. * Returns the fragment url or shader name used in the post process.
  102382. * @returns the fragment url or name in the shader store.
  102383. */
  102384. getEffectName(): string;
  102385. /**
  102386. * An event triggered when the postprocess is activated.
  102387. */
  102388. onActivateObservable: Observable<Camera>;
  102389. private _onActivateObserver;
  102390. /**
  102391. * A function that is added to the onActivateObservable
  102392. */
  102393. set onActivate(callback: Nullable<(camera: Camera) => void>);
  102394. /**
  102395. * An event triggered when the postprocess changes its size.
  102396. */
  102397. onSizeChangedObservable: Observable<PostProcess>;
  102398. private _onSizeChangedObserver;
  102399. /**
  102400. * A function that is added to the onSizeChangedObservable
  102401. */
  102402. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  102403. /**
  102404. * An event triggered when the postprocess applies its effect.
  102405. */
  102406. onApplyObservable: Observable<Effect>;
  102407. private _onApplyObserver;
  102408. /**
  102409. * A function that is added to the onApplyObservable
  102410. */
  102411. set onApply(callback: (effect: Effect) => void);
  102412. /**
  102413. * An event triggered before rendering the postprocess
  102414. */
  102415. onBeforeRenderObservable: Observable<Effect>;
  102416. private _onBeforeRenderObserver;
  102417. /**
  102418. * A function that is added to the onBeforeRenderObservable
  102419. */
  102420. set onBeforeRender(callback: (effect: Effect) => void);
  102421. /**
  102422. * An event triggered after rendering the postprocess
  102423. */
  102424. onAfterRenderObservable: Observable<Effect>;
  102425. private _onAfterRenderObserver;
  102426. /**
  102427. * A function that is added to the onAfterRenderObservable
  102428. */
  102429. set onAfterRender(callback: (efect: Effect) => void);
  102430. /**
  102431. * 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
  102432. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  102433. */
  102434. get inputTexture(): InternalTexture;
  102435. set inputTexture(value: InternalTexture);
  102436. /**
  102437. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  102438. * the only way to unset it is to use this function to restore its internal state
  102439. */
  102440. restoreDefaultInputTexture(): void;
  102441. /**
  102442. * Gets the camera which post process is applied to.
  102443. * @returns The camera the post process is applied to.
  102444. */
  102445. getCamera(): Camera;
  102446. /**
  102447. * Gets the texel size of the postprocess.
  102448. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  102449. */
  102450. get texelSize(): Vector2;
  102451. /**
  102452. * Creates a new instance PostProcess
  102453. * @param name The name of the PostProcess.
  102454. * @param fragmentUrl The url of the fragment shader to be used.
  102455. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  102456. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  102457. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102458. * @param camera The camera to apply the render pass to.
  102459. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102460. * @param engine The engine which the post process will be applied. (default: current engine)
  102461. * @param reusable If the post process can be reused on the same frame. (default: false)
  102462. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  102463. * @param textureType Type of textures used when performing the post process. (default: 0)
  102464. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  102465. * @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
  102466. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  102467. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102468. */
  102469. 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);
  102470. /**
  102471. * Gets a string identifying the name of the class
  102472. * @returns "PostProcess" string
  102473. */
  102474. getClassName(): string;
  102475. /**
  102476. * Gets the engine which this post process belongs to.
  102477. * @returns The engine the post process was enabled with.
  102478. */
  102479. getEngine(): Engine;
  102480. /**
  102481. * The effect that is created when initializing the post process.
  102482. * @returns The created effect corresponding the the postprocess.
  102483. */
  102484. getEffect(): Effect;
  102485. /**
  102486. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  102487. * @param postProcess The post process to share the output with.
  102488. * @returns This post process.
  102489. */
  102490. shareOutputWith(postProcess: PostProcess): PostProcess;
  102491. /**
  102492. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  102493. * This should be called if the post process that shares output with this post process is disabled/disposed.
  102494. */
  102495. useOwnOutput(): void;
  102496. /**
  102497. * Updates the effect with the current post process compile time values and recompiles the shader.
  102498. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102499. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102500. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102501. * @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
  102502. * @param onCompiled Called when the shader has been compiled.
  102503. * @param onError Called if there is an error when compiling a shader.
  102504. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  102505. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  102506. */
  102507. 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;
  102508. /**
  102509. * The post process is reusable if it can be used multiple times within one frame.
  102510. * @returns If the post process is reusable
  102511. */
  102512. isReusable(): boolean;
  102513. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  102514. markTextureDirty(): void;
  102515. /**
  102516. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  102517. * 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.
  102518. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  102519. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  102520. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  102521. * @returns The target texture that was bound to be written to.
  102522. */
  102523. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  102524. /**
  102525. * If the post process is supported.
  102526. */
  102527. get isSupported(): boolean;
  102528. /**
  102529. * The aspect ratio of the output texture.
  102530. */
  102531. get aspectRatio(): number;
  102532. /**
  102533. * Get a value indicating if the post-process is ready to be used
  102534. * @returns true if the post-process is ready (shader is compiled)
  102535. */
  102536. isReady(): boolean;
  102537. /**
  102538. * Binds all textures and uniforms to the shader, this will be run on every pass.
  102539. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  102540. */
  102541. apply(): Nullable<Effect>;
  102542. private _disposeTextures;
  102543. /**
  102544. * Disposes the post process.
  102545. * @param camera The camera to dispose the post process on.
  102546. */
  102547. dispose(camera?: Camera): void;
  102548. /**
  102549. * Serializes the particle system to a JSON object
  102550. * @returns the JSON object
  102551. */
  102552. serialize(): any;
  102553. /**
  102554. * Creates a material from parsed material data
  102555. * @param parsedPostProcess defines parsed post process data
  102556. * @param scene defines the hosting scene
  102557. * @param rootUrl defines the root URL to use to load textures
  102558. * @returns a new post process
  102559. */
  102560. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  102561. }
  102562. }
  102563. declare module BABYLON {
  102564. /** @hidden */
  102565. export var kernelBlurVaryingDeclaration: {
  102566. name: string;
  102567. shader: string;
  102568. };
  102569. }
  102570. declare module BABYLON {
  102571. /** @hidden */
  102572. export var kernelBlurFragment: {
  102573. name: string;
  102574. shader: string;
  102575. };
  102576. }
  102577. declare module BABYLON {
  102578. /** @hidden */
  102579. export var kernelBlurFragment2: {
  102580. name: string;
  102581. shader: string;
  102582. };
  102583. }
  102584. declare module BABYLON {
  102585. /** @hidden */
  102586. export var kernelBlurPixelShader: {
  102587. name: string;
  102588. shader: string;
  102589. };
  102590. }
  102591. declare module BABYLON {
  102592. /** @hidden */
  102593. export var kernelBlurVertex: {
  102594. name: string;
  102595. shader: string;
  102596. };
  102597. }
  102598. declare module BABYLON {
  102599. /** @hidden */
  102600. export var kernelBlurVertexShader: {
  102601. name: string;
  102602. shader: string;
  102603. };
  102604. }
  102605. declare module BABYLON {
  102606. /**
  102607. * The Blur Post Process which blurs an image based on a kernel and direction.
  102608. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  102609. */
  102610. export class BlurPostProcess extends PostProcess {
  102611. private blockCompilation;
  102612. protected _kernel: number;
  102613. protected _idealKernel: number;
  102614. protected _packedFloat: boolean;
  102615. private _staticDefines;
  102616. /** The direction in which to blur the image. */
  102617. direction: Vector2;
  102618. /**
  102619. * Sets the length in pixels of the blur sample region
  102620. */
  102621. set kernel(v: number);
  102622. /**
  102623. * Gets the length in pixels of the blur sample region
  102624. */
  102625. get kernel(): number;
  102626. /**
  102627. * Sets wether or not the blur needs to unpack/repack floats
  102628. */
  102629. set packedFloat(v: boolean);
  102630. /**
  102631. * Gets wether or not the blur is unpacking/repacking floats
  102632. */
  102633. get packedFloat(): boolean;
  102634. /**
  102635. * Gets a string identifying the name of the class
  102636. * @returns "BlurPostProcess" string
  102637. */
  102638. getClassName(): string;
  102639. /**
  102640. * Creates a new instance BlurPostProcess
  102641. * @param name The name of the effect.
  102642. * @param direction The direction in which to blur the image.
  102643. * @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.
  102644. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102645. * @param camera The camera to apply the render pass to.
  102646. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102647. * @param engine The engine which the post process will be applied. (default: current engine)
  102648. * @param reusable If the post process can be reused on the same frame. (default: false)
  102649. * @param textureType Type of textures used when performing the post process. (default: 0)
  102650. * @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)
  102651. */
  102652. 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);
  102653. /**
  102654. * Updates the effect with the current post process compile time values and recompiles the shader.
  102655. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102656. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102657. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102658. * @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
  102659. * @param onCompiled Called when the shader has been compiled.
  102660. * @param onError Called if there is an error when compiling a shader.
  102661. */
  102662. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102663. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102664. /**
  102665. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  102666. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  102667. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  102668. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  102669. * The gaps between physical kernels are compensated for in the weighting of the samples
  102670. * @param idealKernel Ideal blur kernel.
  102671. * @return Nearest best kernel.
  102672. */
  102673. protected _nearestBestKernel(idealKernel: number): number;
  102674. /**
  102675. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  102676. * @param x The point on the Gaussian distribution to sample.
  102677. * @return the value of the Gaussian function at x.
  102678. */
  102679. protected _gaussianWeight(x: number): number;
  102680. /**
  102681. * Generates a string that can be used as a floating point number in GLSL.
  102682. * @param x Value to print.
  102683. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  102684. * @return GLSL float string.
  102685. */
  102686. protected _glslFloat(x: number, decimalFigures?: number): string;
  102687. /** @hidden */
  102688. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  102689. }
  102690. }
  102691. declare module BABYLON {
  102692. /**
  102693. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102694. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102695. * You can then easily use it as a reflectionTexture on a flat surface.
  102696. * In case the surface is not a plane, please consider relying on reflection probes.
  102697. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102698. */
  102699. export class MirrorTexture extends RenderTargetTexture {
  102700. private scene;
  102701. /**
  102702. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  102703. * 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.
  102704. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102705. */
  102706. mirrorPlane: Plane;
  102707. /**
  102708. * Define the blur ratio used to blur the reflection if needed.
  102709. */
  102710. set blurRatio(value: number);
  102711. get blurRatio(): number;
  102712. /**
  102713. * Define the adaptive blur kernel used to blur the reflection if needed.
  102714. * This will autocompute the closest best match for the `blurKernel`
  102715. */
  102716. set adaptiveBlurKernel(value: number);
  102717. /**
  102718. * Define the blur kernel used to blur the reflection if needed.
  102719. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102720. */
  102721. set blurKernel(value: number);
  102722. /**
  102723. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  102724. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102725. */
  102726. set blurKernelX(value: number);
  102727. get blurKernelX(): number;
  102728. /**
  102729. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  102730. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102731. */
  102732. set blurKernelY(value: number);
  102733. get blurKernelY(): number;
  102734. private _autoComputeBlurKernel;
  102735. protected _onRatioRescale(): void;
  102736. private _updateGammaSpace;
  102737. private _imageProcessingConfigChangeObserver;
  102738. private _transformMatrix;
  102739. private _mirrorMatrix;
  102740. private _savedViewMatrix;
  102741. private _blurX;
  102742. private _blurY;
  102743. private _adaptiveBlurKernel;
  102744. private _blurKernelX;
  102745. private _blurKernelY;
  102746. private _blurRatio;
  102747. /**
  102748. * Instantiates a Mirror Texture.
  102749. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102750. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102751. * You can then easily use it as a reflectionTexture on a flat surface.
  102752. * In case the surface is not a plane, please consider relying on reflection probes.
  102753. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102754. * @param name
  102755. * @param size
  102756. * @param scene
  102757. * @param generateMipMaps
  102758. * @param type
  102759. * @param samplingMode
  102760. * @param generateDepthBuffer
  102761. */
  102762. constructor(name: string, size: number | {
  102763. width: number;
  102764. height: number;
  102765. } | {
  102766. ratio: number;
  102767. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  102768. private _preparePostProcesses;
  102769. /**
  102770. * Clone the mirror texture.
  102771. * @returns the cloned texture
  102772. */
  102773. clone(): MirrorTexture;
  102774. /**
  102775. * Serialize the texture to a JSON representation you could use in Parse later on
  102776. * @returns the serialized JSON representation
  102777. */
  102778. serialize(): any;
  102779. /**
  102780. * Dispose the texture and release its associated resources.
  102781. */
  102782. dispose(): void;
  102783. }
  102784. }
  102785. declare module BABYLON {
  102786. /**
  102787. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102788. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102789. */
  102790. export class Texture extends BaseTexture {
  102791. /**
  102792. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  102793. */
  102794. static SerializeBuffers: boolean;
  102795. /** @hidden */
  102796. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  102797. /** @hidden */
  102798. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  102799. /** @hidden */
  102800. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  102801. /** nearest is mag = nearest and min = nearest and mip = linear */
  102802. static readonly NEAREST_SAMPLINGMODE: number;
  102803. /** nearest is mag = nearest and min = nearest and mip = linear */
  102804. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  102805. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102806. static readonly BILINEAR_SAMPLINGMODE: number;
  102807. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102808. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  102809. /** Trilinear is mag = linear and min = linear and mip = linear */
  102810. static readonly TRILINEAR_SAMPLINGMODE: number;
  102811. /** Trilinear is mag = linear and min = linear and mip = linear */
  102812. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  102813. /** mag = nearest and min = nearest and mip = nearest */
  102814. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  102815. /** mag = nearest and min = linear and mip = nearest */
  102816. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  102817. /** mag = nearest and min = linear and mip = linear */
  102818. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  102819. /** mag = nearest and min = linear and mip = none */
  102820. static readonly NEAREST_LINEAR: number;
  102821. /** mag = nearest and min = nearest and mip = none */
  102822. static readonly NEAREST_NEAREST: number;
  102823. /** mag = linear and min = nearest and mip = nearest */
  102824. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  102825. /** mag = linear and min = nearest and mip = linear */
  102826. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  102827. /** mag = linear and min = linear and mip = none */
  102828. static readonly LINEAR_LINEAR: number;
  102829. /** mag = linear and min = nearest and mip = none */
  102830. static readonly LINEAR_NEAREST: number;
  102831. /** Explicit coordinates mode */
  102832. static readonly EXPLICIT_MODE: number;
  102833. /** Spherical coordinates mode */
  102834. static readonly SPHERICAL_MODE: number;
  102835. /** Planar coordinates mode */
  102836. static readonly PLANAR_MODE: number;
  102837. /** Cubic coordinates mode */
  102838. static readonly CUBIC_MODE: number;
  102839. /** Projection coordinates mode */
  102840. static readonly PROJECTION_MODE: number;
  102841. /** Inverse Cubic coordinates mode */
  102842. static readonly SKYBOX_MODE: number;
  102843. /** Inverse Cubic coordinates mode */
  102844. static readonly INVCUBIC_MODE: number;
  102845. /** Equirectangular coordinates mode */
  102846. static readonly EQUIRECTANGULAR_MODE: number;
  102847. /** Equirectangular Fixed coordinates mode */
  102848. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  102849. /** Equirectangular Fixed Mirrored coordinates mode */
  102850. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  102851. /** Texture is not repeating outside of 0..1 UVs */
  102852. static readonly CLAMP_ADDRESSMODE: number;
  102853. /** Texture is repeating outside of 0..1 UVs */
  102854. static readonly WRAP_ADDRESSMODE: number;
  102855. /** Texture is repeating and mirrored */
  102856. static readonly MIRROR_ADDRESSMODE: number;
  102857. /**
  102858. * 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
  102859. */
  102860. static UseSerializedUrlIfAny: boolean;
  102861. /**
  102862. * Define the url of the texture.
  102863. */
  102864. url: Nullable<string>;
  102865. /**
  102866. * Define an offset on the texture to offset the u coordinates of the UVs
  102867. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102868. */
  102869. uOffset: number;
  102870. /**
  102871. * Define an offset on the texture to offset the v coordinates of the UVs
  102872. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102873. */
  102874. vOffset: number;
  102875. /**
  102876. * Define an offset on the texture to scale the u coordinates of the UVs
  102877. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102878. */
  102879. uScale: number;
  102880. /**
  102881. * Define an offset on the texture to scale the v coordinates of the UVs
  102882. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102883. */
  102884. vScale: number;
  102885. /**
  102886. * Define an offset on the texture to rotate around the u coordinates of the UVs
  102887. * @see https://doc.babylonjs.com/how_to/more_materials
  102888. */
  102889. uAng: number;
  102890. /**
  102891. * Define an offset on the texture to rotate around the v coordinates of the UVs
  102892. * @see https://doc.babylonjs.com/how_to/more_materials
  102893. */
  102894. vAng: number;
  102895. /**
  102896. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  102897. * @see https://doc.babylonjs.com/how_to/more_materials
  102898. */
  102899. wAng: number;
  102900. /**
  102901. * Defines the center of rotation (U)
  102902. */
  102903. uRotationCenter: number;
  102904. /**
  102905. * Defines the center of rotation (V)
  102906. */
  102907. vRotationCenter: number;
  102908. /**
  102909. * Defines the center of rotation (W)
  102910. */
  102911. wRotationCenter: number;
  102912. /**
  102913. * Are mip maps generated for this texture or not.
  102914. */
  102915. get noMipmap(): boolean;
  102916. /**
  102917. * List of inspectable custom properties (used by the Inspector)
  102918. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102919. */
  102920. inspectableCustomProperties: Nullable<IInspectable[]>;
  102921. private _noMipmap;
  102922. /** @hidden */
  102923. _invertY: boolean;
  102924. private _rowGenerationMatrix;
  102925. private _cachedTextureMatrix;
  102926. private _projectionModeMatrix;
  102927. private _t0;
  102928. private _t1;
  102929. private _t2;
  102930. private _cachedUOffset;
  102931. private _cachedVOffset;
  102932. private _cachedUScale;
  102933. private _cachedVScale;
  102934. private _cachedUAng;
  102935. private _cachedVAng;
  102936. private _cachedWAng;
  102937. private _cachedProjectionMatrixId;
  102938. private _cachedCoordinatesMode;
  102939. /** @hidden */
  102940. protected _initialSamplingMode: number;
  102941. /** @hidden */
  102942. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  102943. private _deleteBuffer;
  102944. protected _format: Nullable<number>;
  102945. private _delayedOnLoad;
  102946. private _delayedOnError;
  102947. private _mimeType?;
  102948. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  102949. get mimeType(): string | undefined;
  102950. /**
  102951. * Observable triggered once the texture has been loaded.
  102952. */
  102953. onLoadObservable: Observable<Texture>;
  102954. protected _isBlocking: boolean;
  102955. /**
  102956. * Is the texture preventing material to render while loading.
  102957. * If false, a default texture will be used instead of the loading one during the preparation step.
  102958. */
  102959. set isBlocking(value: boolean);
  102960. get isBlocking(): boolean;
  102961. /**
  102962. * Get the current sampling mode associated with the texture.
  102963. */
  102964. get samplingMode(): number;
  102965. /**
  102966. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  102967. */
  102968. get invertY(): boolean;
  102969. /**
  102970. * Instantiates a new texture.
  102971. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102972. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102973. * @param url defines the url of the picture to load as a texture
  102974. * @param sceneOrEngine defines the scene or engine the texture will belong to
  102975. * @param noMipmap defines if the texture will require mip maps or not
  102976. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  102977. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  102978. * @param onLoad defines a callback triggered when the texture has been loaded
  102979. * @param onError defines a callback triggered when an error occurred during the loading session
  102980. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  102981. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  102982. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  102983. * @param mimeType defines an optional mime type information
  102984. */
  102985. 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);
  102986. /**
  102987. * Update the url (and optional buffer) of this texture if url was null during construction.
  102988. * @param url the url of the texture
  102989. * @param buffer the buffer of the texture (defaults to null)
  102990. * @param onLoad callback called when the texture is loaded (defaults to null)
  102991. */
  102992. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  102993. /**
  102994. * Finish the loading sequence of a texture flagged as delayed load.
  102995. * @hidden
  102996. */
  102997. delayLoad(): void;
  102998. private _prepareRowForTextureGeneration;
  102999. /**
  103000. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  103001. * @returns the transform matrix of the texture.
  103002. */
  103003. getTextureMatrix(uBase?: number): Matrix;
  103004. /**
  103005. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  103006. * @returns The reflection texture transform
  103007. */
  103008. getReflectionTextureMatrix(): Matrix;
  103009. /**
  103010. * Clones the texture.
  103011. * @returns the cloned texture
  103012. */
  103013. clone(): Texture;
  103014. /**
  103015. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103016. * @returns The JSON representation of the texture
  103017. */
  103018. serialize(): any;
  103019. /**
  103020. * Get the current class name of the texture useful for serialization or dynamic coding.
  103021. * @returns "Texture"
  103022. */
  103023. getClassName(): string;
  103024. /**
  103025. * Dispose the texture and release its associated resources.
  103026. */
  103027. dispose(): void;
  103028. /**
  103029. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  103030. * @param parsedTexture Define the JSON representation of the texture
  103031. * @param scene Define the scene the parsed texture should be instantiated in
  103032. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  103033. * @returns The parsed texture if successful
  103034. */
  103035. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  103036. /**
  103037. * Creates a texture from its base 64 representation.
  103038. * @param data Define the base64 payload without the data: prefix
  103039. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103040. * @param scene Define the scene the texture should belong to
  103041. * @param noMipmap Forces the texture to not create mip map information if true
  103042. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103043. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103044. * @param onLoad define a callback triggered when the texture has been loaded
  103045. * @param onError define a callback triggered when an error occurred during the loading session
  103046. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103047. * @returns the created texture
  103048. */
  103049. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  103050. /**
  103051. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  103052. * @param data Define the base64 payload without the data: prefix
  103053. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103054. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  103055. * @param scene Define the scene the texture should belong to
  103056. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  103057. * @param noMipmap Forces the texture to not create mip map information if true
  103058. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103059. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103060. * @param onLoad define a callback triggered when the texture has been loaded
  103061. * @param onError define a callback triggered when an error occurred during the loading session
  103062. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103063. * @returns the created texture
  103064. */
  103065. 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;
  103066. }
  103067. }
  103068. declare module BABYLON {
  103069. /**
  103070. * PostProcessManager is used to manage one or more post processes or post process pipelines
  103071. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  103072. */
  103073. export class PostProcessManager {
  103074. private _scene;
  103075. private _indexBuffer;
  103076. private _vertexBuffers;
  103077. /**
  103078. * Creates a new instance PostProcess
  103079. * @param scene The scene that the post process is associated with.
  103080. */
  103081. constructor(scene: Scene);
  103082. private _prepareBuffers;
  103083. private _buildIndexBuffer;
  103084. /**
  103085. * Rebuilds the vertex buffers of the manager.
  103086. * @hidden
  103087. */
  103088. _rebuild(): void;
  103089. /**
  103090. * Prepares a frame to be run through a post process.
  103091. * @param sourceTexture The input texture to the post procesess. (default: null)
  103092. * @param postProcesses An array of post processes to be run. (default: null)
  103093. * @returns True if the post processes were able to be run.
  103094. * @hidden
  103095. */
  103096. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  103097. /**
  103098. * Manually render a set of post processes to a texture.
  103099. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  103100. * @param postProcesses An array of post processes to be run.
  103101. * @param targetTexture The target texture to render to.
  103102. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  103103. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  103104. * @param lodLevel defines which lod of the texture to render to
  103105. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  103106. */
  103107. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  103108. /**
  103109. * Finalize the result of the output of the postprocesses.
  103110. * @param doNotPresent If true the result will not be displayed to the screen.
  103111. * @param targetTexture The target texture to render to.
  103112. * @param faceIndex The index of the face to bind the target texture to.
  103113. * @param postProcesses The array of post processes to render.
  103114. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  103115. * @hidden
  103116. */
  103117. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  103118. /**
  103119. * Disposes of the post process manager.
  103120. */
  103121. dispose(): void;
  103122. }
  103123. }
  103124. declare module BABYLON {
  103125. /**
  103126. * This Helps creating a texture that will be created from a camera in your scene.
  103127. * It is basically a dynamic texture that could be used to create special effects for instance.
  103128. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  103129. */
  103130. export class RenderTargetTexture extends Texture {
  103131. /**
  103132. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  103133. */
  103134. static readonly REFRESHRATE_RENDER_ONCE: number;
  103135. /**
  103136. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  103137. */
  103138. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  103139. /**
  103140. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  103141. * the central point of your effect and can save a lot of performances.
  103142. */
  103143. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  103144. /**
  103145. * Use this predicate to dynamically define the list of mesh you want to render.
  103146. * If set, the renderList property will be overwritten.
  103147. */
  103148. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  103149. private _renderList;
  103150. /**
  103151. * Use this list to define the list of mesh you want to render.
  103152. */
  103153. get renderList(): Nullable<Array<AbstractMesh>>;
  103154. set renderList(value: Nullable<Array<AbstractMesh>>);
  103155. /**
  103156. * Use this function to overload the renderList array at rendering time.
  103157. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  103158. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  103159. * the cube (if the RTT is a cube, else layerOrFace=0).
  103160. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  103161. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  103162. * hold dummy elements!
  103163. */
  103164. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  103165. private _hookArray;
  103166. /**
  103167. * Define if particles should be rendered in your texture.
  103168. */
  103169. renderParticles: boolean;
  103170. /**
  103171. * Define if sprites should be rendered in your texture.
  103172. */
  103173. renderSprites: boolean;
  103174. /**
  103175. * Define the camera used to render the texture.
  103176. */
  103177. activeCamera: Nullable<Camera>;
  103178. /**
  103179. * Override the mesh isReady function with your own one.
  103180. */
  103181. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  103182. /**
  103183. * Override the render function of the texture with your own one.
  103184. */
  103185. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  103186. /**
  103187. * Define if camera post processes should be use while rendering the texture.
  103188. */
  103189. useCameraPostProcesses: boolean;
  103190. /**
  103191. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  103192. */
  103193. ignoreCameraViewport: boolean;
  103194. private _postProcessManager;
  103195. private _postProcesses;
  103196. private _resizeObserver;
  103197. /**
  103198. * An event triggered when the texture is unbind.
  103199. */
  103200. onBeforeBindObservable: Observable<RenderTargetTexture>;
  103201. /**
  103202. * An event triggered when the texture is unbind.
  103203. */
  103204. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  103205. private _onAfterUnbindObserver;
  103206. /**
  103207. * Set a after unbind callback in the texture.
  103208. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  103209. */
  103210. set onAfterUnbind(callback: () => void);
  103211. /**
  103212. * An event triggered before rendering the texture
  103213. */
  103214. onBeforeRenderObservable: Observable<number>;
  103215. private _onBeforeRenderObserver;
  103216. /**
  103217. * Set a before render callback in the texture.
  103218. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  103219. */
  103220. set onBeforeRender(callback: (faceIndex: number) => void);
  103221. /**
  103222. * An event triggered after rendering the texture
  103223. */
  103224. onAfterRenderObservable: Observable<number>;
  103225. private _onAfterRenderObserver;
  103226. /**
  103227. * Set a after render callback in the texture.
  103228. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  103229. */
  103230. set onAfterRender(callback: (faceIndex: number) => void);
  103231. /**
  103232. * An event triggered after the texture clear
  103233. */
  103234. onClearObservable: Observable<Engine>;
  103235. private _onClearObserver;
  103236. /**
  103237. * Set a clear callback in the texture.
  103238. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  103239. */
  103240. set onClear(callback: (Engine: Engine) => void);
  103241. /**
  103242. * An event triggered when the texture is resized.
  103243. */
  103244. onResizeObservable: Observable<RenderTargetTexture>;
  103245. /**
  103246. * Define the clear color of the Render Target if it should be different from the scene.
  103247. */
  103248. clearColor: Color4;
  103249. protected _size: number | {
  103250. width: number;
  103251. height: number;
  103252. layers?: number;
  103253. };
  103254. protected _initialSizeParameter: number | {
  103255. width: number;
  103256. height: number;
  103257. } | {
  103258. ratio: number;
  103259. };
  103260. protected _sizeRatio: Nullable<number>;
  103261. /** @hidden */
  103262. _generateMipMaps: boolean;
  103263. protected _renderingManager: RenderingManager;
  103264. /** @hidden */
  103265. _waitingRenderList?: string[];
  103266. protected _doNotChangeAspectRatio: boolean;
  103267. protected _currentRefreshId: number;
  103268. protected _refreshRate: number;
  103269. protected _textureMatrix: Matrix;
  103270. protected _samples: number;
  103271. protected _renderTargetOptions: RenderTargetCreationOptions;
  103272. /**
  103273. * Gets render target creation options that were used.
  103274. */
  103275. get renderTargetOptions(): RenderTargetCreationOptions;
  103276. protected _onRatioRescale(): void;
  103277. /**
  103278. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  103279. * It must define where the camera used to render the texture is set
  103280. */
  103281. boundingBoxPosition: Vector3;
  103282. private _boundingBoxSize;
  103283. /**
  103284. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  103285. * When defined, the cubemap will switch to local mode
  103286. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  103287. * @example https://www.babylonjs-playground.com/#RNASML
  103288. */
  103289. set boundingBoxSize(value: Vector3);
  103290. get boundingBoxSize(): Vector3;
  103291. /**
  103292. * In case the RTT has been created with a depth texture, get the associated
  103293. * depth texture.
  103294. * Otherwise, return null.
  103295. */
  103296. get depthStencilTexture(): Nullable<InternalTexture>;
  103297. /**
  103298. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  103299. * or used a shadow, depth texture...
  103300. * @param name The friendly name of the texture
  103301. * @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)
  103302. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  103303. * @param generateMipMaps True if mip maps need to be generated after render.
  103304. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  103305. * @param type The type of the buffer in the RTT (int, half float, float...)
  103306. * @param isCube True if a cube texture needs to be created
  103307. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  103308. * @param generateDepthBuffer True to generate a depth buffer
  103309. * @param generateStencilBuffer True to generate a stencil buffer
  103310. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  103311. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  103312. * @param delayAllocation if the texture allocation should be delayed (default: false)
  103313. */
  103314. constructor(name: string, size: number | {
  103315. width: number;
  103316. height: number;
  103317. layers?: number;
  103318. } | {
  103319. ratio: number;
  103320. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  103321. /**
  103322. * Creates a depth stencil texture.
  103323. * This is only available in WebGL 2 or with the depth texture extension available.
  103324. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  103325. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  103326. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  103327. */
  103328. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  103329. private _processSizeParameter;
  103330. /**
  103331. * Define the number of samples to use in case of MSAA.
  103332. * It defaults to one meaning no MSAA has been enabled.
  103333. */
  103334. get samples(): number;
  103335. set samples(value: number);
  103336. /**
  103337. * Resets the refresh counter of the texture and start bak from scratch.
  103338. * Could be useful to regenerate the texture if it is setup to render only once.
  103339. */
  103340. resetRefreshCounter(): void;
  103341. /**
  103342. * Define the refresh rate of the texture or the rendering frequency.
  103343. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  103344. */
  103345. get refreshRate(): number;
  103346. set refreshRate(value: number);
  103347. /**
  103348. * Adds a post process to the render target rendering passes.
  103349. * @param postProcess define the post process to add
  103350. */
  103351. addPostProcess(postProcess: PostProcess): void;
  103352. /**
  103353. * Clear all the post processes attached to the render target
  103354. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  103355. */
  103356. clearPostProcesses(dispose?: boolean): void;
  103357. /**
  103358. * Remove one of the post process from the list of attached post processes to the texture
  103359. * @param postProcess define the post process to remove from the list
  103360. */
  103361. removePostProcess(postProcess: PostProcess): void;
  103362. /** @hidden */
  103363. _shouldRender(): boolean;
  103364. /**
  103365. * Gets the actual render size of the texture.
  103366. * @returns the width of the render size
  103367. */
  103368. getRenderSize(): number;
  103369. /**
  103370. * Gets the actual render width of the texture.
  103371. * @returns the width of the render size
  103372. */
  103373. getRenderWidth(): number;
  103374. /**
  103375. * Gets the actual render height of the texture.
  103376. * @returns the height of the render size
  103377. */
  103378. getRenderHeight(): number;
  103379. /**
  103380. * Gets the actual number of layers of the texture.
  103381. * @returns the number of layers
  103382. */
  103383. getRenderLayers(): number;
  103384. /**
  103385. * Get if the texture can be rescaled or not.
  103386. */
  103387. get canRescale(): boolean;
  103388. /**
  103389. * Resize the texture using a ratio.
  103390. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  103391. */
  103392. scale(ratio: number): void;
  103393. /**
  103394. * Get the texture reflection matrix used to rotate/transform the reflection.
  103395. * @returns the reflection matrix
  103396. */
  103397. getReflectionTextureMatrix(): Matrix;
  103398. /**
  103399. * Resize the texture to a new desired size.
  103400. * Be carrefull as it will recreate all the data in the new texture.
  103401. * @param size Define the new size. It can be:
  103402. * - a number for squared texture,
  103403. * - an object containing { width: number, height: number }
  103404. * - or an object containing a ratio { ratio: number }
  103405. */
  103406. resize(size: number | {
  103407. width: number;
  103408. height: number;
  103409. } | {
  103410. ratio: number;
  103411. }): void;
  103412. private _defaultRenderListPrepared;
  103413. /**
  103414. * Renders all the objects from the render list into the texture.
  103415. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  103416. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  103417. */
  103418. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  103419. private _bestReflectionRenderTargetDimension;
  103420. private _prepareRenderingManager;
  103421. /**
  103422. * @hidden
  103423. * @param faceIndex face index to bind to if this is a cubetexture
  103424. * @param layer defines the index of the texture to bind in the array
  103425. */
  103426. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  103427. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103428. private renderToTarget;
  103429. /**
  103430. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103431. * This allowed control for front to back rendering or reversly depending of the special needs.
  103432. *
  103433. * @param renderingGroupId The rendering group id corresponding to its index
  103434. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103435. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103436. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103437. */
  103438. 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;
  103439. /**
  103440. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103441. *
  103442. * @param renderingGroupId The rendering group id corresponding to its index
  103443. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103444. */
  103445. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  103446. /**
  103447. * Clones the texture.
  103448. * @returns the cloned texture
  103449. */
  103450. clone(): RenderTargetTexture;
  103451. /**
  103452. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103453. * @returns The JSON representation of the texture
  103454. */
  103455. serialize(): any;
  103456. /**
  103457. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  103458. */
  103459. disposeFramebufferObjects(): void;
  103460. /**
  103461. * Dispose the texture and release its associated resources.
  103462. */
  103463. dispose(): void;
  103464. /** @hidden */
  103465. _rebuild(): void;
  103466. /**
  103467. * Clear the info related to rendering groups preventing retention point in material dispose.
  103468. */
  103469. freeRenderingGroups(): void;
  103470. /**
  103471. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  103472. * @returns the view count
  103473. */
  103474. getViewCount(): number;
  103475. }
  103476. }
  103477. declare module BABYLON {
  103478. /**
  103479. * Class used to manipulate GUIDs
  103480. */
  103481. export class GUID {
  103482. /**
  103483. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  103484. * Be aware Math.random() could cause collisions, but:
  103485. * "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"
  103486. * @returns a pseudo random id
  103487. */
  103488. static RandomId(): string;
  103489. }
  103490. }
  103491. declare module BABYLON {
  103492. /**
  103493. * Options to be used when creating a shadow depth material
  103494. */
  103495. export interface IIOptionShadowDepthMaterial {
  103496. /** Variables in the vertex shader code that need to have their names remapped.
  103497. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  103498. * "var_name" should be either: worldPos or vNormalW
  103499. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  103500. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  103501. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  103502. */
  103503. remappedVariables?: string[];
  103504. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  103505. standalone?: boolean;
  103506. }
  103507. /**
  103508. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  103509. */
  103510. export class ShadowDepthWrapper {
  103511. private _scene;
  103512. private _options?;
  103513. private _baseMaterial;
  103514. private _onEffectCreatedObserver;
  103515. private _subMeshToEffect;
  103516. private _subMeshToDepthEffect;
  103517. private _meshes;
  103518. /** @hidden */
  103519. _matriceNames: any;
  103520. /** Gets the standalone status of the wrapper */
  103521. get standalone(): boolean;
  103522. /** Gets the base material the wrapper is built upon */
  103523. get baseMaterial(): Material;
  103524. /**
  103525. * Instantiate a new shadow depth wrapper.
  103526. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  103527. * generate the shadow depth map. For more information, please refer to the documentation:
  103528. * https://doc.babylonjs.com/babylon101/shadows
  103529. * @param baseMaterial Material to wrap
  103530. * @param scene Define the scene the material belongs to
  103531. * @param options Options used to create the wrapper
  103532. */
  103533. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  103534. /**
  103535. * Gets the effect to use to generate the depth map
  103536. * @param subMesh subMesh to get the effect for
  103537. * @param shadowGenerator shadow generator to get the effect for
  103538. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  103539. */
  103540. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  103541. /**
  103542. * Specifies that the submesh is ready to be used for depth rendering
  103543. * @param subMesh submesh to check
  103544. * @param defines the list of defines to take into account when checking the effect
  103545. * @param shadowGenerator combined with subMesh, it defines the effect to check
  103546. * @param useInstances specifies that instances should be used
  103547. * @returns a boolean indicating that the submesh is ready or not
  103548. */
  103549. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  103550. /**
  103551. * Disposes the resources
  103552. */
  103553. dispose(): void;
  103554. private _makeEffect;
  103555. }
  103556. }
  103557. declare module BABYLON {
  103558. interface ThinEngine {
  103559. /**
  103560. * Unbind a list of render target textures from the webGL context
  103561. * This is used only when drawBuffer extension or webGL2 are active
  103562. * @param textures defines the render target textures to unbind
  103563. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  103564. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  103565. */
  103566. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  103567. /**
  103568. * Create a multi render target texture
  103569. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  103570. * @param size defines the size of the texture
  103571. * @param options defines the creation options
  103572. * @returns the cube texture as an InternalTexture
  103573. */
  103574. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  103575. /**
  103576. * Update the sample count for a given multiple render target texture
  103577. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  103578. * @param textures defines the textures to update
  103579. * @param samples defines the sample count to set
  103580. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  103581. */
  103582. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  103583. /**
  103584. * Select a subsets of attachments to draw to.
  103585. * @param attachments gl attachments
  103586. */
  103587. bindAttachments(attachments: number[]): void;
  103588. }
  103589. }
  103590. declare module BABYLON {
  103591. /**
  103592. * Creation options of the multi render target texture.
  103593. */
  103594. export interface IMultiRenderTargetOptions {
  103595. /**
  103596. * Define if the texture needs to create mip maps after render.
  103597. */
  103598. generateMipMaps?: boolean;
  103599. /**
  103600. * Define the types of all the draw buffers we want to create
  103601. */
  103602. types?: number[];
  103603. /**
  103604. * Define the sampling modes of all the draw buffers we want to create
  103605. */
  103606. samplingModes?: number[];
  103607. /**
  103608. * Define if a depth buffer is required
  103609. */
  103610. generateDepthBuffer?: boolean;
  103611. /**
  103612. * Define if a stencil buffer is required
  103613. */
  103614. generateStencilBuffer?: boolean;
  103615. /**
  103616. * Define if a depth texture is required instead of a depth buffer
  103617. */
  103618. generateDepthTexture?: boolean;
  103619. /**
  103620. * Define the number of desired draw buffers
  103621. */
  103622. textureCount?: number;
  103623. /**
  103624. * Define if aspect ratio should be adapted to the texture or stay the scene one
  103625. */
  103626. doNotChangeAspectRatio?: boolean;
  103627. /**
  103628. * Define the default type of the buffers we are creating
  103629. */
  103630. defaultType?: number;
  103631. }
  103632. /**
  103633. * A multi render target, like a render target provides the ability to render to a texture.
  103634. * Unlike the render target, it can render to several draw buffers in one draw.
  103635. * This is specially interesting in deferred rendering or for any effects requiring more than
  103636. * just one color from a single pass.
  103637. */
  103638. export class MultiRenderTarget extends RenderTargetTexture {
  103639. private _internalTextures;
  103640. private _textures;
  103641. private _multiRenderTargetOptions;
  103642. private _count;
  103643. /**
  103644. * Get if draw buffers are currently supported by the used hardware and browser.
  103645. */
  103646. get isSupported(): boolean;
  103647. /**
  103648. * Get the list of textures generated by the multi render target.
  103649. */
  103650. get textures(): Texture[];
  103651. /**
  103652. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  103653. */
  103654. get count(): number;
  103655. /**
  103656. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  103657. */
  103658. get depthTexture(): Texture;
  103659. /**
  103660. * Set the wrapping mode on U of all the textures we are rendering to.
  103661. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103662. */
  103663. set wrapU(wrap: number);
  103664. /**
  103665. * Set the wrapping mode on V of all the textures we are rendering to.
  103666. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103667. */
  103668. set wrapV(wrap: number);
  103669. /**
  103670. * Instantiate a new multi render target texture.
  103671. * A multi render target, like a render target provides the ability to render to a texture.
  103672. * Unlike the render target, it can render to several draw buffers in one draw.
  103673. * This is specially interesting in deferred rendering or for any effects requiring more than
  103674. * just one color from a single pass.
  103675. * @param name Define the name of the texture
  103676. * @param size Define the size of the buffers to render to
  103677. * @param count Define the number of target we are rendering into
  103678. * @param scene Define the scene the texture belongs to
  103679. * @param options Define the options used to create the multi render target
  103680. */
  103681. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  103682. /** @hidden */
  103683. _rebuild(): void;
  103684. private _createInternalTextures;
  103685. private _createTextures;
  103686. /**
  103687. * Define the number of samples used if MSAA is enabled.
  103688. */
  103689. get samples(): number;
  103690. set samples(value: number);
  103691. /**
  103692. * Resize all the textures in the multi render target.
  103693. * Be carrefull as it will recreate all the data in the new texture.
  103694. * @param size Define the new size
  103695. */
  103696. resize(size: any): void;
  103697. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103698. /**
  103699. * Dispose the render targets and their associated resources
  103700. */
  103701. dispose(): void;
  103702. /**
  103703. * Release all the underlying texture used as draw buffers.
  103704. */
  103705. releaseInternalTextures(): void;
  103706. }
  103707. }
  103708. declare module BABYLON {
  103709. /** @hidden */
  103710. export var imageProcessingPixelShader: {
  103711. name: string;
  103712. shader: string;
  103713. };
  103714. }
  103715. declare module BABYLON {
  103716. /**
  103717. * ImageProcessingPostProcess
  103718. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  103719. */
  103720. export class ImageProcessingPostProcess extends PostProcess {
  103721. /**
  103722. * Default configuration related to image processing available in the PBR Material.
  103723. */
  103724. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  103725. /**
  103726. * Gets the image processing configuration used either in this material.
  103727. */
  103728. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  103729. /**
  103730. * Sets the Default image processing configuration used either in the this material.
  103731. *
  103732. * If sets to null, the scene one is in use.
  103733. */
  103734. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  103735. /**
  103736. * Keep track of the image processing observer to allow dispose and replace.
  103737. */
  103738. private _imageProcessingObserver;
  103739. /**
  103740. * Attaches a new image processing configuration to the PBR Material.
  103741. * @param configuration
  103742. */
  103743. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  103744. /**
  103745. * If the post process is supported.
  103746. */
  103747. get isSupported(): boolean;
  103748. /**
  103749. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103750. */
  103751. get colorCurves(): Nullable<ColorCurves>;
  103752. /**
  103753. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103754. */
  103755. set colorCurves(value: Nullable<ColorCurves>);
  103756. /**
  103757. * Gets wether the color curves effect is enabled.
  103758. */
  103759. get colorCurvesEnabled(): boolean;
  103760. /**
  103761. * Sets wether the color curves effect is enabled.
  103762. */
  103763. set colorCurvesEnabled(value: boolean);
  103764. /**
  103765. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103766. */
  103767. get colorGradingTexture(): Nullable<BaseTexture>;
  103768. /**
  103769. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103770. */
  103771. set colorGradingTexture(value: Nullable<BaseTexture>);
  103772. /**
  103773. * Gets wether the color grading effect is enabled.
  103774. */
  103775. get colorGradingEnabled(): boolean;
  103776. /**
  103777. * Gets wether the color grading effect is enabled.
  103778. */
  103779. set colorGradingEnabled(value: boolean);
  103780. /**
  103781. * Gets exposure used in the effect.
  103782. */
  103783. get exposure(): number;
  103784. /**
  103785. * Sets exposure used in the effect.
  103786. */
  103787. set exposure(value: number);
  103788. /**
  103789. * Gets wether tonemapping is enabled or not.
  103790. */
  103791. get toneMappingEnabled(): boolean;
  103792. /**
  103793. * Sets wether tonemapping is enabled or not
  103794. */
  103795. set toneMappingEnabled(value: boolean);
  103796. /**
  103797. * Gets the type of tone mapping effect.
  103798. */
  103799. get toneMappingType(): number;
  103800. /**
  103801. * Sets the type of tone mapping effect.
  103802. */
  103803. set toneMappingType(value: number);
  103804. /**
  103805. * Gets contrast used in the effect.
  103806. */
  103807. get contrast(): number;
  103808. /**
  103809. * Sets contrast used in the effect.
  103810. */
  103811. set contrast(value: number);
  103812. /**
  103813. * Gets Vignette stretch size.
  103814. */
  103815. get vignetteStretch(): number;
  103816. /**
  103817. * Sets Vignette stretch size.
  103818. */
  103819. set vignetteStretch(value: number);
  103820. /**
  103821. * Gets Vignette centre X Offset.
  103822. */
  103823. get vignetteCentreX(): number;
  103824. /**
  103825. * Sets Vignette centre X Offset.
  103826. */
  103827. set vignetteCentreX(value: number);
  103828. /**
  103829. * Gets Vignette centre Y Offset.
  103830. */
  103831. get vignetteCentreY(): number;
  103832. /**
  103833. * Sets Vignette centre Y Offset.
  103834. */
  103835. set vignetteCentreY(value: number);
  103836. /**
  103837. * Gets Vignette weight or intensity of the vignette effect.
  103838. */
  103839. get vignetteWeight(): number;
  103840. /**
  103841. * Sets Vignette weight or intensity of the vignette effect.
  103842. */
  103843. set vignetteWeight(value: number);
  103844. /**
  103845. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103846. * if vignetteEnabled is set to true.
  103847. */
  103848. get vignetteColor(): Color4;
  103849. /**
  103850. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103851. * if vignetteEnabled is set to true.
  103852. */
  103853. set vignetteColor(value: Color4);
  103854. /**
  103855. * Gets Camera field of view used by the Vignette effect.
  103856. */
  103857. get vignetteCameraFov(): number;
  103858. /**
  103859. * Sets Camera field of view used by the Vignette effect.
  103860. */
  103861. set vignetteCameraFov(value: number);
  103862. /**
  103863. * Gets the vignette blend mode allowing different kind of effect.
  103864. */
  103865. get vignetteBlendMode(): number;
  103866. /**
  103867. * Sets the vignette blend mode allowing different kind of effect.
  103868. */
  103869. set vignetteBlendMode(value: number);
  103870. /**
  103871. * Gets wether the vignette effect is enabled.
  103872. */
  103873. get vignetteEnabled(): boolean;
  103874. /**
  103875. * Sets wether the vignette effect is enabled.
  103876. */
  103877. set vignetteEnabled(value: boolean);
  103878. private _fromLinearSpace;
  103879. /**
  103880. * Gets wether the input of the processing is in Gamma or Linear Space.
  103881. */
  103882. get fromLinearSpace(): boolean;
  103883. /**
  103884. * Sets wether the input of the processing is in Gamma or Linear Space.
  103885. */
  103886. set fromLinearSpace(value: boolean);
  103887. /**
  103888. * Defines cache preventing GC.
  103889. */
  103890. private _defines;
  103891. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  103892. /**
  103893. * "ImageProcessingPostProcess"
  103894. * @returns "ImageProcessingPostProcess"
  103895. */
  103896. getClassName(): string;
  103897. /**
  103898. * @hidden
  103899. */
  103900. _updateParameters(): void;
  103901. dispose(camera?: Camera): void;
  103902. }
  103903. }
  103904. declare module BABYLON {
  103905. /** @hidden */
  103906. export var fibonacci: {
  103907. name: string;
  103908. shader: string;
  103909. };
  103910. }
  103911. declare module BABYLON {
  103912. /** @hidden */
  103913. export var subSurfaceScatteringFunctions: {
  103914. name: string;
  103915. shader: string;
  103916. };
  103917. }
  103918. declare module BABYLON {
  103919. /** @hidden */
  103920. export var diffusionProfile: {
  103921. name: string;
  103922. shader: string;
  103923. };
  103924. }
  103925. declare module BABYLON {
  103926. /** @hidden */
  103927. export var subSurfaceScatteringPixelShader: {
  103928. name: string;
  103929. shader: string;
  103930. };
  103931. }
  103932. declare module BABYLON {
  103933. /**
  103934. * Sub surface scattering post process
  103935. */
  103936. export class SubSurfaceScatteringPostProcess extends PostProcess {
  103937. /**
  103938. * Gets a string identifying the name of the class
  103939. * @returns "SubSurfaceScatteringPostProcess" string
  103940. */
  103941. getClassName(): string;
  103942. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  103943. }
  103944. }
  103945. declare module BABYLON {
  103946. /**
  103947. * Interface for defining prepass effects in the prepass post-process pipeline
  103948. */
  103949. export interface PrePassEffectConfiguration {
  103950. /**
  103951. * Post process to attach for this effect
  103952. */
  103953. postProcess: PostProcess;
  103954. /**
  103955. * Is the effect enabled
  103956. */
  103957. enabled: boolean;
  103958. /**
  103959. * Disposes the effect configuration
  103960. */
  103961. dispose(): void;
  103962. /**
  103963. * Disposes the effect configuration
  103964. */
  103965. createPostProcess: () => PostProcess;
  103966. }
  103967. }
  103968. declare module BABYLON {
  103969. /**
  103970. * Contains all parameters needed for the prepass to perform
  103971. * screen space subsurface scattering
  103972. */
  103973. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  103974. private _ssDiffusionS;
  103975. private _ssFilterRadii;
  103976. private _ssDiffusionD;
  103977. /**
  103978. * Post process to attach for screen space subsurface scattering
  103979. */
  103980. postProcess: SubSurfaceScatteringPostProcess;
  103981. /**
  103982. * Diffusion profile color for subsurface scattering
  103983. */
  103984. get ssDiffusionS(): number[];
  103985. /**
  103986. * Diffusion profile max color channel value for subsurface scattering
  103987. */
  103988. get ssDiffusionD(): number[];
  103989. /**
  103990. * Diffusion profile filter radius for subsurface scattering
  103991. */
  103992. get ssFilterRadii(): number[];
  103993. /**
  103994. * Is subsurface enabled
  103995. */
  103996. enabled: boolean;
  103997. /**
  103998. * Diffusion profile colors for subsurface scattering
  103999. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  104000. * See ...
  104001. * Note that you can only store up to 5 of them
  104002. */
  104003. ssDiffusionProfileColors: Color3[];
  104004. /**
  104005. * Defines the ratio real world => scene units.
  104006. * Used for subsurface scattering
  104007. */
  104008. metersPerUnit: number;
  104009. private _scene;
  104010. /**
  104011. * Builds a subsurface configuration object
  104012. * @param scene The scene
  104013. */
  104014. constructor(scene: Scene);
  104015. /**
  104016. * Adds a new diffusion profile.
  104017. * Useful for more realistic subsurface scattering on diverse materials.
  104018. * @param color The color of the diffusion profile. Should be the average color of the material.
  104019. * @return The index of the diffusion profile for the material subsurface configuration
  104020. */
  104021. addDiffusionProfile(color: Color3): number;
  104022. /**
  104023. * Creates the sss post process
  104024. * @return The created post process
  104025. */
  104026. createPostProcess(): SubSurfaceScatteringPostProcess;
  104027. /**
  104028. * Deletes all diffusion profiles.
  104029. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  104030. */
  104031. clearAllDiffusionProfiles(): void;
  104032. /**
  104033. * Disposes this object
  104034. */
  104035. dispose(): void;
  104036. /**
  104037. * @hidden
  104038. * https://zero-radiance.github.io/post/sampling-diffusion/
  104039. *
  104040. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  104041. * ------------------------------------------------------------------------------------
  104042. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  104043. * PDF[r, phi, s] = r * R[r, phi, s]
  104044. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  104045. * ------------------------------------------------------------------------------------
  104046. * We importance sample the color channel with the widest scattering distance.
  104047. */
  104048. getDiffusionProfileParameters(color: Color3): number;
  104049. /**
  104050. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  104051. * 'u' is the random number (the value of the CDF): [0, 1).
  104052. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  104053. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  104054. */
  104055. private _sampleBurleyDiffusionProfile;
  104056. }
  104057. }
  104058. declare module BABYLON {
  104059. /**
  104060. * Renders a pre pass of the scene
  104061. * This means every mesh in the scene will be rendered to a render target texture
  104062. * And then this texture will be composited to the rendering canvas with post processes
  104063. * It is necessary for effects like subsurface scattering or deferred shading
  104064. */
  104065. export class PrePassRenderer {
  104066. /** @hidden */
  104067. static _SceneComponentInitialization: (scene: Scene) => void;
  104068. private _scene;
  104069. private _engine;
  104070. private _isDirty;
  104071. /**
  104072. * Number of textures in the multi render target texture where the scene is directly rendered
  104073. */
  104074. readonly mrtCount: number;
  104075. /**
  104076. * The render target where the scene is directly rendered
  104077. */
  104078. prePassRT: MultiRenderTarget;
  104079. private _mrtTypes;
  104080. private _multiRenderAttachments;
  104081. private _defaultAttachments;
  104082. private _clearAttachments;
  104083. private _postProcesses;
  104084. private readonly _clearColor;
  104085. /**
  104086. * Image processing post process for composition
  104087. */
  104088. imageProcessingPostProcess: ImageProcessingPostProcess;
  104089. /**
  104090. * Configuration for sub surface scattering post process
  104091. */
  104092. subSurfaceConfiguration: SubSurfaceConfiguration;
  104093. /**
  104094. * Should materials render their geometry on the MRT
  104095. */
  104096. materialsShouldRenderGeometry: boolean;
  104097. /**
  104098. * Should materials render the irradiance information on the MRT
  104099. */
  104100. materialsShouldRenderIrradiance: boolean;
  104101. private _enabled;
  104102. /**
  104103. * Indicates if the prepass is enabled
  104104. */
  104105. get enabled(): boolean;
  104106. /**
  104107. * How many samples are used for MSAA of the scene render target
  104108. */
  104109. get samples(): number;
  104110. set samples(n: number);
  104111. /**
  104112. * Instanciates a prepass renderer
  104113. * @param scene The scene
  104114. */
  104115. constructor(scene: Scene);
  104116. private _initializeAttachments;
  104117. private _createCompositionEffect;
  104118. /**
  104119. * Indicates if rendering a prepass is supported
  104120. */
  104121. get isSupported(): boolean;
  104122. /**
  104123. * Sets the proper output textures to draw in the engine.
  104124. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  104125. */
  104126. bindAttachmentsForEffect(effect: Effect): void;
  104127. /**
  104128. * @hidden
  104129. */
  104130. _beforeCameraDraw(): void;
  104131. /**
  104132. * @hidden
  104133. */
  104134. _afterCameraDraw(): void;
  104135. private _checkRTSize;
  104136. private _bindFrameBuffer;
  104137. /**
  104138. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  104139. */
  104140. clear(): void;
  104141. private _setState;
  104142. private _enable;
  104143. private _disable;
  104144. private _resetPostProcessChain;
  104145. private _bindPostProcessChain;
  104146. /**
  104147. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  104148. */
  104149. markAsDirty(): void;
  104150. private _update;
  104151. /**
  104152. * Disposes the prepass renderer.
  104153. */
  104154. dispose(): void;
  104155. }
  104156. }
  104157. declare module BABYLON {
  104158. /**
  104159. * Options for compiling materials.
  104160. */
  104161. export interface IMaterialCompilationOptions {
  104162. /**
  104163. * Defines whether clip planes are enabled.
  104164. */
  104165. clipPlane: boolean;
  104166. /**
  104167. * Defines whether instances are enabled.
  104168. */
  104169. useInstances: boolean;
  104170. }
  104171. /**
  104172. * Options passed when calling customShaderNameResolve
  104173. */
  104174. export interface ICustomShaderNameResolveOptions {
  104175. /**
  104176. * 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
  104177. */
  104178. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  104179. }
  104180. /**
  104181. * Base class for the main features of a material in Babylon.js
  104182. */
  104183. export class Material implements IAnimatable {
  104184. /**
  104185. * Returns the triangle fill mode
  104186. */
  104187. static readonly TriangleFillMode: number;
  104188. /**
  104189. * Returns the wireframe mode
  104190. */
  104191. static readonly WireFrameFillMode: number;
  104192. /**
  104193. * Returns the point fill mode
  104194. */
  104195. static readonly PointFillMode: number;
  104196. /**
  104197. * Returns the point list draw mode
  104198. */
  104199. static readonly PointListDrawMode: number;
  104200. /**
  104201. * Returns the line list draw mode
  104202. */
  104203. static readonly LineListDrawMode: number;
  104204. /**
  104205. * Returns the line loop draw mode
  104206. */
  104207. static readonly LineLoopDrawMode: number;
  104208. /**
  104209. * Returns the line strip draw mode
  104210. */
  104211. static readonly LineStripDrawMode: number;
  104212. /**
  104213. * Returns the triangle strip draw mode
  104214. */
  104215. static readonly TriangleStripDrawMode: number;
  104216. /**
  104217. * Returns the triangle fan draw mode
  104218. */
  104219. static readonly TriangleFanDrawMode: number;
  104220. /**
  104221. * Stores the clock-wise side orientation
  104222. */
  104223. static readonly ClockWiseSideOrientation: number;
  104224. /**
  104225. * Stores the counter clock-wise side orientation
  104226. */
  104227. static readonly CounterClockWiseSideOrientation: number;
  104228. /**
  104229. * The dirty texture flag value
  104230. */
  104231. static readonly TextureDirtyFlag: number;
  104232. /**
  104233. * The dirty light flag value
  104234. */
  104235. static readonly LightDirtyFlag: number;
  104236. /**
  104237. * The dirty fresnel flag value
  104238. */
  104239. static readonly FresnelDirtyFlag: number;
  104240. /**
  104241. * The dirty attribute flag value
  104242. */
  104243. static readonly AttributesDirtyFlag: number;
  104244. /**
  104245. * The dirty misc flag value
  104246. */
  104247. static readonly MiscDirtyFlag: number;
  104248. /**
  104249. * The all dirty flag value
  104250. */
  104251. static readonly AllDirtyFlag: number;
  104252. /**
  104253. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  104254. */
  104255. static readonly MATERIAL_OPAQUE: number;
  104256. /**
  104257. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  104258. */
  104259. static readonly MATERIAL_ALPHATEST: number;
  104260. /**
  104261. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104262. */
  104263. static readonly MATERIAL_ALPHABLEND: number;
  104264. /**
  104265. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104266. * They are also discarded below the alpha cutoff threshold to improve performances.
  104267. */
  104268. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  104269. /**
  104270. * The Whiteout method is used to blend normals.
  104271. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104272. */
  104273. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  104274. /**
  104275. * The Reoriented Normal Mapping method is used to blend normals.
  104276. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104277. */
  104278. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  104279. /**
  104280. * Custom callback helping to override the default shader used in the material.
  104281. */
  104282. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  104283. /**
  104284. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  104285. */
  104286. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  104287. /**
  104288. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  104289. * This means that the material can keep using a previous shader while a new one is being compiled.
  104290. * This is mostly used when shader parallel compilation is supported (true by default)
  104291. */
  104292. allowShaderHotSwapping: boolean;
  104293. /**
  104294. * The ID of the material
  104295. */
  104296. id: string;
  104297. /**
  104298. * Gets or sets the unique id of the material
  104299. */
  104300. uniqueId: number;
  104301. /**
  104302. * The name of the material
  104303. */
  104304. name: string;
  104305. /**
  104306. * Gets or sets user defined metadata
  104307. */
  104308. metadata: any;
  104309. /**
  104310. * For internal use only. Please do not use.
  104311. */
  104312. reservedDataStore: any;
  104313. /**
  104314. * Specifies if the ready state should be checked on each call
  104315. */
  104316. checkReadyOnEveryCall: boolean;
  104317. /**
  104318. * Specifies if the ready state should be checked once
  104319. */
  104320. checkReadyOnlyOnce: boolean;
  104321. /**
  104322. * The state of the material
  104323. */
  104324. state: string;
  104325. /**
  104326. * If the material can be rendered to several textures with MRT extension
  104327. */
  104328. get canRenderToMRT(): boolean;
  104329. /**
  104330. * The alpha value of the material
  104331. */
  104332. protected _alpha: number;
  104333. /**
  104334. * List of inspectable custom properties (used by the Inspector)
  104335. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  104336. */
  104337. inspectableCustomProperties: IInspectable[];
  104338. /**
  104339. * Sets the alpha value of the material
  104340. */
  104341. set alpha(value: number);
  104342. /**
  104343. * Gets the alpha value of the material
  104344. */
  104345. get alpha(): number;
  104346. /**
  104347. * Specifies if back face culling is enabled
  104348. */
  104349. protected _backFaceCulling: boolean;
  104350. /**
  104351. * Sets the back-face culling state
  104352. */
  104353. set backFaceCulling(value: boolean);
  104354. /**
  104355. * Gets the back-face culling state
  104356. */
  104357. get backFaceCulling(): boolean;
  104358. /**
  104359. * Stores the value for side orientation
  104360. */
  104361. sideOrientation: number;
  104362. /**
  104363. * Callback triggered when the material is compiled
  104364. */
  104365. onCompiled: Nullable<(effect: Effect) => void>;
  104366. /**
  104367. * Callback triggered when an error occurs
  104368. */
  104369. onError: Nullable<(effect: Effect, errors: string) => void>;
  104370. /**
  104371. * Callback triggered to get the render target textures
  104372. */
  104373. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  104374. /**
  104375. * Gets a boolean indicating that current material needs to register RTT
  104376. */
  104377. get hasRenderTargetTextures(): boolean;
  104378. /**
  104379. * Specifies if the material should be serialized
  104380. */
  104381. doNotSerialize: boolean;
  104382. /**
  104383. * @hidden
  104384. */
  104385. _storeEffectOnSubMeshes: boolean;
  104386. /**
  104387. * Stores the animations for the material
  104388. */
  104389. animations: Nullable<Array<Animation>>;
  104390. /**
  104391. * An event triggered when the material is disposed
  104392. */
  104393. onDisposeObservable: Observable<Material>;
  104394. /**
  104395. * An observer which watches for dispose events
  104396. */
  104397. private _onDisposeObserver;
  104398. private _onUnBindObservable;
  104399. /**
  104400. * Called during a dispose event
  104401. */
  104402. set onDispose(callback: () => void);
  104403. private _onBindObservable;
  104404. /**
  104405. * An event triggered when the material is bound
  104406. */
  104407. get onBindObservable(): Observable<AbstractMesh>;
  104408. /**
  104409. * An observer which watches for bind events
  104410. */
  104411. private _onBindObserver;
  104412. /**
  104413. * Called during a bind event
  104414. */
  104415. set onBind(callback: (Mesh: AbstractMesh) => void);
  104416. /**
  104417. * An event triggered when the material is unbound
  104418. */
  104419. get onUnBindObservable(): Observable<Material>;
  104420. protected _onEffectCreatedObservable: Nullable<Observable<{
  104421. effect: Effect;
  104422. subMesh: Nullable<SubMesh>;
  104423. }>>;
  104424. /**
  104425. * An event triggered when the effect is (re)created
  104426. */
  104427. get onEffectCreatedObservable(): Observable<{
  104428. effect: Effect;
  104429. subMesh: Nullable<SubMesh>;
  104430. }>;
  104431. /**
  104432. * Stores the value of the alpha mode
  104433. */
  104434. private _alphaMode;
  104435. /**
  104436. * Sets the value of the alpha mode.
  104437. *
  104438. * | Value | Type | Description |
  104439. * | --- | --- | --- |
  104440. * | 0 | ALPHA_DISABLE | |
  104441. * | 1 | ALPHA_ADD | |
  104442. * | 2 | ALPHA_COMBINE | |
  104443. * | 3 | ALPHA_SUBTRACT | |
  104444. * | 4 | ALPHA_MULTIPLY | |
  104445. * | 5 | ALPHA_MAXIMIZED | |
  104446. * | 6 | ALPHA_ONEONE | |
  104447. * | 7 | ALPHA_PREMULTIPLIED | |
  104448. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  104449. * | 9 | ALPHA_INTERPOLATE | |
  104450. * | 10 | ALPHA_SCREENMODE | |
  104451. *
  104452. */
  104453. set alphaMode(value: number);
  104454. /**
  104455. * Gets the value of the alpha mode
  104456. */
  104457. get alphaMode(): number;
  104458. /**
  104459. * Stores the state of the need depth pre-pass value
  104460. */
  104461. private _needDepthPrePass;
  104462. /**
  104463. * Sets the need depth pre-pass value
  104464. */
  104465. set needDepthPrePass(value: boolean);
  104466. /**
  104467. * Gets the depth pre-pass value
  104468. */
  104469. get needDepthPrePass(): boolean;
  104470. /**
  104471. * Specifies if depth writing should be disabled
  104472. */
  104473. disableDepthWrite: boolean;
  104474. /**
  104475. * Specifies if color writing should be disabled
  104476. */
  104477. disableColorWrite: boolean;
  104478. /**
  104479. * Specifies if depth writing should be forced
  104480. */
  104481. forceDepthWrite: boolean;
  104482. /**
  104483. * Specifies the depth function that should be used. 0 means the default engine function
  104484. */
  104485. depthFunction: number;
  104486. /**
  104487. * Specifies if there should be a separate pass for culling
  104488. */
  104489. separateCullingPass: boolean;
  104490. /**
  104491. * Stores the state specifing if fog should be enabled
  104492. */
  104493. private _fogEnabled;
  104494. /**
  104495. * Sets the state for enabling fog
  104496. */
  104497. set fogEnabled(value: boolean);
  104498. /**
  104499. * Gets the value of the fog enabled state
  104500. */
  104501. get fogEnabled(): boolean;
  104502. /**
  104503. * Stores the size of points
  104504. */
  104505. pointSize: number;
  104506. /**
  104507. * Stores the z offset value
  104508. */
  104509. zOffset: number;
  104510. get wireframe(): boolean;
  104511. /**
  104512. * Sets the state of wireframe mode
  104513. */
  104514. set wireframe(value: boolean);
  104515. /**
  104516. * Gets the value specifying if point clouds are enabled
  104517. */
  104518. get pointsCloud(): boolean;
  104519. /**
  104520. * Sets the state of point cloud mode
  104521. */
  104522. set pointsCloud(value: boolean);
  104523. /**
  104524. * Gets the material fill mode
  104525. */
  104526. get fillMode(): number;
  104527. /**
  104528. * Sets the material fill mode
  104529. */
  104530. set fillMode(value: number);
  104531. /**
  104532. * @hidden
  104533. * Stores the effects for the material
  104534. */
  104535. _effect: Nullable<Effect>;
  104536. /**
  104537. * Specifies if uniform buffers should be used
  104538. */
  104539. private _useUBO;
  104540. /**
  104541. * Stores a reference to the scene
  104542. */
  104543. private _scene;
  104544. /**
  104545. * Stores the fill mode state
  104546. */
  104547. private _fillMode;
  104548. /**
  104549. * Specifies if the depth write state should be cached
  104550. */
  104551. private _cachedDepthWriteState;
  104552. /**
  104553. * Specifies if the color write state should be cached
  104554. */
  104555. private _cachedColorWriteState;
  104556. /**
  104557. * Specifies if the depth function state should be cached
  104558. */
  104559. private _cachedDepthFunctionState;
  104560. /**
  104561. * Stores the uniform buffer
  104562. */
  104563. protected _uniformBuffer: UniformBuffer;
  104564. /** @hidden */
  104565. _indexInSceneMaterialArray: number;
  104566. /** @hidden */
  104567. meshMap: Nullable<{
  104568. [id: string]: AbstractMesh | undefined;
  104569. }>;
  104570. /**
  104571. * Creates a material instance
  104572. * @param name defines the name of the material
  104573. * @param scene defines the scene to reference
  104574. * @param doNotAdd specifies if the material should be added to the scene
  104575. */
  104576. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  104577. /**
  104578. * Returns a string representation of the current material
  104579. * @param fullDetails defines a boolean indicating which levels of logging is desired
  104580. * @returns a string with material information
  104581. */
  104582. toString(fullDetails?: boolean): string;
  104583. /**
  104584. * Gets the class name of the material
  104585. * @returns a string with the class name of the material
  104586. */
  104587. getClassName(): string;
  104588. /**
  104589. * Specifies if updates for the material been locked
  104590. */
  104591. get isFrozen(): boolean;
  104592. /**
  104593. * Locks updates for the material
  104594. */
  104595. freeze(): void;
  104596. /**
  104597. * Unlocks updates for the material
  104598. */
  104599. unfreeze(): void;
  104600. /**
  104601. * Specifies if the material is ready to be used
  104602. * @param mesh defines the mesh to check
  104603. * @param useInstances specifies if instances should be used
  104604. * @returns a boolean indicating if the material is ready to be used
  104605. */
  104606. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  104607. /**
  104608. * Specifies that the submesh is ready to be used
  104609. * @param mesh defines the mesh to check
  104610. * @param subMesh defines which submesh to check
  104611. * @param useInstances specifies that instances should be used
  104612. * @returns a boolean indicating that the submesh is ready or not
  104613. */
  104614. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104615. /**
  104616. * Returns the material effect
  104617. * @returns the effect associated with the material
  104618. */
  104619. getEffect(): Nullable<Effect>;
  104620. /**
  104621. * Returns the current scene
  104622. * @returns a Scene
  104623. */
  104624. getScene(): Scene;
  104625. /**
  104626. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  104627. */
  104628. protected _forceAlphaTest: boolean;
  104629. /**
  104630. * The transparency mode of the material.
  104631. */
  104632. protected _transparencyMode: Nullable<number>;
  104633. /**
  104634. * Gets the current transparency mode.
  104635. */
  104636. get transparencyMode(): Nullable<number>;
  104637. /**
  104638. * Sets the transparency mode of the material.
  104639. *
  104640. * | Value | Type | Description |
  104641. * | ----- | ----------------------------------- | ----------- |
  104642. * | 0 | OPAQUE | |
  104643. * | 1 | ALPHATEST | |
  104644. * | 2 | ALPHABLEND | |
  104645. * | 3 | ALPHATESTANDBLEND | |
  104646. *
  104647. */
  104648. set transparencyMode(value: Nullable<number>);
  104649. /**
  104650. * Returns true if alpha blending should be disabled.
  104651. */
  104652. protected get _disableAlphaBlending(): boolean;
  104653. /**
  104654. * Specifies whether or not this material should be rendered in alpha blend mode.
  104655. * @returns a boolean specifying if alpha blending is needed
  104656. */
  104657. needAlphaBlending(): boolean;
  104658. /**
  104659. * Specifies if the mesh will require alpha blending
  104660. * @param mesh defines the mesh to check
  104661. * @returns a boolean specifying if alpha blending is needed for the mesh
  104662. */
  104663. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  104664. /**
  104665. * Specifies whether or not this material should be rendered in alpha test mode.
  104666. * @returns a boolean specifying if an alpha test is needed.
  104667. */
  104668. needAlphaTesting(): boolean;
  104669. /**
  104670. * Specifies if material alpha testing should be turned on for the mesh
  104671. * @param mesh defines the mesh to check
  104672. */
  104673. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  104674. /**
  104675. * Gets the texture used for the alpha test
  104676. * @returns the texture to use for alpha testing
  104677. */
  104678. getAlphaTestTexture(): Nullable<BaseTexture>;
  104679. /**
  104680. * Marks the material to indicate that it needs to be re-calculated
  104681. */
  104682. markDirty(): void;
  104683. /** @hidden */
  104684. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  104685. /**
  104686. * Binds the material to the mesh
  104687. * @param world defines the world transformation matrix
  104688. * @param mesh defines the mesh to bind the material to
  104689. */
  104690. bind(world: Matrix, mesh?: Mesh): void;
  104691. /**
  104692. * Binds the submesh to the material
  104693. * @param world defines the world transformation matrix
  104694. * @param mesh defines the mesh containing the submesh
  104695. * @param subMesh defines the submesh to bind the material to
  104696. */
  104697. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  104698. /**
  104699. * Binds the world matrix to the material
  104700. * @param world defines the world transformation matrix
  104701. */
  104702. bindOnlyWorldMatrix(world: Matrix): void;
  104703. /**
  104704. * Binds the scene's uniform buffer to the effect.
  104705. * @param effect defines the effect to bind to the scene uniform buffer
  104706. * @param sceneUbo defines the uniform buffer storing scene data
  104707. */
  104708. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  104709. /**
  104710. * Binds the view matrix to the effect
  104711. * @param effect defines the effect to bind the view matrix to
  104712. */
  104713. bindView(effect: Effect): void;
  104714. /**
  104715. * Binds the view projection matrix to the effect
  104716. * @param effect defines the effect to bind the view projection matrix to
  104717. */
  104718. bindViewProjection(effect: Effect): void;
  104719. /**
  104720. * Processes to execute after binding the material to a mesh
  104721. * @param mesh defines the rendered mesh
  104722. */
  104723. protected _afterBind(mesh?: Mesh): void;
  104724. /**
  104725. * Unbinds the material from the mesh
  104726. */
  104727. unbind(): void;
  104728. /**
  104729. * Gets the active textures from the material
  104730. * @returns an array of textures
  104731. */
  104732. getActiveTextures(): BaseTexture[];
  104733. /**
  104734. * Specifies if the material uses a texture
  104735. * @param texture defines the texture to check against the material
  104736. * @returns a boolean specifying if the material uses the texture
  104737. */
  104738. hasTexture(texture: BaseTexture): boolean;
  104739. /**
  104740. * Makes a duplicate of the material, and gives it a new name
  104741. * @param name defines the new name for the duplicated material
  104742. * @returns the cloned material
  104743. */
  104744. clone(name: string): Nullable<Material>;
  104745. /**
  104746. * Gets the meshes bound to the material
  104747. * @returns an array of meshes bound to the material
  104748. */
  104749. getBindedMeshes(): AbstractMesh[];
  104750. /**
  104751. * Force shader compilation
  104752. * @param mesh defines the mesh associated with this material
  104753. * @param onCompiled defines a function to execute once the material is compiled
  104754. * @param options defines the options to configure the compilation
  104755. * @param onError defines a function to execute if the material fails compiling
  104756. */
  104757. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  104758. /**
  104759. * Force shader compilation
  104760. * @param mesh defines the mesh that will use this material
  104761. * @param options defines additional options for compiling the shaders
  104762. * @returns a promise that resolves when the compilation completes
  104763. */
  104764. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  104765. private static readonly _AllDirtyCallBack;
  104766. private static readonly _ImageProcessingDirtyCallBack;
  104767. private static readonly _TextureDirtyCallBack;
  104768. private static readonly _FresnelDirtyCallBack;
  104769. private static readonly _MiscDirtyCallBack;
  104770. private static readonly _LightsDirtyCallBack;
  104771. private static readonly _AttributeDirtyCallBack;
  104772. private static _FresnelAndMiscDirtyCallBack;
  104773. private static _TextureAndMiscDirtyCallBack;
  104774. private static readonly _DirtyCallbackArray;
  104775. private static readonly _RunDirtyCallBacks;
  104776. /**
  104777. * Marks a define in the material to indicate that it needs to be re-computed
  104778. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  104779. */
  104780. markAsDirty(flag: number): void;
  104781. /**
  104782. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  104783. * @param func defines a function which checks material defines against the submeshes
  104784. */
  104785. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  104786. /**
  104787. * Indicates that the scene should check if the rendering now needs a prepass
  104788. */
  104789. protected _markScenePrePassDirty(): void;
  104790. /**
  104791. * Indicates that we need to re-calculated for all submeshes
  104792. */
  104793. protected _markAllSubMeshesAsAllDirty(): void;
  104794. /**
  104795. * Indicates that image processing needs to be re-calculated for all submeshes
  104796. */
  104797. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  104798. /**
  104799. * Indicates that textures need to be re-calculated for all submeshes
  104800. */
  104801. protected _markAllSubMeshesAsTexturesDirty(): void;
  104802. /**
  104803. * Indicates that fresnel needs to be re-calculated for all submeshes
  104804. */
  104805. protected _markAllSubMeshesAsFresnelDirty(): void;
  104806. /**
  104807. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  104808. */
  104809. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  104810. /**
  104811. * Indicates that lights need to be re-calculated for all submeshes
  104812. */
  104813. protected _markAllSubMeshesAsLightsDirty(): void;
  104814. /**
  104815. * Indicates that attributes need to be re-calculated for all submeshes
  104816. */
  104817. protected _markAllSubMeshesAsAttributesDirty(): void;
  104818. /**
  104819. * Indicates that misc needs to be re-calculated for all submeshes
  104820. */
  104821. protected _markAllSubMeshesAsMiscDirty(): void;
  104822. /**
  104823. * Indicates that textures and misc need to be re-calculated for all submeshes
  104824. */
  104825. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  104826. /**
  104827. * Sets the required values to the prepass renderer.
  104828. * @param prePassRenderer defines the prepass renderer to setup.
  104829. * @returns true if the pre pass is needed.
  104830. */
  104831. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  104832. /**
  104833. * Disposes the material
  104834. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  104835. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  104836. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  104837. */
  104838. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  104839. /** @hidden */
  104840. private releaseVertexArrayObject;
  104841. /**
  104842. * Serializes this material
  104843. * @returns the serialized material object
  104844. */
  104845. serialize(): any;
  104846. /**
  104847. * Creates a material from parsed material data
  104848. * @param parsedMaterial defines parsed material data
  104849. * @param scene defines the hosting scene
  104850. * @param rootUrl defines the root URL to use to load textures
  104851. * @returns a new material
  104852. */
  104853. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  104854. }
  104855. }
  104856. declare module BABYLON {
  104857. /**
  104858. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104859. * separate meshes. This can be use to improve performances.
  104860. * @see https://doc.babylonjs.com/how_to/multi_materials
  104861. */
  104862. export class MultiMaterial extends Material {
  104863. private _subMaterials;
  104864. /**
  104865. * Gets or Sets the list of Materials used within the multi material.
  104866. * They need to be ordered according to the submeshes order in the associated mesh
  104867. */
  104868. get subMaterials(): Nullable<Material>[];
  104869. set subMaterials(value: Nullable<Material>[]);
  104870. /**
  104871. * Function used to align with Node.getChildren()
  104872. * @returns the list of Materials used within the multi material
  104873. */
  104874. getChildren(): Nullable<Material>[];
  104875. /**
  104876. * Instantiates a new Multi Material
  104877. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104878. * separate meshes. This can be use to improve performances.
  104879. * @see https://doc.babylonjs.com/how_to/multi_materials
  104880. * @param name Define the name in the scene
  104881. * @param scene Define the scene the material belongs to
  104882. */
  104883. constructor(name: string, scene: Scene);
  104884. private _hookArray;
  104885. /**
  104886. * Get one of the submaterial by its index in the submaterials array
  104887. * @param index The index to look the sub material at
  104888. * @returns The Material if the index has been defined
  104889. */
  104890. getSubMaterial(index: number): Nullable<Material>;
  104891. /**
  104892. * Get the list of active textures for the whole sub materials list.
  104893. * @returns All the textures that will be used during the rendering
  104894. */
  104895. getActiveTextures(): BaseTexture[];
  104896. /**
  104897. * Gets the current class name of the material e.g. "MultiMaterial"
  104898. * Mainly use in serialization.
  104899. * @returns the class name
  104900. */
  104901. getClassName(): string;
  104902. /**
  104903. * Checks if the material is ready to render the requested sub mesh
  104904. * @param mesh Define the mesh the submesh belongs to
  104905. * @param subMesh Define the sub mesh to look readyness for
  104906. * @param useInstances Define whether or not the material is used with instances
  104907. * @returns true if ready, otherwise false
  104908. */
  104909. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104910. /**
  104911. * Clones the current material and its related sub materials
  104912. * @param name Define the name of the newly cloned material
  104913. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  104914. * @returns the cloned material
  104915. */
  104916. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  104917. /**
  104918. * Serializes the materials into a JSON representation.
  104919. * @returns the JSON representation
  104920. */
  104921. serialize(): any;
  104922. /**
  104923. * Dispose the material and release its associated resources
  104924. * @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)
  104925. * @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)
  104926. * @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)
  104927. */
  104928. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  104929. /**
  104930. * Creates a MultiMaterial from parsed MultiMaterial data.
  104931. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  104932. * @param scene defines the hosting scene
  104933. * @returns a new MultiMaterial
  104934. */
  104935. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  104936. }
  104937. }
  104938. declare module BABYLON {
  104939. /**
  104940. * Defines a subdivision inside a mesh
  104941. */
  104942. export class SubMesh implements ICullable {
  104943. /** the material index to use */
  104944. materialIndex: number;
  104945. /** vertex index start */
  104946. verticesStart: number;
  104947. /** vertices count */
  104948. verticesCount: number;
  104949. /** index start */
  104950. indexStart: number;
  104951. /** indices count */
  104952. indexCount: number;
  104953. /** @hidden */
  104954. _materialDefines: Nullable<MaterialDefines>;
  104955. /** @hidden */
  104956. _materialEffect: Nullable<Effect>;
  104957. /** @hidden */
  104958. _effectOverride: Nullable<Effect>;
  104959. /**
  104960. * Gets material defines used by the effect associated to the sub mesh
  104961. */
  104962. get materialDefines(): Nullable<MaterialDefines>;
  104963. /**
  104964. * Sets material defines used by the effect associated to the sub mesh
  104965. */
  104966. set materialDefines(defines: Nullable<MaterialDefines>);
  104967. /**
  104968. * Gets associated effect
  104969. */
  104970. get effect(): Nullable<Effect>;
  104971. /**
  104972. * Sets associated effect (effect used to render this submesh)
  104973. * @param effect defines the effect to associate with
  104974. * @param defines defines the set of defines used to compile this effect
  104975. */
  104976. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  104977. /** @hidden */
  104978. _linesIndexCount: number;
  104979. private _mesh;
  104980. private _renderingMesh;
  104981. private _boundingInfo;
  104982. private _linesIndexBuffer;
  104983. /** @hidden */
  104984. _lastColliderWorldVertices: Nullable<Vector3[]>;
  104985. /** @hidden */
  104986. _trianglePlanes: Plane[];
  104987. /** @hidden */
  104988. _lastColliderTransformMatrix: Nullable<Matrix>;
  104989. /** @hidden */
  104990. _renderId: number;
  104991. /** @hidden */
  104992. _alphaIndex: number;
  104993. /** @hidden */
  104994. _distanceToCamera: number;
  104995. /** @hidden */
  104996. _id: number;
  104997. private _currentMaterial;
  104998. /**
  104999. * Add a new submesh to a mesh
  105000. * @param materialIndex defines the material index to use
  105001. * @param verticesStart defines vertex index start
  105002. * @param verticesCount defines vertices count
  105003. * @param indexStart defines index start
  105004. * @param indexCount defines indices count
  105005. * @param mesh defines the parent mesh
  105006. * @param renderingMesh defines an optional rendering mesh
  105007. * @param createBoundingBox defines if bounding box should be created for this submesh
  105008. * @returns the new submesh
  105009. */
  105010. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  105011. /**
  105012. * Creates a new submesh
  105013. * @param materialIndex defines the material index to use
  105014. * @param verticesStart defines vertex index start
  105015. * @param verticesCount defines vertices count
  105016. * @param indexStart defines index start
  105017. * @param indexCount defines indices count
  105018. * @param mesh defines the parent mesh
  105019. * @param renderingMesh defines an optional rendering mesh
  105020. * @param createBoundingBox defines if bounding box should be created for this submesh
  105021. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  105022. */
  105023. constructor(
  105024. /** the material index to use */
  105025. materialIndex: number,
  105026. /** vertex index start */
  105027. verticesStart: number,
  105028. /** vertices count */
  105029. verticesCount: number,
  105030. /** index start */
  105031. indexStart: number,
  105032. /** indices count */
  105033. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  105034. /**
  105035. * Returns true if this submesh covers the entire parent mesh
  105036. * @ignorenaming
  105037. */
  105038. get IsGlobal(): boolean;
  105039. /**
  105040. * Returns the submesh BoudingInfo object
  105041. * @returns current bounding info (or mesh's one if the submesh is global)
  105042. */
  105043. getBoundingInfo(): BoundingInfo;
  105044. /**
  105045. * Sets the submesh BoundingInfo
  105046. * @param boundingInfo defines the new bounding info to use
  105047. * @returns the SubMesh
  105048. */
  105049. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  105050. /**
  105051. * Returns the mesh of the current submesh
  105052. * @return the parent mesh
  105053. */
  105054. getMesh(): AbstractMesh;
  105055. /**
  105056. * Returns the rendering mesh of the submesh
  105057. * @returns the rendering mesh (could be different from parent mesh)
  105058. */
  105059. getRenderingMesh(): Mesh;
  105060. /**
  105061. * Returns the replacement mesh of the submesh
  105062. * @returns the replacement mesh (could be different from parent mesh)
  105063. */
  105064. getReplacementMesh(): Nullable<AbstractMesh>;
  105065. /**
  105066. * Returns the effective mesh of the submesh
  105067. * @returns the effective mesh (could be different from parent mesh)
  105068. */
  105069. getEffectiveMesh(): AbstractMesh;
  105070. /**
  105071. * Returns the submesh material
  105072. * @returns null or the current material
  105073. */
  105074. getMaterial(): Nullable<Material>;
  105075. private _IsMultiMaterial;
  105076. /**
  105077. * Sets a new updated BoundingInfo object to the submesh
  105078. * @param data defines an optional position array to use to determine the bounding info
  105079. * @returns the SubMesh
  105080. */
  105081. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  105082. /** @hidden */
  105083. _checkCollision(collider: Collider): boolean;
  105084. /**
  105085. * Updates the submesh BoundingInfo
  105086. * @param world defines the world matrix to use to update the bounding info
  105087. * @returns the submesh
  105088. */
  105089. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  105090. /**
  105091. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  105092. * @param frustumPlanes defines the frustum planes
  105093. * @returns true if the submesh is intersecting with the frustum
  105094. */
  105095. isInFrustum(frustumPlanes: Plane[]): boolean;
  105096. /**
  105097. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  105098. * @param frustumPlanes defines the frustum planes
  105099. * @returns true if the submesh is inside the frustum
  105100. */
  105101. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  105102. /**
  105103. * Renders the submesh
  105104. * @param enableAlphaMode defines if alpha needs to be used
  105105. * @returns the submesh
  105106. */
  105107. render(enableAlphaMode: boolean): SubMesh;
  105108. /**
  105109. * @hidden
  105110. */
  105111. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  105112. /**
  105113. * Checks if the submesh intersects with a ray
  105114. * @param ray defines the ray to test
  105115. * @returns true is the passed ray intersects the submesh bounding box
  105116. */
  105117. canIntersects(ray: Ray): boolean;
  105118. /**
  105119. * Intersects current submesh with a ray
  105120. * @param ray defines the ray to test
  105121. * @param positions defines mesh's positions array
  105122. * @param indices defines mesh's indices array
  105123. * @param fastCheck defines if the first intersection will be used (and not the closest)
  105124. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  105125. * @returns intersection info or null if no intersection
  105126. */
  105127. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  105128. /** @hidden */
  105129. private _intersectLines;
  105130. /** @hidden */
  105131. private _intersectUnIndexedLines;
  105132. /** @hidden */
  105133. private _intersectTriangles;
  105134. /** @hidden */
  105135. private _intersectUnIndexedTriangles;
  105136. /** @hidden */
  105137. _rebuild(): void;
  105138. /**
  105139. * Creates a new submesh from the passed mesh
  105140. * @param newMesh defines the new hosting mesh
  105141. * @param newRenderingMesh defines an optional rendering mesh
  105142. * @returns the new submesh
  105143. */
  105144. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  105145. /**
  105146. * Release associated resources
  105147. */
  105148. dispose(): void;
  105149. /**
  105150. * Gets the class name
  105151. * @returns the string "SubMesh".
  105152. */
  105153. getClassName(): string;
  105154. /**
  105155. * Creates a new submesh from indices data
  105156. * @param materialIndex the index of the main mesh material
  105157. * @param startIndex the index where to start the copy in the mesh indices array
  105158. * @param indexCount the number of indices to copy then from the startIndex
  105159. * @param mesh the main mesh to create the submesh from
  105160. * @param renderingMesh the optional rendering mesh
  105161. * @returns a new submesh
  105162. */
  105163. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  105164. }
  105165. }
  105166. declare module BABYLON {
  105167. /**
  105168. * Class used to represent data loading progression
  105169. */
  105170. export class SceneLoaderFlags {
  105171. private static _ForceFullSceneLoadingForIncremental;
  105172. private static _ShowLoadingScreen;
  105173. private static _CleanBoneMatrixWeights;
  105174. private static _loggingLevel;
  105175. /**
  105176. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  105177. */
  105178. static get ForceFullSceneLoadingForIncremental(): boolean;
  105179. static set ForceFullSceneLoadingForIncremental(value: boolean);
  105180. /**
  105181. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  105182. */
  105183. static get ShowLoadingScreen(): boolean;
  105184. static set ShowLoadingScreen(value: boolean);
  105185. /**
  105186. * Defines the current logging level (while loading the scene)
  105187. * @ignorenaming
  105188. */
  105189. static get loggingLevel(): number;
  105190. static set loggingLevel(value: number);
  105191. /**
  105192. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  105193. */
  105194. static get CleanBoneMatrixWeights(): boolean;
  105195. static set CleanBoneMatrixWeights(value: boolean);
  105196. }
  105197. }
  105198. declare module BABYLON {
  105199. /**
  105200. * Class used to store geometry data (vertex buffers + index buffer)
  105201. */
  105202. export class Geometry implements IGetSetVerticesData {
  105203. /**
  105204. * Gets or sets the ID of the geometry
  105205. */
  105206. id: string;
  105207. /**
  105208. * Gets or sets the unique ID of the geometry
  105209. */
  105210. uniqueId: number;
  105211. /**
  105212. * Gets the delay loading state of the geometry (none by default which means not delayed)
  105213. */
  105214. delayLoadState: number;
  105215. /**
  105216. * Gets the file containing the data to load when running in delay load state
  105217. */
  105218. delayLoadingFile: Nullable<string>;
  105219. /**
  105220. * Callback called when the geometry is updated
  105221. */
  105222. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  105223. private _scene;
  105224. private _engine;
  105225. private _meshes;
  105226. private _totalVertices;
  105227. /** @hidden */
  105228. _indices: IndicesArray;
  105229. /** @hidden */
  105230. _vertexBuffers: {
  105231. [key: string]: VertexBuffer;
  105232. };
  105233. private _isDisposed;
  105234. private _extend;
  105235. private _boundingBias;
  105236. /** @hidden */
  105237. _delayInfo: Array<string>;
  105238. private _indexBuffer;
  105239. private _indexBufferIsUpdatable;
  105240. /** @hidden */
  105241. _boundingInfo: Nullable<BoundingInfo>;
  105242. /** @hidden */
  105243. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  105244. /** @hidden */
  105245. _softwareSkinningFrameId: number;
  105246. private _vertexArrayObjects;
  105247. private _updatable;
  105248. /** @hidden */
  105249. _positions: Nullable<Vector3[]>;
  105250. /**
  105251. * 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
  105252. */
  105253. get boundingBias(): Vector2;
  105254. /**
  105255. * 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
  105256. */
  105257. set boundingBias(value: Vector2);
  105258. /**
  105259. * Static function used to attach a new empty geometry to a mesh
  105260. * @param mesh defines the mesh to attach the geometry to
  105261. * @returns the new Geometry
  105262. */
  105263. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  105264. /** Get the list of meshes using this geometry */
  105265. get meshes(): Mesh[];
  105266. /**
  105267. * 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
  105268. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  105269. */
  105270. useBoundingInfoFromGeometry: boolean;
  105271. /**
  105272. * Creates a new geometry
  105273. * @param id defines the unique ID
  105274. * @param scene defines the hosting scene
  105275. * @param vertexData defines the VertexData used to get geometry data
  105276. * @param updatable defines if geometry must be updatable (false by default)
  105277. * @param mesh defines the mesh that will be associated with the geometry
  105278. */
  105279. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  105280. /**
  105281. * Gets the current extend of the geometry
  105282. */
  105283. get extend(): {
  105284. minimum: Vector3;
  105285. maximum: Vector3;
  105286. };
  105287. /**
  105288. * Gets the hosting scene
  105289. * @returns the hosting Scene
  105290. */
  105291. getScene(): Scene;
  105292. /**
  105293. * Gets the hosting engine
  105294. * @returns the hosting Engine
  105295. */
  105296. getEngine(): Engine;
  105297. /**
  105298. * Defines if the geometry is ready to use
  105299. * @returns true if the geometry is ready to be used
  105300. */
  105301. isReady(): boolean;
  105302. /**
  105303. * Gets a value indicating that the geometry should not be serialized
  105304. */
  105305. get doNotSerialize(): boolean;
  105306. /** @hidden */
  105307. _rebuild(): void;
  105308. /**
  105309. * Affects all geometry data in one call
  105310. * @param vertexData defines the geometry data
  105311. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  105312. */
  105313. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  105314. /**
  105315. * Set specific vertex data
  105316. * @param kind defines the data kind (Position, normal, etc...)
  105317. * @param data defines the vertex data to use
  105318. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105319. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105320. */
  105321. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  105322. /**
  105323. * Removes a specific vertex data
  105324. * @param kind defines the data kind (Position, normal, etc...)
  105325. */
  105326. removeVerticesData(kind: string): void;
  105327. /**
  105328. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  105329. * @param buffer defines the vertex buffer to use
  105330. * @param totalVertices defines the total number of vertices for position kind (could be null)
  105331. */
  105332. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  105333. /**
  105334. * Update a specific vertex buffer
  105335. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  105336. * It will do nothing if the buffer is not updatable
  105337. * @param kind defines the data kind (Position, normal, etc...)
  105338. * @param data defines the data to use
  105339. * @param offset defines the offset in the target buffer where to store the data
  105340. * @param useBytes set to true if the offset is in bytes
  105341. */
  105342. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  105343. /**
  105344. * Update a specific vertex buffer
  105345. * This function will create a new buffer if the current one is not updatable
  105346. * @param kind defines the data kind (Position, normal, etc...)
  105347. * @param data defines the data to use
  105348. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  105349. */
  105350. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  105351. private _updateBoundingInfo;
  105352. /** @hidden */
  105353. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  105354. /**
  105355. * Gets total number of vertices
  105356. * @returns the total number of vertices
  105357. */
  105358. getTotalVertices(): number;
  105359. /**
  105360. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105361. * @param kind defines the data kind (Position, normal, etc...)
  105362. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105363. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105364. * @returns a float array containing vertex data
  105365. */
  105366. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105367. /**
  105368. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  105369. * @param kind defines the data kind (Position, normal, etc...)
  105370. * @returns true if the vertex buffer with the specified kind is updatable
  105371. */
  105372. isVertexBufferUpdatable(kind: string): boolean;
  105373. /**
  105374. * Gets a specific vertex buffer
  105375. * @param kind defines the data kind (Position, normal, etc...)
  105376. * @returns a VertexBuffer
  105377. */
  105378. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  105379. /**
  105380. * Returns all vertex buffers
  105381. * @return an object holding all vertex buffers indexed by kind
  105382. */
  105383. getVertexBuffers(): Nullable<{
  105384. [key: string]: VertexBuffer;
  105385. }>;
  105386. /**
  105387. * Gets a boolean indicating if specific vertex buffer is present
  105388. * @param kind defines the data kind (Position, normal, etc...)
  105389. * @returns true if data is present
  105390. */
  105391. isVerticesDataPresent(kind: string): boolean;
  105392. /**
  105393. * Gets a list of all attached data kinds (Position, normal, etc...)
  105394. * @returns a list of string containing all kinds
  105395. */
  105396. getVerticesDataKinds(): string[];
  105397. /**
  105398. * Update index buffer
  105399. * @param indices defines the indices to store in the index buffer
  105400. * @param offset defines the offset in the target buffer where to store the data
  105401. * @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)
  105402. */
  105403. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  105404. /**
  105405. * Creates a new index buffer
  105406. * @param indices defines the indices to store in the index buffer
  105407. * @param totalVertices defines the total number of vertices (could be null)
  105408. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105409. */
  105410. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  105411. /**
  105412. * Return the total number of indices
  105413. * @returns the total number of indices
  105414. */
  105415. getTotalIndices(): number;
  105416. /**
  105417. * Gets the index buffer array
  105418. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105419. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105420. * @returns the index buffer array
  105421. */
  105422. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105423. /**
  105424. * Gets the index buffer
  105425. * @return the index buffer
  105426. */
  105427. getIndexBuffer(): Nullable<DataBuffer>;
  105428. /** @hidden */
  105429. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  105430. /**
  105431. * Release the associated resources for a specific mesh
  105432. * @param mesh defines the source mesh
  105433. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  105434. */
  105435. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  105436. /**
  105437. * Apply current geometry to a given mesh
  105438. * @param mesh defines the mesh to apply geometry to
  105439. */
  105440. applyToMesh(mesh: Mesh): void;
  105441. private _updateExtend;
  105442. private _applyToMesh;
  105443. private notifyUpdate;
  105444. /**
  105445. * Load the geometry if it was flagged as delay loaded
  105446. * @param scene defines the hosting scene
  105447. * @param onLoaded defines a callback called when the geometry is loaded
  105448. */
  105449. load(scene: Scene, onLoaded?: () => void): void;
  105450. private _queueLoad;
  105451. /**
  105452. * Invert the geometry to move from a right handed system to a left handed one.
  105453. */
  105454. toLeftHanded(): void;
  105455. /** @hidden */
  105456. _resetPointsArrayCache(): void;
  105457. /** @hidden */
  105458. _generatePointsArray(): boolean;
  105459. /**
  105460. * Gets a value indicating if the geometry is disposed
  105461. * @returns true if the geometry was disposed
  105462. */
  105463. isDisposed(): boolean;
  105464. private _disposeVertexArrayObjects;
  105465. /**
  105466. * Free all associated resources
  105467. */
  105468. dispose(): void;
  105469. /**
  105470. * Clone the current geometry into a new geometry
  105471. * @param id defines the unique ID of the new geometry
  105472. * @returns a new geometry object
  105473. */
  105474. copy(id: string): Geometry;
  105475. /**
  105476. * Serialize the current geometry info (and not the vertices data) into a JSON object
  105477. * @return a JSON representation of the current geometry data (without the vertices data)
  105478. */
  105479. serialize(): any;
  105480. private toNumberArray;
  105481. /**
  105482. * Serialize all vertices data into a JSON oject
  105483. * @returns a JSON representation of the current geometry data
  105484. */
  105485. serializeVerticeData(): any;
  105486. /**
  105487. * Extracts a clone of a mesh geometry
  105488. * @param mesh defines the source mesh
  105489. * @param id defines the unique ID of the new geometry object
  105490. * @returns the new geometry object
  105491. */
  105492. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  105493. /**
  105494. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  105495. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  105496. * Be aware Math.random() could cause collisions, but:
  105497. * "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"
  105498. * @returns a string containing a new GUID
  105499. */
  105500. static RandomId(): string;
  105501. /** @hidden */
  105502. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  105503. private static _CleanMatricesWeights;
  105504. /**
  105505. * Create a new geometry from persisted data (Using .babylon file format)
  105506. * @param parsedVertexData defines the persisted data
  105507. * @param scene defines the hosting scene
  105508. * @param rootUrl defines the root url to use to load assets (like delayed data)
  105509. * @returns the new geometry object
  105510. */
  105511. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  105512. }
  105513. }
  105514. declare module BABYLON {
  105515. /**
  105516. * Define an interface for all classes that will get and set the data on vertices
  105517. */
  105518. export interface IGetSetVerticesData {
  105519. /**
  105520. * Gets a boolean indicating if specific vertex data is present
  105521. * @param kind defines the vertex data kind to use
  105522. * @returns true is data kind is present
  105523. */
  105524. isVerticesDataPresent(kind: string): boolean;
  105525. /**
  105526. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105527. * @param kind defines the data kind (Position, normal, etc...)
  105528. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105529. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105530. * @returns a float array containing vertex data
  105531. */
  105532. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105533. /**
  105534. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  105535. * @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.
  105536. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105537. * @returns the indices array or an empty array if the mesh has no geometry
  105538. */
  105539. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105540. /**
  105541. * Set specific vertex data
  105542. * @param kind defines the data kind (Position, normal, etc...)
  105543. * @param data defines the vertex data to use
  105544. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105545. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105546. */
  105547. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  105548. /**
  105549. * Update a specific associated vertex buffer
  105550. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  105551. * - VertexBuffer.PositionKind
  105552. * - VertexBuffer.UVKind
  105553. * - VertexBuffer.UV2Kind
  105554. * - VertexBuffer.UV3Kind
  105555. * - VertexBuffer.UV4Kind
  105556. * - VertexBuffer.UV5Kind
  105557. * - VertexBuffer.UV6Kind
  105558. * - VertexBuffer.ColorKind
  105559. * - VertexBuffer.MatricesIndicesKind
  105560. * - VertexBuffer.MatricesIndicesExtraKind
  105561. * - VertexBuffer.MatricesWeightsKind
  105562. * - VertexBuffer.MatricesWeightsExtraKind
  105563. * @param data defines the data source
  105564. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  105565. * @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)
  105566. */
  105567. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  105568. /**
  105569. * Creates a new index buffer
  105570. * @param indices defines the indices to store in the index buffer
  105571. * @param totalVertices defines the total number of vertices (could be null)
  105572. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105573. */
  105574. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  105575. }
  105576. /**
  105577. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  105578. */
  105579. export class VertexData {
  105580. /**
  105581. * Mesh side orientation : usually the external or front surface
  105582. */
  105583. static readonly FRONTSIDE: number;
  105584. /**
  105585. * Mesh side orientation : usually the internal or back surface
  105586. */
  105587. static readonly BACKSIDE: number;
  105588. /**
  105589. * Mesh side orientation : both internal and external or front and back surfaces
  105590. */
  105591. static readonly DOUBLESIDE: number;
  105592. /**
  105593. * Mesh side orientation : by default, `FRONTSIDE`
  105594. */
  105595. static readonly DEFAULTSIDE: number;
  105596. /**
  105597. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  105598. */
  105599. positions: Nullable<FloatArray>;
  105600. /**
  105601. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  105602. */
  105603. normals: Nullable<FloatArray>;
  105604. /**
  105605. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  105606. */
  105607. tangents: Nullable<FloatArray>;
  105608. /**
  105609. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105610. */
  105611. uvs: Nullable<FloatArray>;
  105612. /**
  105613. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105614. */
  105615. uvs2: Nullable<FloatArray>;
  105616. /**
  105617. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105618. */
  105619. uvs3: Nullable<FloatArray>;
  105620. /**
  105621. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105622. */
  105623. uvs4: Nullable<FloatArray>;
  105624. /**
  105625. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105626. */
  105627. uvs5: Nullable<FloatArray>;
  105628. /**
  105629. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105630. */
  105631. uvs6: Nullable<FloatArray>;
  105632. /**
  105633. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  105634. */
  105635. colors: Nullable<FloatArray>;
  105636. /**
  105637. * 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).
  105638. */
  105639. matricesIndices: Nullable<FloatArray>;
  105640. /**
  105641. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  105642. */
  105643. matricesWeights: Nullable<FloatArray>;
  105644. /**
  105645. * An array extending the number of possible indices
  105646. */
  105647. matricesIndicesExtra: Nullable<FloatArray>;
  105648. /**
  105649. * An array extending the number of possible weights when the number of indices is extended
  105650. */
  105651. matricesWeightsExtra: Nullable<FloatArray>;
  105652. /**
  105653. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  105654. */
  105655. indices: Nullable<IndicesArray>;
  105656. /**
  105657. * Uses the passed data array to set the set the values for the specified kind of data
  105658. * @param data a linear array of floating numbers
  105659. * @param kind the type of data that is being set, eg positions, colors etc
  105660. */
  105661. set(data: FloatArray, kind: string): void;
  105662. /**
  105663. * Associates the vertexData to the passed Mesh.
  105664. * Sets it as updatable or not (default `false`)
  105665. * @param mesh the mesh the vertexData is applied to
  105666. * @param updatable when used and having the value true allows new data to update the vertexData
  105667. * @returns the VertexData
  105668. */
  105669. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  105670. /**
  105671. * Associates the vertexData to the passed Geometry.
  105672. * Sets it as updatable or not (default `false`)
  105673. * @param geometry the geometry the vertexData is applied to
  105674. * @param updatable when used and having the value true allows new data to update the vertexData
  105675. * @returns VertexData
  105676. */
  105677. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  105678. /**
  105679. * Updates the associated mesh
  105680. * @param mesh the mesh to be updated
  105681. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105682. * @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
  105683. * @returns VertexData
  105684. */
  105685. updateMesh(mesh: Mesh): VertexData;
  105686. /**
  105687. * Updates the associated geometry
  105688. * @param geometry the geometry to be updated
  105689. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105690. * @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
  105691. * @returns VertexData.
  105692. */
  105693. updateGeometry(geometry: Geometry): VertexData;
  105694. private _applyTo;
  105695. private _update;
  105696. /**
  105697. * Transforms each position and each normal of the vertexData according to the passed Matrix
  105698. * @param matrix the transforming matrix
  105699. * @returns the VertexData
  105700. */
  105701. transform(matrix: Matrix): VertexData;
  105702. /**
  105703. * Merges the passed VertexData into the current one
  105704. * @param other the VertexData to be merged into the current one
  105705. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  105706. * @returns the modified VertexData
  105707. */
  105708. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  105709. private _mergeElement;
  105710. private _validate;
  105711. /**
  105712. * Serializes the VertexData
  105713. * @returns a serialized object
  105714. */
  105715. serialize(): any;
  105716. /**
  105717. * Extracts the vertexData from a mesh
  105718. * @param mesh the mesh from which to extract the VertexData
  105719. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  105720. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105721. * @returns the object VertexData associated to the passed mesh
  105722. */
  105723. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105724. /**
  105725. * Extracts the vertexData from the geometry
  105726. * @param geometry the geometry from which to extract the VertexData
  105727. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  105728. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105729. * @returns the object VertexData associated to the passed mesh
  105730. */
  105731. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105732. private static _ExtractFrom;
  105733. /**
  105734. * Creates the VertexData for a Ribbon
  105735. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  105736. * * pathArray array of paths, each of which an array of successive Vector3
  105737. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  105738. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  105739. * * 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
  105740. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105741. * * 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)
  105742. * * 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)
  105743. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  105744. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  105745. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  105746. * @returns the VertexData of the ribbon
  105747. */
  105748. static CreateRibbon(options: {
  105749. pathArray: Vector3[][];
  105750. closeArray?: boolean;
  105751. closePath?: boolean;
  105752. offset?: number;
  105753. sideOrientation?: number;
  105754. frontUVs?: Vector4;
  105755. backUVs?: Vector4;
  105756. invertUV?: boolean;
  105757. uvs?: Vector2[];
  105758. colors?: Color4[];
  105759. }): VertexData;
  105760. /**
  105761. * Creates the VertexData for a box
  105762. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105763. * * size sets the width, height and depth of the box to the value of size, optional default 1
  105764. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  105765. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  105766. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  105767. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105768. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105769. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105770. * * 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)
  105771. * * 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)
  105772. * @returns the VertexData of the box
  105773. */
  105774. static CreateBox(options: {
  105775. size?: number;
  105776. width?: number;
  105777. height?: number;
  105778. depth?: number;
  105779. faceUV?: Vector4[];
  105780. faceColors?: Color4[];
  105781. sideOrientation?: number;
  105782. frontUVs?: Vector4;
  105783. backUVs?: Vector4;
  105784. }): VertexData;
  105785. /**
  105786. * Creates the VertexData for a tiled box
  105787. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105788. * * faceTiles sets the pattern, tile size and number of tiles for a face
  105789. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105790. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105791. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105792. * @returns the VertexData of the box
  105793. */
  105794. static CreateTiledBox(options: {
  105795. pattern?: number;
  105796. width?: number;
  105797. height?: number;
  105798. depth?: number;
  105799. tileSize?: number;
  105800. tileWidth?: number;
  105801. tileHeight?: number;
  105802. alignHorizontal?: number;
  105803. alignVertical?: number;
  105804. faceUV?: Vector4[];
  105805. faceColors?: Color4[];
  105806. sideOrientation?: number;
  105807. }): VertexData;
  105808. /**
  105809. * Creates the VertexData for a tiled plane
  105810. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105811. * * pattern a limited pattern arrangement depending on the number
  105812. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  105813. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  105814. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  105815. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105816. * * 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)
  105817. * * 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)
  105818. * @returns the VertexData of the tiled plane
  105819. */
  105820. static CreateTiledPlane(options: {
  105821. pattern?: number;
  105822. tileSize?: number;
  105823. tileWidth?: number;
  105824. tileHeight?: number;
  105825. size?: number;
  105826. width?: number;
  105827. height?: number;
  105828. alignHorizontal?: number;
  105829. alignVertical?: number;
  105830. sideOrientation?: number;
  105831. frontUVs?: Vector4;
  105832. backUVs?: Vector4;
  105833. }): VertexData;
  105834. /**
  105835. * Creates the VertexData for an ellipsoid, defaults to a sphere
  105836. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105837. * * segments sets the number of horizontal strips optional, default 32
  105838. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  105839. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  105840. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  105841. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  105842. * * 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
  105843. * * 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
  105844. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105845. * * 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)
  105846. * * 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)
  105847. * @returns the VertexData of the ellipsoid
  105848. */
  105849. static CreateSphere(options: {
  105850. segments?: number;
  105851. diameter?: number;
  105852. diameterX?: number;
  105853. diameterY?: number;
  105854. diameterZ?: number;
  105855. arc?: number;
  105856. slice?: number;
  105857. sideOrientation?: number;
  105858. frontUVs?: Vector4;
  105859. backUVs?: Vector4;
  105860. }): VertexData;
  105861. /**
  105862. * Creates the VertexData for a cylinder, cone or prism
  105863. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105864. * * height sets the height (y direction) of the cylinder, optional, default 2
  105865. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  105866. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  105867. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  105868. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105869. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  105870. * * 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
  105871. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105872. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105873. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  105874. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  105875. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105876. * * 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)
  105877. * * 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)
  105878. * @returns the VertexData of the cylinder, cone or prism
  105879. */
  105880. static CreateCylinder(options: {
  105881. height?: number;
  105882. diameterTop?: number;
  105883. diameterBottom?: number;
  105884. diameter?: number;
  105885. tessellation?: number;
  105886. subdivisions?: number;
  105887. arc?: number;
  105888. faceColors?: Color4[];
  105889. faceUV?: Vector4[];
  105890. hasRings?: boolean;
  105891. enclose?: boolean;
  105892. sideOrientation?: number;
  105893. frontUVs?: Vector4;
  105894. backUVs?: Vector4;
  105895. }): VertexData;
  105896. /**
  105897. * Creates the VertexData for a torus
  105898. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105899. * * diameter the diameter of the torus, optional default 1
  105900. * * thickness the diameter of the tube forming the torus, optional default 0.5
  105901. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105902. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105903. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  105904. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  105905. * @returns the VertexData of the torus
  105906. */
  105907. static CreateTorus(options: {
  105908. diameter?: number;
  105909. thickness?: number;
  105910. tessellation?: number;
  105911. sideOrientation?: number;
  105912. frontUVs?: Vector4;
  105913. backUVs?: Vector4;
  105914. }): VertexData;
  105915. /**
  105916. * Creates the VertexData of the LineSystem
  105917. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  105918. * - lines an array of lines, each line being an array of successive Vector3
  105919. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  105920. * @returns the VertexData of the LineSystem
  105921. */
  105922. static CreateLineSystem(options: {
  105923. lines: Vector3[][];
  105924. colors?: Nullable<Color4[][]>;
  105925. }): VertexData;
  105926. /**
  105927. * Create the VertexData for a DashedLines
  105928. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  105929. * - points an array successive Vector3
  105930. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  105931. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  105932. * - dashNb the intended total number of dashes, optional, default 200
  105933. * @returns the VertexData for the DashedLines
  105934. */
  105935. static CreateDashedLines(options: {
  105936. points: Vector3[];
  105937. dashSize?: number;
  105938. gapSize?: number;
  105939. dashNb?: number;
  105940. }): VertexData;
  105941. /**
  105942. * Creates the VertexData for a Ground
  105943. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105944. * - width the width (x direction) of the ground, optional, default 1
  105945. * - height the height (z direction) of the ground, optional, default 1
  105946. * - subdivisions the number of subdivisions per side, optional, default 1
  105947. * @returns the VertexData of the Ground
  105948. */
  105949. static CreateGround(options: {
  105950. width?: number;
  105951. height?: number;
  105952. subdivisions?: number;
  105953. subdivisionsX?: number;
  105954. subdivisionsY?: number;
  105955. }): VertexData;
  105956. /**
  105957. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  105958. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105959. * * xmin the ground minimum X coordinate, optional, default -1
  105960. * * zmin the ground minimum Z coordinate, optional, default -1
  105961. * * xmax the ground maximum X coordinate, optional, default 1
  105962. * * zmax the ground maximum Z coordinate, optional, default 1
  105963. * * 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}
  105964. * * 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}
  105965. * @returns the VertexData of the TiledGround
  105966. */
  105967. static CreateTiledGround(options: {
  105968. xmin: number;
  105969. zmin: number;
  105970. xmax: number;
  105971. zmax: number;
  105972. subdivisions?: {
  105973. w: number;
  105974. h: number;
  105975. };
  105976. precision?: {
  105977. w: number;
  105978. h: number;
  105979. };
  105980. }): VertexData;
  105981. /**
  105982. * Creates the VertexData of the Ground designed from a heightmap
  105983. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  105984. * * width the width (x direction) of the ground
  105985. * * height the height (z direction) of the ground
  105986. * * subdivisions the number of subdivisions per side
  105987. * * minHeight the minimum altitude on the ground, optional, default 0
  105988. * * maxHeight the maximum altitude on the ground, optional default 1
  105989. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  105990. * * buffer the array holding the image color data
  105991. * * bufferWidth the width of image
  105992. * * bufferHeight the height of image
  105993. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  105994. * @returns the VertexData of the Ground designed from a heightmap
  105995. */
  105996. static CreateGroundFromHeightMap(options: {
  105997. width: number;
  105998. height: number;
  105999. subdivisions: number;
  106000. minHeight: number;
  106001. maxHeight: number;
  106002. colorFilter: Color3;
  106003. buffer: Uint8Array;
  106004. bufferWidth: number;
  106005. bufferHeight: number;
  106006. alphaFilter: number;
  106007. }): VertexData;
  106008. /**
  106009. * Creates the VertexData for a Plane
  106010. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  106011. * * size sets the width and height of the plane to the value of size, optional default 1
  106012. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  106013. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  106014. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106015. * * 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)
  106016. * * 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)
  106017. * @returns the VertexData of the box
  106018. */
  106019. static CreatePlane(options: {
  106020. size?: number;
  106021. width?: number;
  106022. height?: number;
  106023. sideOrientation?: number;
  106024. frontUVs?: Vector4;
  106025. backUVs?: Vector4;
  106026. }): VertexData;
  106027. /**
  106028. * Creates the VertexData of the Disc or regular Polygon
  106029. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  106030. * * radius the radius of the disc, optional default 0.5
  106031. * * tessellation the number of polygon sides, optional, default 64
  106032. * * 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
  106033. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106034. * * 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)
  106035. * * 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)
  106036. * @returns the VertexData of the box
  106037. */
  106038. static CreateDisc(options: {
  106039. radius?: number;
  106040. tessellation?: number;
  106041. arc?: number;
  106042. sideOrientation?: number;
  106043. frontUVs?: Vector4;
  106044. backUVs?: Vector4;
  106045. }): VertexData;
  106046. /**
  106047. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  106048. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  106049. * @param polygon a mesh built from polygonTriangulation.build()
  106050. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106051. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106052. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106053. * @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)
  106054. * @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)
  106055. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  106056. * @returns the VertexData of the Polygon
  106057. */
  106058. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  106059. /**
  106060. * Creates the VertexData of the IcoSphere
  106061. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  106062. * * radius the radius of the IcoSphere, optional default 1
  106063. * * radiusX allows stretching in the x direction, optional, default radius
  106064. * * radiusY allows stretching in the y direction, optional, default radius
  106065. * * radiusZ allows stretching in the z direction, optional, default radius
  106066. * * flat when true creates a flat shaded mesh, optional, default true
  106067. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106068. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106069. * * 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)
  106070. * * 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)
  106071. * @returns the VertexData of the IcoSphere
  106072. */
  106073. static CreateIcoSphere(options: {
  106074. radius?: number;
  106075. radiusX?: number;
  106076. radiusY?: number;
  106077. radiusZ?: number;
  106078. flat?: boolean;
  106079. subdivisions?: number;
  106080. sideOrientation?: number;
  106081. frontUVs?: Vector4;
  106082. backUVs?: Vector4;
  106083. }): VertexData;
  106084. /**
  106085. * Creates the VertexData for a Polyhedron
  106086. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  106087. * * type provided types are:
  106088. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  106089. * * 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)
  106090. * * size the size of the IcoSphere, optional default 1
  106091. * * sizeX allows stretching in the x direction, optional, default size
  106092. * * sizeY allows stretching in the y direction, optional, default size
  106093. * * sizeZ allows stretching in the z direction, optional, default size
  106094. * * 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
  106095. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106096. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106097. * * flat when true creates a flat shaded mesh, optional, default true
  106098. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106099. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106100. * * 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)
  106101. * * 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)
  106102. * @returns the VertexData of the Polyhedron
  106103. */
  106104. static CreatePolyhedron(options: {
  106105. type?: number;
  106106. size?: number;
  106107. sizeX?: number;
  106108. sizeY?: number;
  106109. sizeZ?: number;
  106110. custom?: any;
  106111. faceUV?: Vector4[];
  106112. faceColors?: Color4[];
  106113. flat?: boolean;
  106114. sideOrientation?: number;
  106115. frontUVs?: Vector4;
  106116. backUVs?: Vector4;
  106117. }): VertexData;
  106118. /**
  106119. * Creates the VertexData for a TorusKnot
  106120. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  106121. * * radius the radius of the torus knot, optional, default 2
  106122. * * tube the thickness of the tube, optional, default 0.5
  106123. * * radialSegments the number of sides on each tube segments, optional, default 32
  106124. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  106125. * * p the number of windings around the z axis, optional, default 2
  106126. * * q the number of windings around the x axis, optional, default 3
  106127. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106128. * * 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)
  106129. * * 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)
  106130. * @returns the VertexData of the Torus Knot
  106131. */
  106132. static CreateTorusKnot(options: {
  106133. radius?: number;
  106134. tube?: number;
  106135. radialSegments?: number;
  106136. tubularSegments?: number;
  106137. p?: number;
  106138. q?: number;
  106139. sideOrientation?: number;
  106140. frontUVs?: Vector4;
  106141. backUVs?: Vector4;
  106142. }): VertexData;
  106143. /**
  106144. * Compute normals for given positions and indices
  106145. * @param positions an array of vertex positions, [...., x, y, z, ......]
  106146. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  106147. * @param normals an array of vertex normals, [...., x, y, z, ......]
  106148. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  106149. * * facetNormals : optional array of facet normals (vector3)
  106150. * * facetPositions : optional array of facet positions (vector3)
  106151. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  106152. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  106153. * * bInfo : optional bounding info, required for facetPartitioning computation
  106154. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  106155. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  106156. * * useRightHandedSystem: optional boolean to for right handed system computation
  106157. * * depthSort : optional boolean to enable the facet depth sort computation
  106158. * * distanceTo : optional Vector3 to compute the facet depth from this location
  106159. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  106160. */
  106161. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  106162. facetNormals?: any;
  106163. facetPositions?: any;
  106164. facetPartitioning?: any;
  106165. ratio?: number;
  106166. bInfo?: any;
  106167. bbSize?: Vector3;
  106168. subDiv?: any;
  106169. useRightHandedSystem?: boolean;
  106170. depthSort?: boolean;
  106171. distanceTo?: Vector3;
  106172. depthSortedFacets?: any;
  106173. }): void;
  106174. /** @hidden */
  106175. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  106176. /**
  106177. * Applies VertexData created from the imported parameters to the geometry
  106178. * @param parsedVertexData the parsed data from an imported file
  106179. * @param geometry the geometry to apply the VertexData to
  106180. */
  106181. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  106182. }
  106183. }
  106184. declare module BABYLON {
  106185. /**
  106186. * Defines a target to use with MorphTargetManager
  106187. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106188. */
  106189. export class MorphTarget implements IAnimatable {
  106190. /** defines the name of the target */
  106191. name: string;
  106192. /**
  106193. * Gets or sets the list of animations
  106194. */
  106195. animations: Animation[];
  106196. private _scene;
  106197. private _positions;
  106198. private _normals;
  106199. private _tangents;
  106200. private _uvs;
  106201. private _influence;
  106202. private _uniqueId;
  106203. /**
  106204. * Observable raised when the influence changes
  106205. */
  106206. onInfluenceChanged: Observable<boolean>;
  106207. /** @hidden */
  106208. _onDataLayoutChanged: Observable<void>;
  106209. /**
  106210. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  106211. */
  106212. get influence(): number;
  106213. set influence(influence: number);
  106214. /**
  106215. * Gets or sets the id of the morph Target
  106216. */
  106217. id: string;
  106218. private _animationPropertiesOverride;
  106219. /**
  106220. * Gets or sets the animation properties override
  106221. */
  106222. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  106223. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  106224. /**
  106225. * Creates a new MorphTarget
  106226. * @param name defines the name of the target
  106227. * @param influence defines the influence to use
  106228. * @param scene defines the scene the morphtarget belongs to
  106229. */
  106230. constructor(
  106231. /** defines the name of the target */
  106232. name: string, influence?: number, scene?: Nullable<Scene>);
  106233. /**
  106234. * Gets the unique ID of this manager
  106235. */
  106236. get uniqueId(): number;
  106237. /**
  106238. * Gets a boolean defining if the target contains position data
  106239. */
  106240. get hasPositions(): boolean;
  106241. /**
  106242. * Gets a boolean defining if the target contains normal data
  106243. */
  106244. get hasNormals(): boolean;
  106245. /**
  106246. * Gets a boolean defining if the target contains tangent data
  106247. */
  106248. get hasTangents(): boolean;
  106249. /**
  106250. * Gets a boolean defining if the target contains texture coordinates data
  106251. */
  106252. get hasUVs(): boolean;
  106253. /**
  106254. * Affects position data to this target
  106255. * @param data defines the position data to use
  106256. */
  106257. setPositions(data: Nullable<FloatArray>): void;
  106258. /**
  106259. * Gets the position data stored in this target
  106260. * @returns a FloatArray containing the position data (or null if not present)
  106261. */
  106262. getPositions(): Nullable<FloatArray>;
  106263. /**
  106264. * Affects normal data to this target
  106265. * @param data defines the normal data to use
  106266. */
  106267. setNormals(data: Nullable<FloatArray>): void;
  106268. /**
  106269. * Gets the normal data stored in this target
  106270. * @returns a FloatArray containing the normal data (or null if not present)
  106271. */
  106272. getNormals(): Nullable<FloatArray>;
  106273. /**
  106274. * Affects tangent data to this target
  106275. * @param data defines the tangent data to use
  106276. */
  106277. setTangents(data: Nullable<FloatArray>): void;
  106278. /**
  106279. * Gets the tangent data stored in this target
  106280. * @returns a FloatArray containing the tangent data (or null if not present)
  106281. */
  106282. getTangents(): Nullable<FloatArray>;
  106283. /**
  106284. * Affects texture coordinates data to this target
  106285. * @param data defines the texture coordinates data to use
  106286. */
  106287. setUVs(data: Nullable<FloatArray>): void;
  106288. /**
  106289. * Gets the texture coordinates data stored in this target
  106290. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  106291. */
  106292. getUVs(): Nullable<FloatArray>;
  106293. /**
  106294. * Clone the current target
  106295. * @returns a new MorphTarget
  106296. */
  106297. clone(): MorphTarget;
  106298. /**
  106299. * Serializes the current target into a Serialization object
  106300. * @returns the serialized object
  106301. */
  106302. serialize(): any;
  106303. /**
  106304. * Returns the string "MorphTarget"
  106305. * @returns "MorphTarget"
  106306. */
  106307. getClassName(): string;
  106308. /**
  106309. * Creates a new target from serialized data
  106310. * @param serializationObject defines the serialized data to use
  106311. * @returns a new MorphTarget
  106312. */
  106313. static Parse(serializationObject: any): MorphTarget;
  106314. /**
  106315. * Creates a MorphTarget from mesh data
  106316. * @param mesh defines the source mesh
  106317. * @param name defines the name to use for the new target
  106318. * @param influence defines the influence to attach to the target
  106319. * @returns a new MorphTarget
  106320. */
  106321. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  106322. }
  106323. }
  106324. declare module BABYLON {
  106325. /**
  106326. * This class is used to deform meshes using morphing between different targets
  106327. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106328. */
  106329. export class MorphTargetManager {
  106330. private _targets;
  106331. private _targetInfluenceChangedObservers;
  106332. private _targetDataLayoutChangedObservers;
  106333. private _activeTargets;
  106334. private _scene;
  106335. private _influences;
  106336. private _supportsNormals;
  106337. private _supportsTangents;
  106338. private _supportsUVs;
  106339. private _vertexCount;
  106340. private _uniqueId;
  106341. private _tempInfluences;
  106342. /**
  106343. * Gets or sets a boolean indicating if normals must be morphed
  106344. */
  106345. enableNormalMorphing: boolean;
  106346. /**
  106347. * Gets or sets a boolean indicating if tangents must be morphed
  106348. */
  106349. enableTangentMorphing: boolean;
  106350. /**
  106351. * Gets or sets a boolean indicating if UV must be morphed
  106352. */
  106353. enableUVMorphing: boolean;
  106354. /**
  106355. * Creates a new MorphTargetManager
  106356. * @param scene defines the current scene
  106357. */
  106358. constructor(scene?: Nullable<Scene>);
  106359. /**
  106360. * Gets the unique ID of this manager
  106361. */
  106362. get uniqueId(): number;
  106363. /**
  106364. * Gets the number of vertices handled by this manager
  106365. */
  106366. get vertexCount(): number;
  106367. /**
  106368. * Gets a boolean indicating if this manager supports morphing of normals
  106369. */
  106370. get supportsNormals(): boolean;
  106371. /**
  106372. * Gets a boolean indicating if this manager supports morphing of tangents
  106373. */
  106374. get supportsTangents(): boolean;
  106375. /**
  106376. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  106377. */
  106378. get supportsUVs(): boolean;
  106379. /**
  106380. * Gets the number of targets stored in this manager
  106381. */
  106382. get numTargets(): number;
  106383. /**
  106384. * Gets the number of influencers (ie. the number of targets with influences > 0)
  106385. */
  106386. get numInfluencers(): number;
  106387. /**
  106388. * Gets the list of influences (one per target)
  106389. */
  106390. get influences(): Float32Array;
  106391. /**
  106392. * Gets the active target at specified index. An active target is a target with an influence > 0
  106393. * @param index defines the index to check
  106394. * @returns the requested target
  106395. */
  106396. getActiveTarget(index: number): MorphTarget;
  106397. /**
  106398. * Gets the target at specified index
  106399. * @param index defines the index to check
  106400. * @returns the requested target
  106401. */
  106402. getTarget(index: number): MorphTarget;
  106403. /**
  106404. * Add a new target to this manager
  106405. * @param target defines the target to add
  106406. */
  106407. addTarget(target: MorphTarget): void;
  106408. /**
  106409. * Removes a target from the manager
  106410. * @param target defines the target to remove
  106411. */
  106412. removeTarget(target: MorphTarget): void;
  106413. /**
  106414. * Clone the current manager
  106415. * @returns a new MorphTargetManager
  106416. */
  106417. clone(): MorphTargetManager;
  106418. /**
  106419. * Serializes the current manager into a Serialization object
  106420. * @returns the serialized object
  106421. */
  106422. serialize(): any;
  106423. private _syncActiveTargets;
  106424. /**
  106425. * Syncrhonize the targets with all the meshes using this morph target manager
  106426. */
  106427. synchronize(): void;
  106428. /**
  106429. * Creates a new MorphTargetManager from serialized data
  106430. * @param serializationObject defines the serialized data
  106431. * @param scene defines the hosting scene
  106432. * @returns the new MorphTargetManager
  106433. */
  106434. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  106435. }
  106436. }
  106437. declare module BABYLON {
  106438. /**
  106439. * Class used to represent a specific level of detail of a mesh
  106440. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106441. */
  106442. export class MeshLODLevel {
  106443. /** Defines the distance where this level should start being displayed */
  106444. distance: number;
  106445. /** Defines the mesh to use to render this level */
  106446. mesh: Nullable<Mesh>;
  106447. /**
  106448. * Creates a new LOD level
  106449. * @param distance defines the distance where this level should star being displayed
  106450. * @param mesh defines the mesh to use to render this level
  106451. */
  106452. constructor(
  106453. /** Defines the distance where this level should start being displayed */
  106454. distance: number,
  106455. /** Defines the mesh to use to render this level */
  106456. mesh: Nullable<Mesh>);
  106457. }
  106458. }
  106459. declare module BABYLON {
  106460. /**
  106461. * Helper class used to generate a canvas to manipulate images
  106462. */
  106463. export class CanvasGenerator {
  106464. /**
  106465. * Create a new canvas (or offscreen canvas depending on the context)
  106466. * @param width defines the expected width
  106467. * @param height defines the expected height
  106468. * @return a new canvas or offscreen canvas
  106469. */
  106470. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  106471. }
  106472. }
  106473. declare module BABYLON {
  106474. /**
  106475. * Mesh representing the gorund
  106476. */
  106477. export class GroundMesh extends Mesh {
  106478. /** If octree should be generated */
  106479. generateOctree: boolean;
  106480. private _heightQuads;
  106481. /** @hidden */
  106482. _subdivisionsX: number;
  106483. /** @hidden */
  106484. _subdivisionsY: number;
  106485. /** @hidden */
  106486. _width: number;
  106487. /** @hidden */
  106488. _height: number;
  106489. /** @hidden */
  106490. _minX: number;
  106491. /** @hidden */
  106492. _maxX: number;
  106493. /** @hidden */
  106494. _minZ: number;
  106495. /** @hidden */
  106496. _maxZ: number;
  106497. constructor(name: string, scene: Scene);
  106498. /**
  106499. * "GroundMesh"
  106500. * @returns "GroundMesh"
  106501. */
  106502. getClassName(): string;
  106503. /**
  106504. * The minimum of x and y subdivisions
  106505. */
  106506. get subdivisions(): number;
  106507. /**
  106508. * X subdivisions
  106509. */
  106510. get subdivisionsX(): number;
  106511. /**
  106512. * Y subdivisions
  106513. */
  106514. get subdivisionsY(): number;
  106515. /**
  106516. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  106517. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  106518. * @param chunksCount the number of subdivisions for x and y
  106519. * @param octreeBlocksSize (Default: 32)
  106520. */
  106521. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  106522. /**
  106523. * Returns a height (y) value in the Worl system :
  106524. * the ground altitude at the coordinates (x, z) expressed in the World system.
  106525. * @param x x coordinate
  106526. * @param z z coordinate
  106527. * @returns the ground y position if (x, z) are outside the ground surface.
  106528. */
  106529. getHeightAtCoordinates(x: number, z: number): number;
  106530. /**
  106531. * Returns a normalized vector (Vector3) orthogonal to the ground
  106532. * at the ground coordinates (x, z) expressed in the World system.
  106533. * @param x x coordinate
  106534. * @param z z coordinate
  106535. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  106536. */
  106537. getNormalAtCoordinates(x: number, z: number): Vector3;
  106538. /**
  106539. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  106540. * at the ground coordinates (x, z) expressed in the World system.
  106541. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  106542. * @param x x coordinate
  106543. * @param z z coordinate
  106544. * @param ref vector to store the result
  106545. * @returns the GroundMesh.
  106546. */
  106547. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  106548. /**
  106549. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  106550. * if the ground has been updated.
  106551. * This can be used in the render loop.
  106552. * @returns the GroundMesh.
  106553. */
  106554. updateCoordinateHeights(): GroundMesh;
  106555. private _getFacetAt;
  106556. private _initHeightQuads;
  106557. private _computeHeightQuads;
  106558. /**
  106559. * Serializes this ground mesh
  106560. * @param serializationObject object to write serialization to
  106561. */
  106562. serialize(serializationObject: any): void;
  106563. /**
  106564. * Parses a serialized ground mesh
  106565. * @param parsedMesh the serialized mesh
  106566. * @param scene the scene to create the ground mesh in
  106567. * @returns the created ground mesh
  106568. */
  106569. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  106570. }
  106571. }
  106572. declare module BABYLON {
  106573. /**
  106574. * Interface for Physics-Joint data
  106575. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106576. */
  106577. export interface PhysicsJointData {
  106578. /**
  106579. * The main pivot of the joint
  106580. */
  106581. mainPivot?: Vector3;
  106582. /**
  106583. * The connected pivot of the joint
  106584. */
  106585. connectedPivot?: Vector3;
  106586. /**
  106587. * The main axis of the joint
  106588. */
  106589. mainAxis?: Vector3;
  106590. /**
  106591. * The connected axis of the joint
  106592. */
  106593. connectedAxis?: Vector3;
  106594. /**
  106595. * The collision of the joint
  106596. */
  106597. collision?: boolean;
  106598. /**
  106599. * Native Oimo/Cannon/Energy data
  106600. */
  106601. nativeParams?: any;
  106602. }
  106603. /**
  106604. * This is a holder class for the physics joint created by the physics plugin
  106605. * It holds a set of functions to control the underlying joint
  106606. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106607. */
  106608. export class PhysicsJoint {
  106609. /**
  106610. * The type of the physics joint
  106611. */
  106612. type: number;
  106613. /**
  106614. * The data for the physics joint
  106615. */
  106616. jointData: PhysicsJointData;
  106617. private _physicsJoint;
  106618. protected _physicsPlugin: IPhysicsEnginePlugin;
  106619. /**
  106620. * Initializes the physics joint
  106621. * @param type The type of the physics joint
  106622. * @param jointData The data for the physics joint
  106623. */
  106624. constructor(
  106625. /**
  106626. * The type of the physics joint
  106627. */
  106628. type: number,
  106629. /**
  106630. * The data for the physics joint
  106631. */
  106632. jointData: PhysicsJointData);
  106633. /**
  106634. * Gets the physics joint
  106635. */
  106636. get physicsJoint(): any;
  106637. /**
  106638. * Sets the physics joint
  106639. */
  106640. set physicsJoint(newJoint: any);
  106641. /**
  106642. * Sets the physics plugin
  106643. */
  106644. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  106645. /**
  106646. * Execute a function that is physics-plugin specific.
  106647. * @param {Function} func the function that will be executed.
  106648. * It accepts two parameters: the physics world and the physics joint
  106649. */
  106650. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  106651. /**
  106652. * Distance-Joint type
  106653. */
  106654. static DistanceJoint: number;
  106655. /**
  106656. * Hinge-Joint type
  106657. */
  106658. static HingeJoint: number;
  106659. /**
  106660. * Ball-and-Socket joint type
  106661. */
  106662. static BallAndSocketJoint: number;
  106663. /**
  106664. * Wheel-Joint type
  106665. */
  106666. static WheelJoint: number;
  106667. /**
  106668. * Slider-Joint type
  106669. */
  106670. static SliderJoint: number;
  106671. /**
  106672. * Prismatic-Joint type
  106673. */
  106674. static PrismaticJoint: number;
  106675. /**
  106676. * Universal-Joint type
  106677. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  106678. */
  106679. static UniversalJoint: number;
  106680. /**
  106681. * Hinge-Joint 2 type
  106682. */
  106683. static Hinge2Joint: number;
  106684. /**
  106685. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  106686. */
  106687. static PointToPointJoint: number;
  106688. /**
  106689. * Spring-Joint type
  106690. */
  106691. static SpringJoint: number;
  106692. /**
  106693. * Lock-Joint type
  106694. */
  106695. static LockJoint: number;
  106696. }
  106697. /**
  106698. * A class representing a physics distance joint
  106699. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106700. */
  106701. export class DistanceJoint extends PhysicsJoint {
  106702. /**
  106703. *
  106704. * @param jointData The data for the Distance-Joint
  106705. */
  106706. constructor(jointData: DistanceJointData);
  106707. /**
  106708. * Update the predefined distance.
  106709. * @param maxDistance The maximum preferred distance
  106710. * @param minDistance The minimum preferred distance
  106711. */
  106712. updateDistance(maxDistance: number, minDistance?: number): void;
  106713. }
  106714. /**
  106715. * Represents a Motor-Enabled Joint
  106716. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106717. */
  106718. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  106719. /**
  106720. * Initializes the Motor-Enabled Joint
  106721. * @param type The type of the joint
  106722. * @param jointData The physica joint data for the joint
  106723. */
  106724. constructor(type: number, jointData: PhysicsJointData);
  106725. /**
  106726. * Set the motor values.
  106727. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106728. * @param force the force to apply
  106729. * @param maxForce max force for this motor.
  106730. */
  106731. setMotor(force?: number, maxForce?: number): void;
  106732. /**
  106733. * Set the motor's limits.
  106734. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106735. * @param upperLimit The upper limit of the motor
  106736. * @param lowerLimit The lower limit of the motor
  106737. */
  106738. setLimit(upperLimit: number, lowerLimit?: number): void;
  106739. }
  106740. /**
  106741. * This class represents a single physics Hinge-Joint
  106742. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106743. */
  106744. export class HingeJoint extends MotorEnabledJoint {
  106745. /**
  106746. * Initializes the Hinge-Joint
  106747. * @param jointData The joint data for the Hinge-Joint
  106748. */
  106749. constructor(jointData: PhysicsJointData);
  106750. /**
  106751. * Set the motor values.
  106752. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106753. * @param {number} force the force to apply
  106754. * @param {number} maxForce max force for this motor.
  106755. */
  106756. setMotor(force?: number, maxForce?: number): void;
  106757. /**
  106758. * Set the motor's limits.
  106759. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106760. * @param upperLimit The upper limit of the motor
  106761. * @param lowerLimit The lower limit of the motor
  106762. */
  106763. setLimit(upperLimit: number, lowerLimit?: number): void;
  106764. }
  106765. /**
  106766. * This class represents a dual hinge physics joint (same as wheel joint)
  106767. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106768. */
  106769. export class Hinge2Joint extends MotorEnabledJoint {
  106770. /**
  106771. * Initializes the Hinge2-Joint
  106772. * @param jointData The joint data for the Hinge2-Joint
  106773. */
  106774. constructor(jointData: PhysicsJointData);
  106775. /**
  106776. * Set the motor values.
  106777. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106778. * @param {number} targetSpeed the speed the motor is to reach
  106779. * @param {number} maxForce max force for this motor.
  106780. * @param {motorIndex} the motor's index, 0 or 1.
  106781. */
  106782. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  106783. /**
  106784. * Set the motor limits.
  106785. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106786. * @param {number} upperLimit the upper limit
  106787. * @param {number} lowerLimit lower limit
  106788. * @param {motorIndex} the motor's index, 0 or 1.
  106789. */
  106790. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106791. }
  106792. /**
  106793. * Interface for a motor enabled joint
  106794. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106795. */
  106796. export interface IMotorEnabledJoint {
  106797. /**
  106798. * Physics joint
  106799. */
  106800. physicsJoint: any;
  106801. /**
  106802. * Sets the motor of the motor-enabled joint
  106803. * @param force The force of the motor
  106804. * @param maxForce The maximum force of the motor
  106805. * @param motorIndex The index of the motor
  106806. */
  106807. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  106808. /**
  106809. * Sets the limit of the motor
  106810. * @param upperLimit The upper limit of the motor
  106811. * @param lowerLimit The lower limit of the motor
  106812. * @param motorIndex The index of the motor
  106813. */
  106814. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106815. }
  106816. /**
  106817. * Joint data for a Distance-Joint
  106818. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106819. */
  106820. export interface DistanceJointData extends PhysicsJointData {
  106821. /**
  106822. * Max distance the 2 joint objects can be apart
  106823. */
  106824. maxDistance: number;
  106825. }
  106826. /**
  106827. * Joint data from a spring joint
  106828. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106829. */
  106830. export interface SpringJointData extends PhysicsJointData {
  106831. /**
  106832. * Length of the spring
  106833. */
  106834. length: number;
  106835. /**
  106836. * Stiffness of the spring
  106837. */
  106838. stiffness: number;
  106839. /**
  106840. * Damping of the spring
  106841. */
  106842. damping: number;
  106843. /** this callback will be called when applying the force to the impostors. */
  106844. forceApplicationCallback: () => void;
  106845. }
  106846. }
  106847. declare module BABYLON {
  106848. /**
  106849. * Holds the data for the raycast result
  106850. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106851. */
  106852. export class PhysicsRaycastResult {
  106853. private _hasHit;
  106854. private _hitDistance;
  106855. private _hitNormalWorld;
  106856. private _hitPointWorld;
  106857. private _rayFromWorld;
  106858. private _rayToWorld;
  106859. /**
  106860. * Gets if there was a hit
  106861. */
  106862. get hasHit(): boolean;
  106863. /**
  106864. * Gets the distance from the hit
  106865. */
  106866. get hitDistance(): number;
  106867. /**
  106868. * Gets the hit normal/direction in the world
  106869. */
  106870. get hitNormalWorld(): Vector3;
  106871. /**
  106872. * Gets the hit point in the world
  106873. */
  106874. get hitPointWorld(): Vector3;
  106875. /**
  106876. * Gets the ray "start point" of the ray in the world
  106877. */
  106878. get rayFromWorld(): Vector3;
  106879. /**
  106880. * Gets the ray "end point" of the ray in the world
  106881. */
  106882. get rayToWorld(): Vector3;
  106883. /**
  106884. * Sets the hit data (normal & point in world space)
  106885. * @param hitNormalWorld defines the normal in world space
  106886. * @param hitPointWorld defines the point in world space
  106887. */
  106888. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  106889. /**
  106890. * Sets the distance from the start point to the hit point
  106891. * @param distance
  106892. */
  106893. setHitDistance(distance: number): void;
  106894. /**
  106895. * Calculates the distance manually
  106896. */
  106897. calculateHitDistance(): void;
  106898. /**
  106899. * Resets all the values to default
  106900. * @param from The from point on world space
  106901. * @param to The to point on world space
  106902. */
  106903. reset(from?: Vector3, to?: Vector3): void;
  106904. }
  106905. /**
  106906. * Interface for the size containing width and height
  106907. */
  106908. interface IXYZ {
  106909. /**
  106910. * X
  106911. */
  106912. x: number;
  106913. /**
  106914. * Y
  106915. */
  106916. y: number;
  106917. /**
  106918. * Z
  106919. */
  106920. z: number;
  106921. }
  106922. }
  106923. declare module BABYLON {
  106924. /**
  106925. * Interface used to describe a physics joint
  106926. */
  106927. export interface PhysicsImpostorJoint {
  106928. /** Defines the main impostor to which the joint is linked */
  106929. mainImpostor: PhysicsImpostor;
  106930. /** Defines the impostor that is connected to the main impostor using this joint */
  106931. connectedImpostor: PhysicsImpostor;
  106932. /** Defines the joint itself */
  106933. joint: PhysicsJoint;
  106934. }
  106935. /** @hidden */
  106936. export interface IPhysicsEnginePlugin {
  106937. world: any;
  106938. name: string;
  106939. setGravity(gravity: Vector3): void;
  106940. setTimeStep(timeStep: number): void;
  106941. getTimeStep(): number;
  106942. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  106943. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106944. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106945. generatePhysicsBody(impostor: PhysicsImpostor): void;
  106946. removePhysicsBody(impostor: PhysicsImpostor): void;
  106947. generateJoint(joint: PhysicsImpostorJoint): void;
  106948. removeJoint(joint: PhysicsImpostorJoint): void;
  106949. isSupported(): boolean;
  106950. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  106951. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  106952. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106953. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106954. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106955. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106956. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  106957. getBodyMass(impostor: PhysicsImpostor): number;
  106958. getBodyFriction(impostor: PhysicsImpostor): number;
  106959. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  106960. getBodyRestitution(impostor: PhysicsImpostor): number;
  106961. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  106962. getBodyPressure?(impostor: PhysicsImpostor): number;
  106963. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  106964. getBodyStiffness?(impostor: PhysicsImpostor): number;
  106965. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  106966. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  106967. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  106968. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  106969. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  106970. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106971. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106972. sleepBody(impostor: PhysicsImpostor): void;
  106973. wakeUpBody(impostor: PhysicsImpostor): void;
  106974. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  106975. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  106976. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  106977. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106978. getRadius(impostor: PhysicsImpostor): number;
  106979. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  106980. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  106981. dispose(): void;
  106982. }
  106983. /**
  106984. * Interface used to define a physics engine
  106985. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106986. */
  106987. export interface IPhysicsEngine {
  106988. /**
  106989. * Gets the gravity vector used by the simulation
  106990. */
  106991. gravity: Vector3;
  106992. /**
  106993. * Sets the gravity vector used by the simulation
  106994. * @param gravity defines the gravity vector to use
  106995. */
  106996. setGravity(gravity: Vector3): void;
  106997. /**
  106998. * Set the time step of the physics engine.
  106999. * Default is 1/60.
  107000. * To slow it down, enter 1/600 for example.
  107001. * To speed it up, 1/30
  107002. * @param newTimeStep the new timestep to apply to this world.
  107003. */
  107004. setTimeStep(newTimeStep: number): void;
  107005. /**
  107006. * Get the time step of the physics engine.
  107007. * @returns the current time step
  107008. */
  107009. getTimeStep(): number;
  107010. /**
  107011. * Set the sub time step of the physics engine.
  107012. * Default is 0 meaning there is no sub steps
  107013. * To increase physics resolution precision, set a small value (like 1 ms)
  107014. * @param subTimeStep defines the new sub timestep used for physics resolution.
  107015. */
  107016. setSubTimeStep(subTimeStep: number): void;
  107017. /**
  107018. * Get the sub time step of the physics engine.
  107019. * @returns the current sub time step
  107020. */
  107021. getSubTimeStep(): number;
  107022. /**
  107023. * Release all resources
  107024. */
  107025. dispose(): void;
  107026. /**
  107027. * Gets the name of the current physics plugin
  107028. * @returns the name of the plugin
  107029. */
  107030. getPhysicsPluginName(): string;
  107031. /**
  107032. * Adding a new impostor for the impostor tracking.
  107033. * This will be done by the impostor itself.
  107034. * @param impostor the impostor to add
  107035. */
  107036. addImpostor(impostor: PhysicsImpostor): void;
  107037. /**
  107038. * Remove an impostor from the engine.
  107039. * This impostor and its mesh will not longer be updated by the physics engine.
  107040. * @param impostor the impostor to remove
  107041. */
  107042. removeImpostor(impostor: PhysicsImpostor): void;
  107043. /**
  107044. * Add a joint to the physics engine
  107045. * @param mainImpostor defines the main impostor to which the joint is added.
  107046. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  107047. * @param joint defines the joint that will connect both impostors.
  107048. */
  107049. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107050. /**
  107051. * Removes a joint from the simulation
  107052. * @param mainImpostor defines the impostor used with the joint
  107053. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  107054. * @param joint defines the joint to remove
  107055. */
  107056. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107057. /**
  107058. * Gets the current plugin used to run the simulation
  107059. * @returns current plugin
  107060. */
  107061. getPhysicsPlugin(): IPhysicsEnginePlugin;
  107062. /**
  107063. * Gets the list of physic impostors
  107064. * @returns an array of PhysicsImpostor
  107065. */
  107066. getImpostors(): Array<PhysicsImpostor>;
  107067. /**
  107068. * Gets the impostor for a physics enabled object
  107069. * @param object defines the object impersonated by the impostor
  107070. * @returns the PhysicsImpostor or null if not found
  107071. */
  107072. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107073. /**
  107074. * Gets the impostor for a physics body object
  107075. * @param body defines physics body used by the impostor
  107076. * @returns the PhysicsImpostor or null if not found
  107077. */
  107078. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  107079. /**
  107080. * Does a raycast in the physics world
  107081. * @param from when should the ray start?
  107082. * @param to when should the ray end?
  107083. * @returns PhysicsRaycastResult
  107084. */
  107085. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107086. /**
  107087. * Called by the scene. No need to call it.
  107088. * @param delta defines the timespam between frames
  107089. */
  107090. _step(delta: number): void;
  107091. }
  107092. }
  107093. declare module BABYLON {
  107094. /**
  107095. * The interface for the physics imposter parameters
  107096. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107097. */
  107098. export interface PhysicsImpostorParameters {
  107099. /**
  107100. * The mass of the physics imposter
  107101. */
  107102. mass: number;
  107103. /**
  107104. * The friction of the physics imposter
  107105. */
  107106. friction?: number;
  107107. /**
  107108. * The coefficient of restitution of the physics imposter
  107109. */
  107110. restitution?: number;
  107111. /**
  107112. * The native options of the physics imposter
  107113. */
  107114. nativeOptions?: any;
  107115. /**
  107116. * Specifies if the parent should be ignored
  107117. */
  107118. ignoreParent?: boolean;
  107119. /**
  107120. * Specifies if bi-directional transformations should be disabled
  107121. */
  107122. disableBidirectionalTransformation?: boolean;
  107123. /**
  107124. * The pressure inside the physics imposter, soft object only
  107125. */
  107126. pressure?: number;
  107127. /**
  107128. * The stiffness the physics imposter, soft object only
  107129. */
  107130. stiffness?: number;
  107131. /**
  107132. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  107133. */
  107134. velocityIterations?: number;
  107135. /**
  107136. * The number of iterations used in maintaining consistent vertex positions, soft object only
  107137. */
  107138. positionIterations?: number;
  107139. /**
  107140. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  107141. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  107142. * Add to fix multiple points
  107143. */
  107144. fixedPoints?: number;
  107145. /**
  107146. * The collision margin around a soft object
  107147. */
  107148. margin?: number;
  107149. /**
  107150. * The collision margin around a soft object
  107151. */
  107152. damping?: number;
  107153. /**
  107154. * The path for a rope based on an extrusion
  107155. */
  107156. path?: any;
  107157. /**
  107158. * The shape of an extrusion used for a rope based on an extrusion
  107159. */
  107160. shape?: any;
  107161. }
  107162. /**
  107163. * Interface for a physics-enabled object
  107164. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107165. */
  107166. export interface IPhysicsEnabledObject {
  107167. /**
  107168. * The position of the physics-enabled object
  107169. */
  107170. position: Vector3;
  107171. /**
  107172. * The rotation of the physics-enabled object
  107173. */
  107174. rotationQuaternion: Nullable<Quaternion>;
  107175. /**
  107176. * The scale of the physics-enabled object
  107177. */
  107178. scaling: Vector3;
  107179. /**
  107180. * The rotation of the physics-enabled object
  107181. */
  107182. rotation?: Vector3;
  107183. /**
  107184. * The parent of the physics-enabled object
  107185. */
  107186. parent?: any;
  107187. /**
  107188. * The bounding info of the physics-enabled object
  107189. * @returns The bounding info of the physics-enabled object
  107190. */
  107191. getBoundingInfo(): BoundingInfo;
  107192. /**
  107193. * Computes the world matrix
  107194. * @param force Specifies if the world matrix should be computed by force
  107195. * @returns A world matrix
  107196. */
  107197. computeWorldMatrix(force: boolean): Matrix;
  107198. /**
  107199. * Gets the world matrix
  107200. * @returns A world matrix
  107201. */
  107202. getWorldMatrix?(): Matrix;
  107203. /**
  107204. * Gets the child meshes
  107205. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  107206. * @returns An array of abstract meshes
  107207. */
  107208. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  107209. /**
  107210. * Gets the vertex data
  107211. * @param kind The type of vertex data
  107212. * @returns A nullable array of numbers, or a float32 array
  107213. */
  107214. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  107215. /**
  107216. * Gets the indices from the mesh
  107217. * @returns A nullable array of index arrays
  107218. */
  107219. getIndices?(): Nullable<IndicesArray>;
  107220. /**
  107221. * Gets the scene from the mesh
  107222. * @returns the indices array or null
  107223. */
  107224. getScene?(): Scene;
  107225. /**
  107226. * Gets the absolute position from the mesh
  107227. * @returns the absolute position
  107228. */
  107229. getAbsolutePosition(): Vector3;
  107230. /**
  107231. * Gets the absolute pivot point from the mesh
  107232. * @returns the absolute pivot point
  107233. */
  107234. getAbsolutePivotPoint(): Vector3;
  107235. /**
  107236. * Rotates the mesh
  107237. * @param axis The axis of rotation
  107238. * @param amount The amount of rotation
  107239. * @param space The space of the rotation
  107240. * @returns The rotation transform node
  107241. */
  107242. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  107243. /**
  107244. * Translates the mesh
  107245. * @param axis The axis of translation
  107246. * @param distance The distance of translation
  107247. * @param space The space of the translation
  107248. * @returns The transform node
  107249. */
  107250. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  107251. /**
  107252. * Sets the absolute position of the mesh
  107253. * @param absolutePosition The absolute position of the mesh
  107254. * @returns The transform node
  107255. */
  107256. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  107257. /**
  107258. * Gets the class name of the mesh
  107259. * @returns The class name
  107260. */
  107261. getClassName(): string;
  107262. }
  107263. /**
  107264. * Represents a physics imposter
  107265. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107266. */
  107267. export class PhysicsImpostor {
  107268. /**
  107269. * The physics-enabled object used as the physics imposter
  107270. */
  107271. object: IPhysicsEnabledObject;
  107272. /**
  107273. * The type of the physics imposter
  107274. */
  107275. type: number;
  107276. private _options;
  107277. private _scene?;
  107278. /**
  107279. * The default object size of the imposter
  107280. */
  107281. static DEFAULT_OBJECT_SIZE: Vector3;
  107282. /**
  107283. * The identity quaternion of the imposter
  107284. */
  107285. static IDENTITY_QUATERNION: Quaternion;
  107286. /** @hidden */
  107287. _pluginData: any;
  107288. private _physicsEngine;
  107289. private _physicsBody;
  107290. private _bodyUpdateRequired;
  107291. private _onBeforePhysicsStepCallbacks;
  107292. private _onAfterPhysicsStepCallbacks;
  107293. /** @hidden */
  107294. _onPhysicsCollideCallbacks: Array<{
  107295. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  107296. otherImpostors: Array<PhysicsImpostor>;
  107297. }>;
  107298. private _deltaPosition;
  107299. private _deltaRotation;
  107300. private _deltaRotationConjugated;
  107301. /** @hidden */
  107302. _isFromLine: boolean;
  107303. private _parent;
  107304. private _isDisposed;
  107305. private static _tmpVecs;
  107306. private static _tmpQuat;
  107307. /**
  107308. * Specifies if the physics imposter is disposed
  107309. */
  107310. get isDisposed(): boolean;
  107311. /**
  107312. * Gets the mass of the physics imposter
  107313. */
  107314. get mass(): number;
  107315. set mass(value: number);
  107316. /**
  107317. * Gets the coefficient of friction
  107318. */
  107319. get friction(): number;
  107320. /**
  107321. * Sets the coefficient of friction
  107322. */
  107323. set friction(value: number);
  107324. /**
  107325. * Gets the coefficient of restitution
  107326. */
  107327. get restitution(): number;
  107328. /**
  107329. * Sets the coefficient of restitution
  107330. */
  107331. set restitution(value: number);
  107332. /**
  107333. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  107334. */
  107335. get pressure(): number;
  107336. /**
  107337. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  107338. */
  107339. set pressure(value: number);
  107340. /**
  107341. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107342. */
  107343. get stiffness(): number;
  107344. /**
  107345. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107346. */
  107347. set stiffness(value: number);
  107348. /**
  107349. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107350. */
  107351. get velocityIterations(): number;
  107352. /**
  107353. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107354. */
  107355. set velocityIterations(value: number);
  107356. /**
  107357. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107358. */
  107359. get positionIterations(): number;
  107360. /**
  107361. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107362. */
  107363. set positionIterations(value: number);
  107364. /**
  107365. * The unique id of the physics imposter
  107366. * set by the physics engine when adding this impostor to the array
  107367. */
  107368. uniqueId: number;
  107369. /**
  107370. * @hidden
  107371. */
  107372. soft: boolean;
  107373. /**
  107374. * @hidden
  107375. */
  107376. segments: number;
  107377. private _joints;
  107378. /**
  107379. * Initializes the physics imposter
  107380. * @param object The physics-enabled object used as the physics imposter
  107381. * @param type The type of the physics imposter
  107382. * @param _options The options for the physics imposter
  107383. * @param _scene The Babylon scene
  107384. */
  107385. constructor(
  107386. /**
  107387. * The physics-enabled object used as the physics imposter
  107388. */
  107389. object: IPhysicsEnabledObject,
  107390. /**
  107391. * The type of the physics imposter
  107392. */
  107393. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  107394. /**
  107395. * This function will completly initialize this impostor.
  107396. * It will create a new body - but only if this mesh has no parent.
  107397. * If it has, this impostor will not be used other than to define the impostor
  107398. * of the child mesh.
  107399. * @hidden
  107400. */
  107401. _init(): void;
  107402. private _getPhysicsParent;
  107403. /**
  107404. * Should a new body be generated.
  107405. * @returns boolean specifying if body initialization is required
  107406. */
  107407. isBodyInitRequired(): boolean;
  107408. /**
  107409. * Sets the updated scaling
  107410. * @param updated Specifies if the scaling is updated
  107411. */
  107412. setScalingUpdated(): void;
  107413. /**
  107414. * Force a regeneration of this or the parent's impostor's body.
  107415. * Use under cautious - This will remove all joints already implemented.
  107416. */
  107417. forceUpdate(): void;
  107418. /**
  107419. * Gets the body that holds this impostor. Either its own, or its parent.
  107420. */
  107421. get physicsBody(): any;
  107422. /**
  107423. * Get the parent of the physics imposter
  107424. * @returns Physics imposter or null
  107425. */
  107426. get parent(): Nullable<PhysicsImpostor>;
  107427. /**
  107428. * Sets the parent of the physics imposter
  107429. */
  107430. set parent(value: Nullable<PhysicsImpostor>);
  107431. /**
  107432. * Set the physics body. Used mainly by the physics engine/plugin
  107433. */
  107434. set physicsBody(physicsBody: any);
  107435. /**
  107436. * Resets the update flags
  107437. */
  107438. resetUpdateFlags(): void;
  107439. /**
  107440. * Gets the object extend size
  107441. * @returns the object extend size
  107442. */
  107443. getObjectExtendSize(): Vector3;
  107444. /**
  107445. * Gets the object center
  107446. * @returns The object center
  107447. */
  107448. getObjectCenter(): Vector3;
  107449. /**
  107450. * Get a specific parameter from the options parameters
  107451. * @param paramName The object parameter name
  107452. * @returns The object parameter
  107453. */
  107454. getParam(paramName: string): any;
  107455. /**
  107456. * Sets a specific parameter in the options given to the physics plugin
  107457. * @param paramName The parameter name
  107458. * @param value The value of the parameter
  107459. */
  107460. setParam(paramName: string, value: number): void;
  107461. /**
  107462. * Specifically change the body's mass option. Won't recreate the physics body object
  107463. * @param mass The mass of the physics imposter
  107464. */
  107465. setMass(mass: number): void;
  107466. /**
  107467. * Gets the linear velocity
  107468. * @returns linear velocity or null
  107469. */
  107470. getLinearVelocity(): Nullable<Vector3>;
  107471. /**
  107472. * Sets the linear velocity
  107473. * @param velocity linear velocity or null
  107474. */
  107475. setLinearVelocity(velocity: Nullable<Vector3>): void;
  107476. /**
  107477. * Gets the angular velocity
  107478. * @returns angular velocity or null
  107479. */
  107480. getAngularVelocity(): Nullable<Vector3>;
  107481. /**
  107482. * Sets the angular velocity
  107483. * @param velocity The velocity or null
  107484. */
  107485. setAngularVelocity(velocity: Nullable<Vector3>): void;
  107486. /**
  107487. * Execute a function with the physics plugin native code
  107488. * Provide a function the will have two variables - the world object and the physics body object
  107489. * @param func The function to execute with the physics plugin native code
  107490. */
  107491. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  107492. /**
  107493. * Register a function that will be executed before the physics world is stepping forward
  107494. * @param func The function to execute before the physics world is stepped forward
  107495. */
  107496. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107497. /**
  107498. * Unregister a function that will be executed before the physics world is stepping forward
  107499. * @param func The function to execute before the physics world is stepped forward
  107500. */
  107501. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107502. /**
  107503. * Register a function that will be executed after the physics step
  107504. * @param func The function to execute after physics step
  107505. */
  107506. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107507. /**
  107508. * Unregisters a function that will be executed after the physics step
  107509. * @param func The function to execute after physics step
  107510. */
  107511. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107512. /**
  107513. * register a function that will be executed when this impostor collides against a different body
  107514. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  107515. * @param func Callback that is executed on collision
  107516. */
  107517. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  107518. /**
  107519. * Unregisters the physics imposter on contact
  107520. * @param collideAgainst The physics object to collide against
  107521. * @param func Callback to execute on collision
  107522. */
  107523. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  107524. private _tmpQuat;
  107525. private _tmpQuat2;
  107526. /**
  107527. * Get the parent rotation
  107528. * @returns The parent rotation
  107529. */
  107530. getParentsRotation(): Quaternion;
  107531. /**
  107532. * this function is executed by the physics engine.
  107533. */
  107534. beforeStep: () => void;
  107535. /**
  107536. * this function is executed by the physics engine
  107537. */
  107538. afterStep: () => void;
  107539. /**
  107540. * Legacy collision detection event support
  107541. */
  107542. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  107543. /**
  107544. * event and body object due to cannon's event-based architecture.
  107545. */
  107546. onCollide: (e: {
  107547. body: any;
  107548. }) => void;
  107549. /**
  107550. * Apply a force
  107551. * @param force The force to apply
  107552. * @param contactPoint The contact point for the force
  107553. * @returns The physics imposter
  107554. */
  107555. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107556. /**
  107557. * Apply an impulse
  107558. * @param force The impulse force
  107559. * @param contactPoint The contact point for the impulse force
  107560. * @returns The physics imposter
  107561. */
  107562. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107563. /**
  107564. * A help function to create a joint
  107565. * @param otherImpostor A physics imposter used to create a joint
  107566. * @param jointType The type of joint
  107567. * @param jointData The data for the joint
  107568. * @returns The physics imposter
  107569. */
  107570. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  107571. /**
  107572. * Add a joint to this impostor with a different impostor
  107573. * @param otherImpostor A physics imposter used to add a joint
  107574. * @param joint The joint to add
  107575. * @returns The physics imposter
  107576. */
  107577. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  107578. /**
  107579. * Add an anchor to a cloth impostor
  107580. * @param otherImpostor rigid impostor to anchor to
  107581. * @param width ratio across width from 0 to 1
  107582. * @param height ratio up height from 0 to 1
  107583. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  107584. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  107585. * @returns impostor the soft imposter
  107586. */
  107587. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107588. /**
  107589. * Add a hook to a rope impostor
  107590. * @param otherImpostor rigid impostor to anchor to
  107591. * @param length ratio across rope from 0 to 1
  107592. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  107593. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  107594. * @returns impostor the rope imposter
  107595. */
  107596. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107597. /**
  107598. * Will keep this body still, in a sleep mode.
  107599. * @returns the physics imposter
  107600. */
  107601. sleep(): PhysicsImpostor;
  107602. /**
  107603. * Wake the body up.
  107604. * @returns The physics imposter
  107605. */
  107606. wakeUp(): PhysicsImpostor;
  107607. /**
  107608. * Clones the physics imposter
  107609. * @param newObject The physics imposter clones to this physics-enabled object
  107610. * @returns A nullable physics imposter
  107611. */
  107612. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107613. /**
  107614. * Disposes the physics imposter
  107615. */
  107616. dispose(): void;
  107617. /**
  107618. * Sets the delta position
  107619. * @param position The delta position amount
  107620. */
  107621. setDeltaPosition(position: Vector3): void;
  107622. /**
  107623. * Sets the delta rotation
  107624. * @param rotation The delta rotation amount
  107625. */
  107626. setDeltaRotation(rotation: Quaternion): void;
  107627. /**
  107628. * Gets the box size of the physics imposter and stores the result in the input parameter
  107629. * @param result Stores the box size
  107630. * @returns The physics imposter
  107631. */
  107632. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  107633. /**
  107634. * Gets the radius of the physics imposter
  107635. * @returns Radius of the physics imposter
  107636. */
  107637. getRadius(): number;
  107638. /**
  107639. * Sync a bone with this impostor
  107640. * @param bone The bone to sync to the impostor.
  107641. * @param boneMesh The mesh that the bone is influencing.
  107642. * @param jointPivot The pivot of the joint / bone in local space.
  107643. * @param distToJoint Optional distance from the impostor to the joint.
  107644. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107645. */
  107646. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  107647. /**
  107648. * Sync impostor to a bone
  107649. * @param bone The bone that the impostor will be synced to.
  107650. * @param boneMesh The mesh that the bone is influencing.
  107651. * @param jointPivot The pivot of the joint / bone in local space.
  107652. * @param distToJoint Optional distance from the impostor to the joint.
  107653. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107654. * @param boneAxis Optional vector3 axis the bone is aligned with
  107655. */
  107656. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  107657. /**
  107658. * No-Imposter type
  107659. */
  107660. static NoImpostor: number;
  107661. /**
  107662. * Sphere-Imposter type
  107663. */
  107664. static SphereImpostor: number;
  107665. /**
  107666. * Box-Imposter type
  107667. */
  107668. static BoxImpostor: number;
  107669. /**
  107670. * Plane-Imposter type
  107671. */
  107672. static PlaneImpostor: number;
  107673. /**
  107674. * Mesh-imposter type
  107675. */
  107676. static MeshImpostor: number;
  107677. /**
  107678. * Capsule-Impostor type (Ammo.js plugin only)
  107679. */
  107680. static CapsuleImpostor: number;
  107681. /**
  107682. * Cylinder-Imposter type
  107683. */
  107684. static CylinderImpostor: number;
  107685. /**
  107686. * Particle-Imposter type
  107687. */
  107688. static ParticleImpostor: number;
  107689. /**
  107690. * Heightmap-Imposter type
  107691. */
  107692. static HeightmapImpostor: number;
  107693. /**
  107694. * ConvexHull-Impostor type (Ammo.js plugin only)
  107695. */
  107696. static ConvexHullImpostor: number;
  107697. /**
  107698. * Custom-Imposter type (Ammo.js plugin only)
  107699. */
  107700. static CustomImpostor: number;
  107701. /**
  107702. * Rope-Imposter type
  107703. */
  107704. static RopeImpostor: number;
  107705. /**
  107706. * Cloth-Imposter type
  107707. */
  107708. static ClothImpostor: number;
  107709. /**
  107710. * Softbody-Imposter type
  107711. */
  107712. static SoftbodyImpostor: number;
  107713. }
  107714. }
  107715. declare module BABYLON {
  107716. /**
  107717. * @hidden
  107718. **/
  107719. export class _CreationDataStorage {
  107720. closePath?: boolean;
  107721. closeArray?: boolean;
  107722. idx: number[];
  107723. dashSize: number;
  107724. gapSize: number;
  107725. path3D: Path3D;
  107726. pathArray: Vector3[][];
  107727. arc: number;
  107728. radius: number;
  107729. cap: number;
  107730. tessellation: number;
  107731. }
  107732. /**
  107733. * @hidden
  107734. **/
  107735. class _InstanceDataStorage {
  107736. visibleInstances: any;
  107737. batchCache: _InstancesBatch;
  107738. instancesBufferSize: number;
  107739. instancesBuffer: Nullable<Buffer>;
  107740. instancesData: Float32Array;
  107741. overridenInstanceCount: number;
  107742. isFrozen: boolean;
  107743. previousBatch: Nullable<_InstancesBatch>;
  107744. hardwareInstancedRendering: boolean;
  107745. sideOrientation: number;
  107746. manualUpdate: boolean;
  107747. }
  107748. /**
  107749. * @hidden
  107750. **/
  107751. export class _InstancesBatch {
  107752. mustReturn: boolean;
  107753. visibleInstances: Nullable<InstancedMesh[]>[];
  107754. renderSelf: boolean[];
  107755. hardwareInstancedRendering: boolean[];
  107756. }
  107757. /**
  107758. * @hidden
  107759. **/
  107760. class _ThinInstanceDataStorage {
  107761. instancesCount: number;
  107762. matrixBuffer: Nullable<Buffer>;
  107763. matrixBufferSize: number;
  107764. matrixData: Nullable<Float32Array>;
  107765. boundingVectors: Array<Vector3>;
  107766. worldMatrices: Nullable<Matrix[]>;
  107767. }
  107768. /**
  107769. * Class used to represent renderable models
  107770. */
  107771. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  107772. /**
  107773. * Mesh side orientation : usually the external or front surface
  107774. */
  107775. static readonly FRONTSIDE: number;
  107776. /**
  107777. * Mesh side orientation : usually the internal or back surface
  107778. */
  107779. static readonly BACKSIDE: number;
  107780. /**
  107781. * Mesh side orientation : both internal and external or front and back surfaces
  107782. */
  107783. static readonly DOUBLESIDE: number;
  107784. /**
  107785. * Mesh side orientation : by default, `FRONTSIDE`
  107786. */
  107787. static readonly DEFAULTSIDE: number;
  107788. /**
  107789. * Mesh cap setting : no cap
  107790. */
  107791. static readonly NO_CAP: number;
  107792. /**
  107793. * Mesh cap setting : one cap at the beginning of the mesh
  107794. */
  107795. static readonly CAP_START: number;
  107796. /**
  107797. * Mesh cap setting : one cap at the end of the mesh
  107798. */
  107799. static readonly CAP_END: number;
  107800. /**
  107801. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  107802. */
  107803. static readonly CAP_ALL: number;
  107804. /**
  107805. * Mesh pattern setting : no flip or rotate
  107806. */
  107807. static readonly NO_FLIP: number;
  107808. /**
  107809. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  107810. */
  107811. static readonly FLIP_TILE: number;
  107812. /**
  107813. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  107814. */
  107815. static readonly ROTATE_TILE: number;
  107816. /**
  107817. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  107818. */
  107819. static readonly FLIP_ROW: number;
  107820. /**
  107821. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  107822. */
  107823. static readonly ROTATE_ROW: number;
  107824. /**
  107825. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  107826. */
  107827. static readonly FLIP_N_ROTATE_TILE: number;
  107828. /**
  107829. * Mesh pattern setting : rotate pattern and rotate
  107830. */
  107831. static readonly FLIP_N_ROTATE_ROW: number;
  107832. /**
  107833. * Mesh tile positioning : part tiles same on left/right or top/bottom
  107834. */
  107835. static readonly CENTER: number;
  107836. /**
  107837. * Mesh tile positioning : part tiles on left
  107838. */
  107839. static readonly LEFT: number;
  107840. /**
  107841. * Mesh tile positioning : part tiles on right
  107842. */
  107843. static readonly RIGHT: number;
  107844. /**
  107845. * Mesh tile positioning : part tiles on top
  107846. */
  107847. static readonly TOP: number;
  107848. /**
  107849. * Mesh tile positioning : part tiles on bottom
  107850. */
  107851. static readonly BOTTOM: number;
  107852. /**
  107853. * Gets the default side orientation.
  107854. * @param orientation the orientation to value to attempt to get
  107855. * @returns the default orientation
  107856. * @hidden
  107857. */
  107858. static _GetDefaultSideOrientation(orientation?: number): number;
  107859. private _internalMeshDataInfo;
  107860. get computeBonesUsingShaders(): boolean;
  107861. set computeBonesUsingShaders(value: boolean);
  107862. /**
  107863. * An event triggered before rendering the mesh
  107864. */
  107865. get onBeforeRenderObservable(): Observable<Mesh>;
  107866. /**
  107867. * An event triggered before binding the mesh
  107868. */
  107869. get onBeforeBindObservable(): Observable<Mesh>;
  107870. /**
  107871. * An event triggered after rendering the mesh
  107872. */
  107873. get onAfterRenderObservable(): Observable<Mesh>;
  107874. /**
  107875. * An event triggered before drawing the mesh
  107876. */
  107877. get onBeforeDrawObservable(): Observable<Mesh>;
  107878. private _onBeforeDrawObserver;
  107879. /**
  107880. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  107881. */
  107882. set onBeforeDraw(callback: () => void);
  107883. get hasInstances(): boolean;
  107884. get hasThinInstances(): boolean;
  107885. /**
  107886. * Gets the delay loading state of the mesh (when delay loading is turned on)
  107887. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  107888. */
  107889. delayLoadState: number;
  107890. /**
  107891. * Gets the list of instances created from this mesh
  107892. * it is not supposed to be modified manually.
  107893. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  107894. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  107895. */
  107896. instances: InstancedMesh[];
  107897. /**
  107898. * Gets the file containing delay loading data for this mesh
  107899. */
  107900. delayLoadingFile: string;
  107901. /** @hidden */
  107902. _binaryInfo: any;
  107903. /**
  107904. * User defined function used to change how LOD level selection is done
  107905. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107906. */
  107907. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  107908. /**
  107909. * Gets or sets the morph target manager
  107910. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  107911. */
  107912. get morphTargetManager(): Nullable<MorphTargetManager>;
  107913. set morphTargetManager(value: Nullable<MorphTargetManager>);
  107914. /** @hidden */
  107915. _creationDataStorage: Nullable<_CreationDataStorage>;
  107916. /** @hidden */
  107917. _geometry: Nullable<Geometry>;
  107918. /** @hidden */
  107919. _delayInfo: Array<string>;
  107920. /** @hidden */
  107921. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  107922. /** @hidden */
  107923. _instanceDataStorage: _InstanceDataStorage;
  107924. /** @hidden */
  107925. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  107926. private _effectiveMaterial;
  107927. /** @hidden */
  107928. _shouldGenerateFlatShading: boolean;
  107929. /** @hidden */
  107930. _originalBuilderSideOrientation: number;
  107931. /**
  107932. * Use this property to change the original side orientation defined at construction time
  107933. */
  107934. overrideMaterialSideOrientation: Nullable<number>;
  107935. /**
  107936. * Gets the source mesh (the one used to clone this one from)
  107937. */
  107938. get source(): Nullable<Mesh>;
  107939. /**
  107940. * Gets the list of clones of this mesh
  107941. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  107942. * Note that useClonedMeshMap=true is the default setting
  107943. */
  107944. get cloneMeshMap(): Nullable<{
  107945. [id: string]: Mesh | undefined;
  107946. }>;
  107947. /**
  107948. * Gets or sets a boolean indicating that this mesh does not use index buffer
  107949. */
  107950. get isUnIndexed(): boolean;
  107951. set isUnIndexed(value: boolean);
  107952. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  107953. get worldMatrixInstancedBuffer(): Float32Array;
  107954. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  107955. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  107956. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  107957. /**
  107958. * @constructor
  107959. * @param name The value used by scene.getMeshByName() to do a lookup.
  107960. * @param scene The scene to add this mesh to.
  107961. * @param parent The parent of this mesh, if it has one
  107962. * @param source An optional Mesh from which geometry is shared, cloned.
  107963. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  107964. * When false, achieved by calling a clone(), also passing False.
  107965. * This will make creation of children, recursive.
  107966. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  107967. */
  107968. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  107969. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  107970. doNotInstantiate: boolean;
  107971. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  107972. /**
  107973. * Gets the class name
  107974. * @returns the string "Mesh".
  107975. */
  107976. getClassName(): string;
  107977. /** @hidden */
  107978. get _isMesh(): boolean;
  107979. /**
  107980. * Returns a description of this mesh
  107981. * @param fullDetails define if full details about this mesh must be used
  107982. * @returns a descriptive string representing this mesh
  107983. */
  107984. toString(fullDetails?: boolean): string;
  107985. /** @hidden */
  107986. _unBindEffect(): void;
  107987. /**
  107988. * Gets a boolean indicating if this mesh has LOD
  107989. */
  107990. get hasLODLevels(): boolean;
  107991. /**
  107992. * Gets the list of MeshLODLevel associated with the current mesh
  107993. * @returns an array of MeshLODLevel
  107994. */
  107995. getLODLevels(): MeshLODLevel[];
  107996. private _sortLODLevels;
  107997. /**
  107998. * Add a mesh as LOD level triggered at the given distance.
  107999. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108000. * @param distance The distance from the center of the object to show this level
  108001. * @param mesh The mesh to be added as LOD level (can be null)
  108002. * @return This mesh (for chaining)
  108003. */
  108004. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  108005. /**
  108006. * Returns the LOD level mesh at the passed distance or null if not found.
  108007. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108008. * @param distance The distance from the center of the object to show this level
  108009. * @returns a Mesh or `null`
  108010. */
  108011. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  108012. /**
  108013. * Remove a mesh from the LOD array
  108014. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108015. * @param mesh defines the mesh to be removed
  108016. * @return This mesh (for chaining)
  108017. */
  108018. removeLODLevel(mesh: Mesh): Mesh;
  108019. /**
  108020. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  108021. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108022. * @param camera defines the camera to use to compute distance
  108023. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  108024. * @return This mesh (for chaining)
  108025. */
  108026. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  108027. /**
  108028. * Gets the mesh internal Geometry object
  108029. */
  108030. get geometry(): Nullable<Geometry>;
  108031. /**
  108032. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  108033. * @returns the total number of vertices
  108034. */
  108035. getTotalVertices(): number;
  108036. /**
  108037. * Returns the content of an associated vertex buffer
  108038. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108039. * - VertexBuffer.PositionKind
  108040. * - VertexBuffer.UVKind
  108041. * - VertexBuffer.UV2Kind
  108042. * - VertexBuffer.UV3Kind
  108043. * - VertexBuffer.UV4Kind
  108044. * - VertexBuffer.UV5Kind
  108045. * - VertexBuffer.UV6Kind
  108046. * - VertexBuffer.ColorKind
  108047. * - VertexBuffer.MatricesIndicesKind
  108048. * - VertexBuffer.MatricesIndicesExtraKind
  108049. * - VertexBuffer.MatricesWeightsKind
  108050. * - VertexBuffer.MatricesWeightsExtraKind
  108051. * @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
  108052. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  108053. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  108054. */
  108055. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  108056. /**
  108057. * Returns the mesh VertexBuffer object from the requested `kind`
  108058. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108059. * - VertexBuffer.PositionKind
  108060. * - VertexBuffer.NormalKind
  108061. * - VertexBuffer.UVKind
  108062. * - VertexBuffer.UV2Kind
  108063. * - VertexBuffer.UV3Kind
  108064. * - VertexBuffer.UV4Kind
  108065. * - VertexBuffer.UV5Kind
  108066. * - VertexBuffer.UV6Kind
  108067. * - VertexBuffer.ColorKind
  108068. * - VertexBuffer.MatricesIndicesKind
  108069. * - VertexBuffer.MatricesIndicesExtraKind
  108070. * - VertexBuffer.MatricesWeightsKind
  108071. * - VertexBuffer.MatricesWeightsExtraKind
  108072. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  108073. */
  108074. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  108075. /**
  108076. * Tests if a specific vertex buffer is associated with this mesh
  108077. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108078. * - VertexBuffer.PositionKind
  108079. * - VertexBuffer.NormalKind
  108080. * - VertexBuffer.UVKind
  108081. * - VertexBuffer.UV2Kind
  108082. * - VertexBuffer.UV3Kind
  108083. * - VertexBuffer.UV4Kind
  108084. * - VertexBuffer.UV5Kind
  108085. * - VertexBuffer.UV6Kind
  108086. * - VertexBuffer.ColorKind
  108087. * - VertexBuffer.MatricesIndicesKind
  108088. * - VertexBuffer.MatricesIndicesExtraKind
  108089. * - VertexBuffer.MatricesWeightsKind
  108090. * - VertexBuffer.MatricesWeightsExtraKind
  108091. * @returns a boolean
  108092. */
  108093. isVerticesDataPresent(kind: string): boolean;
  108094. /**
  108095. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  108096. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108097. * - VertexBuffer.PositionKind
  108098. * - VertexBuffer.UVKind
  108099. * - VertexBuffer.UV2Kind
  108100. * - VertexBuffer.UV3Kind
  108101. * - VertexBuffer.UV4Kind
  108102. * - VertexBuffer.UV5Kind
  108103. * - VertexBuffer.UV6Kind
  108104. * - VertexBuffer.ColorKind
  108105. * - VertexBuffer.MatricesIndicesKind
  108106. * - VertexBuffer.MatricesIndicesExtraKind
  108107. * - VertexBuffer.MatricesWeightsKind
  108108. * - VertexBuffer.MatricesWeightsExtraKind
  108109. * @returns a boolean
  108110. */
  108111. isVertexBufferUpdatable(kind: string): boolean;
  108112. /**
  108113. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  108114. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108115. * - VertexBuffer.PositionKind
  108116. * - VertexBuffer.NormalKind
  108117. * - VertexBuffer.UVKind
  108118. * - VertexBuffer.UV2Kind
  108119. * - VertexBuffer.UV3Kind
  108120. * - VertexBuffer.UV4Kind
  108121. * - VertexBuffer.UV5Kind
  108122. * - VertexBuffer.UV6Kind
  108123. * - VertexBuffer.ColorKind
  108124. * - VertexBuffer.MatricesIndicesKind
  108125. * - VertexBuffer.MatricesIndicesExtraKind
  108126. * - VertexBuffer.MatricesWeightsKind
  108127. * - VertexBuffer.MatricesWeightsExtraKind
  108128. * @returns an array of strings
  108129. */
  108130. getVerticesDataKinds(): string[];
  108131. /**
  108132. * Returns a positive integer : the total number of indices in this mesh geometry.
  108133. * @returns the numner of indices or zero if the mesh has no geometry.
  108134. */
  108135. getTotalIndices(): number;
  108136. /**
  108137. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  108138. * @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.
  108139. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  108140. * @returns the indices array or an empty array if the mesh has no geometry
  108141. */
  108142. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  108143. get isBlocked(): boolean;
  108144. /**
  108145. * Determine if the current mesh is ready to be rendered
  108146. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  108147. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  108148. * @returns true if all associated assets are ready (material, textures, shaders)
  108149. */
  108150. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  108151. /**
  108152. * 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.
  108153. */
  108154. get areNormalsFrozen(): boolean;
  108155. /**
  108156. * 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.
  108157. * @returns the current mesh
  108158. */
  108159. freezeNormals(): Mesh;
  108160. /**
  108161. * 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
  108162. * @returns the current mesh
  108163. */
  108164. unfreezeNormals(): Mesh;
  108165. /**
  108166. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  108167. */
  108168. set overridenInstanceCount(count: number);
  108169. /** @hidden */
  108170. _preActivate(): Mesh;
  108171. /** @hidden */
  108172. _preActivateForIntermediateRendering(renderId: number): Mesh;
  108173. /** @hidden */
  108174. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  108175. protected _afterComputeWorldMatrix(): void;
  108176. /** @hidden */
  108177. _postActivate(): void;
  108178. /**
  108179. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  108180. * This means the mesh underlying bounding box and sphere are recomputed.
  108181. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  108182. * @returns the current mesh
  108183. */
  108184. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  108185. /** @hidden */
  108186. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  108187. /**
  108188. * This function will subdivide the mesh into multiple submeshes
  108189. * @param count defines the expected number of submeshes
  108190. */
  108191. subdivide(count: number): void;
  108192. /**
  108193. * Copy a FloatArray into a specific associated vertex buffer
  108194. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108195. * - VertexBuffer.PositionKind
  108196. * - VertexBuffer.UVKind
  108197. * - VertexBuffer.UV2Kind
  108198. * - VertexBuffer.UV3Kind
  108199. * - VertexBuffer.UV4Kind
  108200. * - VertexBuffer.UV5Kind
  108201. * - VertexBuffer.UV6Kind
  108202. * - VertexBuffer.ColorKind
  108203. * - VertexBuffer.MatricesIndicesKind
  108204. * - VertexBuffer.MatricesIndicesExtraKind
  108205. * - VertexBuffer.MatricesWeightsKind
  108206. * - VertexBuffer.MatricesWeightsExtraKind
  108207. * @param data defines the data source
  108208. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108209. * @param stride defines the data stride size (can be null)
  108210. * @returns the current mesh
  108211. */
  108212. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  108213. /**
  108214. * Delete a vertex buffer associated with this mesh
  108215. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  108216. * - VertexBuffer.PositionKind
  108217. * - VertexBuffer.UVKind
  108218. * - VertexBuffer.UV2Kind
  108219. * - VertexBuffer.UV3Kind
  108220. * - VertexBuffer.UV4Kind
  108221. * - VertexBuffer.UV5Kind
  108222. * - VertexBuffer.UV6Kind
  108223. * - VertexBuffer.ColorKind
  108224. * - VertexBuffer.MatricesIndicesKind
  108225. * - VertexBuffer.MatricesIndicesExtraKind
  108226. * - VertexBuffer.MatricesWeightsKind
  108227. * - VertexBuffer.MatricesWeightsExtraKind
  108228. */
  108229. removeVerticesData(kind: string): void;
  108230. /**
  108231. * Flags an associated vertex buffer as updatable
  108232. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  108233. * - VertexBuffer.PositionKind
  108234. * - VertexBuffer.UVKind
  108235. * - VertexBuffer.UV2Kind
  108236. * - VertexBuffer.UV3Kind
  108237. * - VertexBuffer.UV4Kind
  108238. * - VertexBuffer.UV5Kind
  108239. * - VertexBuffer.UV6Kind
  108240. * - VertexBuffer.ColorKind
  108241. * - VertexBuffer.MatricesIndicesKind
  108242. * - VertexBuffer.MatricesIndicesExtraKind
  108243. * - VertexBuffer.MatricesWeightsKind
  108244. * - VertexBuffer.MatricesWeightsExtraKind
  108245. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108246. */
  108247. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  108248. /**
  108249. * Sets the mesh global Vertex Buffer
  108250. * @param buffer defines the buffer to use
  108251. * @returns the current mesh
  108252. */
  108253. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  108254. /**
  108255. * Update a specific associated vertex buffer
  108256. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108257. * - VertexBuffer.PositionKind
  108258. * - VertexBuffer.UVKind
  108259. * - VertexBuffer.UV2Kind
  108260. * - VertexBuffer.UV3Kind
  108261. * - VertexBuffer.UV4Kind
  108262. * - VertexBuffer.UV5Kind
  108263. * - VertexBuffer.UV6Kind
  108264. * - VertexBuffer.ColorKind
  108265. * - VertexBuffer.MatricesIndicesKind
  108266. * - VertexBuffer.MatricesIndicesExtraKind
  108267. * - VertexBuffer.MatricesWeightsKind
  108268. * - VertexBuffer.MatricesWeightsExtraKind
  108269. * @param data defines the data source
  108270. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  108271. * @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)
  108272. * @returns the current mesh
  108273. */
  108274. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  108275. /**
  108276. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  108277. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  108278. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  108279. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  108280. * @returns the current mesh
  108281. */
  108282. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  108283. /**
  108284. * Creates a un-shared specific occurence of the geometry for the mesh.
  108285. * @returns the current mesh
  108286. */
  108287. makeGeometryUnique(): Mesh;
  108288. /**
  108289. * Set the index buffer of this mesh
  108290. * @param indices defines the source data
  108291. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  108292. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  108293. * @returns the current mesh
  108294. */
  108295. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  108296. /**
  108297. * Update the current index buffer
  108298. * @param indices defines the source data
  108299. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  108300. * @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)
  108301. * @returns the current mesh
  108302. */
  108303. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  108304. /**
  108305. * Invert the geometry to move from a right handed system to a left handed one.
  108306. * @returns the current mesh
  108307. */
  108308. toLeftHanded(): Mesh;
  108309. /** @hidden */
  108310. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  108311. /** @hidden */
  108312. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  108313. /**
  108314. * Registers for this mesh a javascript function called just before the rendering process
  108315. * @param func defines the function to call before rendering this mesh
  108316. * @returns the current mesh
  108317. */
  108318. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108319. /**
  108320. * Disposes a previously registered javascript function called before the rendering
  108321. * @param func defines the function to remove
  108322. * @returns the current mesh
  108323. */
  108324. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108325. /**
  108326. * Registers for this mesh a javascript function called just after the rendering is complete
  108327. * @param func defines the function to call after rendering this mesh
  108328. * @returns the current mesh
  108329. */
  108330. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108331. /**
  108332. * Disposes a previously registered javascript function called after the rendering.
  108333. * @param func defines the function to remove
  108334. * @returns the current mesh
  108335. */
  108336. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108337. /** @hidden */
  108338. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  108339. /** @hidden */
  108340. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  108341. /** @hidden */
  108342. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  108343. /** @hidden */
  108344. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  108345. /** @hidden */
  108346. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  108347. /** @hidden */
  108348. _rebuild(): void;
  108349. /** @hidden */
  108350. _freeze(): void;
  108351. /** @hidden */
  108352. _unFreeze(): void;
  108353. /**
  108354. * 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
  108355. * @param subMesh defines the subMesh to render
  108356. * @param enableAlphaMode defines if alpha mode can be changed
  108357. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  108358. * @returns the current mesh
  108359. */
  108360. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  108361. private _onBeforeDraw;
  108362. /**
  108363. * Renormalize the mesh and patch it up if there are no weights
  108364. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  108365. * However in the case of zero weights then we set just a single influence to 1.
  108366. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  108367. */
  108368. cleanMatrixWeights(): void;
  108369. private normalizeSkinFourWeights;
  108370. private normalizeSkinWeightsAndExtra;
  108371. /**
  108372. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  108373. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  108374. * the user know there was an issue with importing the mesh
  108375. * @returns a validation object with skinned, valid and report string
  108376. */
  108377. validateSkinning(): {
  108378. skinned: boolean;
  108379. valid: boolean;
  108380. report: string;
  108381. };
  108382. /** @hidden */
  108383. _checkDelayState(): Mesh;
  108384. private _queueLoad;
  108385. /**
  108386. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  108387. * A mesh is in the frustum if its bounding box intersects the frustum
  108388. * @param frustumPlanes defines the frustum to test
  108389. * @returns true if the mesh is in the frustum planes
  108390. */
  108391. isInFrustum(frustumPlanes: Plane[]): boolean;
  108392. /**
  108393. * Sets the mesh material by the material or multiMaterial `id` property
  108394. * @param id is a string identifying the material or the multiMaterial
  108395. * @returns the current mesh
  108396. */
  108397. setMaterialByID(id: string): Mesh;
  108398. /**
  108399. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  108400. * @returns an array of IAnimatable
  108401. */
  108402. getAnimatables(): IAnimatable[];
  108403. /**
  108404. * Modifies the mesh geometry according to the passed transformation matrix.
  108405. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  108406. * The mesh normals are modified using the same transformation.
  108407. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108408. * @param transform defines the transform matrix to use
  108409. * @see https://doc.babylonjs.com/resources/baking_transformations
  108410. * @returns the current mesh
  108411. */
  108412. bakeTransformIntoVertices(transform: Matrix): Mesh;
  108413. /**
  108414. * Modifies the mesh geometry according to its own current World Matrix.
  108415. * The mesh World Matrix is then reset.
  108416. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  108417. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108418. * @see https://doc.babylonjs.com/resources/baking_transformations
  108419. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  108420. * @returns the current mesh
  108421. */
  108422. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  108423. /** @hidden */
  108424. get _positions(): Nullable<Vector3[]>;
  108425. /** @hidden */
  108426. _resetPointsArrayCache(): Mesh;
  108427. /** @hidden */
  108428. _generatePointsArray(): boolean;
  108429. /**
  108430. * Returns a new Mesh object generated from the current mesh properties.
  108431. * This method must not get confused with createInstance()
  108432. * @param name is a string, the name given to the new mesh
  108433. * @param newParent can be any Node object (default `null`)
  108434. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  108435. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  108436. * @returns a new mesh
  108437. */
  108438. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  108439. /**
  108440. * Releases resources associated with this mesh.
  108441. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  108442. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  108443. */
  108444. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  108445. /** @hidden */
  108446. _disposeInstanceSpecificData(): void;
  108447. /** @hidden */
  108448. _disposeThinInstanceSpecificData(): void;
  108449. /**
  108450. * Modifies the mesh geometry according to a displacement map.
  108451. * 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.
  108452. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108453. * @param url is a string, the URL from the image file is to be downloaded.
  108454. * @param minHeight is the lower limit of the displacement.
  108455. * @param maxHeight is the upper limit of the displacement.
  108456. * @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.
  108457. * @param uvOffset is an optional vector2 used to offset UV.
  108458. * @param uvScale is an optional vector2 used to scale UV.
  108459. * @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.
  108460. * @returns the Mesh.
  108461. */
  108462. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108463. /**
  108464. * Modifies the mesh geometry according to a displacementMap buffer.
  108465. * 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.
  108466. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108467. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  108468. * @param heightMapWidth is the width of the buffer image.
  108469. * @param heightMapHeight is the height of the buffer image.
  108470. * @param minHeight is the lower limit of the displacement.
  108471. * @param maxHeight is the upper limit of the displacement.
  108472. * @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.
  108473. * @param uvOffset is an optional vector2 used to offset UV.
  108474. * @param uvScale is an optional vector2 used to scale UV.
  108475. * @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.
  108476. * @returns the Mesh.
  108477. */
  108478. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108479. /**
  108480. * Modify the mesh to get a flat shading rendering.
  108481. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  108482. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  108483. * @returns current mesh
  108484. */
  108485. convertToFlatShadedMesh(): Mesh;
  108486. /**
  108487. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  108488. * In other words, more vertices, no more indices and a single bigger VBO.
  108489. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  108490. * @returns current mesh
  108491. */
  108492. convertToUnIndexedMesh(): Mesh;
  108493. /**
  108494. * Inverses facet orientations.
  108495. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108496. * @param flipNormals will also inverts the normals
  108497. * @returns current mesh
  108498. */
  108499. flipFaces(flipNormals?: boolean): Mesh;
  108500. /**
  108501. * Increase the number of facets and hence vertices in a mesh
  108502. * Vertex normals are interpolated from existing vertex normals
  108503. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108504. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  108505. */
  108506. increaseVertices(numberPerEdge: number): void;
  108507. /**
  108508. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  108509. * This will undo any application of covertToFlatShadedMesh
  108510. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108511. */
  108512. forceSharedVertices(): void;
  108513. /** @hidden */
  108514. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  108515. /** @hidden */
  108516. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  108517. /**
  108518. * Creates a new InstancedMesh object from the mesh model.
  108519. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108520. * @param name defines the name of the new instance
  108521. * @returns a new InstancedMesh
  108522. */
  108523. createInstance(name: string): InstancedMesh;
  108524. /**
  108525. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  108526. * After this call, all the mesh instances have the same submeshes than the current mesh.
  108527. * @returns the current mesh
  108528. */
  108529. synchronizeInstances(): Mesh;
  108530. /**
  108531. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  108532. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  108533. * This should be used together with the simplification to avoid disappearing triangles.
  108534. * @param successCallback an optional success callback to be called after the optimization finished.
  108535. * @returns the current mesh
  108536. */
  108537. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  108538. /**
  108539. * Serialize current mesh
  108540. * @param serializationObject defines the object which will receive the serialization data
  108541. */
  108542. serialize(serializationObject: any): void;
  108543. /** @hidden */
  108544. _syncGeometryWithMorphTargetManager(): void;
  108545. /** @hidden */
  108546. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  108547. /**
  108548. * Returns a new Mesh object parsed from the source provided.
  108549. * @param parsedMesh is the source
  108550. * @param scene defines the hosting scene
  108551. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  108552. * @returns a new Mesh
  108553. */
  108554. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  108555. /**
  108556. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  108557. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108558. * @param name defines the name of the mesh to create
  108559. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  108560. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  108561. * @param closePath creates a seam between the first and the last points of each path of the path array
  108562. * @param offset is taken in account only if the `pathArray` is containing a single path
  108563. * @param scene defines the hosting scene
  108564. * @param updatable defines if the mesh must be flagged as updatable
  108565. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108566. * @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)
  108567. * @returns a new Mesh
  108568. */
  108569. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108570. /**
  108571. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  108572. * @param name defines the name of the mesh to create
  108573. * @param radius sets the radius size (float) of the polygon (default 0.5)
  108574. * @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
  108575. * @param scene defines the hosting scene
  108576. * @param updatable defines if the mesh must be flagged as updatable
  108577. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108578. * @returns a new Mesh
  108579. */
  108580. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108581. /**
  108582. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  108583. * @param name defines the name of the mesh to create
  108584. * @param size sets the size (float) of each box side (default 1)
  108585. * @param scene defines the hosting scene
  108586. * @param updatable defines if the mesh must be flagged as updatable
  108587. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108588. * @returns a new Mesh
  108589. */
  108590. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108591. /**
  108592. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  108593. * @param name defines the name of the mesh to create
  108594. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108595. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108596. * @param scene defines the hosting scene
  108597. * @param updatable defines if the mesh must be flagged as updatable
  108598. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108599. * @returns a new Mesh
  108600. */
  108601. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108602. /**
  108603. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  108604. * @param name defines the name of the mesh to create
  108605. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108606. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108607. * @param scene defines the hosting scene
  108608. * @returns a new Mesh
  108609. */
  108610. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  108611. /**
  108612. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  108613. * @param name defines the name of the mesh to create
  108614. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  108615. * @param diameterTop set the top cap diameter (floats, default 1)
  108616. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  108617. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  108618. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  108619. * @param scene defines the hosting scene
  108620. * @param updatable defines if the mesh must be flagged as updatable
  108621. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108622. * @returns a new Mesh
  108623. */
  108624. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  108625. /**
  108626. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  108627. * @param name defines the name of the mesh to create
  108628. * @param diameter sets the diameter size (float) of the torus (default 1)
  108629. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  108630. * @param tessellation sets the number of torus sides (postive integer, default 16)
  108631. * @param scene defines the hosting scene
  108632. * @param updatable defines if the mesh must be flagged as updatable
  108633. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108634. * @returns a new Mesh
  108635. */
  108636. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108637. /**
  108638. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  108639. * @param name defines the name of the mesh to create
  108640. * @param radius sets the global radius size (float) of the torus knot (default 2)
  108641. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  108642. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  108643. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  108644. * @param p the number of windings on X axis (positive integers, default 2)
  108645. * @param q the number of windings on Y axis (positive integers, default 3)
  108646. * @param scene defines the hosting scene
  108647. * @param updatable defines if the mesh must be flagged as updatable
  108648. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108649. * @returns a new Mesh
  108650. */
  108651. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108652. /**
  108653. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  108654. * @param name defines the name of the mesh to create
  108655. * @param points is an array successive Vector3
  108656. * @param scene defines the hosting scene
  108657. * @param updatable defines if the mesh must be flagged as updatable
  108658. * @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).
  108659. * @returns a new Mesh
  108660. */
  108661. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  108662. /**
  108663. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  108664. * @param name defines the name of the mesh to create
  108665. * @param points is an array successive Vector3
  108666. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  108667. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  108668. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  108669. * @param scene defines the hosting scene
  108670. * @param updatable defines if the mesh must be flagged as updatable
  108671. * @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)
  108672. * @returns a new Mesh
  108673. */
  108674. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  108675. /**
  108676. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  108677. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  108678. * 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.
  108679. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108680. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108681. * Remember you can only change the shape positions, not their number when updating a polygon.
  108682. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  108683. * @param name defines the name of the mesh to create
  108684. * @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
  108685. * @param scene defines the hosting scene
  108686. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108687. * @param updatable defines if the mesh must be flagged as updatable
  108688. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108689. * @param earcutInjection can be used to inject your own earcut reference
  108690. * @returns a new Mesh
  108691. */
  108692. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108693. /**
  108694. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  108695. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  108696. * @param name defines the name of the mesh to create
  108697. * @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
  108698. * @param depth defines the height of extrusion
  108699. * @param scene defines the hosting scene
  108700. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108701. * @param updatable defines if the mesh must be flagged as updatable
  108702. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108703. * @param earcutInjection can be used to inject your own earcut reference
  108704. * @returns a new Mesh
  108705. */
  108706. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108707. /**
  108708. * Creates an extruded shape mesh.
  108709. * 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
  108710. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108711. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108712. * @param name defines the name of the mesh to create
  108713. * @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
  108714. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108715. * @param scale is the value to scale the shape
  108716. * @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
  108717. * @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
  108718. * @param scene defines the hosting scene
  108719. * @param updatable defines if the mesh must be flagged as updatable
  108720. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108721. * @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)
  108722. * @returns a new Mesh
  108723. */
  108724. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108725. /**
  108726. * Creates an custom extruded shape mesh.
  108727. * The custom extrusion is a parametric shape.
  108728. * It has no predefined shape. Its final shape will depend on the input parameters.
  108729. * Please consider using the same method from the MeshBuilder class instead
  108730. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108731. * @param name defines the name of the mesh to create
  108732. * @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
  108733. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108734. * @param scaleFunction is a custom Javascript function called on each path point
  108735. * @param rotationFunction is a custom Javascript function called on each path point
  108736. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  108737. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  108738. * @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
  108739. * @param scene defines the hosting scene
  108740. * @param updatable defines if the mesh must be flagged as updatable
  108741. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108742. * @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)
  108743. * @returns a new Mesh
  108744. */
  108745. 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;
  108746. /**
  108747. * Creates lathe mesh.
  108748. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  108749. * Please consider using the same method from the MeshBuilder class instead
  108750. * @param name defines the name of the mesh to create
  108751. * @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
  108752. * @param radius is the radius value of the lathe
  108753. * @param tessellation is the side number of the lathe.
  108754. * @param scene defines the hosting scene
  108755. * @param updatable defines if the mesh must be flagged as updatable
  108756. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108757. * @returns a new Mesh
  108758. */
  108759. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108760. /**
  108761. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  108762. * @param name defines the name of the mesh to create
  108763. * @param size sets the size (float) of both sides of the plane at once (default 1)
  108764. * @param scene defines the hosting scene
  108765. * @param updatable defines if the mesh must be flagged as updatable
  108766. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108767. * @returns a new Mesh
  108768. */
  108769. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108770. /**
  108771. * Creates a ground mesh.
  108772. * Please consider using the same method from the MeshBuilder class instead
  108773. * @param name defines the name of the mesh to create
  108774. * @param width set the width of the ground
  108775. * @param height set the height of the ground
  108776. * @param subdivisions sets the number of subdivisions per side
  108777. * @param scene defines the hosting scene
  108778. * @param updatable defines if the mesh must be flagged as updatable
  108779. * @returns a new Mesh
  108780. */
  108781. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  108782. /**
  108783. * Creates a tiled ground mesh.
  108784. * Please consider using the same method from the MeshBuilder class instead
  108785. * @param name defines the name of the mesh to create
  108786. * @param xmin set the ground minimum X coordinate
  108787. * @param zmin set the ground minimum Y coordinate
  108788. * @param xmax set the ground maximum X coordinate
  108789. * @param zmax set the ground maximum Z coordinate
  108790. * @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
  108791. * @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
  108792. * @param scene defines the hosting scene
  108793. * @param updatable defines if the mesh must be flagged as updatable
  108794. * @returns a new Mesh
  108795. */
  108796. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  108797. w: number;
  108798. h: number;
  108799. }, precision: {
  108800. w: number;
  108801. h: number;
  108802. }, scene: Scene, updatable?: boolean): Mesh;
  108803. /**
  108804. * Creates a ground mesh from a height map.
  108805. * Please consider using the same method from the MeshBuilder class instead
  108806. * @see https://doc.babylonjs.com/babylon101/height_map
  108807. * @param name defines the name of the mesh to create
  108808. * @param url sets the URL of the height map image resource
  108809. * @param width set the ground width size
  108810. * @param height set the ground height size
  108811. * @param subdivisions sets the number of subdivision per side
  108812. * @param minHeight is the minimum altitude on the ground
  108813. * @param maxHeight is the maximum altitude on the ground
  108814. * @param scene defines the hosting scene
  108815. * @param updatable defines if the mesh must be flagged as updatable
  108816. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  108817. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  108818. * @returns a new Mesh
  108819. */
  108820. 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;
  108821. /**
  108822. * Creates a tube mesh.
  108823. * The tube is a parametric shape.
  108824. * It has no predefined shape. Its final shape will depend on the input parameters.
  108825. * Please consider using the same method from the MeshBuilder class instead
  108826. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108827. * @param name defines the name of the mesh to create
  108828. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  108829. * @param radius sets the tube radius size
  108830. * @param tessellation is the number of sides on the tubular surface
  108831. * @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
  108832. * @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
  108833. * @param scene defines the hosting scene
  108834. * @param updatable defines if the mesh must be flagged as updatable
  108835. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108836. * @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)
  108837. * @returns a new Mesh
  108838. */
  108839. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  108840. (i: number, distance: number): number;
  108841. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108842. /**
  108843. * Creates a polyhedron mesh.
  108844. * Please consider using the same method from the MeshBuilder class instead.
  108845. * * 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
  108846. * * The parameter `size` (positive float, default 1) sets the polygon size
  108847. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  108848. * * 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`
  108849. * * 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
  108850. * * 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)`)
  108851. * * 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
  108852. * * 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
  108853. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108854. * * 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
  108855. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108856. * @param name defines the name of the mesh to create
  108857. * @param options defines the options used to create the mesh
  108858. * @param scene defines the hosting scene
  108859. * @returns a new Mesh
  108860. */
  108861. static CreatePolyhedron(name: string, options: {
  108862. type?: number;
  108863. size?: number;
  108864. sizeX?: number;
  108865. sizeY?: number;
  108866. sizeZ?: number;
  108867. custom?: any;
  108868. faceUV?: Vector4[];
  108869. faceColors?: Color4[];
  108870. updatable?: boolean;
  108871. sideOrientation?: number;
  108872. }, scene: Scene): Mesh;
  108873. /**
  108874. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  108875. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  108876. * * 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`)
  108877. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  108878. * * 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
  108879. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108880. * * 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
  108881. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108882. * @param name defines the name of the mesh
  108883. * @param options defines the options used to create the mesh
  108884. * @param scene defines the hosting scene
  108885. * @returns a new Mesh
  108886. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  108887. */
  108888. static CreateIcoSphere(name: string, options: {
  108889. radius?: number;
  108890. flat?: boolean;
  108891. subdivisions?: number;
  108892. sideOrientation?: number;
  108893. updatable?: boolean;
  108894. }, scene: Scene): Mesh;
  108895. /**
  108896. * Creates a decal mesh.
  108897. * Please consider using the same method from the MeshBuilder class instead.
  108898. * A decal is a mesh usually applied as a model onto the surface of another mesh
  108899. * @param name defines the name of the mesh
  108900. * @param sourceMesh defines the mesh receiving the decal
  108901. * @param position sets the position of the decal in world coordinates
  108902. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  108903. * @param size sets the decal scaling
  108904. * @param angle sets the angle to rotate the decal
  108905. * @returns a new Mesh
  108906. */
  108907. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  108908. /**
  108909. * Prepare internal position array for software CPU skinning
  108910. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  108911. */
  108912. setPositionsForCPUSkinning(): Float32Array;
  108913. /**
  108914. * Prepare internal normal array for software CPU skinning
  108915. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  108916. */
  108917. setNormalsForCPUSkinning(): Float32Array;
  108918. /**
  108919. * Updates the vertex buffer by applying transformation from the bones
  108920. * @param skeleton defines the skeleton to apply to current mesh
  108921. * @returns the current mesh
  108922. */
  108923. applySkeleton(skeleton: Skeleton): Mesh;
  108924. /**
  108925. * 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
  108926. * @param meshes defines the list of meshes to scan
  108927. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  108928. */
  108929. static MinMax(meshes: AbstractMesh[]): {
  108930. min: Vector3;
  108931. max: Vector3;
  108932. };
  108933. /**
  108934. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  108935. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  108936. * @returns a vector3
  108937. */
  108938. static Center(meshesOrMinMaxVector: {
  108939. min: Vector3;
  108940. max: Vector3;
  108941. } | AbstractMesh[]): Vector3;
  108942. /**
  108943. * Merge the array of meshes into a single mesh for performance reasons.
  108944. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  108945. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  108946. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  108947. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  108948. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  108949. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  108950. * @returns a new mesh
  108951. */
  108952. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  108953. /** @hidden */
  108954. addInstance(instance: InstancedMesh): void;
  108955. /** @hidden */
  108956. removeInstance(instance: InstancedMesh): void;
  108957. }
  108958. }
  108959. declare module BABYLON {
  108960. /**
  108961. * This is the base class of all the camera used in the application.
  108962. * @see https://doc.babylonjs.com/features/cameras
  108963. */
  108964. export class Camera extends Node {
  108965. /** @hidden */
  108966. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  108967. /**
  108968. * This is the default projection mode used by the cameras.
  108969. * It helps recreating a feeling of perspective and better appreciate depth.
  108970. * This is the best way to simulate real life cameras.
  108971. */
  108972. static readonly PERSPECTIVE_CAMERA: number;
  108973. /**
  108974. * This helps creating camera with an orthographic mode.
  108975. * 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.
  108976. */
  108977. static readonly ORTHOGRAPHIC_CAMERA: number;
  108978. /**
  108979. * This is the default FOV mode for perspective cameras.
  108980. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  108981. */
  108982. static readonly FOVMODE_VERTICAL_FIXED: number;
  108983. /**
  108984. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  108985. */
  108986. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  108987. /**
  108988. * This specifies ther is no need for a camera rig.
  108989. * Basically only one eye is rendered corresponding to the camera.
  108990. */
  108991. static readonly RIG_MODE_NONE: number;
  108992. /**
  108993. * Simulates a camera Rig with one blue eye and one red eye.
  108994. * This can be use with 3d blue and red glasses.
  108995. */
  108996. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  108997. /**
  108998. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  108999. */
  109000. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  109001. /**
  109002. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  109003. */
  109004. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  109005. /**
  109006. * Defines that both eyes of the camera will be rendered over under each other.
  109007. */
  109008. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  109009. /**
  109010. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  109011. */
  109012. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  109013. /**
  109014. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  109015. */
  109016. static readonly RIG_MODE_VR: number;
  109017. /**
  109018. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  109019. */
  109020. static readonly RIG_MODE_WEBVR: number;
  109021. /**
  109022. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  109023. */
  109024. static readonly RIG_MODE_CUSTOM: number;
  109025. /**
  109026. * Defines if by default attaching controls should prevent the default javascript event to continue.
  109027. */
  109028. static ForceAttachControlToAlwaysPreventDefault: boolean;
  109029. /**
  109030. * Define the input manager associated with the camera.
  109031. */
  109032. inputs: CameraInputsManager<Camera>;
  109033. /** @hidden */
  109034. _position: Vector3;
  109035. /**
  109036. * Define the current local position of the camera in the scene
  109037. */
  109038. get position(): Vector3;
  109039. set position(newPosition: Vector3);
  109040. protected _upVector: Vector3;
  109041. /**
  109042. * The vector the camera should consider as up.
  109043. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  109044. */
  109045. set upVector(vec: Vector3);
  109046. get upVector(): Vector3;
  109047. /**
  109048. * Define the current limit on the left side for an orthographic camera
  109049. * In scene unit
  109050. */
  109051. orthoLeft: Nullable<number>;
  109052. /**
  109053. * Define the current limit on the right side for an orthographic camera
  109054. * In scene unit
  109055. */
  109056. orthoRight: Nullable<number>;
  109057. /**
  109058. * Define the current limit on the bottom side for an orthographic camera
  109059. * In scene unit
  109060. */
  109061. orthoBottom: Nullable<number>;
  109062. /**
  109063. * Define the current limit on the top side for an orthographic camera
  109064. * In scene unit
  109065. */
  109066. orthoTop: Nullable<number>;
  109067. /**
  109068. * Field Of View is set in Radians. (default is 0.8)
  109069. */
  109070. fov: number;
  109071. /**
  109072. * Define the minimum distance the camera can see from.
  109073. * This is important to note that the depth buffer are not infinite and the closer it starts
  109074. * the more your scene might encounter depth fighting issue.
  109075. */
  109076. minZ: number;
  109077. /**
  109078. * Define the maximum distance the camera can see to.
  109079. * This is important to note that the depth buffer are not infinite and the further it end
  109080. * the more your scene might encounter depth fighting issue.
  109081. */
  109082. maxZ: number;
  109083. /**
  109084. * Define the default inertia of the camera.
  109085. * This helps giving a smooth feeling to the camera movement.
  109086. */
  109087. inertia: number;
  109088. /**
  109089. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  109090. */
  109091. mode: number;
  109092. /**
  109093. * Define whether the camera is intermediate.
  109094. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  109095. */
  109096. isIntermediate: boolean;
  109097. /**
  109098. * Define the viewport of the camera.
  109099. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  109100. */
  109101. viewport: Viewport;
  109102. /**
  109103. * Restricts the camera to viewing objects with the same layerMask.
  109104. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  109105. */
  109106. layerMask: number;
  109107. /**
  109108. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  109109. */
  109110. fovMode: number;
  109111. /**
  109112. * Rig mode of the camera.
  109113. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  109114. * This is normally controlled byt the camera themselves as internal use.
  109115. */
  109116. cameraRigMode: number;
  109117. /**
  109118. * Defines the distance between both "eyes" in case of a RIG
  109119. */
  109120. interaxialDistance: number;
  109121. /**
  109122. * Defines if stereoscopic rendering is done side by side or over under.
  109123. */
  109124. isStereoscopicSideBySide: boolean;
  109125. /**
  109126. * 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
  109127. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  109128. * else in the scene. (Eg. security camera)
  109129. *
  109130. * 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)
  109131. */
  109132. customRenderTargets: RenderTargetTexture[];
  109133. /**
  109134. * When set, the camera will render to this render target instead of the default canvas
  109135. *
  109136. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  109137. */
  109138. outputRenderTarget: Nullable<RenderTargetTexture>;
  109139. /**
  109140. * Observable triggered when the camera view matrix has changed.
  109141. */
  109142. onViewMatrixChangedObservable: Observable<Camera>;
  109143. /**
  109144. * Observable triggered when the camera Projection matrix has changed.
  109145. */
  109146. onProjectionMatrixChangedObservable: Observable<Camera>;
  109147. /**
  109148. * Observable triggered when the inputs have been processed.
  109149. */
  109150. onAfterCheckInputsObservable: Observable<Camera>;
  109151. /**
  109152. * Observable triggered when reset has been called and applied to the camera.
  109153. */
  109154. onRestoreStateObservable: Observable<Camera>;
  109155. /**
  109156. * Is this camera a part of a rig system?
  109157. */
  109158. isRigCamera: boolean;
  109159. /**
  109160. * If isRigCamera set to true this will be set with the parent camera.
  109161. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  109162. */
  109163. rigParent?: Camera;
  109164. /** @hidden */
  109165. _cameraRigParams: any;
  109166. /** @hidden */
  109167. _rigCameras: Camera[];
  109168. /** @hidden */
  109169. _rigPostProcess: Nullable<PostProcess>;
  109170. protected _webvrViewMatrix: Matrix;
  109171. /** @hidden */
  109172. _skipRendering: boolean;
  109173. /** @hidden */
  109174. _projectionMatrix: Matrix;
  109175. /** @hidden */
  109176. _postProcesses: Nullable<PostProcess>[];
  109177. /** @hidden */
  109178. _activeMeshes: SmartArray<AbstractMesh>;
  109179. protected _globalPosition: Vector3;
  109180. /** @hidden */
  109181. _computedViewMatrix: Matrix;
  109182. private _doNotComputeProjectionMatrix;
  109183. private _transformMatrix;
  109184. private _frustumPlanes;
  109185. private _refreshFrustumPlanes;
  109186. private _storedFov;
  109187. private _stateStored;
  109188. /**
  109189. * Instantiates a new camera object.
  109190. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  109191. * @see https://doc.babylonjs.com/features/cameras
  109192. * @param name Defines the name of the camera in the scene
  109193. * @param position Defines the position of the camera
  109194. * @param scene Defines the scene the camera belongs too
  109195. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  109196. */
  109197. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  109198. /**
  109199. * Store current camera state (fov, position, etc..)
  109200. * @returns the camera
  109201. */
  109202. storeState(): Camera;
  109203. /**
  109204. * Restores the camera state values if it has been stored. You must call storeState() first
  109205. */
  109206. protected _restoreStateValues(): boolean;
  109207. /**
  109208. * Restored camera state. You must call storeState() first.
  109209. * @returns true if restored and false otherwise
  109210. */
  109211. restoreState(): boolean;
  109212. /**
  109213. * Gets the class name of the camera.
  109214. * @returns the class name
  109215. */
  109216. getClassName(): string;
  109217. /** @hidden */
  109218. readonly _isCamera: boolean;
  109219. /**
  109220. * Gets a string representation of the camera useful for debug purpose.
  109221. * @param fullDetails Defines that a more verboe level of logging is required
  109222. * @returns the string representation
  109223. */
  109224. toString(fullDetails?: boolean): string;
  109225. /**
  109226. * Gets the current world space position of the camera.
  109227. */
  109228. get globalPosition(): Vector3;
  109229. /**
  109230. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  109231. * @returns the active meshe list
  109232. */
  109233. getActiveMeshes(): SmartArray<AbstractMesh>;
  109234. /**
  109235. * Check whether a mesh is part of the current active mesh list of the camera
  109236. * @param mesh Defines the mesh to check
  109237. * @returns true if active, false otherwise
  109238. */
  109239. isActiveMesh(mesh: Mesh): boolean;
  109240. /**
  109241. * Is this camera ready to be used/rendered
  109242. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  109243. * @return true if the camera is ready
  109244. */
  109245. isReady(completeCheck?: boolean): boolean;
  109246. /** @hidden */
  109247. _initCache(): void;
  109248. /** @hidden */
  109249. _updateCache(ignoreParentClass?: boolean): void;
  109250. /** @hidden */
  109251. _isSynchronized(): boolean;
  109252. /** @hidden */
  109253. _isSynchronizedViewMatrix(): boolean;
  109254. /** @hidden */
  109255. _isSynchronizedProjectionMatrix(): boolean;
  109256. /**
  109257. * Attach the input controls to a specific dom element to get the input from.
  109258. * @param element Defines the element the controls should be listened from
  109259. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  109260. */
  109261. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  109262. /**
  109263. * Detach the current controls from the specified dom element.
  109264. * @param element Defines the element to stop listening the inputs from
  109265. */
  109266. detachControl(element: HTMLElement): void;
  109267. /**
  109268. * Update the camera state according to the different inputs gathered during the frame.
  109269. */
  109270. update(): void;
  109271. /** @hidden */
  109272. _checkInputs(): void;
  109273. /** @hidden */
  109274. get rigCameras(): Camera[];
  109275. /**
  109276. * Gets the post process used by the rig cameras
  109277. */
  109278. get rigPostProcess(): Nullable<PostProcess>;
  109279. /**
  109280. * Internal, gets the first post proces.
  109281. * @returns the first post process to be run on this camera.
  109282. */
  109283. _getFirstPostProcess(): Nullable<PostProcess>;
  109284. private _cascadePostProcessesToRigCams;
  109285. /**
  109286. * Attach a post process to the camera.
  109287. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109288. * @param postProcess The post process to attach to the camera
  109289. * @param insertAt The position of the post process in case several of them are in use in the scene
  109290. * @returns the position the post process has been inserted at
  109291. */
  109292. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  109293. /**
  109294. * Detach a post process to the camera.
  109295. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109296. * @param postProcess The post process to detach from the camera
  109297. */
  109298. detachPostProcess(postProcess: PostProcess): void;
  109299. /**
  109300. * Gets the current world matrix of the camera
  109301. */
  109302. getWorldMatrix(): Matrix;
  109303. /** @hidden */
  109304. _getViewMatrix(): Matrix;
  109305. /**
  109306. * Gets the current view matrix of the camera.
  109307. * @param force forces the camera to recompute the matrix without looking at the cached state
  109308. * @returns the view matrix
  109309. */
  109310. getViewMatrix(force?: boolean): Matrix;
  109311. /**
  109312. * Freeze the projection matrix.
  109313. * It will prevent the cache check of the camera projection compute and can speed up perf
  109314. * if no parameter of the camera are meant to change
  109315. * @param projection Defines manually a projection if necessary
  109316. */
  109317. freezeProjectionMatrix(projection?: Matrix): void;
  109318. /**
  109319. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  109320. */
  109321. unfreezeProjectionMatrix(): void;
  109322. /**
  109323. * Gets the current projection matrix of the camera.
  109324. * @param force forces the camera to recompute the matrix without looking at the cached state
  109325. * @returns the projection matrix
  109326. */
  109327. getProjectionMatrix(force?: boolean): Matrix;
  109328. /**
  109329. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  109330. * @returns a Matrix
  109331. */
  109332. getTransformationMatrix(): Matrix;
  109333. private _updateFrustumPlanes;
  109334. /**
  109335. * Checks if a cullable object (mesh...) is in the camera frustum
  109336. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  109337. * @param target The object to check
  109338. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  109339. * @returns true if the object is in frustum otherwise false
  109340. */
  109341. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  109342. /**
  109343. * Checks if a cullable object (mesh...) is in the camera frustum
  109344. * Unlike isInFrustum this cheks the full bounding box
  109345. * @param target The object to check
  109346. * @returns true if the object is in frustum otherwise false
  109347. */
  109348. isCompletelyInFrustum(target: ICullable): boolean;
  109349. /**
  109350. * Gets a ray in the forward direction from the camera.
  109351. * @param length Defines the length of the ray to create
  109352. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109353. * @param origin Defines the start point of the ray which defaults to the camera position
  109354. * @returns the forward ray
  109355. */
  109356. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109357. /**
  109358. * Gets a ray in the forward direction from the camera.
  109359. * @param refRay the ray to (re)use when setting the values
  109360. * @param length Defines the length of the ray to create
  109361. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109362. * @param origin Defines the start point of the ray which defaults to the camera position
  109363. * @returns the forward ray
  109364. */
  109365. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109366. /**
  109367. * Releases resources associated with this node.
  109368. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109369. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109370. */
  109371. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109372. /** @hidden */
  109373. _isLeftCamera: boolean;
  109374. /**
  109375. * Gets the left camera of a rig setup in case of Rigged Camera
  109376. */
  109377. get isLeftCamera(): boolean;
  109378. /** @hidden */
  109379. _isRightCamera: boolean;
  109380. /**
  109381. * Gets the right camera of a rig setup in case of Rigged Camera
  109382. */
  109383. get isRightCamera(): boolean;
  109384. /**
  109385. * Gets the left camera of a rig setup in case of Rigged Camera
  109386. */
  109387. get leftCamera(): Nullable<FreeCamera>;
  109388. /**
  109389. * Gets the right camera of a rig setup in case of Rigged Camera
  109390. */
  109391. get rightCamera(): Nullable<FreeCamera>;
  109392. /**
  109393. * Gets the left camera target of a rig setup in case of Rigged Camera
  109394. * @returns the target position
  109395. */
  109396. getLeftTarget(): Nullable<Vector3>;
  109397. /**
  109398. * Gets the right camera target of a rig setup in case of Rigged Camera
  109399. * @returns the target position
  109400. */
  109401. getRightTarget(): Nullable<Vector3>;
  109402. /**
  109403. * @hidden
  109404. */
  109405. setCameraRigMode(mode: number, rigParams: any): void;
  109406. /** @hidden */
  109407. static _setStereoscopicRigMode(camera: Camera): void;
  109408. /** @hidden */
  109409. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  109410. /** @hidden */
  109411. static _setVRRigMode(camera: Camera, rigParams: any): void;
  109412. /** @hidden */
  109413. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  109414. /** @hidden */
  109415. _getVRProjectionMatrix(): Matrix;
  109416. protected _updateCameraRotationMatrix(): void;
  109417. protected _updateWebVRCameraRotationMatrix(): void;
  109418. /**
  109419. * This function MUST be overwritten by the different WebVR cameras available.
  109420. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109421. * @hidden
  109422. */
  109423. _getWebVRProjectionMatrix(): Matrix;
  109424. /**
  109425. * This function MUST be overwritten by the different WebVR cameras available.
  109426. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109427. * @hidden
  109428. */
  109429. _getWebVRViewMatrix(): Matrix;
  109430. /** @hidden */
  109431. setCameraRigParameter(name: string, value: any): void;
  109432. /**
  109433. * needs to be overridden by children so sub has required properties to be copied
  109434. * @hidden
  109435. */
  109436. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  109437. /**
  109438. * May need to be overridden by children
  109439. * @hidden
  109440. */
  109441. _updateRigCameras(): void;
  109442. /** @hidden */
  109443. _setupInputs(): void;
  109444. /**
  109445. * Serialiaze the camera setup to a json represention
  109446. * @returns the JSON representation
  109447. */
  109448. serialize(): any;
  109449. /**
  109450. * Clones the current camera.
  109451. * @param name The cloned camera name
  109452. * @returns the cloned camera
  109453. */
  109454. clone(name: string): Camera;
  109455. /**
  109456. * Gets the direction of the camera relative to a given local axis.
  109457. * @param localAxis Defines the reference axis to provide a relative direction.
  109458. * @return the direction
  109459. */
  109460. getDirection(localAxis: Vector3): Vector3;
  109461. /**
  109462. * Returns the current camera absolute rotation
  109463. */
  109464. get absoluteRotation(): Quaternion;
  109465. /**
  109466. * Gets the direction of the camera relative to a given local axis into a passed vector.
  109467. * @param localAxis Defines the reference axis to provide a relative direction.
  109468. * @param result Defines the vector to store the result in
  109469. */
  109470. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  109471. /**
  109472. * Gets a camera constructor for a given camera type
  109473. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  109474. * @param name The name of the camera the result will be able to instantiate
  109475. * @param scene The scene the result will construct the camera in
  109476. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  109477. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  109478. * @returns a factory method to construc the camera
  109479. */
  109480. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  109481. /**
  109482. * Compute the world matrix of the camera.
  109483. * @returns the camera world matrix
  109484. */
  109485. computeWorldMatrix(): Matrix;
  109486. /**
  109487. * Parse a JSON and creates the camera from the parsed information
  109488. * @param parsedCamera The JSON to parse
  109489. * @param scene The scene to instantiate the camera in
  109490. * @returns the newly constructed camera
  109491. */
  109492. static Parse(parsedCamera: any, scene: Scene): Camera;
  109493. }
  109494. }
  109495. declare module BABYLON {
  109496. /**
  109497. * Class containing static functions to help procedurally build meshes
  109498. */
  109499. export class DiscBuilder {
  109500. /**
  109501. * Creates a plane polygonal mesh. By default, this is a disc
  109502. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  109503. * * 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
  109504. * * 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
  109505. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109506. * * 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
  109507. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109508. * @param name defines the name of the mesh
  109509. * @param options defines the options used to create the mesh
  109510. * @param scene defines the hosting scene
  109511. * @returns the plane polygonal mesh
  109512. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  109513. */
  109514. static CreateDisc(name: string, options: {
  109515. radius?: number;
  109516. tessellation?: number;
  109517. arc?: number;
  109518. updatable?: boolean;
  109519. sideOrientation?: number;
  109520. frontUVs?: Vector4;
  109521. backUVs?: Vector4;
  109522. }, scene?: Nullable<Scene>): Mesh;
  109523. }
  109524. }
  109525. declare module BABYLON {
  109526. /**
  109527. * Options to be used when creating a FresnelParameters.
  109528. */
  109529. export type IFresnelParametersCreationOptions = {
  109530. /**
  109531. * Define the color used on edges (grazing angle)
  109532. */
  109533. leftColor?: Color3;
  109534. /**
  109535. * Define the color used on center
  109536. */
  109537. rightColor?: Color3;
  109538. /**
  109539. * Define bias applied to computed fresnel term
  109540. */
  109541. bias?: number;
  109542. /**
  109543. * Defined the power exponent applied to fresnel term
  109544. */
  109545. power?: number;
  109546. /**
  109547. * Define if the fresnel effect is enable or not.
  109548. */
  109549. isEnabled?: boolean;
  109550. };
  109551. /**
  109552. * Serialized format for FresnelParameters.
  109553. */
  109554. export type IFresnelParametersSerialized = {
  109555. /**
  109556. * Define the color used on edges (grazing angle) [as an array]
  109557. */
  109558. leftColor: number[];
  109559. /**
  109560. * Define the color used on center [as an array]
  109561. */
  109562. rightColor: number[];
  109563. /**
  109564. * Define bias applied to computed fresnel term
  109565. */
  109566. bias: number;
  109567. /**
  109568. * Defined the power exponent applied to fresnel term
  109569. */
  109570. power?: number;
  109571. /**
  109572. * Define if the fresnel effect is enable or not.
  109573. */
  109574. isEnabled: boolean;
  109575. };
  109576. /**
  109577. * This represents all the required information to add a fresnel effect on a material:
  109578. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109579. */
  109580. export class FresnelParameters {
  109581. private _isEnabled;
  109582. /**
  109583. * Define if the fresnel effect is enable or not.
  109584. */
  109585. get isEnabled(): boolean;
  109586. set isEnabled(value: boolean);
  109587. /**
  109588. * Define the color used on edges (grazing angle)
  109589. */
  109590. leftColor: Color3;
  109591. /**
  109592. * Define the color used on center
  109593. */
  109594. rightColor: Color3;
  109595. /**
  109596. * Define bias applied to computed fresnel term
  109597. */
  109598. bias: number;
  109599. /**
  109600. * Defined the power exponent applied to fresnel term
  109601. */
  109602. power: number;
  109603. /**
  109604. * Creates a new FresnelParameters object.
  109605. *
  109606. * @param options provide your own settings to optionally to override defaults
  109607. */
  109608. constructor(options?: IFresnelParametersCreationOptions);
  109609. /**
  109610. * Clones the current fresnel and its valuues
  109611. * @returns a clone fresnel configuration
  109612. */
  109613. clone(): FresnelParameters;
  109614. /**
  109615. * Determines equality between FresnelParameters objects
  109616. * @param otherFresnelParameters defines the second operand
  109617. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  109618. */
  109619. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  109620. /**
  109621. * Serializes the current fresnel parameters to a JSON representation.
  109622. * @return the JSON serialization
  109623. */
  109624. serialize(): IFresnelParametersSerialized;
  109625. /**
  109626. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  109627. * @param parsedFresnelParameters Define the JSON representation
  109628. * @returns the parsed parameters
  109629. */
  109630. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  109631. }
  109632. }
  109633. declare module BABYLON {
  109634. /**
  109635. * This groups all the flags used to control the materials channel.
  109636. */
  109637. export class MaterialFlags {
  109638. private static _DiffuseTextureEnabled;
  109639. /**
  109640. * Are diffuse textures enabled in the application.
  109641. */
  109642. static get DiffuseTextureEnabled(): boolean;
  109643. static set DiffuseTextureEnabled(value: boolean);
  109644. private static _DetailTextureEnabled;
  109645. /**
  109646. * Are detail textures enabled in the application.
  109647. */
  109648. static get DetailTextureEnabled(): boolean;
  109649. static set DetailTextureEnabled(value: boolean);
  109650. private static _AmbientTextureEnabled;
  109651. /**
  109652. * Are ambient textures enabled in the application.
  109653. */
  109654. static get AmbientTextureEnabled(): boolean;
  109655. static set AmbientTextureEnabled(value: boolean);
  109656. private static _OpacityTextureEnabled;
  109657. /**
  109658. * Are opacity textures enabled in the application.
  109659. */
  109660. static get OpacityTextureEnabled(): boolean;
  109661. static set OpacityTextureEnabled(value: boolean);
  109662. private static _ReflectionTextureEnabled;
  109663. /**
  109664. * Are reflection textures enabled in the application.
  109665. */
  109666. static get ReflectionTextureEnabled(): boolean;
  109667. static set ReflectionTextureEnabled(value: boolean);
  109668. private static _EmissiveTextureEnabled;
  109669. /**
  109670. * Are emissive textures enabled in the application.
  109671. */
  109672. static get EmissiveTextureEnabled(): boolean;
  109673. static set EmissiveTextureEnabled(value: boolean);
  109674. private static _SpecularTextureEnabled;
  109675. /**
  109676. * Are specular textures enabled in the application.
  109677. */
  109678. static get SpecularTextureEnabled(): boolean;
  109679. static set SpecularTextureEnabled(value: boolean);
  109680. private static _BumpTextureEnabled;
  109681. /**
  109682. * Are bump textures enabled in the application.
  109683. */
  109684. static get BumpTextureEnabled(): boolean;
  109685. static set BumpTextureEnabled(value: boolean);
  109686. private static _LightmapTextureEnabled;
  109687. /**
  109688. * Are lightmap textures enabled in the application.
  109689. */
  109690. static get LightmapTextureEnabled(): boolean;
  109691. static set LightmapTextureEnabled(value: boolean);
  109692. private static _RefractionTextureEnabled;
  109693. /**
  109694. * Are refraction textures enabled in the application.
  109695. */
  109696. static get RefractionTextureEnabled(): boolean;
  109697. static set RefractionTextureEnabled(value: boolean);
  109698. private static _ColorGradingTextureEnabled;
  109699. /**
  109700. * Are color grading textures enabled in the application.
  109701. */
  109702. static get ColorGradingTextureEnabled(): boolean;
  109703. static set ColorGradingTextureEnabled(value: boolean);
  109704. private static _FresnelEnabled;
  109705. /**
  109706. * Are fresnels enabled in the application.
  109707. */
  109708. static get FresnelEnabled(): boolean;
  109709. static set FresnelEnabled(value: boolean);
  109710. private static _ClearCoatTextureEnabled;
  109711. /**
  109712. * Are clear coat textures enabled in the application.
  109713. */
  109714. static get ClearCoatTextureEnabled(): boolean;
  109715. static set ClearCoatTextureEnabled(value: boolean);
  109716. private static _ClearCoatBumpTextureEnabled;
  109717. /**
  109718. * Are clear coat bump textures enabled in the application.
  109719. */
  109720. static get ClearCoatBumpTextureEnabled(): boolean;
  109721. static set ClearCoatBumpTextureEnabled(value: boolean);
  109722. private static _ClearCoatTintTextureEnabled;
  109723. /**
  109724. * Are clear coat tint textures enabled in the application.
  109725. */
  109726. static get ClearCoatTintTextureEnabled(): boolean;
  109727. static set ClearCoatTintTextureEnabled(value: boolean);
  109728. private static _SheenTextureEnabled;
  109729. /**
  109730. * Are sheen textures enabled in the application.
  109731. */
  109732. static get SheenTextureEnabled(): boolean;
  109733. static set SheenTextureEnabled(value: boolean);
  109734. private static _AnisotropicTextureEnabled;
  109735. /**
  109736. * Are anisotropic textures enabled in the application.
  109737. */
  109738. static get AnisotropicTextureEnabled(): boolean;
  109739. static set AnisotropicTextureEnabled(value: boolean);
  109740. private static _ThicknessTextureEnabled;
  109741. /**
  109742. * Are thickness textures enabled in the application.
  109743. */
  109744. static get ThicknessTextureEnabled(): boolean;
  109745. static set ThicknessTextureEnabled(value: boolean);
  109746. }
  109747. }
  109748. declare module BABYLON {
  109749. /** @hidden */
  109750. export var defaultFragmentDeclaration: {
  109751. name: string;
  109752. shader: string;
  109753. };
  109754. }
  109755. declare module BABYLON {
  109756. /** @hidden */
  109757. export var defaultUboDeclaration: {
  109758. name: string;
  109759. shader: string;
  109760. };
  109761. }
  109762. declare module BABYLON {
  109763. /** @hidden */
  109764. export var prePassDeclaration: {
  109765. name: string;
  109766. shader: string;
  109767. };
  109768. }
  109769. declare module BABYLON {
  109770. /** @hidden */
  109771. export var lightFragmentDeclaration: {
  109772. name: string;
  109773. shader: string;
  109774. };
  109775. }
  109776. declare module BABYLON {
  109777. /** @hidden */
  109778. export var lightUboDeclaration: {
  109779. name: string;
  109780. shader: string;
  109781. };
  109782. }
  109783. declare module BABYLON {
  109784. /** @hidden */
  109785. export var lightsFragmentFunctions: {
  109786. name: string;
  109787. shader: string;
  109788. };
  109789. }
  109790. declare module BABYLON {
  109791. /** @hidden */
  109792. export var shadowsFragmentFunctions: {
  109793. name: string;
  109794. shader: string;
  109795. };
  109796. }
  109797. declare module BABYLON {
  109798. /** @hidden */
  109799. export var fresnelFunction: {
  109800. name: string;
  109801. shader: string;
  109802. };
  109803. }
  109804. declare module BABYLON {
  109805. /** @hidden */
  109806. export var bumpFragmentMainFunctions: {
  109807. name: string;
  109808. shader: string;
  109809. };
  109810. }
  109811. declare module BABYLON {
  109812. /** @hidden */
  109813. export var bumpFragmentFunctions: {
  109814. name: string;
  109815. shader: string;
  109816. };
  109817. }
  109818. declare module BABYLON {
  109819. /** @hidden */
  109820. export var logDepthDeclaration: {
  109821. name: string;
  109822. shader: string;
  109823. };
  109824. }
  109825. declare module BABYLON {
  109826. /** @hidden */
  109827. export var bumpFragment: {
  109828. name: string;
  109829. shader: string;
  109830. };
  109831. }
  109832. declare module BABYLON {
  109833. /** @hidden */
  109834. export var depthPrePass: {
  109835. name: string;
  109836. shader: string;
  109837. };
  109838. }
  109839. declare module BABYLON {
  109840. /** @hidden */
  109841. export var lightFragment: {
  109842. name: string;
  109843. shader: string;
  109844. };
  109845. }
  109846. declare module BABYLON {
  109847. /** @hidden */
  109848. export var logDepthFragment: {
  109849. name: string;
  109850. shader: string;
  109851. };
  109852. }
  109853. declare module BABYLON {
  109854. /** @hidden */
  109855. export var defaultPixelShader: {
  109856. name: string;
  109857. shader: string;
  109858. };
  109859. }
  109860. declare module BABYLON {
  109861. /** @hidden */
  109862. export var defaultVertexDeclaration: {
  109863. name: string;
  109864. shader: string;
  109865. };
  109866. }
  109867. declare module BABYLON {
  109868. /** @hidden */
  109869. export var bumpVertexDeclaration: {
  109870. name: string;
  109871. shader: string;
  109872. };
  109873. }
  109874. declare module BABYLON {
  109875. /** @hidden */
  109876. export var bumpVertex: {
  109877. name: string;
  109878. shader: string;
  109879. };
  109880. }
  109881. declare module BABYLON {
  109882. /** @hidden */
  109883. export var fogVertex: {
  109884. name: string;
  109885. shader: string;
  109886. };
  109887. }
  109888. declare module BABYLON {
  109889. /** @hidden */
  109890. export var shadowsVertex: {
  109891. name: string;
  109892. shader: string;
  109893. };
  109894. }
  109895. declare module BABYLON {
  109896. /** @hidden */
  109897. export var pointCloudVertex: {
  109898. name: string;
  109899. shader: string;
  109900. };
  109901. }
  109902. declare module BABYLON {
  109903. /** @hidden */
  109904. export var logDepthVertex: {
  109905. name: string;
  109906. shader: string;
  109907. };
  109908. }
  109909. declare module BABYLON {
  109910. /** @hidden */
  109911. export var defaultVertexShader: {
  109912. name: string;
  109913. shader: string;
  109914. };
  109915. }
  109916. declare module BABYLON {
  109917. /**
  109918. * @hidden
  109919. */
  109920. export interface IMaterialDetailMapDefines {
  109921. DETAIL: boolean;
  109922. DETAILDIRECTUV: number;
  109923. DETAIL_NORMALBLENDMETHOD: number;
  109924. /** @hidden */
  109925. _areTexturesDirty: boolean;
  109926. }
  109927. /**
  109928. * Define the code related to the detail map parameters of a material
  109929. *
  109930. * Inspired from:
  109931. * 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
  109932. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  109933. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  109934. */
  109935. export class DetailMapConfiguration {
  109936. private _texture;
  109937. /**
  109938. * The detail texture of the material.
  109939. */
  109940. texture: Nullable<BaseTexture>;
  109941. /**
  109942. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  109943. * Bigger values mean stronger blending
  109944. */
  109945. diffuseBlendLevel: number;
  109946. /**
  109947. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  109948. * Bigger values mean stronger blending. Only used with PBR materials
  109949. */
  109950. roughnessBlendLevel: number;
  109951. /**
  109952. * Defines how strong the bump effect from the detail map is
  109953. * Bigger values mean stronger effect
  109954. */
  109955. bumpLevel: number;
  109956. private _normalBlendMethod;
  109957. /**
  109958. * The method used to blend the bump and detail normals together
  109959. */
  109960. normalBlendMethod: number;
  109961. private _isEnabled;
  109962. /**
  109963. * Enable or disable the detail map on this material
  109964. */
  109965. isEnabled: boolean;
  109966. /** @hidden */
  109967. private _internalMarkAllSubMeshesAsTexturesDirty;
  109968. /** @hidden */
  109969. _markAllSubMeshesAsTexturesDirty(): void;
  109970. /**
  109971. * Instantiate a new detail map
  109972. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  109973. */
  109974. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  109975. /**
  109976. * Gets whether the submesh is ready to be used or not.
  109977. * @param defines the list of "defines" to update.
  109978. * @param scene defines the scene the material belongs to.
  109979. * @returns - boolean indicating that the submesh is ready or not.
  109980. */
  109981. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  109982. /**
  109983. * Update the defines for detail map usage
  109984. * @param defines the list of "defines" to update.
  109985. * @param scene defines the scene the material belongs to.
  109986. */
  109987. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  109988. /**
  109989. * Binds the material data.
  109990. * @param uniformBuffer defines the Uniform buffer to fill in.
  109991. * @param scene defines the scene the material belongs to.
  109992. * @param isFrozen defines whether the material is frozen or not.
  109993. */
  109994. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  109995. /**
  109996. * Checks to see if a texture is used in the material.
  109997. * @param texture - Base texture to use.
  109998. * @returns - Boolean specifying if a texture is used in the material.
  109999. */
  110000. hasTexture(texture: BaseTexture): boolean;
  110001. /**
  110002. * Returns an array of the actively used textures.
  110003. * @param activeTextures Array of BaseTextures
  110004. */
  110005. getActiveTextures(activeTextures: BaseTexture[]): void;
  110006. /**
  110007. * Returns the animatable textures.
  110008. * @param animatables Array of animatable textures.
  110009. */
  110010. getAnimatables(animatables: IAnimatable[]): void;
  110011. /**
  110012. * Disposes the resources of the material.
  110013. * @param forceDisposeTextures - Forces the disposal of all textures.
  110014. */
  110015. dispose(forceDisposeTextures?: boolean): void;
  110016. /**
  110017. * Get the current class name useful for serialization or dynamic coding.
  110018. * @returns "DetailMap"
  110019. */
  110020. getClassName(): string;
  110021. /**
  110022. * Add the required uniforms to the current list.
  110023. * @param uniforms defines the current uniform list.
  110024. */
  110025. static AddUniforms(uniforms: string[]): void;
  110026. /**
  110027. * Add the required samplers to the current list.
  110028. * @param samplers defines the current sampler list.
  110029. */
  110030. static AddSamplers(samplers: string[]): void;
  110031. /**
  110032. * Add the required uniforms to the current buffer.
  110033. * @param uniformBuffer defines the current uniform buffer.
  110034. */
  110035. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  110036. /**
  110037. * Makes a duplicate of the current instance into another one.
  110038. * @param detailMap define the instance where to copy the info
  110039. */
  110040. copyTo(detailMap: DetailMapConfiguration): void;
  110041. /**
  110042. * Serializes this detail map instance
  110043. * @returns - An object with the serialized instance.
  110044. */
  110045. serialize(): any;
  110046. /**
  110047. * Parses a detail map setting from a serialized object.
  110048. * @param source - Serialized object.
  110049. * @param scene Defines the scene we are parsing for
  110050. * @param rootUrl Defines the rootUrl to load from
  110051. */
  110052. parse(source: any, scene: Scene, rootUrl: string): void;
  110053. }
  110054. }
  110055. declare module BABYLON {
  110056. /** @hidden */
  110057. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  110058. MAINUV1: boolean;
  110059. MAINUV2: boolean;
  110060. DIFFUSE: boolean;
  110061. DIFFUSEDIRECTUV: number;
  110062. DETAIL: boolean;
  110063. DETAILDIRECTUV: number;
  110064. DETAIL_NORMALBLENDMETHOD: number;
  110065. AMBIENT: boolean;
  110066. AMBIENTDIRECTUV: number;
  110067. OPACITY: boolean;
  110068. OPACITYDIRECTUV: number;
  110069. OPACITYRGB: boolean;
  110070. REFLECTION: boolean;
  110071. EMISSIVE: boolean;
  110072. EMISSIVEDIRECTUV: number;
  110073. SPECULAR: boolean;
  110074. SPECULARDIRECTUV: number;
  110075. BUMP: boolean;
  110076. BUMPDIRECTUV: number;
  110077. PARALLAX: boolean;
  110078. PARALLAXOCCLUSION: boolean;
  110079. SPECULAROVERALPHA: boolean;
  110080. CLIPPLANE: boolean;
  110081. CLIPPLANE2: boolean;
  110082. CLIPPLANE3: boolean;
  110083. CLIPPLANE4: boolean;
  110084. CLIPPLANE5: boolean;
  110085. CLIPPLANE6: boolean;
  110086. ALPHATEST: boolean;
  110087. DEPTHPREPASS: boolean;
  110088. ALPHAFROMDIFFUSE: boolean;
  110089. POINTSIZE: boolean;
  110090. FOG: boolean;
  110091. SPECULARTERM: boolean;
  110092. DIFFUSEFRESNEL: boolean;
  110093. OPACITYFRESNEL: boolean;
  110094. REFLECTIONFRESNEL: boolean;
  110095. REFRACTIONFRESNEL: boolean;
  110096. EMISSIVEFRESNEL: boolean;
  110097. FRESNEL: boolean;
  110098. NORMAL: boolean;
  110099. UV1: boolean;
  110100. UV2: boolean;
  110101. VERTEXCOLOR: boolean;
  110102. VERTEXALPHA: boolean;
  110103. NUM_BONE_INFLUENCERS: number;
  110104. BonesPerMesh: number;
  110105. BONETEXTURE: boolean;
  110106. INSTANCES: boolean;
  110107. THIN_INSTANCES: boolean;
  110108. GLOSSINESS: boolean;
  110109. ROUGHNESS: boolean;
  110110. EMISSIVEASILLUMINATION: boolean;
  110111. LINKEMISSIVEWITHDIFFUSE: boolean;
  110112. REFLECTIONFRESNELFROMSPECULAR: boolean;
  110113. LIGHTMAP: boolean;
  110114. LIGHTMAPDIRECTUV: number;
  110115. OBJECTSPACE_NORMALMAP: boolean;
  110116. USELIGHTMAPASSHADOWMAP: boolean;
  110117. REFLECTIONMAP_3D: boolean;
  110118. REFLECTIONMAP_SPHERICAL: boolean;
  110119. REFLECTIONMAP_PLANAR: boolean;
  110120. REFLECTIONMAP_CUBIC: boolean;
  110121. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  110122. REFLECTIONMAP_PROJECTION: boolean;
  110123. REFLECTIONMAP_SKYBOX: boolean;
  110124. REFLECTIONMAP_EXPLICIT: boolean;
  110125. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  110126. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  110127. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  110128. INVERTCUBICMAP: boolean;
  110129. LOGARITHMICDEPTH: boolean;
  110130. REFRACTION: boolean;
  110131. REFRACTIONMAP_3D: boolean;
  110132. REFLECTIONOVERALPHA: boolean;
  110133. TWOSIDEDLIGHTING: boolean;
  110134. SHADOWFLOAT: boolean;
  110135. MORPHTARGETS: boolean;
  110136. MORPHTARGETS_NORMAL: boolean;
  110137. MORPHTARGETS_TANGENT: boolean;
  110138. MORPHTARGETS_UV: boolean;
  110139. NUM_MORPH_INFLUENCERS: number;
  110140. NONUNIFORMSCALING: boolean;
  110141. PREMULTIPLYALPHA: boolean;
  110142. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  110143. ALPHABLEND: boolean;
  110144. PREPASS: boolean;
  110145. SCENE_MRT_COUNT: number;
  110146. RGBDLIGHTMAP: boolean;
  110147. RGBDREFLECTION: boolean;
  110148. RGBDREFRACTION: boolean;
  110149. IMAGEPROCESSING: boolean;
  110150. VIGNETTE: boolean;
  110151. VIGNETTEBLENDMODEMULTIPLY: boolean;
  110152. VIGNETTEBLENDMODEOPAQUE: boolean;
  110153. TONEMAPPING: boolean;
  110154. TONEMAPPING_ACES: boolean;
  110155. CONTRAST: boolean;
  110156. COLORCURVES: boolean;
  110157. COLORGRADING: boolean;
  110158. COLORGRADING3D: boolean;
  110159. SAMPLER3DGREENDEPTH: boolean;
  110160. SAMPLER3DBGRMAP: boolean;
  110161. IMAGEPROCESSINGPOSTPROCESS: boolean;
  110162. MULTIVIEW: boolean;
  110163. /**
  110164. * If the reflection texture on this material is in linear color space
  110165. * @hidden
  110166. */
  110167. IS_REFLECTION_LINEAR: boolean;
  110168. /**
  110169. * If the refraction texture on this material is in linear color space
  110170. * @hidden
  110171. */
  110172. IS_REFRACTION_LINEAR: boolean;
  110173. EXPOSURE: boolean;
  110174. constructor();
  110175. setReflectionMode(modeToEnable: string): void;
  110176. }
  110177. /**
  110178. * This is the default material used in Babylon. It is the best trade off between quality
  110179. * and performances.
  110180. * @see https://doc.babylonjs.com/babylon101/materials
  110181. */
  110182. export class StandardMaterial extends PushMaterial {
  110183. private _diffuseTexture;
  110184. /**
  110185. * The basic texture of the material as viewed under a light.
  110186. */
  110187. diffuseTexture: Nullable<BaseTexture>;
  110188. private _ambientTexture;
  110189. /**
  110190. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  110191. */
  110192. ambientTexture: Nullable<BaseTexture>;
  110193. private _opacityTexture;
  110194. /**
  110195. * Define the transparency of the material from a texture.
  110196. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  110197. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  110198. */
  110199. opacityTexture: Nullable<BaseTexture>;
  110200. private _reflectionTexture;
  110201. /**
  110202. * Define the texture used to display the reflection.
  110203. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110204. */
  110205. reflectionTexture: Nullable<BaseTexture>;
  110206. private _emissiveTexture;
  110207. /**
  110208. * Define texture of the material as if self lit.
  110209. * This will be mixed in the final result even in the absence of light.
  110210. */
  110211. emissiveTexture: Nullable<BaseTexture>;
  110212. private _specularTexture;
  110213. /**
  110214. * Define how the color and intensity of the highlight given by the light in the material.
  110215. */
  110216. specularTexture: Nullable<BaseTexture>;
  110217. private _bumpTexture;
  110218. /**
  110219. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  110220. * 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.
  110221. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  110222. */
  110223. bumpTexture: Nullable<BaseTexture>;
  110224. private _lightmapTexture;
  110225. /**
  110226. * Complex lighting can be computationally expensive to compute at runtime.
  110227. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  110228. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  110229. */
  110230. lightmapTexture: Nullable<BaseTexture>;
  110231. private _refractionTexture;
  110232. /**
  110233. * Define the texture used to display the refraction.
  110234. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110235. */
  110236. refractionTexture: Nullable<BaseTexture>;
  110237. /**
  110238. * The color of the material lit by the environmental background lighting.
  110239. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  110240. */
  110241. ambientColor: Color3;
  110242. /**
  110243. * The basic color of the material as viewed under a light.
  110244. */
  110245. diffuseColor: Color3;
  110246. /**
  110247. * Define how the color and intensity of the highlight given by the light in the material.
  110248. */
  110249. specularColor: Color3;
  110250. /**
  110251. * Define the color of the material as if self lit.
  110252. * This will be mixed in the final result even in the absence of light.
  110253. */
  110254. emissiveColor: Color3;
  110255. /**
  110256. * Defines how sharp are the highlights in the material.
  110257. * The bigger the value the sharper giving a more glossy feeling to the result.
  110258. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  110259. */
  110260. specularPower: number;
  110261. private _useAlphaFromDiffuseTexture;
  110262. /**
  110263. * Does the transparency come from the diffuse texture alpha channel.
  110264. */
  110265. useAlphaFromDiffuseTexture: boolean;
  110266. private _useEmissiveAsIllumination;
  110267. /**
  110268. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  110269. */
  110270. useEmissiveAsIllumination: boolean;
  110271. private _linkEmissiveWithDiffuse;
  110272. /**
  110273. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  110274. * the emissive level when the final color is close to one.
  110275. */
  110276. linkEmissiveWithDiffuse: boolean;
  110277. private _useSpecularOverAlpha;
  110278. /**
  110279. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  110280. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  110281. */
  110282. useSpecularOverAlpha: boolean;
  110283. private _useReflectionOverAlpha;
  110284. /**
  110285. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  110286. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  110287. */
  110288. useReflectionOverAlpha: boolean;
  110289. private _disableLighting;
  110290. /**
  110291. * Does lights from the scene impacts this material.
  110292. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  110293. */
  110294. disableLighting: boolean;
  110295. private _useObjectSpaceNormalMap;
  110296. /**
  110297. * Allows using an object space normal map (instead of tangent space).
  110298. */
  110299. useObjectSpaceNormalMap: boolean;
  110300. private _useParallax;
  110301. /**
  110302. * Is parallax enabled or not.
  110303. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110304. */
  110305. useParallax: boolean;
  110306. private _useParallaxOcclusion;
  110307. /**
  110308. * Is parallax occlusion enabled or not.
  110309. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  110310. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110311. */
  110312. useParallaxOcclusion: boolean;
  110313. /**
  110314. * 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.
  110315. */
  110316. parallaxScaleBias: number;
  110317. private _roughness;
  110318. /**
  110319. * Helps to define how blurry the reflections should appears in the material.
  110320. */
  110321. roughness: number;
  110322. /**
  110323. * In case of refraction, define the value of the index of refraction.
  110324. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110325. */
  110326. indexOfRefraction: number;
  110327. /**
  110328. * Invert the refraction texture alongside the y axis.
  110329. * It can be useful with procedural textures or probe for instance.
  110330. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110331. */
  110332. invertRefractionY: boolean;
  110333. /**
  110334. * Defines the alpha limits in alpha test mode.
  110335. */
  110336. alphaCutOff: number;
  110337. private _useLightmapAsShadowmap;
  110338. /**
  110339. * In case of light mapping, define whether the map contains light or shadow informations.
  110340. */
  110341. useLightmapAsShadowmap: boolean;
  110342. private _diffuseFresnelParameters;
  110343. /**
  110344. * Define the diffuse fresnel parameters of the material.
  110345. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110346. */
  110347. diffuseFresnelParameters: FresnelParameters;
  110348. private _opacityFresnelParameters;
  110349. /**
  110350. * Define the opacity fresnel parameters of the material.
  110351. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110352. */
  110353. opacityFresnelParameters: FresnelParameters;
  110354. private _reflectionFresnelParameters;
  110355. /**
  110356. * Define the reflection fresnel parameters of the material.
  110357. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110358. */
  110359. reflectionFresnelParameters: FresnelParameters;
  110360. private _refractionFresnelParameters;
  110361. /**
  110362. * Define the refraction fresnel parameters of the material.
  110363. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110364. */
  110365. refractionFresnelParameters: FresnelParameters;
  110366. private _emissiveFresnelParameters;
  110367. /**
  110368. * Define the emissive fresnel parameters of the material.
  110369. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110370. */
  110371. emissiveFresnelParameters: FresnelParameters;
  110372. private _useReflectionFresnelFromSpecular;
  110373. /**
  110374. * If true automatically deducts the fresnels values from the material specularity.
  110375. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110376. */
  110377. useReflectionFresnelFromSpecular: boolean;
  110378. private _useGlossinessFromSpecularMapAlpha;
  110379. /**
  110380. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  110381. */
  110382. useGlossinessFromSpecularMapAlpha: boolean;
  110383. private _maxSimultaneousLights;
  110384. /**
  110385. * Defines the maximum number of lights that can be used in the material
  110386. */
  110387. maxSimultaneousLights: number;
  110388. private _invertNormalMapX;
  110389. /**
  110390. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  110391. */
  110392. invertNormalMapX: boolean;
  110393. private _invertNormalMapY;
  110394. /**
  110395. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  110396. */
  110397. invertNormalMapY: boolean;
  110398. private _twoSidedLighting;
  110399. /**
  110400. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  110401. */
  110402. twoSidedLighting: boolean;
  110403. /**
  110404. * Default configuration related to image processing available in the standard Material.
  110405. */
  110406. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  110407. /**
  110408. * Gets the image processing configuration used either in this material.
  110409. */
  110410. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  110411. /**
  110412. * Sets the Default image processing configuration used either in the this material.
  110413. *
  110414. * If sets to null, the scene one is in use.
  110415. */
  110416. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  110417. /**
  110418. * Keep track of the image processing observer to allow dispose and replace.
  110419. */
  110420. private _imageProcessingObserver;
  110421. /**
  110422. * Attaches a new image processing configuration to the Standard Material.
  110423. * @param configuration
  110424. */
  110425. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  110426. /**
  110427. * Gets wether the color curves effect is enabled.
  110428. */
  110429. get cameraColorCurvesEnabled(): boolean;
  110430. /**
  110431. * Sets wether the color curves effect is enabled.
  110432. */
  110433. set cameraColorCurvesEnabled(value: boolean);
  110434. /**
  110435. * Gets wether the color grading effect is enabled.
  110436. */
  110437. get cameraColorGradingEnabled(): boolean;
  110438. /**
  110439. * Gets wether the color grading effect is enabled.
  110440. */
  110441. set cameraColorGradingEnabled(value: boolean);
  110442. /**
  110443. * Gets wether tonemapping is enabled or not.
  110444. */
  110445. get cameraToneMappingEnabled(): boolean;
  110446. /**
  110447. * Sets wether tonemapping is enabled or not
  110448. */
  110449. set cameraToneMappingEnabled(value: boolean);
  110450. /**
  110451. * The camera exposure used on this material.
  110452. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110453. * This corresponds to a photographic exposure.
  110454. */
  110455. get cameraExposure(): number;
  110456. /**
  110457. * The camera exposure used on this material.
  110458. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110459. * This corresponds to a photographic exposure.
  110460. */
  110461. set cameraExposure(value: number);
  110462. /**
  110463. * Gets The camera contrast used on this material.
  110464. */
  110465. get cameraContrast(): number;
  110466. /**
  110467. * Sets The camera contrast used on this material.
  110468. */
  110469. set cameraContrast(value: number);
  110470. /**
  110471. * Gets the Color Grading 2D Lookup Texture.
  110472. */
  110473. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  110474. /**
  110475. * Sets the Color Grading 2D Lookup Texture.
  110476. */
  110477. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  110478. /**
  110479. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110480. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110481. * 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;
  110482. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110483. */
  110484. get cameraColorCurves(): Nullable<ColorCurves>;
  110485. /**
  110486. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110487. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110488. * 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;
  110489. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110490. */
  110491. set cameraColorCurves(value: Nullable<ColorCurves>);
  110492. /**
  110493. * Can this material render to several textures at once
  110494. */
  110495. get canRenderToMRT(): boolean;
  110496. /**
  110497. * Defines the detail map parameters for the material.
  110498. */
  110499. readonly detailMap: DetailMapConfiguration;
  110500. protected _renderTargets: SmartArray<RenderTargetTexture>;
  110501. protected _worldViewProjectionMatrix: Matrix;
  110502. protected _globalAmbientColor: Color3;
  110503. protected _useLogarithmicDepth: boolean;
  110504. protected _rebuildInParallel: boolean;
  110505. /**
  110506. * Instantiates a new standard material.
  110507. * This is the default material used in Babylon. It is the best trade off between quality
  110508. * and performances.
  110509. * @see https://doc.babylonjs.com/babylon101/materials
  110510. * @param name Define the name of the material in the scene
  110511. * @param scene Define the scene the material belong to
  110512. */
  110513. constructor(name: string, scene: Scene);
  110514. /**
  110515. * Gets a boolean indicating that current material needs to register RTT
  110516. */
  110517. get hasRenderTargetTextures(): boolean;
  110518. /**
  110519. * Gets the current class name of the material e.g. "StandardMaterial"
  110520. * Mainly use in serialization.
  110521. * @returns the class name
  110522. */
  110523. getClassName(): string;
  110524. /**
  110525. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  110526. * You can try switching to logarithmic depth.
  110527. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  110528. */
  110529. get useLogarithmicDepth(): boolean;
  110530. set useLogarithmicDepth(value: boolean);
  110531. /**
  110532. * Specifies if the material will require alpha blending
  110533. * @returns a boolean specifying if alpha blending is needed
  110534. */
  110535. needAlphaBlending(): boolean;
  110536. /**
  110537. * Specifies if this material should be rendered in alpha test mode
  110538. * @returns a boolean specifying if an alpha test is needed.
  110539. */
  110540. needAlphaTesting(): boolean;
  110541. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  110542. /**
  110543. * Get the texture used for alpha test purpose.
  110544. * @returns the diffuse texture in case of the standard material.
  110545. */
  110546. getAlphaTestTexture(): Nullable<BaseTexture>;
  110547. /**
  110548. * Get if the submesh is ready to be used and all its information available.
  110549. * Child classes can use it to update shaders
  110550. * @param mesh defines the mesh to check
  110551. * @param subMesh defines which submesh to check
  110552. * @param useInstances specifies that instances should be used
  110553. * @returns a boolean indicating that the submesh is ready or not
  110554. */
  110555. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  110556. /**
  110557. * Builds the material UBO layouts.
  110558. * Used internally during the effect preparation.
  110559. */
  110560. buildUniformLayout(): void;
  110561. /**
  110562. * Unbinds the material from the mesh
  110563. */
  110564. unbind(): void;
  110565. /**
  110566. * Binds the submesh to this material by preparing the effect and shader to draw
  110567. * @param world defines the world transformation matrix
  110568. * @param mesh defines the mesh containing the submesh
  110569. * @param subMesh defines the submesh to bind the material to
  110570. */
  110571. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  110572. /**
  110573. * Get the list of animatables in the material.
  110574. * @returns the list of animatables object used in the material
  110575. */
  110576. getAnimatables(): IAnimatable[];
  110577. /**
  110578. * Gets the active textures from the material
  110579. * @returns an array of textures
  110580. */
  110581. getActiveTextures(): BaseTexture[];
  110582. /**
  110583. * Specifies if the material uses a texture
  110584. * @param texture defines the texture to check against the material
  110585. * @returns a boolean specifying if the material uses the texture
  110586. */
  110587. hasTexture(texture: BaseTexture): boolean;
  110588. /**
  110589. * Disposes the material
  110590. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  110591. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  110592. */
  110593. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  110594. /**
  110595. * Makes a duplicate of the material, and gives it a new name
  110596. * @param name defines the new name for the duplicated material
  110597. * @returns the cloned material
  110598. */
  110599. clone(name: string): StandardMaterial;
  110600. /**
  110601. * Serializes this material in a JSON representation
  110602. * @returns the serialized material object
  110603. */
  110604. serialize(): any;
  110605. /**
  110606. * Creates a standard material from parsed material data
  110607. * @param source defines the JSON representation of the material
  110608. * @param scene defines the hosting scene
  110609. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  110610. * @returns a new standard material
  110611. */
  110612. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  110613. /**
  110614. * Are diffuse textures enabled in the application.
  110615. */
  110616. static get DiffuseTextureEnabled(): boolean;
  110617. static set DiffuseTextureEnabled(value: boolean);
  110618. /**
  110619. * Are detail textures enabled in the application.
  110620. */
  110621. static get DetailTextureEnabled(): boolean;
  110622. static set DetailTextureEnabled(value: boolean);
  110623. /**
  110624. * Are ambient textures enabled in the application.
  110625. */
  110626. static get AmbientTextureEnabled(): boolean;
  110627. static set AmbientTextureEnabled(value: boolean);
  110628. /**
  110629. * Are opacity textures enabled in the application.
  110630. */
  110631. static get OpacityTextureEnabled(): boolean;
  110632. static set OpacityTextureEnabled(value: boolean);
  110633. /**
  110634. * Are reflection textures enabled in the application.
  110635. */
  110636. static get ReflectionTextureEnabled(): boolean;
  110637. static set ReflectionTextureEnabled(value: boolean);
  110638. /**
  110639. * Are emissive textures enabled in the application.
  110640. */
  110641. static get EmissiveTextureEnabled(): boolean;
  110642. static set EmissiveTextureEnabled(value: boolean);
  110643. /**
  110644. * Are specular textures enabled in the application.
  110645. */
  110646. static get SpecularTextureEnabled(): boolean;
  110647. static set SpecularTextureEnabled(value: boolean);
  110648. /**
  110649. * Are bump textures enabled in the application.
  110650. */
  110651. static get BumpTextureEnabled(): boolean;
  110652. static set BumpTextureEnabled(value: boolean);
  110653. /**
  110654. * Are lightmap textures enabled in the application.
  110655. */
  110656. static get LightmapTextureEnabled(): boolean;
  110657. static set LightmapTextureEnabled(value: boolean);
  110658. /**
  110659. * Are refraction textures enabled in the application.
  110660. */
  110661. static get RefractionTextureEnabled(): boolean;
  110662. static set RefractionTextureEnabled(value: boolean);
  110663. /**
  110664. * Are color grading textures enabled in the application.
  110665. */
  110666. static get ColorGradingTextureEnabled(): boolean;
  110667. static set ColorGradingTextureEnabled(value: boolean);
  110668. /**
  110669. * Are fresnels enabled in the application.
  110670. */
  110671. static get FresnelEnabled(): boolean;
  110672. static set FresnelEnabled(value: boolean);
  110673. }
  110674. }
  110675. declare module BABYLON {
  110676. /**
  110677. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  110678. *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.
  110679. * The SPS is also a particle system. It provides some methods to manage the particles.
  110680. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  110681. *
  110682. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  110683. */
  110684. export class SolidParticleSystem implements IDisposable {
  110685. /**
  110686. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  110687. * Example : var p = SPS.particles[i];
  110688. */
  110689. particles: SolidParticle[];
  110690. /**
  110691. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  110692. */
  110693. nbParticles: number;
  110694. /**
  110695. * If the particles must ever face the camera (default false). Useful for planar particles.
  110696. */
  110697. billboard: boolean;
  110698. /**
  110699. * Recompute normals when adding a shape
  110700. */
  110701. recomputeNormals: boolean;
  110702. /**
  110703. * This a counter ofr your own usage. It's not set by any SPS functions.
  110704. */
  110705. counter: number;
  110706. /**
  110707. * The SPS name. This name is also given to the underlying mesh.
  110708. */
  110709. name: string;
  110710. /**
  110711. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  110712. */
  110713. mesh: Mesh;
  110714. /**
  110715. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  110716. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  110717. */
  110718. vars: any;
  110719. /**
  110720. * This array is populated when the SPS is set as 'pickable'.
  110721. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  110722. * Each element of this array is an object `{idx: int, faceId: int}`.
  110723. * `idx` is the picked particle index in the `SPS.particles` array
  110724. * `faceId` is the picked face index counted within this particle.
  110725. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  110726. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  110727. * Use the method SPS.pickedParticle(pickingInfo) instead.
  110728. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110729. */
  110730. pickedParticles: {
  110731. idx: number;
  110732. faceId: number;
  110733. }[];
  110734. /**
  110735. * This array is populated when the SPS is set as 'pickable'
  110736. * Each key of this array is a submesh index.
  110737. * Each element of this array is a second array defined like this :
  110738. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  110739. * Each element of this second array is an object `{idx: int, faceId: int}`.
  110740. * `idx` is the picked particle index in the `SPS.particles` array
  110741. * `faceId` is the picked face index counted within this particle.
  110742. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  110743. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110744. */
  110745. pickedBySubMesh: {
  110746. idx: number;
  110747. faceId: number;
  110748. }[][];
  110749. /**
  110750. * This array is populated when `enableDepthSort` is set to true.
  110751. * Each element of this array is an instance of the class DepthSortedParticle.
  110752. */
  110753. depthSortedParticles: DepthSortedParticle[];
  110754. /**
  110755. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  110756. * @hidden
  110757. */
  110758. _bSphereOnly: boolean;
  110759. /**
  110760. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  110761. * @hidden
  110762. */
  110763. _bSphereRadiusFactor: number;
  110764. private _scene;
  110765. private _positions;
  110766. private _indices;
  110767. private _normals;
  110768. private _colors;
  110769. private _uvs;
  110770. private _indices32;
  110771. private _positions32;
  110772. private _normals32;
  110773. private _fixedNormal32;
  110774. private _colors32;
  110775. private _uvs32;
  110776. private _index;
  110777. private _updatable;
  110778. private _pickable;
  110779. private _isVisibilityBoxLocked;
  110780. private _alwaysVisible;
  110781. private _depthSort;
  110782. private _expandable;
  110783. private _shapeCounter;
  110784. private _copy;
  110785. private _color;
  110786. private _computeParticleColor;
  110787. private _computeParticleTexture;
  110788. private _computeParticleRotation;
  110789. private _computeParticleVertex;
  110790. private _computeBoundingBox;
  110791. private _depthSortParticles;
  110792. private _camera;
  110793. private _mustUnrotateFixedNormals;
  110794. private _particlesIntersect;
  110795. private _needs32Bits;
  110796. private _isNotBuilt;
  110797. private _lastParticleId;
  110798. private _idxOfId;
  110799. private _multimaterialEnabled;
  110800. private _useModelMaterial;
  110801. private _indicesByMaterial;
  110802. private _materialIndexes;
  110803. private _depthSortFunction;
  110804. private _materialSortFunction;
  110805. private _materials;
  110806. private _multimaterial;
  110807. private _materialIndexesById;
  110808. private _defaultMaterial;
  110809. private _autoUpdateSubMeshes;
  110810. private _tmpVertex;
  110811. /**
  110812. * Creates a SPS (Solid Particle System) object.
  110813. * @param name (String) is the SPS name, this will be the underlying mesh name.
  110814. * @param scene (Scene) is the scene in which the SPS is added.
  110815. * @param options defines the options of the sps e.g.
  110816. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  110817. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  110818. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  110819. * * 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.
  110820. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  110821. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  110822. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  110823. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  110824. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  110825. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  110826. */
  110827. constructor(name: string, scene: Scene, options?: {
  110828. updatable?: boolean;
  110829. isPickable?: boolean;
  110830. enableDepthSort?: boolean;
  110831. particleIntersection?: boolean;
  110832. boundingSphereOnly?: boolean;
  110833. bSphereRadiusFactor?: number;
  110834. expandable?: boolean;
  110835. useModelMaterial?: boolean;
  110836. enableMultiMaterial?: boolean;
  110837. });
  110838. /**
  110839. * Builds the SPS underlying mesh. Returns a standard Mesh.
  110840. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  110841. * @returns the created mesh
  110842. */
  110843. buildMesh(): Mesh;
  110844. /**
  110845. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  110846. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  110847. * Thus the particles generated from `digest()` have their property `position` set yet.
  110848. * @param mesh ( Mesh ) is the mesh to be digested
  110849. * @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
  110850. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  110851. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  110852. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110853. * @returns the current SPS
  110854. */
  110855. digest(mesh: Mesh, options?: {
  110856. facetNb?: number;
  110857. number?: number;
  110858. delta?: number;
  110859. storage?: [];
  110860. }): SolidParticleSystem;
  110861. /**
  110862. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  110863. * @hidden
  110864. */
  110865. private _unrotateFixedNormals;
  110866. /**
  110867. * Resets the temporary working copy particle
  110868. * @hidden
  110869. */
  110870. private _resetCopy;
  110871. /**
  110872. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  110873. * @param p the current index in the positions array to be updated
  110874. * @param ind the current index in the indices array
  110875. * @param shape a Vector3 array, the shape geometry
  110876. * @param positions the positions array to be updated
  110877. * @param meshInd the shape indices array
  110878. * @param indices the indices array to be updated
  110879. * @param meshUV the shape uv array
  110880. * @param uvs the uv array to be updated
  110881. * @param meshCol the shape color array
  110882. * @param colors the color array to be updated
  110883. * @param meshNor the shape normals array
  110884. * @param normals the normals array to be updated
  110885. * @param idx the particle index
  110886. * @param idxInShape the particle index in its shape
  110887. * @param options the addShape() method passed options
  110888. * @model the particle model
  110889. * @hidden
  110890. */
  110891. private _meshBuilder;
  110892. /**
  110893. * Returns a shape Vector3 array from positions float array
  110894. * @param positions float array
  110895. * @returns a vector3 array
  110896. * @hidden
  110897. */
  110898. private _posToShape;
  110899. /**
  110900. * Returns a shapeUV array from a float uvs (array deep copy)
  110901. * @param uvs as a float array
  110902. * @returns a shapeUV array
  110903. * @hidden
  110904. */
  110905. private _uvsToShapeUV;
  110906. /**
  110907. * Adds a new particle object in the particles array
  110908. * @param idx particle index in particles array
  110909. * @param id particle id
  110910. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  110911. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  110912. * @param model particle ModelShape object
  110913. * @param shapeId model shape identifier
  110914. * @param idxInShape index of the particle in the current model
  110915. * @param bInfo model bounding info object
  110916. * @param storage target storage array, if any
  110917. * @hidden
  110918. */
  110919. private _addParticle;
  110920. /**
  110921. * Adds some particles to the SPS from the model shape. Returns the shape id.
  110922. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  110923. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  110924. * @param nb (positive integer) the number of particles to be created from this model
  110925. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  110926. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  110927. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110928. * @returns the number of shapes in the system
  110929. */
  110930. addShape(mesh: Mesh, nb: number, options?: {
  110931. positionFunction?: any;
  110932. vertexFunction?: any;
  110933. storage?: [];
  110934. }): number;
  110935. /**
  110936. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  110937. * @hidden
  110938. */
  110939. private _rebuildParticle;
  110940. /**
  110941. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  110942. * @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.
  110943. * @returns the SPS.
  110944. */
  110945. rebuildMesh(reset?: boolean): SolidParticleSystem;
  110946. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  110947. * Returns an array with the removed particles.
  110948. * 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.
  110949. * The SPS can't be empty so at least one particle needs to remain in place.
  110950. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  110951. * @param start index of the first particle to remove
  110952. * @param end index of the last particle to remove (included)
  110953. * @returns an array populated with the removed particles
  110954. */
  110955. removeParticles(start: number, end: number): SolidParticle[];
  110956. /**
  110957. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  110958. * @param solidParticleArray an array populated with Solid Particles objects
  110959. * @returns the SPS
  110960. */
  110961. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  110962. /**
  110963. * Creates a new particle and modifies the SPS mesh geometry :
  110964. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  110965. * - calls _addParticle() to populate the particle array
  110966. * factorized code from addShape() and insertParticlesFromArray()
  110967. * @param idx particle index in the particles array
  110968. * @param i particle index in its shape
  110969. * @param modelShape particle ModelShape object
  110970. * @param shape shape vertex array
  110971. * @param meshInd shape indices array
  110972. * @param meshUV shape uv array
  110973. * @param meshCol shape color array
  110974. * @param meshNor shape normals array
  110975. * @param bbInfo shape bounding info
  110976. * @param storage target particle storage
  110977. * @options addShape() passed options
  110978. * @hidden
  110979. */
  110980. private _insertNewParticle;
  110981. /**
  110982. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  110983. * This method calls `updateParticle()` for each particle of the SPS.
  110984. * For an animated SPS, it is usually called within the render loop.
  110985. * 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.
  110986. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  110987. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  110988. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  110989. * @returns the SPS.
  110990. */
  110991. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  110992. /**
  110993. * Disposes the SPS.
  110994. */
  110995. dispose(): void;
  110996. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  110997. * idx is the particle index in the SPS
  110998. * faceId is the picked face index counted within this particle.
  110999. * Returns null if the pickInfo can't identify a picked particle.
  111000. * @param pickingInfo (PickingInfo object)
  111001. * @returns {idx: number, faceId: number} or null
  111002. */
  111003. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  111004. idx: number;
  111005. faceId: number;
  111006. }>;
  111007. /**
  111008. * Returns a SolidParticle object from its identifier : particle.id
  111009. * @param id (integer) the particle Id
  111010. * @returns the searched particle or null if not found in the SPS.
  111011. */
  111012. getParticleById(id: number): Nullable<SolidParticle>;
  111013. /**
  111014. * Returns a new array populated with the particles having the passed shapeId.
  111015. * @param shapeId (integer) the shape identifier
  111016. * @returns a new solid particle array
  111017. */
  111018. getParticlesByShapeId(shapeId: number): SolidParticle[];
  111019. /**
  111020. * Populates the passed array "ref" with the particles having the passed shapeId.
  111021. * @param shapeId the shape identifier
  111022. * @returns the SPS
  111023. * @param ref
  111024. */
  111025. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  111026. /**
  111027. * Computes the required SubMeshes according the materials assigned to the particles.
  111028. * @returns the solid particle system.
  111029. * Does nothing if called before the SPS mesh is built.
  111030. */
  111031. computeSubMeshes(): SolidParticleSystem;
  111032. /**
  111033. * Sorts the solid particles by material when MultiMaterial is enabled.
  111034. * Updates the indices32 array.
  111035. * Updates the indicesByMaterial array.
  111036. * Updates the mesh indices array.
  111037. * @returns the SPS
  111038. * @hidden
  111039. */
  111040. private _sortParticlesByMaterial;
  111041. /**
  111042. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  111043. * @hidden
  111044. */
  111045. private _setMaterialIndexesById;
  111046. /**
  111047. * Returns an array with unique values of Materials from the passed array
  111048. * @param array the material array to be checked and filtered
  111049. * @hidden
  111050. */
  111051. private _filterUniqueMaterialId;
  111052. /**
  111053. * Sets a new Standard Material as _defaultMaterial if not already set.
  111054. * @hidden
  111055. */
  111056. private _setDefaultMaterial;
  111057. /**
  111058. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  111059. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111060. * @returns the SPS.
  111061. */
  111062. refreshVisibleSize(): SolidParticleSystem;
  111063. /**
  111064. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  111065. * @param size the size (float) of the visibility box
  111066. * note : this doesn't lock the SPS mesh bounding box.
  111067. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111068. */
  111069. setVisibilityBox(size: number): void;
  111070. /**
  111071. * Gets whether the SPS as always visible or not
  111072. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111073. */
  111074. get isAlwaysVisible(): boolean;
  111075. /**
  111076. * Sets the SPS as always visible or not
  111077. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111078. */
  111079. set isAlwaysVisible(val: boolean);
  111080. /**
  111081. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111082. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111083. */
  111084. set isVisibilityBoxLocked(val: boolean);
  111085. /**
  111086. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111087. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111088. */
  111089. get isVisibilityBoxLocked(): boolean;
  111090. /**
  111091. * Tells to `setParticles()` to compute the particle rotations or not.
  111092. * Default value : true. The SPS is faster when it's set to false.
  111093. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111094. */
  111095. set computeParticleRotation(val: boolean);
  111096. /**
  111097. * Tells to `setParticles()` to compute the particle colors or not.
  111098. * Default value : true. The SPS is faster when it's set to false.
  111099. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111100. */
  111101. set computeParticleColor(val: boolean);
  111102. set computeParticleTexture(val: boolean);
  111103. /**
  111104. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  111105. * Default value : false. The SPS is faster when it's set to false.
  111106. * Note : the particle custom vertex positions aren't stored values.
  111107. */
  111108. set computeParticleVertex(val: boolean);
  111109. /**
  111110. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  111111. */
  111112. set computeBoundingBox(val: boolean);
  111113. /**
  111114. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  111115. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111116. * Default : `true`
  111117. */
  111118. set depthSortParticles(val: boolean);
  111119. /**
  111120. * Gets if `setParticles()` computes the particle rotations or not.
  111121. * Default value : true. The SPS is faster when it's set to false.
  111122. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111123. */
  111124. get computeParticleRotation(): boolean;
  111125. /**
  111126. * Gets if `setParticles()` computes the particle colors or not.
  111127. * Default value : true. The SPS is faster when it's set to false.
  111128. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111129. */
  111130. get computeParticleColor(): boolean;
  111131. /**
  111132. * Gets if `setParticles()` computes the particle textures or not.
  111133. * Default value : true. The SPS is faster when it's set to false.
  111134. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  111135. */
  111136. get computeParticleTexture(): boolean;
  111137. /**
  111138. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  111139. * Default value : false. The SPS is faster when it's set to false.
  111140. * Note : the particle custom vertex positions aren't stored values.
  111141. */
  111142. get computeParticleVertex(): boolean;
  111143. /**
  111144. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  111145. */
  111146. get computeBoundingBox(): boolean;
  111147. /**
  111148. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  111149. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111150. * Default : `true`
  111151. */
  111152. get depthSortParticles(): boolean;
  111153. /**
  111154. * Gets if the SPS is created as expandable at construction time.
  111155. * Default : `false`
  111156. */
  111157. get expandable(): boolean;
  111158. /**
  111159. * Gets if the SPS supports the Multi Materials
  111160. */
  111161. get multimaterialEnabled(): boolean;
  111162. /**
  111163. * Gets if the SPS uses the model materials for its own multimaterial.
  111164. */
  111165. get useModelMaterial(): boolean;
  111166. /**
  111167. * The SPS used material array.
  111168. */
  111169. get materials(): Material[];
  111170. /**
  111171. * Sets the SPS MultiMaterial from the passed materials.
  111172. * Note : the passed array is internally copied and not used then by reference.
  111173. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  111174. */
  111175. setMultiMaterial(materials: Material[]): void;
  111176. /**
  111177. * The SPS computed multimaterial object
  111178. */
  111179. get multimaterial(): MultiMaterial;
  111180. set multimaterial(mm: MultiMaterial);
  111181. /**
  111182. * If the subMeshes must be updated on the next call to setParticles()
  111183. */
  111184. get autoUpdateSubMeshes(): boolean;
  111185. set autoUpdateSubMeshes(val: boolean);
  111186. /**
  111187. * This function does nothing. It may be overwritten to set all the particle first values.
  111188. * The SPS doesn't call this function, you may have to call it by your own.
  111189. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111190. */
  111191. initParticles(): void;
  111192. /**
  111193. * This function does nothing. It may be overwritten to recycle a particle.
  111194. * The SPS doesn't call this function, you may have to call it by your own.
  111195. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111196. * @param particle The particle to recycle
  111197. * @returns the recycled particle
  111198. */
  111199. recycleParticle(particle: SolidParticle): SolidParticle;
  111200. /**
  111201. * Updates a particle : this function should be overwritten by the user.
  111202. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  111203. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111204. * @example : just set a particle position or velocity and recycle conditions
  111205. * @param particle The particle to update
  111206. * @returns the updated particle
  111207. */
  111208. updateParticle(particle: SolidParticle): SolidParticle;
  111209. /**
  111210. * Updates a vertex of a particle : it can be overwritten by the user.
  111211. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  111212. * @param particle the current particle
  111213. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  111214. * @param pt the index of the current vertex in the particle shape
  111215. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  111216. * @example : just set a vertex particle position or color
  111217. * @returns the sps
  111218. */
  111219. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  111220. /**
  111221. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  111222. * This does nothing and may be overwritten by the user.
  111223. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111224. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111225. * @param update the boolean update value actually passed to setParticles()
  111226. */
  111227. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111228. /**
  111229. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  111230. * This will be passed three parameters.
  111231. * This does nothing and may be overwritten by the user.
  111232. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111233. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111234. * @param update the boolean update value actually passed to setParticles()
  111235. */
  111236. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111237. }
  111238. }
  111239. declare module BABYLON {
  111240. /**
  111241. * Represents one particle of a solid particle system.
  111242. */
  111243. export class SolidParticle {
  111244. /**
  111245. * particle global index
  111246. */
  111247. idx: number;
  111248. /**
  111249. * particle identifier
  111250. */
  111251. id: number;
  111252. /**
  111253. * The color of the particle
  111254. */
  111255. color: Nullable<Color4>;
  111256. /**
  111257. * The world space position of the particle.
  111258. */
  111259. position: Vector3;
  111260. /**
  111261. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  111262. */
  111263. rotation: Vector3;
  111264. /**
  111265. * The world space rotation quaternion of the particle.
  111266. */
  111267. rotationQuaternion: Nullable<Quaternion>;
  111268. /**
  111269. * The scaling of the particle.
  111270. */
  111271. scaling: Vector3;
  111272. /**
  111273. * The uvs of the particle.
  111274. */
  111275. uvs: Vector4;
  111276. /**
  111277. * The current speed of the particle.
  111278. */
  111279. velocity: Vector3;
  111280. /**
  111281. * The pivot point in the particle local space.
  111282. */
  111283. pivot: Vector3;
  111284. /**
  111285. * Must the particle be translated from its pivot point in its local space ?
  111286. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  111287. * Default : false
  111288. */
  111289. translateFromPivot: boolean;
  111290. /**
  111291. * Is the particle active or not ?
  111292. */
  111293. alive: boolean;
  111294. /**
  111295. * Is the particle visible or not ?
  111296. */
  111297. isVisible: boolean;
  111298. /**
  111299. * Index of this particle in the global "positions" array (Internal use)
  111300. * @hidden
  111301. */
  111302. _pos: number;
  111303. /**
  111304. * @hidden Index of this particle in the global "indices" array (Internal use)
  111305. */
  111306. _ind: number;
  111307. /**
  111308. * @hidden ModelShape of this particle (Internal use)
  111309. */
  111310. _model: ModelShape;
  111311. /**
  111312. * ModelShape id of this particle
  111313. */
  111314. shapeId: number;
  111315. /**
  111316. * Index of the particle in its shape id
  111317. */
  111318. idxInShape: number;
  111319. /**
  111320. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  111321. */
  111322. _modelBoundingInfo: BoundingInfo;
  111323. /**
  111324. * @hidden Particle BoundingInfo object (Internal use)
  111325. */
  111326. _boundingInfo: BoundingInfo;
  111327. /**
  111328. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  111329. */
  111330. _sps: SolidParticleSystem;
  111331. /**
  111332. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  111333. */
  111334. _stillInvisible: boolean;
  111335. /**
  111336. * @hidden Last computed particle rotation matrix
  111337. */
  111338. _rotationMatrix: number[];
  111339. /**
  111340. * Parent particle Id, if any.
  111341. * Default null.
  111342. */
  111343. parentId: Nullable<number>;
  111344. /**
  111345. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  111346. */
  111347. materialIndex: Nullable<number>;
  111348. /**
  111349. * Custom object or properties.
  111350. */
  111351. props: Nullable<any>;
  111352. /**
  111353. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  111354. * The possible values are :
  111355. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111356. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111357. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111358. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111359. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111360. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  111361. * */
  111362. cullingStrategy: number;
  111363. /**
  111364. * @hidden Internal global position in the SPS.
  111365. */
  111366. _globalPosition: Vector3;
  111367. /**
  111368. * Creates a Solid Particle object.
  111369. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  111370. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  111371. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  111372. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  111373. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  111374. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  111375. * @param shapeId (integer) is the model shape identifier in the SPS.
  111376. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  111377. * @param sps defines the sps it is associated to
  111378. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  111379. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  111380. */
  111381. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  111382. /**
  111383. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  111384. * @param target the particle target
  111385. * @returns the current particle
  111386. */
  111387. copyToRef(target: SolidParticle): SolidParticle;
  111388. /**
  111389. * Legacy support, changed scale to scaling
  111390. */
  111391. get scale(): Vector3;
  111392. /**
  111393. * Legacy support, changed scale to scaling
  111394. */
  111395. set scale(scale: Vector3);
  111396. /**
  111397. * Legacy support, changed quaternion to rotationQuaternion
  111398. */
  111399. get quaternion(): Nullable<Quaternion>;
  111400. /**
  111401. * Legacy support, changed quaternion to rotationQuaternion
  111402. */
  111403. set quaternion(q: Nullable<Quaternion>);
  111404. /**
  111405. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  111406. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  111407. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  111408. * @returns true if it intersects
  111409. */
  111410. intersectsMesh(target: Mesh | SolidParticle): boolean;
  111411. /**
  111412. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  111413. * A particle is in the frustum if its bounding box intersects the frustum
  111414. * @param frustumPlanes defines the frustum to test
  111415. * @returns true if the particle is in the frustum planes
  111416. */
  111417. isInFrustum(frustumPlanes: Plane[]): boolean;
  111418. /**
  111419. * get the rotation matrix of the particle
  111420. * @hidden
  111421. */
  111422. getRotationMatrix(m: Matrix): void;
  111423. }
  111424. /**
  111425. * Represents the shape of the model used by one particle of a solid particle system.
  111426. * SPS internal tool, don't use it manually.
  111427. */
  111428. export class ModelShape {
  111429. /**
  111430. * The shape id
  111431. * @hidden
  111432. */
  111433. shapeID: number;
  111434. /**
  111435. * flat array of model positions (internal use)
  111436. * @hidden
  111437. */
  111438. _shape: Vector3[];
  111439. /**
  111440. * flat array of model UVs (internal use)
  111441. * @hidden
  111442. */
  111443. _shapeUV: number[];
  111444. /**
  111445. * color array of the model
  111446. * @hidden
  111447. */
  111448. _shapeColors: number[];
  111449. /**
  111450. * indices array of the model
  111451. * @hidden
  111452. */
  111453. _indices: number[];
  111454. /**
  111455. * normals array of the model
  111456. * @hidden
  111457. */
  111458. _normals: number[];
  111459. /**
  111460. * length of the shape in the model indices array (internal use)
  111461. * @hidden
  111462. */
  111463. _indicesLength: number;
  111464. /**
  111465. * Custom position function (internal use)
  111466. * @hidden
  111467. */
  111468. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  111469. /**
  111470. * Custom vertex function (internal use)
  111471. * @hidden
  111472. */
  111473. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  111474. /**
  111475. * Model material (internal use)
  111476. * @hidden
  111477. */
  111478. _material: Nullable<Material>;
  111479. /**
  111480. * 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.
  111481. * SPS internal tool, don't use it manually.
  111482. * @hidden
  111483. */
  111484. 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>);
  111485. }
  111486. /**
  111487. * Represents a Depth Sorted Particle in the solid particle system.
  111488. * @hidden
  111489. */
  111490. export class DepthSortedParticle {
  111491. /**
  111492. * Particle index
  111493. */
  111494. idx: number;
  111495. /**
  111496. * Index of the particle in the "indices" array
  111497. */
  111498. ind: number;
  111499. /**
  111500. * Length of the particle shape in the "indices" array
  111501. */
  111502. indicesLength: number;
  111503. /**
  111504. * Squared distance from the particle to the camera
  111505. */
  111506. sqDistance: number;
  111507. /**
  111508. * Material index when used with MultiMaterials
  111509. */
  111510. materialIndex: number;
  111511. /**
  111512. * Creates a new sorted particle
  111513. * @param materialIndex
  111514. */
  111515. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  111516. }
  111517. /**
  111518. * Represents a solid particle vertex
  111519. */
  111520. export class SolidParticleVertex {
  111521. /**
  111522. * Vertex position
  111523. */
  111524. position: Vector3;
  111525. /**
  111526. * Vertex color
  111527. */
  111528. color: Color4;
  111529. /**
  111530. * Vertex UV
  111531. */
  111532. uv: Vector2;
  111533. /**
  111534. * Creates a new solid particle vertex
  111535. */
  111536. constructor();
  111537. /** Vertex x coordinate */
  111538. get x(): number;
  111539. set x(val: number);
  111540. /** Vertex y coordinate */
  111541. get y(): number;
  111542. set y(val: number);
  111543. /** Vertex z coordinate */
  111544. get z(): number;
  111545. set z(val: number);
  111546. }
  111547. }
  111548. declare module BABYLON {
  111549. /**
  111550. * @hidden
  111551. */
  111552. export class _MeshCollisionData {
  111553. _checkCollisions: boolean;
  111554. _collisionMask: number;
  111555. _collisionGroup: number;
  111556. _surroundingMeshes: Nullable<AbstractMesh[]>;
  111557. _collider: Nullable<Collider>;
  111558. _oldPositionForCollisions: Vector3;
  111559. _diffPositionForCollisions: Vector3;
  111560. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  111561. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  111562. }
  111563. }
  111564. declare module BABYLON {
  111565. /** @hidden */
  111566. class _FacetDataStorage {
  111567. facetPositions: Vector3[];
  111568. facetNormals: Vector3[];
  111569. facetPartitioning: number[][];
  111570. facetNb: number;
  111571. partitioningSubdivisions: number;
  111572. partitioningBBoxRatio: number;
  111573. facetDataEnabled: boolean;
  111574. facetParameters: any;
  111575. bbSize: Vector3;
  111576. subDiv: {
  111577. max: number;
  111578. X: number;
  111579. Y: number;
  111580. Z: number;
  111581. };
  111582. facetDepthSort: boolean;
  111583. facetDepthSortEnabled: boolean;
  111584. depthSortedIndices: IndicesArray;
  111585. depthSortedFacets: {
  111586. ind: number;
  111587. sqDistance: number;
  111588. }[];
  111589. facetDepthSortFunction: (f1: {
  111590. ind: number;
  111591. sqDistance: number;
  111592. }, f2: {
  111593. ind: number;
  111594. sqDistance: number;
  111595. }) => number;
  111596. facetDepthSortFrom: Vector3;
  111597. facetDepthSortOrigin: Vector3;
  111598. invertedMatrix: Matrix;
  111599. }
  111600. /**
  111601. * @hidden
  111602. **/
  111603. class _InternalAbstractMeshDataInfo {
  111604. _hasVertexAlpha: boolean;
  111605. _useVertexColors: boolean;
  111606. _numBoneInfluencers: number;
  111607. _applyFog: boolean;
  111608. _receiveShadows: boolean;
  111609. _facetData: _FacetDataStorage;
  111610. _visibility: number;
  111611. _skeleton: Nullable<Skeleton>;
  111612. _layerMask: number;
  111613. _computeBonesUsingShaders: boolean;
  111614. _isActive: boolean;
  111615. _onlyForInstances: boolean;
  111616. _isActiveIntermediate: boolean;
  111617. _onlyForInstancesIntermediate: boolean;
  111618. _actAsRegularMesh: boolean;
  111619. }
  111620. /**
  111621. * Class used to store all common mesh properties
  111622. */
  111623. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  111624. /** No occlusion */
  111625. static OCCLUSION_TYPE_NONE: number;
  111626. /** Occlusion set to optimisitic */
  111627. static OCCLUSION_TYPE_OPTIMISTIC: number;
  111628. /** Occlusion set to strict */
  111629. static OCCLUSION_TYPE_STRICT: number;
  111630. /** Use an accurante occlusion algorithm */
  111631. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  111632. /** Use a conservative occlusion algorithm */
  111633. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  111634. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  111635. * Test order :
  111636. * Is the bounding sphere outside the frustum ?
  111637. * If not, are the bounding box vertices outside the frustum ?
  111638. * It not, then the cullable object is in the frustum.
  111639. */
  111640. static readonly CULLINGSTRATEGY_STANDARD: number;
  111641. /** Culling strategy : Bounding Sphere Only.
  111642. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  111643. * It's also less accurate than the standard because some not visible objects can still be selected.
  111644. * Test : is the bounding sphere outside the frustum ?
  111645. * If not, then the cullable object is in the frustum.
  111646. */
  111647. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  111648. /** Culling strategy : Optimistic Inclusion.
  111649. * This in an inclusion test first, then the standard exclusion test.
  111650. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  111651. * 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.
  111652. * Anyway, it's as accurate as the standard strategy.
  111653. * Test :
  111654. * Is the cullable object bounding sphere center in the frustum ?
  111655. * If not, apply the default culling strategy.
  111656. */
  111657. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  111658. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  111659. * This in an inclusion test first, then the bounding sphere only exclusion test.
  111660. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  111661. * 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.
  111662. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  111663. * Test :
  111664. * Is the cullable object bounding sphere center in the frustum ?
  111665. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  111666. */
  111667. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  111668. /**
  111669. * No billboard
  111670. */
  111671. static get BILLBOARDMODE_NONE(): number;
  111672. /** Billboard on X axis */
  111673. static get BILLBOARDMODE_X(): number;
  111674. /** Billboard on Y axis */
  111675. static get BILLBOARDMODE_Y(): number;
  111676. /** Billboard on Z axis */
  111677. static get BILLBOARDMODE_Z(): number;
  111678. /** Billboard on all axes */
  111679. static get BILLBOARDMODE_ALL(): number;
  111680. /** Billboard on using position instead of orientation */
  111681. static get BILLBOARDMODE_USE_POSITION(): number;
  111682. /** @hidden */
  111683. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  111684. /**
  111685. * The culling strategy to use to check whether the mesh must be rendered or not.
  111686. * This value can be changed at any time and will be used on the next render mesh selection.
  111687. * The possible values are :
  111688. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111689. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111690. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111691. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111692. * Please read each static variable documentation to get details about the culling process.
  111693. * */
  111694. cullingStrategy: number;
  111695. /**
  111696. * Gets the number of facets in the mesh
  111697. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111698. */
  111699. get facetNb(): number;
  111700. /**
  111701. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  111702. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111703. */
  111704. get partitioningSubdivisions(): number;
  111705. set partitioningSubdivisions(nb: number);
  111706. /**
  111707. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  111708. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  111709. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111710. */
  111711. get partitioningBBoxRatio(): number;
  111712. set partitioningBBoxRatio(ratio: number);
  111713. /**
  111714. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  111715. * Works only for updatable meshes.
  111716. * Doesn't work with multi-materials
  111717. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111718. */
  111719. get mustDepthSortFacets(): boolean;
  111720. set mustDepthSortFacets(sort: boolean);
  111721. /**
  111722. * The location (Vector3) where the facet depth sort must be computed from.
  111723. * By default, the active camera position.
  111724. * Used only when facet depth sort is enabled
  111725. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111726. */
  111727. get facetDepthSortFrom(): Vector3;
  111728. set facetDepthSortFrom(location: Vector3);
  111729. /**
  111730. * gets a boolean indicating if facetData is enabled
  111731. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111732. */
  111733. get isFacetDataEnabled(): boolean;
  111734. /** @hidden */
  111735. _updateNonUniformScalingState(value: boolean): boolean;
  111736. /**
  111737. * An event triggered when this mesh collides with another one
  111738. */
  111739. onCollideObservable: Observable<AbstractMesh>;
  111740. /** Set a function to call when this mesh collides with another one */
  111741. set onCollide(callback: () => void);
  111742. /**
  111743. * An event triggered when the collision's position changes
  111744. */
  111745. onCollisionPositionChangeObservable: Observable<Vector3>;
  111746. /** Set a function to call when the collision's position changes */
  111747. set onCollisionPositionChange(callback: () => void);
  111748. /**
  111749. * An event triggered when material is changed
  111750. */
  111751. onMaterialChangedObservable: Observable<AbstractMesh>;
  111752. /**
  111753. * Gets or sets the orientation for POV movement & rotation
  111754. */
  111755. definedFacingForward: boolean;
  111756. /** @hidden */
  111757. _occlusionQuery: Nullable<WebGLQuery>;
  111758. /** @hidden */
  111759. _renderingGroup: Nullable<RenderingGroup>;
  111760. /**
  111761. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111762. */
  111763. get visibility(): number;
  111764. /**
  111765. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111766. */
  111767. set visibility(value: number);
  111768. /** Gets or sets the alpha index used to sort transparent meshes
  111769. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  111770. */
  111771. alphaIndex: number;
  111772. /**
  111773. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  111774. */
  111775. isVisible: boolean;
  111776. /**
  111777. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  111778. */
  111779. isPickable: boolean;
  111780. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  111781. showSubMeshesBoundingBox: boolean;
  111782. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  111783. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  111784. */
  111785. isBlocker: boolean;
  111786. /**
  111787. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  111788. */
  111789. enablePointerMoveEvents: boolean;
  111790. private _renderingGroupId;
  111791. /**
  111792. * Specifies the rendering group id for this mesh (0 by default)
  111793. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  111794. */
  111795. get renderingGroupId(): number;
  111796. set renderingGroupId(value: number);
  111797. private _material;
  111798. /** Gets or sets current material */
  111799. get material(): Nullable<Material>;
  111800. set material(value: Nullable<Material>);
  111801. /**
  111802. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  111803. * @see https://doc.babylonjs.com/babylon101/shadows
  111804. */
  111805. get receiveShadows(): boolean;
  111806. set receiveShadows(value: boolean);
  111807. /** Defines color to use when rendering outline */
  111808. outlineColor: Color3;
  111809. /** Define width to use when rendering outline */
  111810. outlineWidth: number;
  111811. /** Defines color to use when rendering overlay */
  111812. overlayColor: Color3;
  111813. /** Defines alpha to use when rendering overlay */
  111814. overlayAlpha: number;
  111815. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  111816. get hasVertexAlpha(): boolean;
  111817. set hasVertexAlpha(value: boolean);
  111818. /** 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) */
  111819. get useVertexColors(): boolean;
  111820. set useVertexColors(value: boolean);
  111821. /**
  111822. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  111823. */
  111824. get computeBonesUsingShaders(): boolean;
  111825. set computeBonesUsingShaders(value: boolean);
  111826. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  111827. get numBoneInfluencers(): number;
  111828. set numBoneInfluencers(value: number);
  111829. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  111830. get applyFog(): boolean;
  111831. set applyFog(value: boolean);
  111832. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  111833. useOctreeForRenderingSelection: boolean;
  111834. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  111835. useOctreeForPicking: boolean;
  111836. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  111837. useOctreeForCollisions: boolean;
  111838. /**
  111839. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  111840. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  111841. */
  111842. get layerMask(): number;
  111843. set layerMask(value: number);
  111844. /**
  111845. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  111846. */
  111847. alwaysSelectAsActiveMesh: boolean;
  111848. /**
  111849. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  111850. */
  111851. doNotSyncBoundingInfo: boolean;
  111852. /**
  111853. * Gets or sets the current action manager
  111854. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  111855. */
  111856. actionManager: Nullable<AbstractActionManager>;
  111857. private _meshCollisionData;
  111858. /**
  111859. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  111860. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111861. */
  111862. ellipsoid: Vector3;
  111863. /**
  111864. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  111865. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111866. */
  111867. ellipsoidOffset: Vector3;
  111868. /**
  111869. * Gets or sets a collision mask used to mask collisions (default is -1).
  111870. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111871. */
  111872. get collisionMask(): number;
  111873. set collisionMask(mask: number);
  111874. /**
  111875. * Gets or sets the current collision group mask (-1 by default).
  111876. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111877. */
  111878. get collisionGroup(): number;
  111879. set collisionGroup(mask: number);
  111880. /**
  111881. * Gets or sets current surrounding meshes (null by default).
  111882. *
  111883. * By default collision detection is tested against every mesh in the scene.
  111884. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  111885. * meshes will be tested for the collision.
  111886. *
  111887. * Note: if set to an empty array no collision will happen when this mesh is moved.
  111888. */
  111889. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  111890. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  111891. /**
  111892. * Defines edge width used when edgesRenderer is enabled
  111893. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111894. */
  111895. edgesWidth: number;
  111896. /**
  111897. * Defines edge color used when edgesRenderer is enabled
  111898. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111899. */
  111900. edgesColor: Color4;
  111901. /** @hidden */
  111902. _edgesRenderer: Nullable<IEdgesRenderer>;
  111903. /** @hidden */
  111904. _masterMesh: Nullable<AbstractMesh>;
  111905. /** @hidden */
  111906. _boundingInfo: Nullable<BoundingInfo>;
  111907. /** @hidden */
  111908. _renderId: number;
  111909. /**
  111910. * Gets or sets the list of subMeshes
  111911. * @see https://doc.babylonjs.com/how_to/multi_materials
  111912. */
  111913. subMeshes: SubMesh[];
  111914. /** @hidden */
  111915. _intersectionsInProgress: AbstractMesh[];
  111916. /** @hidden */
  111917. _unIndexed: boolean;
  111918. /** @hidden */
  111919. _lightSources: Light[];
  111920. /** Gets the list of lights affecting that mesh */
  111921. get lightSources(): Light[];
  111922. /** @hidden */
  111923. get _positions(): Nullable<Vector3[]>;
  111924. /** @hidden */
  111925. _waitingData: {
  111926. lods: Nullable<any>;
  111927. actions: Nullable<any>;
  111928. freezeWorldMatrix: Nullable<boolean>;
  111929. };
  111930. /** @hidden */
  111931. _bonesTransformMatrices: Nullable<Float32Array>;
  111932. /** @hidden */
  111933. _transformMatrixTexture: Nullable<RawTexture>;
  111934. /**
  111935. * Gets or sets a skeleton to apply skining transformations
  111936. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  111937. */
  111938. set skeleton(value: Nullable<Skeleton>);
  111939. get skeleton(): Nullable<Skeleton>;
  111940. /**
  111941. * An event triggered when the mesh is rebuilt.
  111942. */
  111943. onRebuildObservable: Observable<AbstractMesh>;
  111944. /**
  111945. * Creates a new AbstractMesh
  111946. * @param name defines the name of the mesh
  111947. * @param scene defines the hosting scene
  111948. */
  111949. constructor(name: string, scene?: Nullable<Scene>);
  111950. /**
  111951. * Returns the string "AbstractMesh"
  111952. * @returns "AbstractMesh"
  111953. */
  111954. getClassName(): string;
  111955. /**
  111956. * Gets a string representation of the current mesh
  111957. * @param fullDetails defines a boolean indicating if full details must be included
  111958. * @returns a string representation of the current mesh
  111959. */
  111960. toString(fullDetails?: boolean): string;
  111961. /**
  111962. * @hidden
  111963. */
  111964. protected _getEffectiveParent(): Nullable<Node>;
  111965. /** @hidden */
  111966. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  111967. /** @hidden */
  111968. _rebuild(): void;
  111969. /** @hidden */
  111970. _resyncLightSources(): void;
  111971. /** @hidden */
  111972. _resyncLightSource(light: Light): void;
  111973. /** @hidden */
  111974. _unBindEffect(): void;
  111975. /** @hidden */
  111976. _removeLightSource(light: Light, dispose: boolean): void;
  111977. private _markSubMeshesAsDirty;
  111978. /** @hidden */
  111979. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  111980. /** @hidden */
  111981. _markSubMeshesAsAttributesDirty(): void;
  111982. /** @hidden */
  111983. _markSubMeshesAsMiscDirty(): void;
  111984. /**
  111985. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  111986. */
  111987. get scaling(): Vector3;
  111988. set scaling(newScaling: Vector3);
  111989. /**
  111990. * Returns true if the mesh is blocked. Implemented by child classes
  111991. */
  111992. get isBlocked(): boolean;
  111993. /**
  111994. * Returns the mesh itself by default. Implemented by child classes
  111995. * @param camera defines the camera to use to pick the right LOD level
  111996. * @returns the currentAbstractMesh
  111997. */
  111998. getLOD(camera: Camera): Nullable<AbstractMesh>;
  111999. /**
  112000. * Returns 0 by default. Implemented by child classes
  112001. * @returns an integer
  112002. */
  112003. getTotalVertices(): number;
  112004. /**
  112005. * Returns a positive integer : the total number of indices in this mesh geometry.
  112006. * @returns the numner of indices or zero if the mesh has no geometry.
  112007. */
  112008. getTotalIndices(): number;
  112009. /**
  112010. * Returns null by default. Implemented by child classes
  112011. * @returns null
  112012. */
  112013. getIndices(): Nullable<IndicesArray>;
  112014. /**
  112015. * Returns the array of the requested vertex data kind. Implemented by child classes
  112016. * @param kind defines the vertex data kind to use
  112017. * @returns null
  112018. */
  112019. getVerticesData(kind: string): Nullable<FloatArray>;
  112020. /**
  112021. * Sets the vertex data of the mesh geometry for the requested `kind`.
  112022. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  112023. * Note that a new underlying VertexBuffer object is created each call.
  112024. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  112025. * @param kind defines vertex data kind:
  112026. * * VertexBuffer.PositionKind
  112027. * * VertexBuffer.UVKind
  112028. * * VertexBuffer.UV2Kind
  112029. * * VertexBuffer.UV3Kind
  112030. * * VertexBuffer.UV4Kind
  112031. * * VertexBuffer.UV5Kind
  112032. * * VertexBuffer.UV6Kind
  112033. * * VertexBuffer.ColorKind
  112034. * * VertexBuffer.MatricesIndicesKind
  112035. * * VertexBuffer.MatricesIndicesExtraKind
  112036. * * VertexBuffer.MatricesWeightsKind
  112037. * * VertexBuffer.MatricesWeightsExtraKind
  112038. * @param data defines the data source
  112039. * @param updatable defines if the data must be flagged as updatable (or static)
  112040. * @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
  112041. * @returns the current mesh
  112042. */
  112043. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  112044. /**
  112045. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  112046. * If the mesh has no geometry, it is simply returned as it is.
  112047. * @param kind defines vertex data kind:
  112048. * * VertexBuffer.PositionKind
  112049. * * VertexBuffer.UVKind
  112050. * * VertexBuffer.UV2Kind
  112051. * * VertexBuffer.UV3Kind
  112052. * * VertexBuffer.UV4Kind
  112053. * * VertexBuffer.UV5Kind
  112054. * * VertexBuffer.UV6Kind
  112055. * * VertexBuffer.ColorKind
  112056. * * VertexBuffer.MatricesIndicesKind
  112057. * * VertexBuffer.MatricesIndicesExtraKind
  112058. * * VertexBuffer.MatricesWeightsKind
  112059. * * VertexBuffer.MatricesWeightsExtraKind
  112060. * @param data defines the data source
  112061. * @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
  112062. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  112063. * @returns the current mesh
  112064. */
  112065. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  112066. /**
  112067. * Sets the mesh indices,
  112068. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  112069. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  112070. * @param totalVertices Defines the total number of vertices
  112071. * @returns the current mesh
  112072. */
  112073. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  112074. /**
  112075. * Gets a boolean indicating if specific vertex data is present
  112076. * @param kind defines the vertex data kind to use
  112077. * @returns true is data kind is present
  112078. */
  112079. isVerticesDataPresent(kind: string): boolean;
  112080. /**
  112081. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  112082. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  112083. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  112084. * @returns a BoundingInfo
  112085. */
  112086. getBoundingInfo(): BoundingInfo;
  112087. /**
  112088. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  112089. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  112090. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  112091. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  112092. * @returns the current mesh
  112093. */
  112094. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  112095. /**
  112096. * Overwrite the current bounding info
  112097. * @param boundingInfo defines the new bounding info
  112098. * @returns the current mesh
  112099. */
  112100. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  112101. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  112102. get useBones(): boolean;
  112103. /** @hidden */
  112104. _preActivate(): void;
  112105. /** @hidden */
  112106. _preActivateForIntermediateRendering(renderId: number): void;
  112107. /** @hidden */
  112108. _activate(renderId: number, intermediateRendering: boolean): boolean;
  112109. /** @hidden */
  112110. _postActivate(): void;
  112111. /** @hidden */
  112112. _freeze(): void;
  112113. /** @hidden */
  112114. _unFreeze(): void;
  112115. /**
  112116. * Gets the current world matrix
  112117. * @returns a Matrix
  112118. */
  112119. getWorldMatrix(): Matrix;
  112120. /** @hidden */
  112121. _getWorldMatrixDeterminant(): number;
  112122. /**
  112123. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  112124. */
  112125. get isAnInstance(): boolean;
  112126. /**
  112127. * Gets a boolean indicating if this mesh has instances
  112128. */
  112129. get hasInstances(): boolean;
  112130. /**
  112131. * Gets a boolean indicating if this mesh has thin instances
  112132. */
  112133. get hasThinInstances(): boolean;
  112134. /**
  112135. * Perform relative position change from the point of view of behind the front of the mesh.
  112136. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112137. * Supports definition of mesh facing forward or backward
  112138. * @param amountRight defines the distance on the right axis
  112139. * @param amountUp defines the distance on the up axis
  112140. * @param amountForward defines the distance on the forward axis
  112141. * @returns the current mesh
  112142. */
  112143. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  112144. /**
  112145. * Calculate relative position change from the point of view of behind the front of the mesh.
  112146. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112147. * Supports definition of mesh facing forward or backward
  112148. * @param amountRight defines the distance on the right axis
  112149. * @param amountUp defines the distance on the up axis
  112150. * @param amountForward defines the distance on the forward axis
  112151. * @returns the new displacement vector
  112152. */
  112153. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  112154. /**
  112155. * Perform relative rotation change from the point of view of behind the front of the mesh.
  112156. * Supports definition of mesh facing forward or backward
  112157. * @param flipBack defines the flip
  112158. * @param twirlClockwise defines the twirl
  112159. * @param tiltRight defines the tilt
  112160. * @returns the current mesh
  112161. */
  112162. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  112163. /**
  112164. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  112165. * Supports definition of mesh facing forward or backward.
  112166. * @param flipBack defines the flip
  112167. * @param twirlClockwise defines the twirl
  112168. * @param tiltRight defines the tilt
  112169. * @returns the new rotation vector
  112170. */
  112171. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  112172. /**
  112173. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  112174. * This means the mesh underlying bounding box and sphere are recomputed.
  112175. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  112176. * @returns the current mesh
  112177. */
  112178. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  112179. /** @hidden */
  112180. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  112181. /** @hidden */
  112182. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  112183. /** @hidden */
  112184. _updateBoundingInfo(): AbstractMesh;
  112185. /** @hidden */
  112186. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  112187. /** @hidden */
  112188. protected _afterComputeWorldMatrix(): void;
  112189. /** @hidden */
  112190. get _effectiveMesh(): AbstractMesh;
  112191. /**
  112192. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  112193. * A mesh is in the frustum if its bounding box intersects the frustum
  112194. * @param frustumPlanes defines the frustum to test
  112195. * @returns true if the mesh is in the frustum planes
  112196. */
  112197. isInFrustum(frustumPlanes: Plane[]): boolean;
  112198. /**
  112199. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  112200. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  112201. * @param frustumPlanes defines the frustum to test
  112202. * @returns true if the mesh is completely in the frustum planes
  112203. */
  112204. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  112205. /**
  112206. * True if the mesh intersects another mesh or a SolidParticle object
  112207. * @param mesh defines a target mesh or SolidParticle to test
  112208. * @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)
  112209. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  112210. * @returns true if there is an intersection
  112211. */
  112212. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  112213. /**
  112214. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  112215. * @param point defines the point to test
  112216. * @returns true if there is an intersection
  112217. */
  112218. intersectsPoint(point: Vector3): boolean;
  112219. /**
  112220. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  112221. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112222. */
  112223. get checkCollisions(): boolean;
  112224. set checkCollisions(collisionEnabled: boolean);
  112225. /**
  112226. * Gets Collider object used to compute collisions (not physics)
  112227. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112228. */
  112229. get collider(): Nullable<Collider>;
  112230. /**
  112231. * Move the mesh using collision engine
  112232. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112233. * @param displacement defines the requested displacement vector
  112234. * @returns the current mesh
  112235. */
  112236. moveWithCollisions(displacement: Vector3): AbstractMesh;
  112237. private _onCollisionPositionChange;
  112238. /** @hidden */
  112239. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  112240. /** @hidden */
  112241. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  112242. /** @hidden */
  112243. _checkCollision(collider: Collider): AbstractMesh;
  112244. /** @hidden */
  112245. _generatePointsArray(): boolean;
  112246. /**
  112247. * Checks if the passed Ray intersects with the mesh
  112248. * @param ray defines the ray to use
  112249. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  112250. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  112251. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  112252. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  112253. * @returns the picking info
  112254. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  112255. */
  112256. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  112257. /**
  112258. * Clones the current mesh
  112259. * @param name defines the mesh name
  112260. * @param newParent defines the new mesh parent
  112261. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  112262. * @returns the new mesh
  112263. */
  112264. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  112265. /**
  112266. * Disposes all the submeshes of the current meshnp
  112267. * @returns the current mesh
  112268. */
  112269. releaseSubMeshes(): AbstractMesh;
  112270. /**
  112271. * Releases resources associated with this abstract mesh.
  112272. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112273. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112274. */
  112275. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112276. /**
  112277. * Adds the passed mesh as a child to the current mesh
  112278. * @param mesh defines the child mesh
  112279. * @returns the current mesh
  112280. */
  112281. addChild(mesh: AbstractMesh): AbstractMesh;
  112282. /**
  112283. * Removes the passed mesh from the current mesh children list
  112284. * @param mesh defines the child mesh
  112285. * @returns the current mesh
  112286. */
  112287. removeChild(mesh: AbstractMesh): AbstractMesh;
  112288. /** @hidden */
  112289. private _initFacetData;
  112290. /**
  112291. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  112292. * This method can be called within the render loop.
  112293. * 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
  112294. * @returns the current mesh
  112295. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112296. */
  112297. updateFacetData(): AbstractMesh;
  112298. /**
  112299. * Returns the facetLocalNormals array.
  112300. * The normals are expressed in the mesh local spac
  112301. * @returns an array of Vector3
  112302. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112303. */
  112304. getFacetLocalNormals(): Vector3[];
  112305. /**
  112306. * Returns the facetLocalPositions array.
  112307. * The facet positions are expressed in the mesh local space
  112308. * @returns an array of Vector3
  112309. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112310. */
  112311. getFacetLocalPositions(): Vector3[];
  112312. /**
  112313. * Returns the facetLocalPartioning array
  112314. * @returns an array of array of numbers
  112315. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112316. */
  112317. getFacetLocalPartitioning(): number[][];
  112318. /**
  112319. * Returns the i-th facet position in the world system.
  112320. * This method allocates a new Vector3 per call
  112321. * @param i defines the facet index
  112322. * @returns a new Vector3
  112323. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112324. */
  112325. getFacetPosition(i: number): Vector3;
  112326. /**
  112327. * Sets the reference Vector3 with the i-th facet position in the world system
  112328. * @param i defines the facet index
  112329. * @param ref defines the target vector
  112330. * @returns the current mesh
  112331. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112332. */
  112333. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  112334. /**
  112335. * Returns the i-th facet normal in the world system.
  112336. * This method allocates a new Vector3 per call
  112337. * @param i defines the facet index
  112338. * @returns a new Vector3
  112339. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112340. */
  112341. getFacetNormal(i: number): Vector3;
  112342. /**
  112343. * Sets the reference Vector3 with the i-th facet normal in the world system
  112344. * @param i defines the facet index
  112345. * @param ref defines the target vector
  112346. * @returns the current mesh
  112347. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112348. */
  112349. getFacetNormalToRef(i: number, ref: Vector3): this;
  112350. /**
  112351. * 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)
  112352. * @param x defines x coordinate
  112353. * @param y defines y coordinate
  112354. * @param z defines z coordinate
  112355. * @returns the array of facet indexes
  112356. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112357. */
  112358. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  112359. /**
  112360. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  112361. * @param projected sets as the (x,y,z) world projection on the facet
  112362. * @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
  112363. * @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
  112364. * @param x defines x coordinate
  112365. * @param y defines y coordinate
  112366. * @param z defines z coordinate
  112367. * @returns the face index if found (or null instead)
  112368. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112369. */
  112370. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112371. /**
  112372. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  112373. * @param projected sets as the (x,y,z) local projection on the facet
  112374. * @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
  112375. * @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
  112376. * @param x defines x coordinate
  112377. * @param y defines y coordinate
  112378. * @param z defines z coordinate
  112379. * @returns the face index if found (or null instead)
  112380. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112381. */
  112382. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112383. /**
  112384. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  112385. * @returns the parameters
  112386. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112387. */
  112388. getFacetDataParameters(): any;
  112389. /**
  112390. * Disables the feature FacetData and frees the related memory
  112391. * @returns the current mesh
  112392. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112393. */
  112394. disableFacetData(): AbstractMesh;
  112395. /**
  112396. * Updates the AbstractMesh indices array
  112397. * @param indices defines the data source
  112398. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  112399. * @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)
  112400. * @returns the current mesh
  112401. */
  112402. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  112403. /**
  112404. * Creates new normals data for the mesh
  112405. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  112406. * @returns the current mesh
  112407. */
  112408. createNormals(updatable: boolean): AbstractMesh;
  112409. /**
  112410. * Align the mesh with a normal
  112411. * @param normal defines the normal to use
  112412. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  112413. * @returns the current mesh
  112414. */
  112415. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  112416. /** @hidden */
  112417. _checkOcclusionQuery(): boolean;
  112418. /**
  112419. * Disables the mesh edge rendering mode
  112420. * @returns the currentAbstractMesh
  112421. */
  112422. disableEdgesRendering(): AbstractMesh;
  112423. /**
  112424. * Enables the edge rendering mode on the mesh.
  112425. * This mode makes the mesh edges visible
  112426. * @param epsilon defines the maximal distance between two angles to detect a face
  112427. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  112428. * @returns the currentAbstractMesh
  112429. * @see https://www.babylonjs-playground.com/#19O9TU#0
  112430. */
  112431. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  112432. /**
  112433. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  112434. * @returns an array of particle systems in the scene that use the mesh as an emitter
  112435. */
  112436. getConnectedParticleSystems(): IParticleSystem[];
  112437. }
  112438. }
  112439. declare module BABYLON {
  112440. /**
  112441. * Interface used to define ActionEvent
  112442. */
  112443. export interface IActionEvent {
  112444. /** The mesh or sprite that triggered the action */
  112445. source: any;
  112446. /** The X mouse cursor position at the time of the event */
  112447. pointerX: number;
  112448. /** The Y mouse cursor position at the time of the event */
  112449. pointerY: number;
  112450. /** The mesh that is currently pointed at (can be null) */
  112451. meshUnderPointer: Nullable<AbstractMesh>;
  112452. /** the original (browser) event that triggered the ActionEvent */
  112453. sourceEvent?: any;
  112454. /** additional data for the event */
  112455. additionalData?: any;
  112456. }
  112457. /**
  112458. * ActionEvent is the event being sent when an action is triggered.
  112459. */
  112460. export class ActionEvent implements IActionEvent {
  112461. /** The mesh or sprite that triggered the action */
  112462. source: any;
  112463. /** The X mouse cursor position at the time of the event */
  112464. pointerX: number;
  112465. /** The Y mouse cursor position at the time of the event */
  112466. pointerY: number;
  112467. /** The mesh that is currently pointed at (can be null) */
  112468. meshUnderPointer: Nullable<AbstractMesh>;
  112469. /** the original (browser) event that triggered the ActionEvent */
  112470. sourceEvent?: any;
  112471. /** additional data for the event */
  112472. additionalData?: any;
  112473. /**
  112474. * Creates a new ActionEvent
  112475. * @param source The mesh or sprite that triggered the action
  112476. * @param pointerX The X mouse cursor position at the time of the event
  112477. * @param pointerY The Y mouse cursor position at the time of the event
  112478. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  112479. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  112480. * @param additionalData additional data for the event
  112481. */
  112482. constructor(
  112483. /** The mesh or sprite that triggered the action */
  112484. source: any,
  112485. /** The X mouse cursor position at the time of the event */
  112486. pointerX: number,
  112487. /** The Y mouse cursor position at the time of the event */
  112488. pointerY: number,
  112489. /** The mesh that is currently pointed at (can be null) */
  112490. meshUnderPointer: Nullable<AbstractMesh>,
  112491. /** the original (browser) event that triggered the ActionEvent */
  112492. sourceEvent?: any,
  112493. /** additional data for the event */
  112494. additionalData?: any);
  112495. /**
  112496. * Helper function to auto-create an ActionEvent from a source mesh.
  112497. * @param source The source mesh that triggered the event
  112498. * @param evt The original (browser) event
  112499. * @param additionalData additional data for the event
  112500. * @returns the new ActionEvent
  112501. */
  112502. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  112503. /**
  112504. * Helper function to auto-create an ActionEvent from a source sprite
  112505. * @param source The source sprite that triggered the event
  112506. * @param scene Scene associated with the sprite
  112507. * @param evt The original (browser) event
  112508. * @param additionalData additional data for the event
  112509. * @returns the new ActionEvent
  112510. */
  112511. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  112512. /**
  112513. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  112514. * @param scene the scene where the event occurred
  112515. * @param evt The original (browser) event
  112516. * @returns the new ActionEvent
  112517. */
  112518. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  112519. /**
  112520. * Helper function to auto-create an ActionEvent from a primitive
  112521. * @param prim defines the target primitive
  112522. * @param pointerPos defines the pointer position
  112523. * @param evt The original (browser) event
  112524. * @param additionalData additional data for the event
  112525. * @returns the new ActionEvent
  112526. */
  112527. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  112528. }
  112529. }
  112530. declare module BABYLON {
  112531. /**
  112532. * Abstract class used to decouple action Manager from scene and meshes.
  112533. * Do not instantiate.
  112534. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  112535. */
  112536. export abstract class AbstractActionManager implements IDisposable {
  112537. /** Gets the list of active triggers */
  112538. static Triggers: {
  112539. [key: string]: number;
  112540. };
  112541. /** Gets the cursor to use when hovering items */
  112542. hoverCursor: string;
  112543. /** Gets the list of actions */
  112544. actions: IAction[];
  112545. /**
  112546. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  112547. */
  112548. isRecursive: boolean;
  112549. /**
  112550. * Releases all associated resources
  112551. */
  112552. abstract dispose(): void;
  112553. /**
  112554. * Does this action manager has pointer triggers
  112555. */
  112556. abstract get hasPointerTriggers(): boolean;
  112557. /**
  112558. * Does this action manager has pick triggers
  112559. */
  112560. abstract get hasPickTriggers(): boolean;
  112561. /**
  112562. * Process a specific trigger
  112563. * @param trigger defines the trigger to process
  112564. * @param evt defines the event details to be processed
  112565. */
  112566. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  112567. /**
  112568. * Does this action manager handles actions of any of the given triggers
  112569. * @param triggers defines the triggers to be tested
  112570. * @return a boolean indicating whether one (or more) of the triggers is handled
  112571. */
  112572. abstract hasSpecificTriggers(triggers: number[]): boolean;
  112573. /**
  112574. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  112575. * speed.
  112576. * @param triggerA defines the trigger to be tested
  112577. * @param triggerB defines the trigger to be tested
  112578. * @return a boolean indicating whether one (or more) of the triggers is handled
  112579. */
  112580. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  112581. /**
  112582. * Does this action manager handles actions of a given trigger
  112583. * @param trigger defines the trigger to be tested
  112584. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  112585. * @return whether the trigger is handled
  112586. */
  112587. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  112588. /**
  112589. * Serialize this manager to a JSON object
  112590. * @param name defines the property name to store this manager
  112591. * @returns a JSON representation of this manager
  112592. */
  112593. abstract serialize(name: string): any;
  112594. /**
  112595. * Registers an action to this action manager
  112596. * @param action defines the action to be registered
  112597. * @return the action amended (prepared) after registration
  112598. */
  112599. abstract registerAction(action: IAction): Nullable<IAction>;
  112600. /**
  112601. * Unregisters an action to this action manager
  112602. * @param action defines the action to be unregistered
  112603. * @return a boolean indicating whether the action has been unregistered
  112604. */
  112605. abstract unregisterAction(action: IAction): Boolean;
  112606. /**
  112607. * Does exist one action manager with at least one trigger
  112608. **/
  112609. static get HasTriggers(): boolean;
  112610. /**
  112611. * Does exist one action manager with at least one pick trigger
  112612. **/
  112613. static get HasPickTriggers(): boolean;
  112614. /**
  112615. * Does exist one action manager that handles actions of a given trigger
  112616. * @param trigger defines the trigger to be tested
  112617. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  112618. **/
  112619. static HasSpecificTrigger(trigger: number): boolean;
  112620. }
  112621. }
  112622. declare module BABYLON {
  112623. /**
  112624. * Defines how a node can be built from a string name.
  112625. */
  112626. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  112627. /**
  112628. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  112629. */
  112630. export class Node implements IBehaviorAware<Node> {
  112631. /** @hidden */
  112632. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  112633. private static _NodeConstructors;
  112634. /**
  112635. * Add a new node constructor
  112636. * @param type defines the type name of the node to construct
  112637. * @param constructorFunc defines the constructor function
  112638. */
  112639. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  112640. /**
  112641. * Returns a node constructor based on type name
  112642. * @param type defines the type name
  112643. * @param name defines the new node name
  112644. * @param scene defines the hosting scene
  112645. * @param options defines optional options to transmit to constructors
  112646. * @returns the new constructor or null
  112647. */
  112648. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  112649. /**
  112650. * Gets or sets the name of the node
  112651. */
  112652. name: string;
  112653. /**
  112654. * Gets or sets the id of the node
  112655. */
  112656. id: string;
  112657. /**
  112658. * Gets or sets the unique id of the node
  112659. */
  112660. uniqueId: number;
  112661. /**
  112662. * Gets or sets a string used to store user defined state for the node
  112663. */
  112664. state: string;
  112665. /**
  112666. * Gets or sets an object used to store user defined information for the node
  112667. */
  112668. metadata: any;
  112669. /**
  112670. * For internal use only. Please do not use.
  112671. */
  112672. reservedDataStore: any;
  112673. /**
  112674. * List of inspectable custom properties (used by the Inspector)
  112675. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  112676. */
  112677. inspectableCustomProperties: IInspectable[];
  112678. private _doNotSerialize;
  112679. /**
  112680. * Gets or sets a boolean used to define if the node must be serialized
  112681. */
  112682. get doNotSerialize(): boolean;
  112683. set doNotSerialize(value: boolean);
  112684. /** @hidden */
  112685. _isDisposed: boolean;
  112686. /**
  112687. * Gets a list of Animations associated with the node
  112688. */
  112689. animations: Animation[];
  112690. protected _ranges: {
  112691. [name: string]: Nullable<AnimationRange>;
  112692. };
  112693. /**
  112694. * Callback raised when the node is ready to be used
  112695. */
  112696. onReady: Nullable<(node: Node) => void>;
  112697. private _isEnabled;
  112698. private _isParentEnabled;
  112699. private _isReady;
  112700. /** @hidden */
  112701. _currentRenderId: number;
  112702. private _parentUpdateId;
  112703. /** @hidden */
  112704. _childUpdateId: number;
  112705. /** @hidden */
  112706. _waitingParentId: Nullable<string>;
  112707. /** @hidden */
  112708. _scene: Scene;
  112709. /** @hidden */
  112710. _cache: any;
  112711. private _parentNode;
  112712. private _children;
  112713. /** @hidden */
  112714. _worldMatrix: Matrix;
  112715. /** @hidden */
  112716. _worldMatrixDeterminant: number;
  112717. /** @hidden */
  112718. _worldMatrixDeterminantIsDirty: boolean;
  112719. /** @hidden */
  112720. private _sceneRootNodesIndex;
  112721. /**
  112722. * Gets a boolean indicating if the node has been disposed
  112723. * @returns true if the node was disposed
  112724. */
  112725. isDisposed(): boolean;
  112726. /**
  112727. * Gets or sets the parent of the node (without keeping the current position in the scene)
  112728. * @see https://doc.babylonjs.com/how_to/parenting
  112729. */
  112730. set parent(parent: Nullable<Node>);
  112731. get parent(): Nullable<Node>;
  112732. /** @hidden */
  112733. _addToSceneRootNodes(): void;
  112734. /** @hidden */
  112735. _removeFromSceneRootNodes(): void;
  112736. private _animationPropertiesOverride;
  112737. /**
  112738. * Gets or sets the animation properties override
  112739. */
  112740. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  112741. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  112742. /**
  112743. * Gets a string identifying the name of the class
  112744. * @returns "Node" string
  112745. */
  112746. getClassName(): string;
  112747. /** @hidden */
  112748. readonly _isNode: boolean;
  112749. /**
  112750. * An event triggered when the mesh is disposed
  112751. */
  112752. onDisposeObservable: Observable<Node>;
  112753. private _onDisposeObserver;
  112754. /**
  112755. * Sets a callback that will be raised when the node will be disposed
  112756. */
  112757. set onDispose(callback: () => void);
  112758. /**
  112759. * Creates a new Node
  112760. * @param name the name and id to be given to this node
  112761. * @param scene the scene this node will be added to
  112762. */
  112763. constructor(name: string, scene?: Nullable<Scene>);
  112764. /**
  112765. * Gets the scene of the node
  112766. * @returns a scene
  112767. */
  112768. getScene(): Scene;
  112769. /**
  112770. * Gets the engine of the node
  112771. * @returns a Engine
  112772. */
  112773. getEngine(): Engine;
  112774. private _behaviors;
  112775. /**
  112776. * Attach a behavior to the node
  112777. * @see https://doc.babylonjs.com/features/behaviour
  112778. * @param behavior defines the behavior to attach
  112779. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  112780. * @returns the current Node
  112781. */
  112782. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  112783. /**
  112784. * Remove an attached behavior
  112785. * @see https://doc.babylonjs.com/features/behaviour
  112786. * @param behavior defines the behavior to attach
  112787. * @returns the current Node
  112788. */
  112789. removeBehavior(behavior: Behavior<Node>): Node;
  112790. /**
  112791. * Gets the list of attached behaviors
  112792. * @see https://doc.babylonjs.com/features/behaviour
  112793. */
  112794. get behaviors(): Behavior<Node>[];
  112795. /**
  112796. * Gets an attached behavior by name
  112797. * @param name defines the name of the behavior to look for
  112798. * @see https://doc.babylonjs.com/features/behaviour
  112799. * @returns null if behavior was not found else the requested behavior
  112800. */
  112801. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  112802. /**
  112803. * Returns the latest update of the World matrix
  112804. * @returns a Matrix
  112805. */
  112806. getWorldMatrix(): Matrix;
  112807. /** @hidden */
  112808. _getWorldMatrixDeterminant(): number;
  112809. /**
  112810. * Returns directly the latest state of the mesh World matrix.
  112811. * A Matrix is returned.
  112812. */
  112813. get worldMatrixFromCache(): Matrix;
  112814. /** @hidden */
  112815. _initCache(): void;
  112816. /** @hidden */
  112817. updateCache(force?: boolean): void;
  112818. /** @hidden */
  112819. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112820. /** @hidden */
  112821. _updateCache(ignoreParentClass?: boolean): void;
  112822. /** @hidden */
  112823. _isSynchronized(): boolean;
  112824. /** @hidden */
  112825. _markSyncedWithParent(): void;
  112826. /** @hidden */
  112827. isSynchronizedWithParent(): boolean;
  112828. /** @hidden */
  112829. isSynchronized(): boolean;
  112830. /**
  112831. * Is this node ready to be used/rendered
  112832. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  112833. * @return true if the node is ready
  112834. */
  112835. isReady(completeCheck?: boolean): boolean;
  112836. /**
  112837. * Is this node enabled?
  112838. * 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
  112839. * @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
  112840. * @return whether this node (and its parent) is enabled
  112841. */
  112842. isEnabled(checkAncestors?: boolean): boolean;
  112843. /** @hidden */
  112844. protected _syncParentEnabledState(): void;
  112845. /**
  112846. * Set the enabled state of this node
  112847. * @param value defines the new enabled state
  112848. */
  112849. setEnabled(value: boolean): void;
  112850. /**
  112851. * Is this node a descendant of the given node?
  112852. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  112853. * @param ancestor defines the parent node to inspect
  112854. * @returns a boolean indicating if this node is a descendant of the given node
  112855. */
  112856. isDescendantOf(ancestor: Node): boolean;
  112857. /** @hidden */
  112858. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  112859. /**
  112860. * Will return all nodes that have this node as ascendant
  112861. * @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
  112862. * @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
  112863. * @return all children nodes of all types
  112864. */
  112865. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  112866. /**
  112867. * Get all child-meshes of this node
  112868. * @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)
  112869. * @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
  112870. * @returns an array of AbstractMesh
  112871. */
  112872. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  112873. /**
  112874. * Get all direct children of this node
  112875. * @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
  112876. * @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)
  112877. * @returns an array of Node
  112878. */
  112879. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  112880. /** @hidden */
  112881. _setReady(state: boolean): void;
  112882. /**
  112883. * Get an animation by name
  112884. * @param name defines the name of the animation to look for
  112885. * @returns null if not found else the requested animation
  112886. */
  112887. getAnimationByName(name: string): Nullable<Animation>;
  112888. /**
  112889. * Creates an animation range for this node
  112890. * @param name defines the name of the range
  112891. * @param from defines the starting key
  112892. * @param to defines the end key
  112893. */
  112894. createAnimationRange(name: string, from: number, to: number): void;
  112895. /**
  112896. * Delete a specific animation range
  112897. * @param name defines the name of the range to delete
  112898. * @param deleteFrames defines if animation frames from the range must be deleted as well
  112899. */
  112900. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  112901. /**
  112902. * Get an animation range by name
  112903. * @param name defines the name of the animation range to look for
  112904. * @returns null if not found else the requested animation range
  112905. */
  112906. getAnimationRange(name: string): Nullable<AnimationRange>;
  112907. /**
  112908. * Gets the list of all animation ranges defined on this node
  112909. * @returns an array
  112910. */
  112911. getAnimationRanges(): Nullable<AnimationRange>[];
  112912. /**
  112913. * Will start the animation sequence
  112914. * @param name defines the range frames for animation sequence
  112915. * @param loop defines if the animation should loop (false by default)
  112916. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  112917. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  112918. * @returns the object created for this animation. If range does not exist, it will return null
  112919. */
  112920. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  112921. /**
  112922. * Serialize animation ranges into a JSON compatible object
  112923. * @returns serialization object
  112924. */
  112925. serializeAnimationRanges(): any;
  112926. /**
  112927. * Computes the world matrix of the node
  112928. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  112929. * @returns the world matrix
  112930. */
  112931. computeWorldMatrix(force?: boolean): Matrix;
  112932. /**
  112933. * Releases resources associated with this node.
  112934. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112935. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112936. */
  112937. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112938. /**
  112939. * Parse animation range data from a serialization object and store them into a given node
  112940. * @param node defines where to store the animation ranges
  112941. * @param parsedNode defines the serialization object to read data from
  112942. * @param scene defines the hosting scene
  112943. */
  112944. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  112945. /**
  112946. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  112947. * @param includeDescendants Include bounding info from descendants as well (true by default)
  112948. * @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
  112949. * @returns the new bounding vectors
  112950. */
  112951. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  112952. min: Vector3;
  112953. max: Vector3;
  112954. };
  112955. }
  112956. }
  112957. declare module BABYLON {
  112958. /**
  112959. * @hidden
  112960. */
  112961. export class _IAnimationState {
  112962. key: number;
  112963. repeatCount: number;
  112964. workValue?: any;
  112965. loopMode?: number;
  112966. offsetValue?: any;
  112967. highLimitValue?: any;
  112968. }
  112969. /**
  112970. * Class used to store any kind of animation
  112971. */
  112972. export class Animation {
  112973. /**Name of the animation */
  112974. name: string;
  112975. /**Property to animate */
  112976. targetProperty: string;
  112977. /**The frames per second of the animation */
  112978. framePerSecond: number;
  112979. /**The data type of the animation */
  112980. dataType: number;
  112981. /**The loop mode of the animation */
  112982. loopMode?: number | undefined;
  112983. /**Specifies if blending should be enabled */
  112984. enableBlending?: boolean | undefined;
  112985. /**
  112986. * Use matrix interpolation instead of using direct key value when animating matrices
  112987. */
  112988. static AllowMatricesInterpolation: boolean;
  112989. /**
  112990. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  112991. */
  112992. static AllowMatrixDecomposeForInterpolation: boolean;
  112993. /** Define the Url to load snippets */
  112994. static SnippetUrl: string;
  112995. /** Snippet ID if the animation was created from the snippet server */
  112996. snippetId: string;
  112997. /**
  112998. * Stores the key frames of the animation
  112999. */
  113000. private _keys;
  113001. /**
  113002. * Stores the easing function of the animation
  113003. */
  113004. private _easingFunction;
  113005. /**
  113006. * @hidden Internal use only
  113007. */
  113008. _runtimeAnimations: RuntimeAnimation[];
  113009. /**
  113010. * The set of event that will be linked to this animation
  113011. */
  113012. private _events;
  113013. /**
  113014. * Stores an array of target property paths
  113015. */
  113016. targetPropertyPath: string[];
  113017. /**
  113018. * Stores the blending speed of the animation
  113019. */
  113020. blendingSpeed: number;
  113021. /**
  113022. * Stores the animation ranges for the animation
  113023. */
  113024. private _ranges;
  113025. /**
  113026. * @hidden Internal use
  113027. */
  113028. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  113029. /**
  113030. * Sets up an animation
  113031. * @param property The property to animate
  113032. * @param animationType The animation type to apply
  113033. * @param framePerSecond The frames per second of the animation
  113034. * @param easingFunction The easing function used in the animation
  113035. * @returns The created animation
  113036. */
  113037. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  113038. /**
  113039. * Create and start an animation on a node
  113040. * @param name defines the name of the global animation that will be run on all nodes
  113041. * @param node defines the root node where the animation will take place
  113042. * @param targetProperty defines property to animate
  113043. * @param framePerSecond defines the number of frame per second yo use
  113044. * @param totalFrame defines the number of frames in total
  113045. * @param from defines the initial value
  113046. * @param to defines the final value
  113047. * @param loopMode defines which loop mode you want to use (off by default)
  113048. * @param easingFunction defines the easing function to use (linear by default)
  113049. * @param onAnimationEnd defines the callback to call when animation end
  113050. * @returns the animatable created for this animation
  113051. */
  113052. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113053. /**
  113054. * Create and start an animation on a node and its descendants
  113055. * @param name defines the name of the global animation that will be run on all nodes
  113056. * @param node defines the root node where the animation will take place
  113057. * @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
  113058. * @param targetProperty defines property to animate
  113059. * @param framePerSecond defines the number of frame per second to use
  113060. * @param totalFrame defines the number of frames in total
  113061. * @param from defines the initial value
  113062. * @param to defines the final value
  113063. * @param loopMode defines which loop mode you want to use (off by default)
  113064. * @param easingFunction defines the easing function to use (linear by default)
  113065. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  113066. * @returns the list of animatables created for all nodes
  113067. * @example https://www.babylonjs-playground.com/#MH0VLI
  113068. */
  113069. 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[]>;
  113070. /**
  113071. * Creates a new animation, merges it with the existing animations and starts it
  113072. * @param name Name of the animation
  113073. * @param node Node which contains the scene that begins the animations
  113074. * @param targetProperty Specifies which property to animate
  113075. * @param framePerSecond The frames per second of the animation
  113076. * @param totalFrame The total number of frames
  113077. * @param from The frame at the beginning of the animation
  113078. * @param to The frame at the end of the animation
  113079. * @param loopMode Specifies the loop mode of the animation
  113080. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  113081. * @param onAnimationEnd Callback to run once the animation is complete
  113082. * @returns Nullable animation
  113083. */
  113084. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113085. /**
  113086. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  113087. * @param sourceAnimation defines the Animation containing keyframes to convert
  113088. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  113089. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  113090. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  113091. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  113092. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  113093. */
  113094. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  113095. /**
  113096. * Transition property of an host to the target Value
  113097. * @param property The property to transition
  113098. * @param targetValue The target Value of the property
  113099. * @param host The object where the property to animate belongs
  113100. * @param scene Scene used to run the animation
  113101. * @param frameRate Framerate (in frame/s) to use
  113102. * @param transition The transition type we want to use
  113103. * @param duration The duration of the animation, in milliseconds
  113104. * @param onAnimationEnd Callback trigger at the end of the animation
  113105. * @returns Nullable animation
  113106. */
  113107. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  113108. /**
  113109. * Return the array of runtime animations currently using this animation
  113110. */
  113111. get runtimeAnimations(): RuntimeAnimation[];
  113112. /**
  113113. * Specifies if any of the runtime animations are currently running
  113114. */
  113115. get hasRunningRuntimeAnimations(): boolean;
  113116. /**
  113117. * Initializes the animation
  113118. * @param name Name of the animation
  113119. * @param targetProperty Property to animate
  113120. * @param framePerSecond The frames per second of the animation
  113121. * @param dataType The data type of the animation
  113122. * @param loopMode The loop mode of the animation
  113123. * @param enableBlending Specifies if blending should be enabled
  113124. */
  113125. constructor(
  113126. /**Name of the animation */
  113127. name: string,
  113128. /**Property to animate */
  113129. targetProperty: string,
  113130. /**The frames per second of the animation */
  113131. framePerSecond: number,
  113132. /**The data type of the animation */
  113133. dataType: number,
  113134. /**The loop mode of the animation */
  113135. loopMode?: number | undefined,
  113136. /**Specifies if blending should be enabled */
  113137. enableBlending?: boolean | undefined);
  113138. /**
  113139. * Converts the animation to a string
  113140. * @param fullDetails support for multiple levels of logging within scene loading
  113141. * @returns String form of the animation
  113142. */
  113143. toString(fullDetails?: boolean): string;
  113144. /**
  113145. * Add an event to this animation
  113146. * @param event Event to add
  113147. */
  113148. addEvent(event: AnimationEvent): void;
  113149. /**
  113150. * Remove all events found at the given frame
  113151. * @param frame The frame to remove events from
  113152. */
  113153. removeEvents(frame: number): void;
  113154. /**
  113155. * Retrieves all the events from the animation
  113156. * @returns Events from the animation
  113157. */
  113158. getEvents(): AnimationEvent[];
  113159. /**
  113160. * Creates an animation range
  113161. * @param name Name of the animation range
  113162. * @param from Starting frame of the animation range
  113163. * @param to Ending frame of the animation
  113164. */
  113165. createRange(name: string, from: number, to: number): void;
  113166. /**
  113167. * Deletes an animation range by name
  113168. * @param name Name of the animation range to delete
  113169. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  113170. */
  113171. deleteRange(name: string, deleteFrames?: boolean): void;
  113172. /**
  113173. * Gets the animation range by name, or null if not defined
  113174. * @param name Name of the animation range
  113175. * @returns Nullable animation range
  113176. */
  113177. getRange(name: string): Nullable<AnimationRange>;
  113178. /**
  113179. * Gets the key frames from the animation
  113180. * @returns The key frames of the animation
  113181. */
  113182. getKeys(): Array<IAnimationKey>;
  113183. /**
  113184. * Gets the highest frame rate of the animation
  113185. * @returns Highest frame rate of the animation
  113186. */
  113187. getHighestFrame(): number;
  113188. /**
  113189. * Gets the easing function of the animation
  113190. * @returns Easing function of the animation
  113191. */
  113192. getEasingFunction(): IEasingFunction;
  113193. /**
  113194. * Sets the easing function of the animation
  113195. * @param easingFunction A custom mathematical formula for animation
  113196. */
  113197. setEasingFunction(easingFunction: EasingFunction): void;
  113198. /**
  113199. * Interpolates a scalar linearly
  113200. * @param startValue Start value of the animation curve
  113201. * @param endValue End value of the animation curve
  113202. * @param gradient Scalar amount to interpolate
  113203. * @returns Interpolated scalar value
  113204. */
  113205. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  113206. /**
  113207. * Interpolates a scalar cubically
  113208. * @param startValue Start value of the animation curve
  113209. * @param outTangent End tangent of the animation
  113210. * @param endValue End value of the animation curve
  113211. * @param inTangent Start tangent of the animation curve
  113212. * @param gradient Scalar amount to interpolate
  113213. * @returns Interpolated scalar value
  113214. */
  113215. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  113216. /**
  113217. * Interpolates a quaternion using a spherical linear interpolation
  113218. * @param startValue Start value of the animation curve
  113219. * @param endValue End value of the animation curve
  113220. * @param gradient Scalar amount to interpolate
  113221. * @returns Interpolated quaternion value
  113222. */
  113223. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  113224. /**
  113225. * Interpolates a quaternion cubically
  113226. * @param startValue Start value of the animation curve
  113227. * @param outTangent End tangent of the animation curve
  113228. * @param endValue End value of the animation curve
  113229. * @param inTangent Start tangent of the animation curve
  113230. * @param gradient Scalar amount to interpolate
  113231. * @returns Interpolated quaternion value
  113232. */
  113233. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  113234. /**
  113235. * Interpolates a Vector3 linearl
  113236. * @param startValue Start value of the animation curve
  113237. * @param endValue End value of the animation curve
  113238. * @param gradient Scalar amount to interpolate
  113239. * @returns Interpolated scalar value
  113240. */
  113241. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  113242. /**
  113243. * Interpolates a Vector3 cubically
  113244. * @param startValue Start value of the animation curve
  113245. * @param outTangent End tangent of the animation
  113246. * @param endValue End value of the animation curve
  113247. * @param inTangent Start tangent of the animation curve
  113248. * @param gradient Scalar amount to interpolate
  113249. * @returns InterpolatedVector3 value
  113250. */
  113251. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  113252. /**
  113253. * Interpolates a Vector2 linearly
  113254. * @param startValue Start value of the animation curve
  113255. * @param endValue End value of the animation curve
  113256. * @param gradient Scalar amount to interpolate
  113257. * @returns Interpolated Vector2 value
  113258. */
  113259. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  113260. /**
  113261. * Interpolates a Vector2 cubically
  113262. * @param startValue Start value of the animation curve
  113263. * @param outTangent End tangent of the animation
  113264. * @param endValue End value of the animation curve
  113265. * @param inTangent Start tangent of the animation curve
  113266. * @param gradient Scalar amount to interpolate
  113267. * @returns Interpolated Vector2 value
  113268. */
  113269. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  113270. /**
  113271. * Interpolates a size linearly
  113272. * @param startValue Start value of the animation curve
  113273. * @param endValue End value of the animation curve
  113274. * @param gradient Scalar amount to interpolate
  113275. * @returns Interpolated Size value
  113276. */
  113277. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  113278. /**
  113279. * Interpolates a Color3 linearly
  113280. * @param startValue Start value of the animation curve
  113281. * @param endValue End value of the animation curve
  113282. * @param gradient Scalar amount to interpolate
  113283. * @returns Interpolated Color3 value
  113284. */
  113285. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  113286. /**
  113287. * Interpolates a Color4 linearly
  113288. * @param startValue Start value of the animation curve
  113289. * @param endValue End value of the animation curve
  113290. * @param gradient Scalar amount to interpolate
  113291. * @returns Interpolated Color3 value
  113292. */
  113293. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  113294. /**
  113295. * @hidden Internal use only
  113296. */
  113297. _getKeyValue(value: any): any;
  113298. /**
  113299. * @hidden Internal use only
  113300. */
  113301. _interpolate(currentFrame: number, state: _IAnimationState): any;
  113302. /**
  113303. * Defines the function to use to interpolate matrices
  113304. * @param startValue defines the start matrix
  113305. * @param endValue defines the end matrix
  113306. * @param gradient defines the gradient between both matrices
  113307. * @param result defines an optional target matrix where to store the interpolation
  113308. * @returns the interpolated matrix
  113309. */
  113310. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  113311. /**
  113312. * Makes a copy of the animation
  113313. * @returns Cloned animation
  113314. */
  113315. clone(): Animation;
  113316. /**
  113317. * Sets the key frames of the animation
  113318. * @param values The animation key frames to set
  113319. */
  113320. setKeys(values: Array<IAnimationKey>): void;
  113321. /**
  113322. * Serializes the animation to an object
  113323. * @returns Serialized object
  113324. */
  113325. serialize(): any;
  113326. /**
  113327. * Float animation type
  113328. */
  113329. static readonly ANIMATIONTYPE_FLOAT: number;
  113330. /**
  113331. * Vector3 animation type
  113332. */
  113333. static readonly ANIMATIONTYPE_VECTOR3: number;
  113334. /**
  113335. * Quaternion animation type
  113336. */
  113337. static readonly ANIMATIONTYPE_QUATERNION: number;
  113338. /**
  113339. * Matrix animation type
  113340. */
  113341. static readonly ANIMATIONTYPE_MATRIX: number;
  113342. /**
  113343. * Color3 animation type
  113344. */
  113345. static readonly ANIMATIONTYPE_COLOR3: number;
  113346. /**
  113347. * Color3 animation type
  113348. */
  113349. static readonly ANIMATIONTYPE_COLOR4: number;
  113350. /**
  113351. * Vector2 animation type
  113352. */
  113353. static readonly ANIMATIONTYPE_VECTOR2: number;
  113354. /**
  113355. * Size animation type
  113356. */
  113357. static readonly ANIMATIONTYPE_SIZE: number;
  113358. /**
  113359. * Relative Loop Mode
  113360. */
  113361. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  113362. /**
  113363. * Cycle Loop Mode
  113364. */
  113365. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  113366. /**
  113367. * Constant Loop Mode
  113368. */
  113369. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  113370. /** @hidden */
  113371. static _UniversalLerp(left: any, right: any, amount: number): any;
  113372. /**
  113373. * Parses an animation object and creates an animation
  113374. * @param parsedAnimation Parsed animation object
  113375. * @returns Animation object
  113376. */
  113377. static Parse(parsedAnimation: any): Animation;
  113378. /**
  113379. * Appends the serialized animations from the source animations
  113380. * @param source Source containing the animations
  113381. * @param destination Target to store the animations
  113382. */
  113383. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113384. /**
  113385. * Creates a new animation or an array of animations from a snippet saved in a remote file
  113386. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  113387. * @param url defines the url to load from
  113388. * @returns a promise that will resolve to the new animation or an array of animations
  113389. */
  113390. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  113391. /**
  113392. * Creates an animation or an array of animations from a snippet saved by the Inspector
  113393. * @param snippetId defines the snippet to load
  113394. * @returns a promise that will resolve to the new animation or a new array of animations
  113395. */
  113396. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  113397. }
  113398. }
  113399. declare module BABYLON {
  113400. /**
  113401. * Interface containing an array of animations
  113402. */
  113403. export interface IAnimatable {
  113404. /**
  113405. * Array of animations
  113406. */
  113407. animations: Nullable<Array<Animation>>;
  113408. }
  113409. }
  113410. declare module BABYLON {
  113411. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  113412. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113413. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113414. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113415. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113416. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113417. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113418. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113419. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113420. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113421. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113422. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113423. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113424. /**
  113425. * Decorator used to define property that can be serialized as reference to a camera
  113426. * @param sourceName defines the name of the property to decorate
  113427. */
  113428. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113429. /**
  113430. * Class used to help serialization objects
  113431. */
  113432. export class SerializationHelper {
  113433. /** @hidden */
  113434. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  113435. /** @hidden */
  113436. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  113437. /** @hidden */
  113438. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  113439. /** @hidden */
  113440. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  113441. /**
  113442. * Appends the serialized animations from the source animations
  113443. * @param source Source containing the animations
  113444. * @param destination Target to store the animations
  113445. */
  113446. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113447. /**
  113448. * Static function used to serialized a specific entity
  113449. * @param entity defines the entity to serialize
  113450. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  113451. * @returns a JSON compatible object representing the serialization of the entity
  113452. */
  113453. static Serialize<T>(entity: T, serializationObject?: any): any;
  113454. /**
  113455. * Creates a new entity from a serialization data object
  113456. * @param creationFunction defines a function used to instanciated the new entity
  113457. * @param source defines the source serialization data
  113458. * @param scene defines the hosting scene
  113459. * @param rootUrl defines the root url for resources
  113460. * @returns a new entity
  113461. */
  113462. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  113463. /**
  113464. * Clones an object
  113465. * @param creationFunction defines the function used to instanciate the new object
  113466. * @param source defines the source object
  113467. * @returns the cloned object
  113468. */
  113469. static Clone<T>(creationFunction: () => T, source: T): T;
  113470. /**
  113471. * Instanciates a new object based on a source one (some data will be shared between both object)
  113472. * @param creationFunction defines the function used to instanciate the new object
  113473. * @param source defines the source object
  113474. * @returns the new object
  113475. */
  113476. static Instanciate<T>(creationFunction: () => T, source: T): T;
  113477. }
  113478. }
  113479. declare module BABYLON {
  113480. /**
  113481. * Base class of all the textures in babylon.
  113482. * It groups all the common properties the materials, post process, lights... might need
  113483. * in order to make a correct use of the texture.
  113484. */
  113485. export class BaseTexture implements IAnimatable {
  113486. /**
  113487. * Default anisotropic filtering level for the application.
  113488. * It is set to 4 as a good tradeoff between perf and quality.
  113489. */
  113490. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  113491. /**
  113492. * Gets or sets the unique id of the texture
  113493. */
  113494. uniqueId: number;
  113495. /**
  113496. * Define the name of the texture.
  113497. */
  113498. name: string;
  113499. /**
  113500. * Gets or sets an object used to store user defined information.
  113501. */
  113502. metadata: any;
  113503. /**
  113504. * For internal use only. Please do not use.
  113505. */
  113506. reservedDataStore: any;
  113507. private _hasAlpha;
  113508. /**
  113509. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  113510. */
  113511. set hasAlpha(value: boolean);
  113512. get hasAlpha(): boolean;
  113513. /**
  113514. * Defines if the alpha value should be determined via the rgb values.
  113515. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  113516. */
  113517. getAlphaFromRGB: boolean;
  113518. /**
  113519. * Intensity or strength of the texture.
  113520. * It is commonly used by materials to fine tune the intensity of the texture
  113521. */
  113522. level: number;
  113523. /**
  113524. * Define the UV chanel to use starting from 0 and defaulting to 0.
  113525. * This is part of the texture as textures usually maps to one uv set.
  113526. */
  113527. coordinatesIndex: number;
  113528. protected _coordinatesMode: number;
  113529. /**
  113530. * How a texture is mapped.
  113531. *
  113532. * | Value | Type | Description |
  113533. * | ----- | ----------------------------------- | ----------- |
  113534. * | 0 | EXPLICIT_MODE | |
  113535. * | 1 | SPHERICAL_MODE | |
  113536. * | 2 | PLANAR_MODE | |
  113537. * | 3 | CUBIC_MODE | |
  113538. * | 4 | PROJECTION_MODE | |
  113539. * | 5 | SKYBOX_MODE | |
  113540. * | 6 | INVCUBIC_MODE | |
  113541. * | 7 | EQUIRECTANGULAR_MODE | |
  113542. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  113543. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  113544. */
  113545. set coordinatesMode(value: number);
  113546. get coordinatesMode(): number;
  113547. private _wrapU;
  113548. /**
  113549. * | Value | Type | Description |
  113550. * | ----- | ------------------ | ----------- |
  113551. * | 0 | CLAMP_ADDRESSMODE | |
  113552. * | 1 | WRAP_ADDRESSMODE | |
  113553. * | 2 | MIRROR_ADDRESSMODE | |
  113554. */
  113555. get wrapU(): number;
  113556. set wrapU(value: number);
  113557. private _wrapV;
  113558. /**
  113559. * | Value | Type | Description |
  113560. * | ----- | ------------------ | ----------- |
  113561. * | 0 | CLAMP_ADDRESSMODE | |
  113562. * | 1 | WRAP_ADDRESSMODE | |
  113563. * | 2 | MIRROR_ADDRESSMODE | |
  113564. */
  113565. get wrapV(): number;
  113566. set wrapV(value: number);
  113567. /**
  113568. * | Value | Type | Description |
  113569. * | ----- | ------------------ | ----------- |
  113570. * | 0 | CLAMP_ADDRESSMODE | |
  113571. * | 1 | WRAP_ADDRESSMODE | |
  113572. * | 2 | MIRROR_ADDRESSMODE | |
  113573. */
  113574. wrapR: number;
  113575. /**
  113576. * With compliant hardware and browser (supporting anisotropic filtering)
  113577. * this defines the level of anisotropic filtering in the texture.
  113578. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  113579. */
  113580. anisotropicFilteringLevel: number;
  113581. /**
  113582. * Define if the texture is a cube texture or if false a 2d texture.
  113583. */
  113584. get isCube(): boolean;
  113585. set isCube(value: boolean);
  113586. /**
  113587. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  113588. */
  113589. get is3D(): boolean;
  113590. set is3D(value: boolean);
  113591. /**
  113592. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  113593. */
  113594. get is2DArray(): boolean;
  113595. set is2DArray(value: boolean);
  113596. /**
  113597. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  113598. * HDR texture are usually stored in linear space.
  113599. * This only impacts the PBR and Background materials
  113600. */
  113601. gammaSpace: boolean;
  113602. /**
  113603. * Gets or sets whether or not the texture contains RGBD data.
  113604. */
  113605. get isRGBD(): boolean;
  113606. set isRGBD(value: boolean);
  113607. /**
  113608. * Is Z inverted in the texture (useful in a cube texture).
  113609. */
  113610. invertZ: boolean;
  113611. /**
  113612. * Are mip maps generated for this texture or not.
  113613. */
  113614. get noMipmap(): boolean;
  113615. /**
  113616. * @hidden
  113617. */
  113618. lodLevelInAlpha: boolean;
  113619. /**
  113620. * With prefiltered texture, defined the offset used during the prefiltering steps.
  113621. */
  113622. get lodGenerationOffset(): number;
  113623. set lodGenerationOffset(value: number);
  113624. /**
  113625. * With prefiltered texture, defined the scale used during the prefiltering steps.
  113626. */
  113627. get lodGenerationScale(): number;
  113628. set lodGenerationScale(value: number);
  113629. /**
  113630. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  113631. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  113632. * average roughness values.
  113633. */
  113634. get linearSpecularLOD(): boolean;
  113635. set linearSpecularLOD(value: boolean);
  113636. /**
  113637. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  113638. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  113639. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  113640. */
  113641. get irradianceTexture(): Nullable<BaseTexture>;
  113642. set irradianceTexture(value: Nullable<BaseTexture>);
  113643. /**
  113644. * Define if the texture is a render target.
  113645. */
  113646. isRenderTarget: boolean;
  113647. /**
  113648. * Define the unique id of the texture in the scene.
  113649. */
  113650. get uid(): string;
  113651. /** @hidden */
  113652. _prefiltered: boolean;
  113653. /**
  113654. * Return a string representation of the texture.
  113655. * @returns the texture as a string
  113656. */
  113657. toString(): string;
  113658. /**
  113659. * Get the class name of the texture.
  113660. * @returns "BaseTexture"
  113661. */
  113662. getClassName(): string;
  113663. /**
  113664. * Define the list of animation attached to the texture.
  113665. */
  113666. animations: Animation[];
  113667. /**
  113668. * An event triggered when the texture is disposed.
  113669. */
  113670. onDisposeObservable: Observable<BaseTexture>;
  113671. private _onDisposeObserver;
  113672. /**
  113673. * Callback triggered when the texture has been disposed.
  113674. * Kept for back compatibility, you can use the onDisposeObservable instead.
  113675. */
  113676. set onDispose(callback: () => void);
  113677. /**
  113678. * Define the current state of the loading sequence when in delayed load mode.
  113679. */
  113680. delayLoadState: number;
  113681. protected _scene: Nullable<Scene>;
  113682. protected _engine: Nullable<ThinEngine>;
  113683. /** @hidden */
  113684. _texture: Nullable<InternalTexture>;
  113685. private _uid;
  113686. /**
  113687. * Define if the texture is preventinga material to render or not.
  113688. * If not and the texture is not ready, the engine will use a default black texture instead.
  113689. */
  113690. get isBlocking(): boolean;
  113691. /**
  113692. * Instantiates a new BaseTexture.
  113693. * Base class of all the textures in babylon.
  113694. * It groups all the common properties the materials, post process, lights... might need
  113695. * in order to make a correct use of the texture.
  113696. * @param sceneOrEngine Define the scene or engine the texture blongs to
  113697. */
  113698. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  113699. /**
  113700. * Get the scene the texture belongs to.
  113701. * @returns the scene or null if undefined
  113702. */
  113703. getScene(): Nullable<Scene>;
  113704. /** @hidden */
  113705. protected _getEngine(): Nullable<ThinEngine>;
  113706. /**
  113707. * Get the texture transform matrix used to offset tile the texture for istance.
  113708. * @returns the transformation matrix
  113709. */
  113710. getTextureMatrix(): Matrix;
  113711. /**
  113712. * Get the texture reflection matrix used to rotate/transform the reflection.
  113713. * @returns the reflection matrix
  113714. */
  113715. getReflectionTextureMatrix(): Matrix;
  113716. /**
  113717. * Get the underlying lower level texture from Babylon.
  113718. * @returns the insternal texture
  113719. */
  113720. getInternalTexture(): Nullable<InternalTexture>;
  113721. /**
  113722. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  113723. * @returns true if ready or not blocking
  113724. */
  113725. isReadyOrNotBlocking(): boolean;
  113726. /**
  113727. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  113728. * @returns true if fully ready
  113729. */
  113730. isReady(): boolean;
  113731. private _cachedSize;
  113732. /**
  113733. * Get the size of the texture.
  113734. * @returns the texture size.
  113735. */
  113736. getSize(): ISize;
  113737. /**
  113738. * Get the base size of the texture.
  113739. * It can be different from the size if the texture has been resized for POT for instance
  113740. * @returns the base size
  113741. */
  113742. getBaseSize(): ISize;
  113743. /**
  113744. * Update the sampling mode of the texture.
  113745. * Default is Trilinear mode.
  113746. *
  113747. * | Value | Type | Description |
  113748. * | ----- | ------------------ | ----------- |
  113749. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  113750. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  113751. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  113752. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  113753. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  113754. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  113755. * | 7 | NEAREST_LINEAR | |
  113756. * | 8 | NEAREST_NEAREST | |
  113757. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  113758. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  113759. * | 11 | LINEAR_LINEAR | |
  113760. * | 12 | LINEAR_NEAREST | |
  113761. *
  113762. * > _mag_: magnification filter (close to the viewer)
  113763. * > _min_: minification filter (far from the viewer)
  113764. * > _mip_: filter used between mip map levels
  113765. *@param samplingMode Define the new sampling mode of the texture
  113766. */
  113767. updateSamplingMode(samplingMode: number): void;
  113768. /**
  113769. * Scales the texture if is `canRescale()`
  113770. * @param ratio the resize factor we want to use to rescale
  113771. */
  113772. scale(ratio: number): void;
  113773. /**
  113774. * Get if the texture can rescale.
  113775. */
  113776. get canRescale(): boolean;
  113777. /** @hidden */
  113778. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  113779. /** @hidden */
  113780. _rebuild(): void;
  113781. /**
  113782. * Triggers the load sequence in delayed load mode.
  113783. */
  113784. delayLoad(): void;
  113785. /**
  113786. * Clones the texture.
  113787. * @returns the cloned texture
  113788. */
  113789. clone(): Nullable<BaseTexture>;
  113790. /**
  113791. * Get the texture underlying type (INT, FLOAT...)
  113792. */
  113793. get textureType(): number;
  113794. /**
  113795. * Get the texture underlying format (RGB, RGBA...)
  113796. */
  113797. get textureFormat(): number;
  113798. /**
  113799. * Indicates that textures need to be re-calculated for all materials
  113800. */
  113801. protected _markAllSubMeshesAsTexturesDirty(): void;
  113802. /**
  113803. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  113804. * This will returns an RGBA array buffer containing either in values (0-255) or
  113805. * float values (0-1) depending of the underlying buffer type.
  113806. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  113807. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  113808. * @param buffer defines a user defined buffer to fill with data (can be null)
  113809. * @returns The Array buffer containing the pixels data.
  113810. */
  113811. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  113812. /**
  113813. * Release and destroy the underlying lower level texture aka internalTexture.
  113814. */
  113815. releaseInternalTexture(): void;
  113816. /** @hidden */
  113817. get _lodTextureHigh(): Nullable<BaseTexture>;
  113818. /** @hidden */
  113819. get _lodTextureMid(): Nullable<BaseTexture>;
  113820. /** @hidden */
  113821. get _lodTextureLow(): Nullable<BaseTexture>;
  113822. /**
  113823. * Dispose the texture and release its associated resources.
  113824. */
  113825. dispose(): void;
  113826. /**
  113827. * Serialize the texture into a JSON representation that can be parsed later on.
  113828. * @returns the JSON representation of the texture
  113829. */
  113830. serialize(): any;
  113831. /**
  113832. * Helper function to be called back once a list of texture contains only ready textures.
  113833. * @param textures Define the list of textures to wait for
  113834. * @param callback Define the callback triggered once the entire list will be ready
  113835. */
  113836. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  113837. private static _isScene;
  113838. }
  113839. }
  113840. declare module BABYLON {
  113841. /**
  113842. * Options to be used when creating an effect.
  113843. */
  113844. export interface IEffectCreationOptions {
  113845. /**
  113846. * Atrributes that will be used in the shader.
  113847. */
  113848. attributes: string[];
  113849. /**
  113850. * Uniform varible names that will be set in the shader.
  113851. */
  113852. uniformsNames: string[];
  113853. /**
  113854. * Uniform buffer variable names that will be set in the shader.
  113855. */
  113856. uniformBuffersNames: string[];
  113857. /**
  113858. * Sampler texture variable names that will be set in the shader.
  113859. */
  113860. samplers: string[];
  113861. /**
  113862. * Define statements that will be set in the shader.
  113863. */
  113864. defines: any;
  113865. /**
  113866. * Possible fallbacks for this effect to improve performance when needed.
  113867. */
  113868. fallbacks: Nullable<IEffectFallbacks>;
  113869. /**
  113870. * Callback that will be called when the shader is compiled.
  113871. */
  113872. onCompiled: Nullable<(effect: Effect) => void>;
  113873. /**
  113874. * Callback that will be called if an error occurs during shader compilation.
  113875. */
  113876. onError: Nullable<(effect: Effect, errors: string) => void>;
  113877. /**
  113878. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113879. */
  113880. indexParameters?: any;
  113881. /**
  113882. * Max number of lights that can be used in the shader.
  113883. */
  113884. maxSimultaneousLights?: number;
  113885. /**
  113886. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  113887. */
  113888. transformFeedbackVaryings?: Nullable<string[]>;
  113889. /**
  113890. * 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
  113891. */
  113892. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  113893. /**
  113894. * Is this effect rendering to several color attachments ?
  113895. */
  113896. multiTarget?: boolean;
  113897. }
  113898. /**
  113899. * Effect containing vertex and fragment shader that can be executed on an object.
  113900. */
  113901. export class Effect implements IDisposable {
  113902. /**
  113903. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  113904. */
  113905. static ShadersRepository: string;
  113906. /**
  113907. * Enable logging of the shader code when a compilation error occurs
  113908. */
  113909. static LogShaderCodeOnCompilationError: boolean;
  113910. /**
  113911. * Name of the effect.
  113912. */
  113913. name: any;
  113914. /**
  113915. * String container all the define statements that should be set on the shader.
  113916. */
  113917. defines: string;
  113918. /**
  113919. * Callback that will be called when the shader is compiled.
  113920. */
  113921. onCompiled: Nullable<(effect: Effect) => void>;
  113922. /**
  113923. * Callback that will be called if an error occurs during shader compilation.
  113924. */
  113925. onError: Nullable<(effect: Effect, errors: string) => void>;
  113926. /**
  113927. * Callback that will be called when effect is bound.
  113928. */
  113929. onBind: Nullable<(effect: Effect) => void>;
  113930. /**
  113931. * Unique ID of the effect.
  113932. */
  113933. uniqueId: number;
  113934. /**
  113935. * Observable that will be called when the shader is compiled.
  113936. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  113937. */
  113938. onCompileObservable: Observable<Effect>;
  113939. /**
  113940. * Observable that will be called if an error occurs during shader compilation.
  113941. */
  113942. onErrorObservable: Observable<Effect>;
  113943. /** @hidden */
  113944. _onBindObservable: Nullable<Observable<Effect>>;
  113945. /**
  113946. * @hidden
  113947. * Specifies if the effect was previously ready
  113948. */
  113949. _wasPreviouslyReady: boolean;
  113950. /**
  113951. * Observable that will be called when effect is bound.
  113952. */
  113953. get onBindObservable(): Observable<Effect>;
  113954. /** @hidden */
  113955. _bonesComputationForcedToCPU: boolean;
  113956. /** @hidden */
  113957. _multiTarget: boolean;
  113958. private static _uniqueIdSeed;
  113959. private _engine;
  113960. private _uniformBuffersNames;
  113961. private _uniformBuffersNamesList;
  113962. private _uniformsNames;
  113963. private _samplerList;
  113964. private _samplers;
  113965. private _isReady;
  113966. private _compilationError;
  113967. private _allFallbacksProcessed;
  113968. private _attributesNames;
  113969. private _attributes;
  113970. private _attributeLocationByName;
  113971. private _uniforms;
  113972. /**
  113973. * Key for the effect.
  113974. * @hidden
  113975. */
  113976. _key: string;
  113977. private _indexParameters;
  113978. private _fallbacks;
  113979. private _vertexSourceCode;
  113980. private _fragmentSourceCode;
  113981. private _vertexSourceCodeOverride;
  113982. private _fragmentSourceCodeOverride;
  113983. private _transformFeedbackVaryings;
  113984. /**
  113985. * Compiled shader to webGL program.
  113986. * @hidden
  113987. */
  113988. _pipelineContext: Nullable<IPipelineContext>;
  113989. private _valueCache;
  113990. private static _baseCache;
  113991. /**
  113992. * Instantiates an effect.
  113993. * An effect can be used to create/manage/execute vertex and fragment shaders.
  113994. * @param baseName Name of the effect.
  113995. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  113996. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  113997. * @param samplers List of sampler variables that will be passed to the shader.
  113998. * @param engine Engine to be used to render the effect
  113999. * @param defines Define statements to be added to the shader.
  114000. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  114001. * @param onCompiled Callback that will be called when the shader is compiled.
  114002. * @param onError Callback that will be called if an error occurs during shader compilation.
  114003. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  114004. */
  114005. 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);
  114006. private _useFinalCode;
  114007. /**
  114008. * Unique key for this effect
  114009. */
  114010. get key(): string;
  114011. /**
  114012. * If the effect has been compiled and prepared.
  114013. * @returns if the effect is compiled and prepared.
  114014. */
  114015. isReady(): boolean;
  114016. private _isReadyInternal;
  114017. /**
  114018. * The engine the effect was initialized with.
  114019. * @returns the engine.
  114020. */
  114021. getEngine(): Engine;
  114022. /**
  114023. * The pipeline context for this effect
  114024. * @returns the associated pipeline context
  114025. */
  114026. getPipelineContext(): Nullable<IPipelineContext>;
  114027. /**
  114028. * The set of names of attribute variables for the shader.
  114029. * @returns An array of attribute names.
  114030. */
  114031. getAttributesNames(): string[];
  114032. /**
  114033. * Returns the attribute at the given index.
  114034. * @param index The index of the attribute.
  114035. * @returns The location of the attribute.
  114036. */
  114037. getAttributeLocation(index: number): number;
  114038. /**
  114039. * Returns the attribute based on the name of the variable.
  114040. * @param name of the attribute to look up.
  114041. * @returns the attribute location.
  114042. */
  114043. getAttributeLocationByName(name: string): number;
  114044. /**
  114045. * The number of attributes.
  114046. * @returns the numnber of attributes.
  114047. */
  114048. getAttributesCount(): number;
  114049. /**
  114050. * Gets the index of a uniform variable.
  114051. * @param uniformName of the uniform to look up.
  114052. * @returns the index.
  114053. */
  114054. getUniformIndex(uniformName: string): number;
  114055. /**
  114056. * Returns the attribute based on the name of the variable.
  114057. * @param uniformName of the uniform to look up.
  114058. * @returns the location of the uniform.
  114059. */
  114060. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  114061. /**
  114062. * Returns an array of sampler variable names
  114063. * @returns The array of sampler variable names.
  114064. */
  114065. getSamplers(): string[];
  114066. /**
  114067. * Returns an array of uniform variable names
  114068. * @returns The array of uniform variable names.
  114069. */
  114070. getUniformNames(): string[];
  114071. /**
  114072. * Returns an array of uniform buffer variable names
  114073. * @returns The array of uniform buffer variable names.
  114074. */
  114075. getUniformBuffersNames(): string[];
  114076. /**
  114077. * Returns the index parameters used to create the effect
  114078. * @returns The index parameters object
  114079. */
  114080. getIndexParameters(): any;
  114081. /**
  114082. * The error from the last compilation.
  114083. * @returns the error string.
  114084. */
  114085. getCompilationError(): string;
  114086. /**
  114087. * Gets a boolean indicating that all fallbacks were used during compilation
  114088. * @returns true if all fallbacks were used
  114089. */
  114090. allFallbacksProcessed(): boolean;
  114091. /**
  114092. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  114093. * @param func The callback to be used.
  114094. */
  114095. executeWhenCompiled(func: (effect: Effect) => void): void;
  114096. private _checkIsReady;
  114097. private _loadShader;
  114098. /**
  114099. * Gets the vertex shader source code of this effect
  114100. */
  114101. get vertexSourceCode(): string;
  114102. /**
  114103. * Gets the fragment shader source code of this effect
  114104. */
  114105. get fragmentSourceCode(): string;
  114106. /**
  114107. * Recompiles the webGL program
  114108. * @param vertexSourceCode The source code for the vertex shader.
  114109. * @param fragmentSourceCode The source code for the fragment shader.
  114110. * @param onCompiled Callback called when completed.
  114111. * @param onError Callback called on error.
  114112. * @hidden
  114113. */
  114114. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  114115. /**
  114116. * Prepares the effect
  114117. * @hidden
  114118. */
  114119. _prepareEffect(): void;
  114120. private _getShaderCodeAndErrorLine;
  114121. private _processCompilationErrors;
  114122. /**
  114123. * Checks if the effect is supported. (Must be called after compilation)
  114124. */
  114125. get isSupported(): boolean;
  114126. /**
  114127. * Binds a texture to the engine to be used as output of the shader.
  114128. * @param channel Name of the output variable.
  114129. * @param texture Texture to bind.
  114130. * @hidden
  114131. */
  114132. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  114133. /**
  114134. * Sets a texture on the engine to be used in the shader.
  114135. * @param channel Name of the sampler variable.
  114136. * @param texture Texture to set.
  114137. */
  114138. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  114139. /**
  114140. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  114141. * @param channel Name of the sampler variable.
  114142. * @param texture Texture to set.
  114143. */
  114144. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  114145. /**
  114146. * Sets an array of textures on the engine to be used in the shader.
  114147. * @param channel Name of the variable.
  114148. * @param textures Textures to set.
  114149. */
  114150. setTextureArray(channel: string, textures: BaseTexture[]): void;
  114151. /**
  114152. * 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)
  114153. * @param channel Name of the sampler variable.
  114154. * @param postProcess Post process to get the input texture from.
  114155. */
  114156. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  114157. /**
  114158. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  114159. * 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)
  114160. * @param channel Name of the sampler variable.
  114161. * @param postProcess Post process to get the output texture from.
  114162. */
  114163. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  114164. /** @hidden */
  114165. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  114166. /** @hidden */
  114167. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  114168. /** @hidden */
  114169. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  114170. /** @hidden */
  114171. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  114172. /**
  114173. * Binds a buffer to a uniform.
  114174. * @param buffer Buffer to bind.
  114175. * @param name Name of the uniform variable to bind to.
  114176. */
  114177. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  114178. /**
  114179. * Binds block to a uniform.
  114180. * @param blockName Name of the block to bind.
  114181. * @param index Index to bind.
  114182. */
  114183. bindUniformBlock(blockName: string, index: number): void;
  114184. /**
  114185. * Sets an interger value on a uniform variable.
  114186. * @param uniformName Name of the variable.
  114187. * @param value Value to be set.
  114188. * @returns this effect.
  114189. */
  114190. setInt(uniformName: string, value: number): Effect;
  114191. /**
  114192. * Sets an int array on a uniform variable.
  114193. * @param uniformName Name of the variable.
  114194. * @param array array to be set.
  114195. * @returns this effect.
  114196. */
  114197. setIntArray(uniformName: string, array: Int32Array): Effect;
  114198. /**
  114199. * 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)
  114200. * @param uniformName Name of the variable.
  114201. * @param array array to be set.
  114202. * @returns this effect.
  114203. */
  114204. setIntArray2(uniformName: string, array: Int32Array): Effect;
  114205. /**
  114206. * 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)
  114207. * @param uniformName Name of the variable.
  114208. * @param array array to be set.
  114209. * @returns this effect.
  114210. */
  114211. setIntArray3(uniformName: string, array: Int32Array): Effect;
  114212. /**
  114213. * 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)
  114214. * @param uniformName Name of the variable.
  114215. * @param array array to be set.
  114216. * @returns this effect.
  114217. */
  114218. setIntArray4(uniformName: string, array: Int32Array): Effect;
  114219. /**
  114220. * Sets an float array on a uniform variable.
  114221. * @param uniformName Name of the variable.
  114222. * @param array array to be set.
  114223. * @returns this effect.
  114224. */
  114225. setFloatArray(uniformName: string, array: Float32Array): Effect;
  114226. /**
  114227. * 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)
  114228. * @param uniformName Name of the variable.
  114229. * @param array array to be set.
  114230. * @returns this effect.
  114231. */
  114232. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  114233. /**
  114234. * 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)
  114235. * @param uniformName Name of the variable.
  114236. * @param array array to be set.
  114237. * @returns this effect.
  114238. */
  114239. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  114240. /**
  114241. * 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)
  114242. * @param uniformName Name of the variable.
  114243. * @param array array to be set.
  114244. * @returns this effect.
  114245. */
  114246. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  114247. /**
  114248. * Sets an array on a uniform variable.
  114249. * @param uniformName Name of the variable.
  114250. * @param array array to be set.
  114251. * @returns this effect.
  114252. */
  114253. setArray(uniformName: string, array: number[]): Effect;
  114254. /**
  114255. * 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)
  114256. * @param uniformName Name of the variable.
  114257. * @param array array to be set.
  114258. * @returns this effect.
  114259. */
  114260. setArray2(uniformName: string, array: number[]): Effect;
  114261. /**
  114262. * 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)
  114263. * @param uniformName Name of the variable.
  114264. * @param array array to be set.
  114265. * @returns this effect.
  114266. */
  114267. setArray3(uniformName: string, array: number[]): Effect;
  114268. /**
  114269. * 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)
  114270. * @param uniformName Name of the variable.
  114271. * @param array array to be set.
  114272. * @returns this effect.
  114273. */
  114274. setArray4(uniformName: string, array: number[]): Effect;
  114275. /**
  114276. * Sets matrices on a uniform variable.
  114277. * @param uniformName Name of the variable.
  114278. * @param matrices matrices to be set.
  114279. * @returns this effect.
  114280. */
  114281. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  114282. /**
  114283. * Sets matrix on a uniform variable.
  114284. * @param uniformName Name of the variable.
  114285. * @param matrix matrix to be set.
  114286. * @returns this effect.
  114287. */
  114288. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  114289. /**
  114290. * 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)
  114291. * @param uniformName Name of the variable.
  114292. * @param matrix matrix to be set.
  114293. * @returns this effect.
  114294. */
  114295. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114296. /**
  114297. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  114298. * @param uniformName Name of the variable.
  114299. * @param matrix matrix to be set.
  114300. * @returns this effect.
  114301. */
  114302. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114303. /**
  114304. * Sets a float on a uniform variable.
  114305. * @param uniformName Name of the variable.
  114306. * @param value value to be set.
  114307. * @returns this effect.
  114308. */
  114309. setFloat(uniformName: string, value: number): Effect;
  114310. /**
  114311. * Sets a boolean on a uniform variable.
  114312. * @param uniformName Name of the variable.
  114313. * @param bool value to be set.
  114314. * @returns this effect.
  114315. */
  114316. setBool(uniformName: string, bool: boolean): Effect;
  114317. /**
  114318. * Sets a Vector2 on a uniform variable.
  114319. * @param uniformName Name of the variable.
  114320. * @param vector2 vector2 to be set.
  114321. * @returns this effect.
  114322. */
  114323. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  114324. /**
  114325. * Sets a float2 on a uniform variable.
  114326. * @param uniformName Name of the variable.
  114327. * @param x First float in float2.
  114328. * @param y Second float in float2.
  114329. * @returns this effect.
  114330. */
  114331. setFloat2(uniformName: string, x: number, y: number): Effect;
  114332. /**
  114333. * Sets a Vector3 on a uniform variable.
  114334. * @param uniformName Name of the variable.
  114335. * @param vector3 Value to be set.
  114336. * @returns this effect.
  114337. */
  114338. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  114339. /**
  114340. * Sets a float3 on a uniform variable.
  114341. * @param uniformName Name of the variable.
  114342. * @param x First float in float3.
  114343. * @param y Second float in float3.
  114344. * @param z Third float in float3.
  114345. * @returns this effect.
  114346. */
  114347. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  114348. /**
  114349. * Sets a Vector4 on a uniform variable.
  114350. * @param uniformName Name of the variable.
  114351. * @param vector4 Value to be set.
  114352. * @returns this effect.
  114353. */
  114354. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  114355. /**
  114356. * Sets a float4 on a uniform variable.
  114357. * @param uniformName Name of the variable.
  114358. * @param x First float in float4.
  114359. * @param y Second float in float4.
  114360. * @param z Third float in float4.
  114361. * @param w Fourth float in float4.
  114362. * @returns this effect.
  114363. */
  114364. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  114365. /**
  114366. * Sets a Color3 on a uniform variable.
  114367. * @param uniformName Name of the variable.
  114368. * @param color3 Value to be set.
  114369. * @returns this effect.
  114370. */
  114371. setColor3(uniformName: string, color3: IColor3Like): Effect;
  114372. /**
  114373. * Sets a Color4 on a uniform variable.
  114374. * @param uniformName Name of the variable.
  114375. * @param color3 Value to be set.
  114376. * @param alpha Alpha value to be set.
  114377. * @returns this effect.
  114378. */
  114379. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  114380. /**
  114381. * Sets a Color4 on a uniform variable
  114382. * @param uniformName defines the name of the variable
  114383. * @param color4 defines the value to be set
  114384. * @returns this effect.
  114385. */
  114386. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  114387. /** Release all associated resources */
  114388. dispose(): void;
  114389. /**
  114390. * This function will add a new shader to the shader store
  114391. * @param name the name of the shader
  114392. * @param pixelShader optional pixel shader content
  114393. * @param vertexShader optional vertex shader content
  114394. */
  114395. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  114396. /**
  114397. * Store of each shader (The can be looked up using effect.key)
  114398. */
  114399. static ShadersStore: {
  114400. [key: string]: string;
  114401. };
  114402. /**
  114403. * Store of each included file for a shader (The can be looked up using effect.key)
  114404. */
  114405. static IncludesShadersStore: {
  114406. [key: string]: string;
  114407. };
  114408. /**
  114409. * Resets the cache of effects.
  114410. */
  114411. static ResetCache(): void;
  114412. }
  114413. }
  114414. declare module BABYLON {
  114415. /**
  114416. * Interface used to describe the capabilities of the engine relatively to the current browser
  114417. */
  114418. export interface EngineCapabilities {
  114419. /** Maximum textures units per fragment shader */
  114420. maxTexturesImageUnits: number;
  114421. /** Maximum texture units per vertex shader */
  114422. maxVertexTextureImageUnits: number;
  114423. /** Maximum textures units in the entire pipeline */
  114424. maxCombinedTexturesImageUnits: number;
  114425. /** Maximum texture size */
  114426. maxTextureSize: number;
  114427. /** Maximum texture samples */
  114428. maxSamples?: number;
  114429. /** Maximum cube texture size */
  114430. maxCubemapTextureSize: number;
  114431. /** Maximum render texture size */
  114432. maxRenderTextureSize: number;
  114433. /** Maximum number of vertex attributes */
  114434. maxVertexAttribs: number;
  114435. /** Maximum number of varyings */
  114436. maxVaryingVectors: number;
  114437. /** Maximum number of uniforms per vertex shader */
  114438. maxVertexUniformVectors: number;
  114439. /** Maximum number of uniforms per fragment shader */
  114440. maxFragmentUniformVectors: number;
  114441. /** Defines if standard derivates (dx/dy) are supported */
  114442. standardDerivatives: boolean;
  114443. /** Defines if s3tc texture compression is supported */
  114444. s3tc?: WEBGL_compressed_texture_s3tc;
  114445. /** Defines if pvrtc texture compression is supported */
  114446. pvrtc: any;
  114447. /** Defines if etc1 texture compression is supported */
  114448. etc1: any;
  114449. /** Defines if etc2 texture compression is supported */
  114450. etc2: any;
  114451. /** Defines if astc texture compression is supported */
  114452. astc: any;
  114453. /** Defines if float textures are supported */
  114454. textureFloat: boolean;
  114455. /** Defines if vertex array objects are supported */
  114456. vertexArrayObject: boolean;
  114457. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  114458. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  114459. /** Gets the maximum level of anisotropy supported */
  114460. maxAnisotropy: number;
  114461. /** Defines if instancing is supported */
  114462. instancedArrays: boolean;
  114463. /** Defines if 32 bits indices are supported */
  114464. uintIndices: boolean;
  114465. /** Defines if high precision shaders are supported */
  114466. highPrecisionShaderSupported: boolean;
  114467. /** Defines if depth reading in the fragment shader is supported */
  114468. fragmentDepthSupported: boolean;
  114469. /** Defines if float texture linear filtering is supported*/
  114470. textureFloatLinearFiltering: boolean;
  114471. /** Defines if rendering to float textures is supported */
  114472. textureFloatRender: boolean;
  114473. /** Defines if half float textures are supported*/
  114474. textureHalfFloat: boolean;
  114475. /** Defines if half float texture linear filtering is supported*/
  114476. textureHalfFloatLinearFiltering: boolean;
  114477. /** Defines if rendering to half float textures is supported */
  114478. textureHalfFloatRender: boolean;
  114479. /** Defines if textureLOD shader command is supported */
  114480. textureLOD: boolean;
  114481. /** Defines if draw buffers extension is supported */
  114482. drawBuffersExtension: boolean;
  114483. /** Defines if depth textures are supported */
  114484. depthTextureExtension: boolean;
  114485. /** Defines if float color buffer are supported */
  114486. colorBufferFloat: boolean;
  114487. /** Gets disjoint timer query extension (null if not supported) */
  114488. timerQuery?: EXT_disjoint_timer_query;
  114489. /** Defines if timestamp can be used with timer query */
  114490. canUseTimestampForTimerQuery: boolean;
  114491. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  114492. multiview?: any;
  114493. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  114494. oculusMultiview?: any;
  114495. /** Function used to let the system compiles shaders in background */
  114496. parallelShaderCompile?: {
  114497. COMPLETION_STATUS_KHR: number;
  114498. };
  114499. /** Max number of texture samples for MSAA */
  114500. maxMSAASamples: number;
  114501. /** Defines if the blend min max extension is supported */
  114502. blendMinMax: boolean;
  114503. }
  114504. }
  114505. declare module BABYLON {
  114506. /**
  114507. * @hidden
  114508. **/
  114509. export class DepthCullingState {
  114510. private _isDepthTestDirty;
  114511. private _isDepthMaskDirty;
  114512. private _isDepthFuncDirty;
  114513. private _isCullFaceDirty;
  114514. private _isCullDirty;
  114515. private _isZOffsetDirty;
  114516. private _isFrontFaceDirty;
  114517. private _depthTest;
  114518. private _depthMask;
  114519. private _depthFunc;
  114520. private _cull;
  114521. private _cullFace;
  114522. private _zOffset;
  114523. private _frontFace;
  114524. /**
  114525. * Initializes the state.
  114526. */
  114527. constructor();
  114528. get isDirty(): boolean;
  114529. get zOffset(): number;
  114530. set zOffset(value: number);
  114531. get cullFace(): Nullable<number>;
  114532. set cullFace(value: Nullable<number>);
  114533. get cull(): Nullable<boolean>;
  114534. set cull(value: Nullable<boolean>);
  114535. get depthFunc(): Nullable<number>;
  114536. set depthFunc(value: Nullable<number>);
  114537. get depthMask(): boolean;
  114538. set depthMask(value: boolean);
  114539. get depthTest(): boolean;
  114540. set depthTest(value: boolean);
  114541. get frontFace(): Nullable<number>;
  114542. set frontFace(value: Nullable<number>);
  114543. reset(): void;
  114544. apply(gl: WebGLRenderingContext): void;
  114545. }
  114546. }
  114547. declare module BABYLON {
  114548. /**
  114549. * @hidden
  114550. **/
  114551. export class StencilState {
  114552. /** 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 */
  114553. static readonly ALWAYS: number;
  114554. /** Passed to stencilOperation to specify that stencil value must be kept */
  114555. static readonly KEEP: number;
  114556. /** Passed to stencilOperation to specify that stencil value must be replaced */
  114557. static readonly REPLACE: number;
  114558. private _isStencilTestDirty;
  114559. private _isStencilMaskDirty;
  114560. private _isStencilFuncDirty;
  114561. private _isStencilOpDirty;
  114562. private _stencilTest;
  114563. private _stencilMask;
  114564. private _stencilFunc;
  114565. private _stencilFuncRef;
  114566. private _stencilFuncMask;
  114567. private _stencilOpStencilFail;
  114568. private _stencilOpDepthFail;
  114569. private _stencilOpStencilDepthPass;
  114570. get isDirty(): boolean;
  114571. get stencilFunc(): number;
  114572. set stencilFunc(value: number);
  114573. get stencilFuncRef(): number;
  114574. set stencilFuncRef(value: number);
  114575. get stencilFuncMask(): number;
  114576. set stencilFuncMask(value: number);
  114577. get stencilOpStencilFail(): number;
  114578. set stencilOpStencilFail(value: number);
  114579. get stencilOpDepthFail(): number;
  114580. set stencilOpDepthFail(value: number);
  114581. get stencilOpStencilDepthPass(): number;
  114582. set stencilOpStencilDepthPass(value: number);
  114583. get stencilMask(): number;
  114584. set stencilMask(value: number);
  114585. get stencilTest(): boolean;
  114586. set stencilTest(value: boolean);
  114587. constructor();
  114588. reset(): void;
  114589. apply(gl: WebGLRenderingContext): void;
  114590. }
  114591. }
  114592. declare module BABYLON {
  114593. /**
  114594. * @hidden
  114595. **/
  114596. export class AlphaState {
  114597. private _isAlphaBlendDirty;
  114598. private _isBlendFunctionParametersDirty;
  114599. private _isBlendEquationParametersDirty;
  114600. private _isBlendConstantsDirty;
  114601. private _alphaBlend;
  114602. private _blendFunctionParameters;
  114603. private _blendEquationParameters;
  114604. private _blendConstants;
  114605. /**
  114606. * Initializes the state.
  114607. */
  114608. constructor();
  114609. get isDirty(): boolean;
  114610. get alphaBlend(): boolean;
  114611. set alphaBlend(value: boolean);
  114612. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  114613. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  114614. setAlphaEquationParameters(rgb: number, alpha: number): void;
  114615. reset(): void;
  114616. apply(gl: WebGLRenderingContext): void;
  114617. }
  114618. }
  114619. declare module BABYLON {
  114620. /** @hidden */
  114621. export class WebGL2ShaderProcessor implements IShaderProcessor {
  114622. attributeProcessor(attribute: string): string;
  114623. varyingProcessor(varying: string, isFragment: boolean): string;
  114624. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  114625. }
  114626. }
  114627. declare module BABYLON {
  114628. /**
  114629. * Interface for attribute information associated with buffer instanciation
  114630. */
  114631. export interface InstancingAttributeInfo {
  114632. /**
  114633. * Name of the GLSL attribute
  114634. * if attribute index is not specified, this is used to retrieve the index from the effect
  114635. */
  114636. attributeName: string;
  114637. /**
  114638. * Index/offset of the attribute in the vertex shader
  114639. * if not specified, this will be computes from the name.
  114640. */
  114641. index?: number;
  114642. /**
  114643. * size of the attribute, 1, 2, 3 or 4
  114644. */
  114645. attributeSize: number;
  114646. /**
  114647. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  114648. */
  114649. offset: number;
  114650. /**
  114651. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  114652. * default to 1
  114653. */
  114654. divisor?: number;
  114655. /**
  114656. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  114657. * default is FLOAT
  114658. */
  114659. attributeType?: number;
  114660. /**
  114661. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  114662. */
  114663. normalized?: boolean;
  114664. }
  114665. }
  114666. declare module BABYLON {
  114667. interface ThinEngine {
  114668. /**
  114669. * Update a video texture
  114670. * @param texture defines the texture to update
  114671. * @param video defines the video element to use
  114672. * @param invertY defines if data must be stored with Y axis inverted
  114673. */
  114674. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  114675. }
  114676. }
  114677. declare module BABYLON {
  114678. interface ThinEngine {
  114679. /**
  114680. * Creates a dynamic texture
  114681. * @param width defines the width of the texture
  114682. * @param height defines the height of the texture
  114683. * @param generateMipMaps defines if the engine should generate the mip levels
  114684. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  114685. * @returns the dynamic texture inside an InternalTexture
  114686. */
  114687. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  114688. /**
  114689. * Update the content of a dynamic texture
  114690. * @param texture defines the texture to update
  114691. * @param canvas defines the canvas containing the source
  114692. * @param invertY defines if data must be stored with Y axis inverted
  114693. * @param premulAlpha defines if alpha is stored as premultiplied
  114694. * @param format defines the format of the data
  114695. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  114696. */
  114697. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  114698. }
  114699. }
  114700. declare module BABYLON {
  114701. /**
  114702. * Settings for finer control over video usage
  114703. */
  114704. export interface VideoTextureSettings {
  114705. /**
  114706. * Applies `autoplay` to video, if specified
  114707. */
  114708. autoPlay?: boolean;
  114709. /**
  114710. * Applies `loop` to video, if specified
  114711. */
  114712. loop?: boolean;
  114713. /**
  114714. * Automatically updates internal texture from video at every frame in the render loop
  114715. */
  114716. autoUpdateTexture: boolean;
  114717. /**
  114718. * Image src displayed during the video loading or until the user interacts with the video.
  114719. */
  114720. poster?: string;
  114721. }
  114722. /**
  114723. * If you want to display a video in your scene, this is the special texture for that.
  114724. * This special texture works similar to other textures, with the exception of a few parameters.
  114725. * @see https://doc.babylonjs.com/how_to/video_texture
  114726. */
  114727. export class VideoTexture extends Texture {
  114728. /**
  114729. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  114730. */
  114731. readonly autoUpdateTexture: boolean;
  114732. /**
  114733. * The video instance used by the texture internally
  114734. */
  114735. readonly video: HTMLVideoElement;
  114736. private _onUserActionRequestedObservable;
  114737. /**
  114738. * Event triggerd when a dom action is required by the user to play the video.
  114739. * This happens due to recent changes in browser policies preventing video to auto start.
  114740. */
  114741. get onUserActionRequestedObservable(): Observable<Texture>;
  114742. private _generateMipMaps;
  114743. private _stillImageCaptured;
  114744. private _displayingPosterTexture;
  114745. private _settings;
  114746. private _createInternalTextureOnEvent;
  114747. private _frameId;
  114748. private _currentSrc;
  114749. /**
  114750. * Creates a video texture.
  114751. * If you want to display a video in your scene, this is the special texture for that.
  114752. * This special texture works similar to other textures, with the exception of a few parameters.
  114753. * @see https://doc.babylonjs.com/how_to/video_texture
  114754. * @param name optional name, will detect from video source, if not defined
  114755. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  114756. * @param scene is obviously the current scene.
  114757. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  114758. * @param invertY is false by default but can be used to invert video on Y axis
  114759. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  114760. * @param settings allows finer control over video usage
  114761. */
  114762. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  114763. private _getName;
  114764. private _getVideo;
  114765. private _createInternalTexture;
  114766. private reset;
  114767. /**
  114768. * @hidden Internal method to initiate `update`.
  114769. */
  114770. _rebuild(): void;
  114771. /**
  114772. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  114773. */
  114774. update(): void;
  114775. /**
  114776. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  114777. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  114778. */
  114779. updateTexture(isVisible: boolean): void;
  114780. protected _updateInternalTexture: () => void;
  114781. /**
  114782. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  114783. * @param url New url.
  114784. */
  114785. updateURL(url: string): void;
  114786. /**
  114787. * Clones the texture.
  114788. * @returns the cloned texture
  114789. */
  114790. clone(): VideoTexture;
  114791. /**
  114792. * Dispose the texture and release its associated resources.
  114793. */
  114794. dispose(): void;
  114795. /**
  114796. * Creates a video texture straight from a stream.
  114797. * @param scene Define the scene the texture should be created in
  114798. * @param stream Define the stream the texture should be created from
  114799. * @returns The created video texture as a promise
  114800. */
  114801. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  114802. /**
  114803. * Creates a video texture straight from your WebCam video feed.
  114804. * @param scene Define the scene the texture should be created in
  114805. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114806. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114807. * @returns The created video texture as a promise
  114808. */
  114809. static CreateFromWebCamAsync(scene: Scene, constraints: {
  114810. minWidth: number;
  114811. maxWidth: number;
  114812. minHeight: number;
  114813. maxHeight: number;
  114814. deviceId: string;
  114815. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  114816. /**
  114817. * Creates a video texture straight from your WebCam video feed.
  114818. * @param scene Define the scene the texture should be created in
  114819. * @param onReady Define a callback to triggered once the texture will be ready
  114820. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114821. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114822. */
  114823. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  114824. minWidth: number;
  114825. maxWidth: number;
  114826. minHeight: number;
  114827. maxHeight: number;
  114828. deviceId: string;
  114829. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  114830. }
  114831. }
  114832. declare module BABYLON {
  114833. /**
  114834. * Defines the interface used by objects working like Scene
  114835. * @hidden
  114836. */
  114837. export interface ISceneLike {
  114838. _addPendingData(data: any): void;
  114839. _removePendingData(data: any): void;
  114840. offlineProvider: IOfflineProvider;
  114841. }
  114842. /**
  114843. * Information about the current host
  114844. */
  114845. export interface HostInformation {
  114846. /**
  114847. * Defines if the current host is a mobile
  114848. */
  114849. isMobile: boolean;
  114850. }
  114851. /** Interface defining initialization parameters for Engine class */
  114852. export interface EngineOptions extends WebGLContextAttributes {
  114853. /**
  114854. * Defines if the engine should no exceed a specified device ratio
  114855. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  114856. */
  114857. limitDeviceRatio?: number;
  114858. /**
  114859. * Defines if webvr should be enabled automatically
  114860. * @see https://doc.babylonjs.com/how_to/webvr_camera
  114861. */
  114862. autoEnableWebVR?: boolean;
  114863. /**
  114864. * Defines if webgl2 should be turned off even if supported
  114865. * @see https://doc.babylonjs.com/features/webgl2
  114866. */
  114867. disableWebGL2Support?: boolean;
  114868. /**
  114869. * Defines if webaudio should be initialized as well
  114870. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  114871. */
  114872. audioEngine?: boolean;
  114873. /**
  114874. * Defines if animations should run using a deterministic lock step
  114875. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  114876. */
  114877. deterministicLockstep?: boolean;
  114878. /** Defines the maximum steps to use with deterministic lock step mode */
  114879. lockstepMaxSteps?: number;
  114880. /** Defines the seconds between each deterministic lock step */
  114881. timeStep?: number;
  114882. /**
  114883. * Defines that engine should ignore context lost events
  114884. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  114885. */
  114886. doNotHandleContextLost?: boolean;
  114887. /**
  114888. * Defines that engine should ignore modifying touch action attribute and style
  114889. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  114890. */
  114891. doNotHandleTouchAction?: boolean;
  114892. /**
  114893. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  114894. */
  114895. useHighPrecisionFloats?: boolean;
  114896. /**
  114897. * Make the canvas XR Compatible for XR sessions
  114898. */
  114899. xrCompatible?: boolean;
  114900. /**
  114901. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  114902. */
  114903. useHighPrecisionMatrix?: boolean;
  114904. }
  114905. /**
  114906. * The base engine class (root of all engines)
  114907. */
  114908. export class ThinEngine {
  114909. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  114910. static ExceptionList: ({
  114911. key: string;
  114912. capture: string;
  114913. captureConstraint: number;
  114914. targets: string[];
  114915. } | {
  114916. key: string;
  114917. capture: null;
  114918. captureConstraint: null;
  114919. targets: string[];
  114920. })[];
  114921. /** @hidden */
  114922. static _TextureLoaders: IInternalTextureLoader[];
  114923. /**
  114924. * Returns the current npm package of the sdk
  114925. */
  114926. static get NpmPackage(): string;
  114927. /**
  114928. * Returns the current version of the framework
  114929. */
  114930. static get Version(): string;
  114931. /**
  114932. * Returns a string describing the current engine
  114933. */
  114934. get description(): string;
  114935. /**
  114936. * Gets or sets the epsilon value used by collision engine
  114937. */
  114938. static CollisionsEpsilon: number;
  114939. /**
  114940. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  114941. */
  114942. static get ShadersRepository(): string;
  114943. static set ShadersRepository(value: string);
  114944. /** @hidden */
  114945. _shaderProcessor: IShaderProcessor;
  114946. /**
  114947. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  114948. */
  114949. forcePOTTextures: boolean;
  114950. /**
  114951. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  114952. */
  114953. isFullscreen: boolean;
  114954. /**
  114955. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  114956. */
  114957. cullBackFaces: boolean;
  114958. /**
  114959. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  114960. */
  114961. renderEvenInBackground: boolean;
  114962. /**
  114963. * Gets or sets a boolean indicating that cache can be kept between frames
  114964. */
  114965. preventCacheWipeBetweenFrames: boolean;
  114966. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  114967. validateShaderPrograms: boolean;
  114968. /**
  114969. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  114970. * This can provide greater z depth for distant objects.
  114971. */
  114972. useReverseDepthBuffer: boolean;
  114973. /**
  114974. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  114975. */
  114976. disableUniformBuffers: boolean;
  114977. /** @hidden */
  114978. _uniformBuffers: UniformBuffer[];
  114979. /**
  114980. * Gets a boolean indicating that the engine supports uniform buffers
  114981. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  114982. */
  114983. get supportsUniformBuffers(): boolean;
  114984. /** @hidden */
  114985. _gl: WebGLRenderingContext;
  114986. /** @hidden */
  114987. _webGLVersion: number;
  114988. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  114989. protected _windowIsBackground: boolean;
  114990. protected _creationOptions: EngineOptions;
  114991. protected _highPrecisionShadersAllowed: boolean;
  114992. /** @hidden */
  114993. get _shouldUseHighPrecisionShader(): boolean;
  114994. /**
  114995. * Gets a boolean indicating that only power of 2 textures are supported
  114996. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  114997. */
  114998. get needPOTTextures(): boolean;
  114999. /** @hidden */
  115000. _badOS: boolean;
  115001. /** @hidden */
  115002. _badDesktopOS: boolean;
  115003. private _hardwareScalingLevel;
  115004. /** @hidden */
  115005. _caps: EngineCapabilities;
  115006. private _isStencilEnable;
  115007. private _glVersion;
  115008. private _glRenderer;
  115009. private _glVendor;
  115010. /** @hidden */
  115011. _videoTextureSupported: boolean;
  115012. protected _renderingQueueLaunched: boolean;
  115013. protected _activeRenderLoops: (() => void)[];
  115014. /**
  115015. * Observable signaled when a context lost event is raised
  115016. */
  115017. onContextLostObservable: Observable<ThinEngine>;
  115018. /**
  115019. * Observable signaled when a context restored event is raised
  115020. */
  115021. onContextRestoredObservable: Observable<ThinEngine>;
  115022. private _onContextLost;
  115023. private _onContextRestored;
  115024. protected _contextWasLost: boolean;
  115025. /** @hidden */
  115026. _doNotHandleContextLost: boolean;
  115027. /**
  115028. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  115029. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  115030. */
  115031. get doNotHandleContextLost(): boolean;
  115032. set doNotHandleContextLost(value: boolean);
  115033. /**
  115034. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  115035. */
  115036. disableVertexArrayObjects: boolean;
  115037. /** @hidden */
  115038. protected _colorWrite: boolean;
  115039. /** @hidden */
  115040. protected _colorWriteChanged: boolean;
  115041. /** @hidden */
  115042. protected _depthCullingState: DepthCullingState;
  115043. /** @hidden */
  115044. protected _stencilState: StencilState;
  115045. /** @hidden */
  115046. _alphaState: AlphaState;
  115047. /** @hidden */
  115048. _alphaMode: number;
  115049. /** @hidden */
  115050. _alphaEquation: number;
  115051. /** @hidden */
  115052. _internalTexturesCache: InternalTexture[];
  115053. /** @hidden */
  115054. protected _activeChannel: number;
  115055. private _currentTextureChannel;
  115056. /** @hidden */
  115057. protected _boundTexturesCache: {
  115058. [key: string]: Nullable<InternalTexture>;
  115059. };
  115060. /** @hidden */
  115061. protected _currentEffect: Nullable<Effect>;
  115062. /** @hidden */
  115063. protected _currentProgram: Nullable<WebGLProgram>;
  115064. private _compiledEffects;
  115065. private _vertexAttribArraysEnabled;
  115066. /** @hidden */
  115067. protected _cachedViewport: Nullable<IViewportLike>;
  115068. private _cachedVertexArrayObject;
  115069. /** @hidden */
  115070. protected _cachedVertexBuffers: any;
  115071. /** @hidden */
  115072. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  115073. /** @hidden */
  115074. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  115075. /** @hidden */
  115076. _currentRenderTarget: Nullable<InternalTexture>;
  115077. private _uintIndicesCurrentlySet;
  115078. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  115079. /** @hidden */
  115080. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  115081. /** @hidden */
  115082. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  115083. private _currentBufferPointers;
  115084. private _currentInstanceLocations;
  115085. private _currentInstanceBuffers;
  115086. private _textureUnits;
  115087. /** @hidden */
  115088. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115089. /** @hidden */
  115090. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115091. /** @hidden */
  115092. _boundRenderFunction: any;
  115093. private _vaoRecordInProgress;
  115094. private _mustWipeVertexAttributes;
  115095. private _emptyTexture;
  115096. private _emptyCubeTexture;
  115097. private _emptyTexture3D;
  115098. private _emptyTexture2DArray;
  115099. /** @hidden */
  115100. _frameHandler: number;
  115101. private _nextFreeTextureSlots;
  115102. private _maxSimultaneousTextures;
  115103. private _activeRequests;
  115104. /** @hidden */
  115105. _transformTextureUrl: Nullable<(url: string) => string>;
  115106. /**
  115107. * Gets information about the current host
  115108. */
  115109. hostInformation: HostInformation;
  115110. protected get _supportsHardwareTextureRescaling(): boolean;
  115111. private _framebufferDimensionsObject;
  115112. /**
  115113. * sets the object from which width and height will be taken from when getting render width and height
  115114. * Will fallback to the gl object
  115115. * @param dimensions the framebuffer width and height that will be used.
  115116. */
  115117. set framebufferDimensionsObject(dimensions: Nullable<{
  115118. framebufferWidth: number;
  115119. framebufferHeight: number;
  115120. }>);
  115121. /**
  115122. * Gets the current viewport
  115123. */
  115124. get currentViewport(): Nullable<IViewportLike>;
  115125. /**
  115126. * Gets the default empty texture
  115127. */
  115128. get emptyTexture(): InternalTexture;
  115129. /**
  115130. * Gets the default empty 3D texture
  115131. */
  115132. get emptyTexture3D(): InternalTexture;
  115133. /**
  115134. * Gets the default empty 2D array texture
  115135. */
  115136. get emptyTexture2DArray(): InternalTexture;
  115137. /**
  115138. * Gets the default empty cube texture
  115139. */
  115140. get emptyCubeTexture(): InternalTexture;
  115141. /**
  115142. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  115143. */
  115144. readonly premultipliedAlpha: boolean;
  115145. /**
  115146. * Observable event triggered before each texture is initialized
  115147. */
  115148. onBeforeTextureInitObservable: Observable<Texture>;
  115149. /**
  115150. * Creates a new engine
  115151. * @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
  115152. * @param antialias defines enable antialiasing (default: false)
  115153. * @param options defines further options to be sent to the getContext() function
  115154. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  115155. */
  115156. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  115157. private _rebuildInternalTextures;
  115158. private _rebuildEffects;
  115159. /**
  115160. * Gets a boolean indicating if all created effects are ready
  115161. * @returns true if all effects are ready
  115162. */
  115163. areAllEffectsReady(): boolean;
  115164. protected _rebuildBuffers(): void;
  115165. protected _initGLContext(): void;
  115166. /**
  115167. * Gets version of the current webGL context
  115168. */
  115169. get webGLVersion(): number;
  115170. /**
  115171. * Gets a string identifying the name of the class
  115172. * @returns "Engine" string
  115173. */
  115174. getClassName(): string;
  115175. /**
  115176. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  115177. */
  115178. get isStencilEnable(): boolean;
  115179. /** @hidden */
  115180. _prepareWorkingCanvas(): void;
  115181. /**
  115182. * Reset the texture cache to empty state
  115183. */
  115184. resetTextureCache(): void;
  115185. /**
  115186. * Gets an object containing information about the current webGL context
  115187. * @returns an object containing the vender, the renderer and the version of the current webGL context
  115188. */
  115189. getGlInfo(): {
  115190. vendor: string;
  115191. renderer: string;
  115192. version: string;
  115193. };
  115194. /**
  115195. * Defines the hardware scaling level.
  115196. * By default the hardware scaling level is computed from the window device ratio.
  115197. * 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.
  115198. * @param level defines the level to use
  115199. */
  115200. setHardwareScalingLevel(level: number): void;
  115201. /**
  115202. * Gets the current hardware scaling level.
  115203. * By default the hardware scaling level is computed from the window device ratio.
  115204. * 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.
  115205. * @returns a number indicating the current hardware scaling level
  115206. */
  115207. getHardwareScalingLevel(): number;
  115208. /**
  115209. * Gets the list of loaded textures
  115210. * @returns an array containing all loaded textures
  115211. */
  115212. getLoadedTexturesCache(): InternalTexture[];
  115213. /**
  115214. * Gets the object containing all engine capabilities
  115215. * @returns the EngineCapabilities object
  115216. */
  115217. getCaps(): EngineCapabilities;
  115218. /**
  115219. * stop executing a render loop function and remove it from the execution array
  115220. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  115221. */
  115222. stopRenderLoop(renderFunction?: () => void): void;
  115223. /** @hidden */
  115224. _renderLoop(): void;
  115225. /**
  115226. * Gets the HTML canvas attached with the current webGL context
  115227. * @returns a HTML canvas
  115228. */
  115229. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  115230. /**
  115231. * Gets host window
  115232. * @returns the host window object
  115233. */
  115234. getHostWindow(): Nullable<Window>;
  115235. /**
  115236. * Gets the current render width
  115237. * @param useScreen defines if screen size must be used (or the current render target if any)
  115238. * @returns a number defining the current render width
  115239. */
  115240. getRenderWidth(useScreen?: boolean): number;
  115241. /**
  115242. * Gets the current render height
  115243. * @param useScreen defines if screen size must be used (or the current render target if any)
  115244. * @returns a number defining the current render height
  115245. */
  115246. getRenderHeight(useScreen?: boolean): number;
  115247. /**
  115248. * Can be used to override the current requestAnimationFrame requester.
  115249. * @hidden
  115250. */
  115251. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  115252. /**
  115253. * Register and execute a render loop. The engine can have more than one render function
  115254. * @param renderFunction defines the function to continuously execute
  115255. */
  115256. runRenderLoop(renderFunction: () => void): void;
  115257. /**
  115258. * Clear the current render buffer or the current render target (if any is set up)
  115259. * @param color defines the color to use
  115260. * @param backBuffer defines if the back buffer must be cleared
  115261. * @param depth defines if the depth buffer must be cleared
  115262. * @param stencil defines if the stencil buffer must be cleared
  115263. */
  115264. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  115265. private _viewportCached;
  115266. /** @hidden */
  115267. _viewport(x: number, y: number, width: number, height: number): void;
  115268. /**
  115269. * Set the WebGL's viewport
  115270. * @param viewport defines the viewport element to be used
  115271. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  115272. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  115273. */
  115274. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  115275. /**
  115276. * Begin a new frame
  115277. */
  115278. beginFrame(): void;
  115279. /**
  115280. * Enf the current frame
  115281. */
  115282. endFrame(): void;
  115283. /**
  115284. * Resize the view according to the canvas' size
  115285. */
  115286. resize(): void;
  115287. /**
  115288. * Force a specific size of the canvas
  115289. * @param width defines the new canvas' width
  115290. * @param height defines the new canvas' height
  115291. * @returns true if the size was changed
  115292. */
  115293. setSize(width: number, height: number): boolean;
  115294. /**
  115295. * Binds the frame buffer to the specified texture.
  115296. * @param texture The texture to render to or null for the default canvas
  115297. * @param faceIndex The face of the texture to render to in case of cube texture
  115298. * @param requiredWidth The width of the target to render to
  115299. * @param requiredHeight The height of the target to render to
  115300. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  115301. * @param lodLevel defines the lod level to bind to the frame buffer
  115302. * @param layer defines the 2d array index to bind to frame buffer to
  115303. */
  115304. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  115305. /** @hidden */
  115306. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  115307. /**
  115308. * Unbind the current render target texture from the webGL context
  115309. * @param texture defines the render target texture to unbind
  115310. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  115311. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  115312. */
  115313. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  115314. /**
  115315. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  115316. */
  115317. flushFramebuffer(): void;
  115318. /**
  115319. * Unbind the current render target and bind the default framebuffer
  115320. */
  115321. restoreDefaultFramebuffer(): void;
  115322. /** @hidden */
  115323. protected _resetVertexBufferBinding(): void;
  115324. /**
  115325. * Creates a vertex buffer
  115326. * @param data the data for the vertex buffer
  115327. * @returns the new WebGL static buffer
  115328. */
  115329. createVertexBuffer(data: DataArray): DataBuffer;
  115330. private _createVertexBuffer;
  115331. /**
  115332. * Creates a dynamic vertex buffer
  115333. * @param data the data for the dynamic vertex buffer
  115334. * @returns the new WebGL dynamic buffer
  115335. */
  115336. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  115337. protected _resetIndexBufferBinding(): void;
  115338. /**
  115339. * Creates a new index buffer
  115340. * @param indices defines the content of the index buffer
  115341. * @param updatable defines if the index buffer must be updatable
  115342. * @returns a new webGL buffer
  115343. */
  115344. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  115345. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  115346. /**
  115347. * Bind a webGL buffer to the webGL context
  115348. * @param buffer defines the buffer to bind
  115349. */
  115350. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  115351. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  115352. private bindBuffer;
  115353. /**
  115354. * update the bound buffer with the given data
  115355. * @param data defines the data to update
  115356. */
  115357. updateArrayBuffer(data: Float32Array): void;
  115358. private _vertexAttribPointer;
  115359. /** @hidden */
  115360. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  115361. private _bindVertexBuffersAttributes;
  115362. /**
  115363. * Records a vertex array object
  115364. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115365. * @param vertexBuffers defines the list of vertex buffers to store
  115366. * @param indexBuffer defines the index buffer to store
  115367. * @param effect defines the effect to store
  115368. * @returns the new vertex array object
  115369. */
  115370. recordVertexArrayObject(vertexBuffers: {
  115371. [key: string]: VertexBuffer;
  115372. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  115373. /**
  115374. * Bind a specific vertex array object
  115375. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115376. * @param vertexArrayObject defines the vertex array object to bind
  115377. * @param indexBuffer defines the index buffer to bind
  115378. */
  115379. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  115380. /**
  115381. * Bind webGl buffers directly to the webGL context
  115382. * @param vertexBuffer defines the vertex buffer to bind
  115383. * @param indexBuffer defines the index buffer to bind
  115384. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  115385. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  115386. * @param effect defines the effect associated with the vertex buffer
  115387. */
  115388. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  115389. private _unbindVertexArrayObject;
  115390. /**
  115391. * Bind a list of vertex buffers to the webGL context
  115392. * @param vertexBuffers defines the list of vertex buffers to bind
  115393. * @param indexBuffer defines the index buffer to bind
  115394. * @param effect defines the effect associated with the vertex buffers
  115395. */
  115396. bindBuffers(vertexBuffers: {
  115397. [key: string]: Nullable<VertexBuffer>;
  115398. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  115399. /**
  115400. * Unbind all instance attributes
  115401. */
  115402. unbindInstanceAttributes(): void;
  115403. /**
  115404. * Release and free the memory of a vertex array object
  115405. * @param vao defines the vertex array object to delete
  115406. */
  115407. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  115408. /** @hidden */
  115409. _releaseBuffer(buffer: DataBuffer): boolean;
  115410. protected _deleteBuffer(buffer: DataBuffer): void;
  115411. /**
  115412. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  115413. * @param instancesBuffer defines the webGL buffer to update and bind
  115414. * @param data defines the data to store in the buffer
  115415. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  115416. */
  115417. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  115418. /**
  115419. * Bind the content of a webGL buffer used with instantiation
  115420. * @param instancesBuffer defines the webGL buffer to bind
  115421. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  115422. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  115423. */
  115424. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  115425. /**
  115426. * Disable the instance attribute corresponding to the name in parameter
  115427. * @param name defines the name of the attribute to disable
  115428. */
  115429. disableInstanceAttributeByName(name: string): void;
  115430. /**
  115431. * Disable the instance attribute corresponding to the location in parameter
  115432. * @param attributeLocation defines the attribute location of the attribute to disable
  115433. */
  115434. disableInstanceAttribute(attributeLocation: number): void;
  115435. /**
  115436. * Disable the attribute corresponding to the location in parameter
  115437. * @param attributeLocation defines the attribute location of the attribute to disable
  115438. */
  115439. disableAttributeByIndex(attributeLocation: number): void;
  115440. /**
  115441. * Send a draw order
  115442. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115443. * @param indexStart defines the starting index
  115444. * @param indexCount defines the number of index to draw
  115445. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115446. */
  115447. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  115448. /**
  115449. * Draw a list of points
  115450. * @param verticesStart defines the index of first vertex to draw
  115451. * @param verticesCount defines the count of vertices to draw
  115452. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115453. */
  115454. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115455. /**
  115456. * Draw a list of unindexed primitives
  115457. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115458. * @param verticesStart defines the index of first vertex to draw
  115459. * @param verticesCount defines the count of vertices to draw
  115460. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115461. */
  115462. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115463. /**
  115464. * Draw a list of indexed primitives
  115465. * @param fillMode defines the primitive to use
  115466. * @param indexStart defines the starting index
  115467. * @param indexCount defines the number of index to draw
  115468. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115469. */
  115470. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  115471. /**
  115472. * Draw a list of unindexed primitives
  115473. * @param fillMode defines the primitive to use
  115474. * @param verticesStart defines the index of first vertex to draw
  115475. * @param verticesCount defines the count of vertices to draw
  115476. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115477. */
  115478. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115479. private _drawMode;
  115480. /** @hidden */
  115481. protected _reportDrawCall(): void;
  115482. /** @hidden */
  115483. _releaseEffect(effect: Effect): void;
  115484. /** @hidden */
  115485. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  115486. /**
  115487. * Create a new effect (used to store vertex/fragment shaders)
  115488. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  115489. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  115490. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  115491. * @param samplers defines an array of string used to represent textures
  115492. * @param defines defines the string containing the defines to use to compile the shaders
  115493. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  115494. * @param onCompiled defines a function to call when the effect creation is successful
  115495. * @param onError defines a function to call when the effect creation has failed
  115496. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  115497. * @returns the new Effect
  115498. */
  115499. 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;
  115500. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  115501. private _compileShader;
  115502. private _compileRawShader;
  115503. /** @hidden */
  115504. _getShaderSource(shader: WebGLShader): Nullable<string>;
  115505. /**
  115506. * Directly creates a webGL program
  115507. * @param pipelineContext defines the pipeline context to attach to
  115508. * @param vertexCode defines the vertex shader code to use
  115509. * @param fragmentCode defines the fragment shader code to use
  115510. * @param context defines the webGL context to use (if not set, the current one will be used)
  115511. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115512. * @returns the new webGL program
  115513. */
  115514. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115515. /**
  115516. * Creates a webGL program
  115517. * @param pipelineContext defines the pipeline context to attach to
  115518. * @param vertexCode defines the vertex shader code to use
  115519. * @param fragmentCode defines the fragment shader code to use
  115520. * @param defines defines the string containing the defines to use to compile the shaders
  115521. * @param context defines the webGL context to use (if not set, the current one will be used)
  115522. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115523. * @returns the new webGL program
  115524. */
  115525. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115526. /**
  115527. * Creates a new pipeline context
  115528. * @returns the new pipeline
  115529. */
  115530. createPipelineContext(): IPipelineContext;
  115531. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115532. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  115533. /** @hidden */
  115534. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  115535. /** @hidden */
  115536. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  115537. /** @hidden */
  115538. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  115539. /**
  115540. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  115541. * @param pipelineContext defines the pipeline context to use
  115542. * @param uniformsNames defines the list of uniform names
  115543. * @returns an array of webGL uniform locations
  115544. */
  115545. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  115546. /**
  115547. * Gets the lsit of active attributes for a given webGL program
  115548. * @param pipelineContext defines the pipeline context to use
  115549. * @param attributesNames defines the list of attribute names to get
  115550. * @returns an array of indices indicating the offset of each attribute
  115551. */
  115552. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  115553. /**
  115554. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  115555. * @param effect defines the effect to activate
  115556. */
  115557. enableEffect(effect: Nullable<Effect>): void;
  115558. /**
  115559. * Set the value of an uniform to a number (int)
  115560. * @param uniform defines the webGL uniform location where to store the value
  115561. * @param value defines the int number to store
  115562. */
  115563. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115564. /**
  115565. * Set the value of an uniform to an array of int32
  115566. * @param uniform defines the webGL uniform location where to store the value
  115567. * @param array defines the array of int32 to store
  115568. */
  115569. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115570. /**
  115571. * Set the value of an uniform to an array of int32 (stored as vec2)
  115572. * @param uniform defines the webGL uniform location where to store the value
  115573. * @param array defines the array of int32 to store
  115574. */
  115575. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115576. /**
  115577. * Set the value of an uniform to an array of int32 (stored as vec3)
  115578. * @param uniform defines the webGL uniform location where to store the value
  115579. * @param array defines the array of int32 to store
  115580. */
  115581. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115582. /**
  115583. * Set the value of an uniform to an array of int32 (stored as vec4)
  115584. * @param uniform defines the webGL uniform location where to store the value
  115585. * @param array defines the array of int32 to store
  115586. */
  115587. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115588. /**
  115589. * Set the value of an uniform to an array of number
  115590. * @param uniform defines the webGL uniform location where to store the value
  115591. * @param array defines the array of number to store
  115592. */
  115593. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115594. /**
  115595. * Set the value of an uniform to an array of number (stored as vec2)
  115596. * @param uniform defines the webGL uniform location where to store the value
  115597. * @param array defines the array of number to store
  115598. */
  115599. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115600. /**
  115601. * Set the value of an uniform to an array of number (stored as vec3)
  115602. * @param uniform defines the webGL uniform location where to store the value
  115603. * @param array defines the array of number to store
  115604. */
  115605. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115606. /**
  115607. * Set the value of an uniform to an array of number (stored as vec4)
  115608. * @param uniform defines the webGL uniform location where to store the value
  115609. * @param array defines the array of number to store
  115610. */
  115611. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115612. /**
  115613. * Set the value of an uniform to an array of float32 (stored as matrices)
  115614. * @param uniform defines the webGL uniform location where to store the value
  115615. * @param matrices defines the array of float32 to store
  115616. */
  115617. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  115618. /**
  115619. * Set the value of an uniform to a matrix (3x3)
  115620. * @param uniform defines the webGL uniform location where to store the value
  115621. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  115622. */
  115623. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115624. /**
  115625. * Set the value of an uniform to a matrix (2x2)
  115626. * @param uniform defines the webGL uniform location where to store the value
  115627. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  115628. */
  115629. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115630. /**
  115631. * Set the value of an uniform to a number (float)
  115632. * @param uniform defines the webGL uniform location where to store the value
  115633. * @param value defines the float number to store
  115634. */
  115635. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115636. /**
  115637. * Set the value of an uniform to a vec2
  115638. * @param uniform defines the webGL uniform location where to store the value
  115639. * @param x defines the 1st component of the value
  115640. * @param y defines the 2nd component of the value
  115641. */
  115642. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  115643. /**
  115644. * Set the value of an uniform to a vec3
  115645. * @param uniform defines the webGL uniform location where to store the value
  115646. * @param x defines the 1st component of the value
  115647. * @param y defines the 2nd component of the value
  115648. * @param z defines the 3rd component of the value
  115649. */
  115650. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  115651. /**
  115652. * Set the value of an uniform to a vec4
  115653. * @param uniform defines the webGL uniform location where to store the value
  115654. * @param x defines the 1st component of the value
  115655. * @param y defines the 2nd component of the value
  115656. * @param z defines the 3rd component of the value
  115657. * @param w defines the 4th component of the value
  115658. */
  115659. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  115660. /**
  115661. * Apply all cached states (depth, culling, stencil and alpha)
  115662. */
  115663. applyStates(): void;
  115664. /**
  115665. * Enable or disable color writing
  115666. * @param enable defines the state to set
  115667. */
  115668. setColorWrite(enable: boolean): void;
  115669. /**
  115670. * Gets a boolean indicating if color writing is enabled
  115671. * @returns the current color writing state
  115672. */
  115673. getColorWrite(): boolean;
  115674. /**
  115675. * Gets the depth culling state manager
  115676. */
  115677. get depthCullingState(): DepthCullingState;
  115678. /**
  115679. * Gets the alpha state manager
  115680. */
  115681. get alphaState(): AlphaState;
  115682. /**
  115683. * Gets the stencil state manager
  115684. */
  115685. get stencilState(): StencilState;
  115686. /**
  115687. * Clears the list of texture accessible through engine.
  115688. * This can help preventing texture load conflict due to name collision.
  115689. */
  115690. clearInternalTexturesCache(): void;
  115691. /**
  115692. * Force the entire cache to be cleared
  115693. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  115694. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  115695. */
  115696. wipeCaches(bruteForce?: boolean): void;
  115697. /** @hidden */
  115698. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  115699. min: number;
  115700. mag: number;
  115701. };
  115702. /** @hidden */
  115703. _createTexture(): WebGLTexture;
  115704. /**
  115705. * Usually called from Texture.ts.
  115706. * Passed information to create a WebGLTexture
  115707. * @param url defines a value which contains one of the following:
  115708. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  115709. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  115710. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  115711. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  115712. * @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)
  115713. * @param scene needed for loading to the correct scene
  115714. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  115715. * @param onLoad optional callback to be called upon successful completion
  115716. * @param onError optional callback to be called upon failure
  115717. * @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
  115718. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  115719. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  115720. * @param forcedExtension defines the extension to use to pick the right loader
  115721. * @param mimeType defines an optional mime type
  115722. * @returns a InternalTexture for assignment back into BABYLON.Texture
  115723. */
  115724. 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;
  115725. /**
  115726. * Loads an image as an HTMLImageElement.
  115727. * @param input url string, ArrayBuffer, or Blob to load
  115728. * @param onLoad callback called when the image successfully loads
  115729. * @param onError callback called when the image fails to load
  115730. * @param offlineProvider offline provider for caching
  115731. * @param mimeType optional mime type
  115732. * @returns the HTMLImageElement of the loaded image
  115733. * @hidden
  115734. */
  115735. 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>;
  115736. /**
  115737. * @hidden
  115738. */
  115739. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  115740. private _unpackFlipYCached;
  115741. /**
  115742. * In case you are sharing the context with other applications, it might
  115743. * be interested to not cache the unpack flip y state to ensure a consistent
  115744. * value would be set.
  115745. */
  115746. enableUnpackFlipYCached: boolean;
  115747. /** @hidden */
  115748. _unpackFlipY(value: boolean): void;
  115749. /** @hidden */
  115750. _getUnpackAlignement(): number;
  115751. private _getTextureTarget;
  115752. /**
  115753. * Update the sampling mode of a given texture
  115754. * @param samplingMode defines the required sampling mode
  115755. * @param texture defines the texture to update
  115756. * @param generateMipMaps defines whether to generate mipmaps for the texture
  115757. */
  115758. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  115759. /**
  115760. * Update the sampling mode of a given texture
  115761. * @param texture defines the texture to update
  115762. * @param wrapU defines the texture wrap mode of the u coordinates
  115763. * @param wrapV defines the texture wrap mode of the v coordinates
  115764. * @param wrapR defines the texture wrap mode of the r coordinates
  115765. */
  115766. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  115767. /** @hidden */
  115768. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  115769. width: number;
  115770. height: number;
  115771. layers?: number;
  115772. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  115773. /** @hidden */
  115774. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115775. /** @hidden */
  115776. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  115777. /**
  115778. * Update a portion of an internal texture
  115779. * @param texture defines the texture to update
  115780. * @param imageData defines the data to store into the texture
  115781. * @param xOffset defines the x coordinates of the update rectangle
  115782. * @param yOffset defines the y coordinates of the update rectangle
  115783. * @param width defines the width of the update rectangle
  115784. * @param height defines the height of the update rectangle
  115785. * @param faceIndex defines the face index if texture is a cube (0 by default)
  115786. * @param lod defines the lod level to update (0 by default)
  115787. */
  115788. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  115789. /** @hidden */
  115790. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115791. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  115792. private _prepareWebGLTexture;
  115793. /** @hidden */
  115794. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  115795. private _getDepthStencilBuffer;
  115796. /** @hidden */
  115797. _releaseFramebufferObjects(texture: InternalTexture): void;
  115798. /** @hidden */
  115799. _releaseTexture(texture: InternalTexture): void;
  115800. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  115801. protected _setProgram(program: WebGLProgram): void;
  115802. protected _boundUniforms: {
  115803. [key: number]: WebGLUniformLocation;
  115804. };
  115805. /**
  115806. * Binds an effect to the webGL context
  115807. * @param effect defines the effect to bind
  115808. */
  115809. bindSamplers(effect: Effect): void;
  115810. private _activateCurrentTexture;
  115811. /** @hidden */
  115812. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  115813. /** @hidden */
  115814. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  115815. /**
  115816. * Unbind all textures from the webGL context
  115817. */
  115818. unbindAllTextures(): void;
  115819. /**
  115820. * Sets a texture to the according uniform.
  115821. * @param channel The texture channel
  115822. * @param uniform The uniform to set
  115823. * @param texture The texture to apply
  115824. */
  115825. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  115826. private _bindSamplerUniformToChannel;
  115827. private _getTextureWrapMode;
  115828. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  115829. /**
  115830. * Sets an array of texture to the webGL context
  115831. * @param channel defines the channel where the texture array must be set
  115832. * @param uniform defines the associated uniform location
  115833. * @param textures defines the array of textures to bind
  115834. */
  115835. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  115836. /** @hidden */
  115837. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  115838. private _setTextureParameterFloat;
  115839. private _setTextureParameterInteger;
  115840. /**
  115841. * Unbind all vertex attributes from the webGL context
  115842. */
  115843. unbindAllAttributes(): void;
  115844. /**
  115845. * 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
  115846. */
  115847. releaseEffects(): void;
  115848. /**
  115849. * Dispose and release all associated resources
  115850. */
  115851. dispose(): void;
  115852. /**
  115853. * Attach a new callback raised when context lost event is fired
  115854. * @param callback defines the callback to call
  115855. */
  115856. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115857. /**
  115858. * Attach a new callback raised when context restored event is fired
  115859. * @param callback defines the callback to call
  115860. */
  115861. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115862. /**
  115863. * Get the current error code of the webGL context
  115864. * @returns the error code
  115865. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  115866. */
  115867. getError(): number;
  115868. private _canRenderToFloatFramebuffer;
  115869. private _canRenderToHalfFloatFramebuffer;
  115870. private _canRenderToFramebuffer;
  115871. /** @hidden */
  115872. _getWebGLTextureType(type: number): number;
  115873. /** @hidden */
  115874. _getInternalFormat(format: number): number;
  115875. /** @hidden */
  115876. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  115877. /** @hidden */
  115878. _getRGBAMultiSampleBufferFormat(type: number): number;
  115879. /** @hidden */
  115880. _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;
  115881. /**
  115882. * Loads a file from a url
  115883. * @param url url to load
  115884. * @param onSuccess callback called when the file successfully loads
  115885. * @param onProgress callback called while file is loading (if the server supports this mode)
  115886. * @param offlineProvider defines the offline provider for caching
  115887. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  115888. * @param onError callback called when the file fails to load
  115889. * @returns a file request object
  115890. * @hidden
  115891. */
  115892. 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;
  115893. /**
  115894. * Reads pixels from the current frame buffer. Please note that this function can be slow
  115895. * @param x defines the x coordinate of the rectangle where pixels must be read
  115896. * @param y defines the y coordinate of the rectangle where pixels must be read
  115897. * @param width defines the width of the rectangle where pixels must be read
  115898. * @param height defines the height of the rectangle where pixels must be read
  115899. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  115900. * @returns a Uint8Array containing RGBA colors
  115901. */
  115902. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  115903. private static _isSupported;
  115904. /**
  115905. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  115906. * @returns true if the engine can be created
  115907. * @ignorenaming
  115908. */
  115909. static isSupported(): boolean;
  115910. /**
  115911. * Find the next highest power of two.
  115912. * @param x Number to start search from.
  115913. * @return Next highest power of two.
  115914. */
  115915. static CeilingPOT(x: number): number;
  115916. /**
  115917. * Find the next lowest power of two.
  115918. * @param x Number to start search from.
  115919. * @return Next lowest power of two.
  115920. */
  115921. static FloorPOT(x: number): number;
  115922. /**
  115923. * Find the nearest power of two.
  115924. * @param x Number to start search from.
  115925. * @return Next nearest power of two.
  115926. */
  115927. static NearestPOT(x: number): number;
  115928. /**
  115929. * Get the closest exponent of two
  115930. * @param value defines the value to approximate
  115931. * @param max defines the maximum value to return
  115932. * @param mode defines how to define the closest value
  115933. * @returns closest exponent of two of the given value
  115934. */
  115935. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  115936. /**
  115937. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  115938. * @param func - the function to be called
  115939. * @param requester - the object that will request the next frame. Falls back to window.
  115940. * @returns frame number
  115941. */
  115942. static QueueNewFrame(func: () => void, requester?: any): number;
  115943. /**
  115944. * Gets host document
  115945. * @returns the host document object
  115946. */
  115947. getHostDocument(): Nullable<Document>;
  115948. }
  115949. }
  115950. declare module BABYLON {
  115951. /**
  115952. * Class representing spherical harmonics coefficients to the 3rd degree
  115953. */
  115954. export class SphericalHarmonics {
  115955. /**
  115956. * Defines whether or not the harmonics have been prescaled for rendering.
  115957. */
  115958. preScaled: boolean;
  115959. /**
  115960. * The l0,0 coefficients of the spherical harmonics
  115961. */
  115962. l00: Vector3;
  115963. /**
  115964. * The l1,-1 coefficients of the spherical harmonics
  115965. */
  115966. l1_1: Vector3;
  115967. /**
  115968. * The l1,0 coefficients of the spherical harmonics
  115969. */
  115970. l10: Vector3;
  115971. /**
  115972. * The l1,1 coefficients of the spherical harmonics
  115973. */
  115974. l11: Vector3;
  115975. /**
  115976. * The l2,-2 coefficients of the spherical harmonics
  115977. */
  115978. l2_2: Vector3;
  115979. /**
  115980. * The l2,-1 coefficients of the spherical harmonics
  115981. */
  115982. l2_1: Vector3;
  115983. /**
  115984. * The l2,0 coefficients of the spherical harmonics
  115985. */
  115986. l20: Vector3;
  115987. /**
  115988. * The l2,1 coefficients of the spherical harmonics
  115989. */
  115990. l21: Vector3;
  115991. /**
  115992. * The l2,2 coefficients of the spherical harmonics
  115993. */
  115994. l22: Vector3;
  115995. /**
  115996. * Adds a light to the spherical harmonics
  115997. * @param direction the direction of the light
  115998. * @param color the color of the light
  115999. * @param deltaSolidAngle the delta solid angle of the light
  116000. */
  116001. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  116002. /**
  116003. * Scales the spherical harmonics by the given amount
  116004. * @param scale the amount to scale
  116005. */
  116006. scaleInPlace(scale: number): void;
  116007. /**
  116008. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  116009. *
  116010. * ```
  116011. * E_lm = A_l * L_lm
  116012. * ```
  116013. *
  116014. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  116015. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  116016. * the scaling factors are given in equation 9.
  116017. */
  116018. convertIncidentRadianceToIrradiance(): void;
  116019. /**
  116020. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  116021. *
  116022. * ```
  116023. * L = (1/pi) * E * rho
  116024. * ```
  116025. *
  116026. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  116027. */
  116028. convertIrradianceToLambertianRadiance(): void;
  116029. /**
  116030. * Integrates the reconstruction coefficients directly in to the SH preventing further
  116031. * required operations at run time.
  116032. *
  116033. * This is simply done by scaling back the SH with Ylm constants parameter.
  116034. * The trigonometric part being applied by the shader at run time.
  116035. */
  116036. preScaleForRendering(): void;
  116037. /**
  116038. * Constructs a spherical harmonics from an array.
  116039. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  116040. * @returns the spherical harmonics
  116041. */
  116042. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  116043. /**
  116044. * Gets the spherical harmonics from polynomial
  116045. * @param polynomial the spherical polynomial
  116046. * @returns the spherical harmonics
  116047. */
  116048. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  116049. }
  116050. /**
  116051. * Class representing spherical polynomial coefficients to the 3rd degree
  116052. */
  116053. export class SphericalPolynomial {
  116054. private _harmonics;
  116055. /**
  116056. * The spherical harmonics used to create the polynomials.
  116057. */
  116058. get preScaledHarmonics(): SphericalHarmonics;
  116059. /**
  116060. * The x coefficients of the spherical polynomial
  116061. */
  116062. x: Vector3;
  116063. /**
  116064. * The y coefficients of the spherical polynomial
  116065. */
  116066. y: Vector3;
  116067. /**
  116068. * The z coefficients of the spherical polynomial
  116069. */
  116070. z: Vector3;
  116071. /**
  116072. * The xx coefficients of the spherical polynomial
  116073. */
  116074. xx: Vector3;
  116075. /**
  116076. * The yy coefficients of the spherical polynomial
  116077. */
  116078. yy: Vector3;
  116079. /**
  116080. * The zz coefficients of the spherical polynomial
  116081. */
  116082. zz: Vector3;
  116083. /**
  116084. * The xy coefficients of the spherical polynomial
  116085. */
  116086. xy: Vector3;
  116087. /**
  116088. * The yz coefficients of the spherical polynomial
  116089. */
  116090. yz: Vector3;
  116091. /**
  116092. * The zx coefficients of the spherical polynomial
  116093. */
  116094. zx: Vector3;
  116095. /**
  116096. * Adds an ambient color to the spherical polynomial
  116097. * @param color the color to add
  116098. */
  116099. addAmbient(color: Color3): void;
  116100. /**
  116101. * Scales the spherical polynomial by the given amount
  116102. * @param scale the amount to scale
  116103. */
  116104. scaleInPlace(scale: number): void;
  116105. /**
  116106. * Gets the spherical polynomial from harmonics
  116107. * @param harmonics the spherical harmonics
  116108. * @returns the spherical polynomial
  116109. */
  116110. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  116111. /**
  116112. * Constructs a spherical polynomial from an array.
  116113. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  116114. * @returns the spherical polynomial
  116115. */
  116116. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  116117. }
  116118. }
  116119. declare module BABYLON {
  116120. /**
  116121. * Defines the source of the internal texture
  116122. */
  116123. export enum InternalTextureSource {
  116124. /**
  116125. * The source of the texture data is unknown
  116126. */
  116127. Unknown = 0,
  116128. /**
  116129. * Texture data comes from an URL
  116130. */
  116131. Url = 1,
  116132. /**
  116133. * Texture data is only used for temporary storage
  116134. */
  116135. Temp = 2,
  116136. /**
  116137. * Texture data comes from raw data (ArrayBuffer)
  116138. */
  116139. Raw = 3,
  116140. /**
  116141. * Texture content is dynamic (video or dynamic texture)
  116142. */
  116143. Dynamic = 4,
  116144. /**
  116145. * Texture content is generated by rendering to it
  116146. */
  116147. RenderTarget = 5,
  116148. /**
  116149. * Texture content is part of a multi render target process
  116150. */
  116151. MultiRenderTarget = 6,
  116152. /**
  116153. * Texture data comes from a cube data file
  116154. */
  116155. Cube = 7,
  116156. /**
  116157. * Texture data comes from a raw cube data
  116158. */
  116159. CubeRaw = 8,
  116160. /**
  116161. * Texture data come from a prefiltered cube data file
  116162. */
  116163. CubePrefiltered = 9,
  116164. /**
  116165. * Texture content is raw 3D data
  116166. */
  116167. Raw3D = 10,
  116168. /**
  116169. * Texture content is raw 2D array data
  116170. */
  116171. Raw2DArray = 11,
  116172. /**
  116173. * Texture content is a depth texture
  116174. */
  116175. Depth = 12,
  116176. /**
  116177. * Texture data comes from a raw cube data encoded with RGBD
  116178. */
  116179. CubeRawRGBD = 13
  116180. }
  116181. /**
  116182. * Class used to store data associated with WebGL texture data for the engine
  116183. * This class should not be used directly
  116184. */
  116185. export class InternalTexture {
  116186. /** @hidden */
  116187. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  116188. /**
  116189. * Defines if the texture is ready
  116190. */
  116191. isReady: boolean;
  116192. /**
  116193. * Defines if the texture is a cube texture
  116194. */
  116195. isCube: boolean;
  116196. /**
  116197. * Defines if the texture contains 3D data
  116198. */
  116199. is3D: boolean;
  116200. /**
  116201. * Defines if the texture contains 2D array data
  116202. */
  116203. is2DArray: boolean;
  116204. /**
  116205. * Defines if the texture contains multiview data
  116206. */
  116207. isMultiview: boolean;
  116208. /**
  116209. * Gets the URL used to load this texture
  116210. */
  116211. url: string;
  116212. /**
  116213. * Gets the sampling mode of the texture
  116214. */
  116215. samplingMode: number;
  116216. /**
  116217. * Gets a boolean indicating if the texture needs mipmaps generation
  116218. */
  116219. generateMipMaps: boolean;
  116220. /**
  116221. * Gets the number of samples used by the texture (WebGL2+ only)
  116222. */
  116223. samples: number;
  116224. /**
  116225. * Gets the type of the texture (int, float...)
  116226. */
  116227. type: number;
  116228. /**
  116229. * Gets the format of the texture (RGB, RGBA...)
  116230. */
  116231. format: number;
  116232. /**
  116233. * Observable called when the texture is loaded
  116234. */
  116235. onLoadedObservable: Observable<InternalTexture>;
  116236. /**
  116237. * Gets the width of the texture
  116238. */
  116239. width: number;
  116240. /**
  116241. * Gets the height of the texture
  116242. */
  116243. height: number;
  116244. /**
  116245. * Gets the depth of the texture
  116246. */
  116247. depth: number;
  116248. /**
  116249. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  116250. */
  116251. baseWidth: number;
  116252. /**
  116253. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  116254. */
  116255. baseHeight: number;
  116256. /**
  116257. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  116258. */
  116259. baseDepth: number;
  116260. /**
  116261. * Gets a boolean indicating if the texture is inverted on Y axis
  116262. */
  116263. invertY: boolean;
  116264. /** @hidden */
  116265. _invertVScale: boolean;
  116266. /** @hidden */
  116267. _associatedChannel: number;
  116268. /** @hidden */
  116269. _source: InternalTextureSource;
  116270. /** @hidden */
  116271. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  116272. /** @hidden */
  116273. _bufferView: Nullable<ArrayBufferView>;
  116274. /** @hidden */
  116275. _bufferViewArray: Nullable<ArrayBufferView[]>;
  116276. /** @hidden */
  116277. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  116278. /** @hidden */
  116279. _size: number;
  116280. /** @hidden */
  116281. _extension: string;
  116282. /** @hidden */
  116283. _files: Nullable<string[]>;
  116284. /** @hidden */
  116285. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  116286. /** @hidden */
  116287. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  116288. /** @hidden */
  116289. _framebuffer: Nullable<WebGLFramebuffer>;
  116290. /** @hidden */
  116291. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  116292. /** @hidden */
  116293. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  116294. /** @hidden */
  116295. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  116296. /** @hidden */
  116297. _attachments: Nullable<number[]>;
  116298. /** @hidden */
  116299. _textureArray: Nullable<InternalTexture[]>;
  116300. /** @hidden */
  116301. _cachedCoordinatesMode: Nullable<number>;
  116302. /** @hidden */
  116303. _cachedWrapU: Nullable<number>;
  116304. /** @hidden */
  116305. _cachedWrapV: Nullable<number>;
  116306. /** @hidden */
  116307. _cachedWrapR: Nullable<number>;
  116308. /** @hidden */
  116309. _cachedAnisotropicFilteringLevel: Nullable<number>;
  116310. /** @hidden */
  116311. _isDisabled: boolean;
  116312. /** @hidden */
  116313. _compression: Nullable<string>;
  116314. /** @hidden */
  116315. _generateStencilBuffer: boolean;
  116316. /** @hidden */
  116317. _generateDepthBuffer: boolean;
  116318. /** @hidden */
  116319. _comparisonFunction: number;
  116320. /** @hidden */
  116321. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  116322. /** @hidden */
  116323. _lodGenerationScale: number;
  116324. /** @hidden */
  116325. _lodGenerationOffset: number;
  116326. /** @hidden */
  116327. _depthStencilTexture: Nullable<InternalTexture>;
  116328. /** @hidden */
  116329. _colorTextureArray: Nullable<WebGLTexture>;
  116330. /** @hidden */
  116331. _depthStencilTextureArray: Nullable<WebGLTexture>;
  116332. /** @hidden */
  116333. _lodTextureHigh: Nullable<BaseTexture>;
  116334. /** @hidden */
  116335. _lodTextureMid: Nullable<BaseTexture>;
  116336. /** @hidden */
  116337. _lodTextureLow: Nullable<BaseTexture>;
  116338. /** @hidden */
  116339. _isRGBD: boolean;
  116340. /** @hidden */
  116341. _linearSpecularLOD: boolean;
  116342. /** @hidden */
  116343. _irradianceTexture: Nullable<BaseTexture>;
  116344. /** @hidden */
  116345. _webGLTexture: Nullable<WebGLTexture>;
  116346. /** @hidden */
  116347. _references: number;
  116348. private _engine;
  116349. /**
  116350. * Gets the Engine the texture belongs to.
  116351. * @returns The babylon engine
  116352. */
  116353. getEngine(): ThinEngine;
  116354. /**
  116355. * Gets the data source type of the texture
  116356. */
  116357. get source(): InternalTextureSource;
  116358. /**
  116359. * Creates a new InternalTexture
  116360. * @param engine defines the engine to use
  116361. * @param source defines the type of data that will be used
  116362. * @param delayAllocation if the texture allocation should be delayed (default: false)
  116363. */
  116364. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  116365. /**
  116366. * Increments the number of references (ie. the number of Texture that point to it)
  116367. */
  116368. incrementReferences(): void;
  116369. /**
  116370. * Change the size of the texture (not the size of the content)
  116371. * @param width defines the new width
  116372. * @param height defines the new height
  116373. * @param depth defines the new depth (1 by default)
  116374. */
  116375. updateSize(width: int, height: int, depth?: int): void;
  116376. /** @hidden */
  116377. _rebuild(): void;
  116378. /** @hidden */
  116379. _swapAndDie(target: InternalTexture): void;
  116380. /**
  116381. * Dispose the current allocated resources
  116382. */
  116383. dispose(): void;
  116384. }
  116385. }
  116386. declare module BABYLON {
  116387. /**
  116388. * Class used to work with sound analyzer using fast fourier transform (FFT)
  116389. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116390. */
  116391. export class Analyser {
  116392. /**
  116393. * Gets or sets the smoothing
  116394. * @ignorenaming
  116395. */
  116396. SMOOTHING: number;
  116397. /**
  116398. * Gets or sets the FFT table size
  116399. * @ignorenaming
  116400. */
  116401. FFT_SIZE: number;
  116402. /**
  116403. * Gets or sets the bar graph amplitude
  116404. * @ignorenaming
  116405. */
  116406. BARGRAPHAMPLITUDE: number;
  116407. /**
  116408. * Gets or sets the position of the debug canvas
  116409. * @ignorenaming
  116410. */
  116411. DEBUGCANVASPOS: {
  116412. x: number;
  116413. y: number;
  116414. };
  116415. /**
  116416. * Gets or sets the debug canvas size
  116417. * @ignorenaming
  116418. */
  116419. DEBUGCANVASSIZE: {
  116420. width: number;
  116421. height: number;
  116422. };
  116423. private _byteFreqs;
  116424. private _byteTime;
  116425. private _floatFreqs;
  116426. private _webAudioAnalyser;
  116427. private _debugCanvas;
  116428. private _debugCanvasContext;
  116429. private _scene;
  116430. private _registerFunc;
  116431. private _audioEngine;
  116432. /**
  116433. * Creates a new analyser
  116434. * @param scene defines hosting scene
  116435. */
  116436. constructor(scene: Scene);
  116437. /**
  116438. * Get the number of data values you will have to play with for the visualization
  116439. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  116440. * @returns a number
  116441. */
  116442. getFrequencyBinCount(): number;
  116443. /**
  116444. * Gets the current frequency data as a byte array
  116445. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116446. * @returns a Uint8Array
  116447. */
  116448. getByteFrequencyData(): Uint8Array;
  116449. /**
  116450. * Gets the current waveform as a byte array
  116451. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  116452. * @returns a Uint8Array
  116453. */
  116454. getByteTimeDomainData(): Uint8Array;
  116455. /**
  116456. * Gets the current frequency data as a float array
  116457. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116458. * @returns a Float32Array
  116459. */
  116460. getFloatFrequencyData(): Float32Array;
  116461. /**
  116462. * Renders the debug canvas
  116463. */
  116464. drawDebugCanvas(): void;
  116465. /**
  116466. * Stops rendering the debug canvas and removes it
  116467. */
  116468. stopDebugCanvas(): void;
  116469. /**
  116470. * Connects two audio nodes
  116471. * @param inputAudioNode defines first node to connect
  116472. * @param outputAudioNode defines second node to connect
  116473. */
  116474. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  116475. /**
  116476. * Releases all associated resources
  116477. */
  116478. dispose(): void;
  116479. }
  116480. }
  116481. declare module BABYLON {
  116482. /**
  116483. * This represents an audio engine and it is responsible
  116484. * to play, synchronize and analyse sounds throughout the application.
  116485. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116486. */
  116487. export interface IAudioEngine extends IDisposable {
  116488. /**
  116489. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116490. */
  116491. readonly canUseWebAudio: boolean;
  116492. /**
  116493. * Gets the current AudioContext if available.
  116494. */
  116495. readonly audioContext: Nullable<AudioContext>;
  116496. /**
  116497. * The master gain node defines the global audio volume of your audio engine.
  116498. */
  116499. readonly masterGain: GainNode;
  116500. /**
  116501. * Gets whether or not mp3 are supported by your browser.
  116502. */
  116503. readonly isMP3supported: boolean;
  116504. /**
  116505. * Gets whether or not ogg are supported by your browser.
  116506. */
  116507. readonly isOGGsupported: boolean;
  116508. /**
  116509. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116510. * @ignoreNaming
  116511. */
  116512. WarnedWebAudioUnsupported: boolean;
  116513. /**
  116514. * Defines if the audio engine relies on a custom unlocked button.
  116515. * In this case, the embedded button will not be displayed.
  116516. */
  116517. useCustomUnlockedButton: boolean;
  116518. /**
  116519. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  116520. */
  116521. readonly unlocked: boolean;
  116522. /**
  116523. * Event raised when audio has been unlocked on the browser.
  116524. */
  116525. onAudioUnlockedObservable: Observable<AudioEngine>;
  116526. /**
  116527. * Event raised when audio has been locked on the browser.
  116528. */
  116529. onAudioLockedObservable: Observable<AudioEngine>;
  116530. /**
  116531. * Flags the audio engine in Locked state.
  116532. * This happens due to new browser policies preventing audio to autoplay.
  116533. */
  116534. lock(): void;
  116535. /**
  116536. * Unlocks the audio engine once a user action has been done on the dom.
  116537. * This is helpful to resume play once browser policies have been satisfied.
  116538. */
  116539. unlock(): void;
  116540. /**
  116541. * Gets the global volume sets on the master gain.
  116542. * @returns the global volume if set or -1 otherwise
  116543. */
  116544. getGlobalVolume(): number;
  116545. /**
  116546. * Sets the global volume of your experience (sets on the master gain).
  116547. * @param newVolume Defines the new global volume of the application
  116548. */
  116549. setGlobalVolume(newVolume: number): void;
  116550. /**
  116551. * Connect the audio engine to an audio analyser allowing some amazing
  116552. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116553. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116554. * @param analyser The analyser to connect to the engine
  116555. */
  116556. connectToAnalyser(analyser: Analyser): void;
  116557. }
  116558. /**
  116559. * This represents the default audio engine used in babylon.
  116560. * It is responsible to play, synchronize and analyse sounds throughout the application.
  116561. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116562. */
  116563. export class AudioEngine implements IAudioEngine {
  116564. private _audioContext;
  116565. private _audioContextInitialized;
  116566. private _muteButton;
  116567. private _hostElement;
  116568. /**
  116569. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116570. */
  116571. canUseWebAudio: boolean;
  116572. /**
  116573. * The master gain node defines the global audio volume of your audio engine.
  116574. */
  116575. masterGain: GainNode;
  116576. /**
  116577. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116578. * @ignoreNaming
  116579. */
  116580. WarnedWebAudioUnsupported: boolean;
  116581. /**
  116582. * Gets whether or not mp3 are supported by your browser.
  116583. */
  116584. isMP3supported: boolean;
  116585. /**
  116586. * Gets whether or not ogg are supported by your browser.
  116587. */
  116588. isOGGsupported: boolean;
  116589. /**
  116590. * Gets whether audio has been unlocked on the device.
  116591. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  116592. * a user interaction has happened.
  116593. */
  116594. unlocked: boolean;
  116595. /**
  116596. * Defines if the audio engine relies on a custom unlocked button.
  116597. * In this case, the embedded button will not be displayed.
  116598. */
  116599. useCustomUnlockedButton: boolean;
  116600. /**
  116601. * Event raised when audio has been unlocked on the browser.
  116602. */
  116603. onAudioUnlockedObservable: Observable<AudioEngine>;
  116604. /**
  116605. * Event raised when audio has been locked on the browser.
  116606. */
  116607. onAudioLockedObservable: Observable<AudioEngine>;
  116608. /**
  116609. * Gets the current AudioContext if available.
  116610. */
  116611. get audioContext(): Nullable<AudioContext>;
  116612. private _connectedAnalyser;
  116613. /**
  116614. * Instantiates a new audio engine.
  116615. *
  116616. * There should be only one per page as some browsers restrict the number
  116617. * of audio contexts you can create.
  116618. * @param hostElement defines the host element where to display the mute icon if necessary
  116619. */
  116620. constructor(hostElement?: Nullable<HTMLElement>);
  116621. /**
  116622. * Flags the audio engine in Locked state.
  116623. * This happens due to new browser policies preventing audio to autoplay.
  116624. */
  116625. lock(): void;
  116626. /**
  116627. * Unlocks the audio engine once a user action has been done on the dom.
  116628. * This is helpful to resume play once browser policies have been satisfied.
  116629. */
  116630. unlock(): void;
  116631. private _resumeAudioContext;
  116632. private _initializeAudioContext;
  116633. private _tryToRun;
  116634. private _triggerRunningState;
  116635. private _triggerSuspendedState;
  116636. private _displayMuteButton;
  116637. private _moveButtonToTopLeft;
  116638. private _onResize;
  116639. private _hideMuteButton;
  116640. /**
  116641. * Destroy and release the resources associated with the audio ccontext.
  116642. */
  116643. dispose(): void;
  116644. /**
  116645. * Gets the global volume sets on the master gain.
  116646. * @returns the global volume if set or -1 otherwise
  116647. */
  116648. getGlobalVolume(): number;
  116649. /**
  116650. * Sets the global volume of your experience (sets on the master gain).
  116651. * @param newVolume Defines the new global volume of the application
  116652. */
  116653. setGlobalVolume(newVolume: number): void;
  116654. /**
  116655. * Connect the audio engine to an audio analyser allowing some amazing
  116656. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116657. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116658. * @param analyser The analyser to connect to the engine
  116659. */
  116660. connectToAnalyser(analyser: Analyser): void;
  116661. }
  116662. }
  116663. declare module BABYLON {
  116664. /**
  116665. * Interface used to present a loading screen while loading a scene
  116666. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116667. */
  116668. export interface ILoadingScreen {
  116669. /**
  116670. * Function called to display the loading screen
  116671. */
  116672. displayLoadingUI: () => void;
  116673. /**
  116674. * Function called to hide the loading screen
  116675. */
  116676. hideLoadingUI: () => void;
  116677. /**
  116678. * Gets or sets the color to use for the background
  116679. */
  116680. loadingUIBackgroundColor: string;
  116681. /**
  116682. * Gets or sets the text to display while loading
  116683. */
  116684. loadingUIText: string;
  116685. }
  116686. /**
  116687. * Class used for the default loading screen
  116688. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116689. */
  116690. export class DefaultLoadingScreen implements ILoadingScreen {
  116691. private _renderingCanvas;
  116692. private _loadingText;
  116693. private _loadingDivBackgroundColor;
  116694. private _loadingDiv;
  116695. private _loadingTextDiv;
  116696. /** Gets or sets the logo url to use for the default loading screen */
  116697. static DefaultLogoUrl: string;
  116698. /** Gets or sets the spinner url to use for the default loading screen */
  116699. static DefaultSpinnerUrl: string;
  116700. /**
  116701. * Creates a new default loading screen
  116702. * @param _renderingCanvas defines the canvas used to render the scene
  116703. * @param _loadingText defines the default text to display
  116704. * @param _loadingDivBackgroundColor defines the default background color
  116705. */
  116706. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  116707. /**
  116708. * Function called to display the loading screen
  116709. */
  116710. displayLoadingUI(): void;
  116711. /**
  116712. * Function called to hide the loading screen
  116713. */
  116714. hideLoadingUI(): void;
  116715. /**
  116716. * Gets or sets the text to display while loading
  116717. */
  116718. set loadingUIText(text: string);
  116719. get loadingUIText(): string;
  116720. /**
  116721. * Gets or sets the color to use for the background
  116722. */
  116723. get loadingUIBackgroundColor(): string;
  116724. set loadingUIBackgroundColor(color: string);
  116725. private _resizeLoadingUI;
  116726. }
  116727. }
  116728. declare module BABYLON {
  116729. /**
  116730. * Interface for any object that can request an animation frame
  116731. */
  116732. export interface ICustomAnimationFrameRequester {
  116733. /**
  116734. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  116735. */
  116736. renderFunction?: Function;
  116737. /**
  116738. * Called to request the next frame to render to
  116739. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  116740. */
  116741. requestAnimationFrame: Function;
  116742. /**
  116743. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  116744. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  116745. */
  116746. requestID?: number;
  116747. }
  116748. }
  116749. declare module BABYLON {
  116750. /**
  116751. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  116752. */
  116753. export class PerformanceMonitor {
  116754. private _enabled;
  116755. private _rollingFrameTime;
  116756. private _lastFrameTimeMs;
  116757. /**
  116758. * constructor
  116759. * @param frameSampleSize The number of samples required to saturate the sliding window
  116760. */
  116761. constructor(frameSampleSize?: number);
  116762. /**
  116763. * Samples current frame
  116764. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  116765. */
  116766. sampleFrame(timeMs?: number): void;
  116767. /**
  116768. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116769. */
  116770. get averageFrameTime(): number;
  116771. /**
  116772. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116773. */
  116774. get averageFrameTimeVariance(): number;
  116775. /**
  116776. * Returns the frame time of the most recent frame
  116777. */
  116778. get instantaneousFrameTime(): number;
  116779. /**
  116780. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  116781. */
  116782. get averageFPS(): number;
  116783. /**
  116784. * Returns the average framerate in frames per second using the most recent frame time
  116785. */
  116786. get instantaneousFPS(): number;
  116787. /**
  116788. * Returns true if enough samples have been taken to completely fill the sliding window
  116789. */
  116790. get isSaturated(): boolean;
  116791. /**
  116792. * Enables contributions to the sliding window sample set
  116793. */
  116794. enable(): void;
  116795. /**
  116796. * Disables contributions to the sliding window sample set
  116797. * Samples will not be interpolated over the disabled period
  116798. */
  116799. disable(): void;
  116800. /**
  116801. * Returns true if sampling is enabled
  116802. */
  116803. get isEnabled(): boolean;
  116804. /**
  116805. * Resets performance monitor
  116806. */
  116807. reset(): void;
  116808. }
  116809. /**
  116810. * RollingAverage
  116811. *
  116812. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  116813. */
  116814. export class RollingAverage {
  116815. /**
  116816. * Current average
  116817. */
  116818. average: number;
  116819. /**
  116820. * Current variance
  116821. */
  116822. variance: number;
  116823. protected _samples: Array<number>;
  116824. protected _sampleCount: number;
  116825. protected _pos: number;
  116826. protected _m2: number;
  116827. /**
  116828. * constructor
  116829. * @param length The number of samples required to saturate the sliding window
  116830. */
  116831. constructor(length: number);
  116832. /**
  116833. * Adds a sample to the sample set
  116834. * @param v The sample value
  116835. */
  116836. add(v: number): void;
  116837. /**
  116838. * Returns previously added values or null if outside of history or outside the sliding window domain
  116839. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  116840. * @return Value previously recorded with add() or null if outside of range
  116841. */
  116842. history(i: number): number;
  116843. /**
  116844. * Returns true if enough samples have been taken to completely fill the sliding window
  116845. * @return true if sample-set saturated
  116846. */
  116847. isSaturated(): boolean;
  116848. /**
  116849. * Resets the rolling average (equivalent to 0 samples taken so far)
  116850. */
  116851. reset(): void;
  116852. /**
  116853. * Wraps a value around the sample range boundaries
  116854. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  116855. * @return Wrapped position in sample range
  116856. */
  116857. protected _wrapPosition(i: number): number;
  116858. }
  116859. }
  116860. declare module BABYLON {
  116861. /**
  116862. * This class is used to track a performance counter which is number based.
  116863. * The user has access to many properties which give statistics of different nature.
  116864. *
  116865. * The implementer can track two kinds of Performance Counter: time and count.
  116866. * 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.
  116867. * 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.
  116868. */
  116869. export class PerfCounter {
  116870. /**
  116871. * Gets or sets a global boolean to turn on and off all the counters
  116872. */
  116873. static Enabled: boolean;
  116874. /**
  116875. * Returns the smallest value ever
  116876. */
  116877. get min(): number;
  116878. /**
  116879. * Returns the biggest value ever
  116880. */
  116881. get max(): number;
  116882. /**
  116883. * Returns the average value since the performance counter is running
  116884. */
  116885. get average(): number;
  116886. /**
  116887. * Returns the average value of the last second the counter was monitored
  116888. */
  116889. get lastSecAverage(): number;
  116890. /**
  116891. * Returns the current value
  116892. */
  116893. get current(): number;
  116894. /**
  116895. * Gets the accumulated total
  116896. */
  116897. get total(): number;
  116898. /**
  116899. * Gets the total value count
  116900. */
  116901. get count(): number;
  116902. /**
  116903. * Creates a new counter
  116904. */
  116905. constructor();
  116906. /**
  116907. * Call this method to start monitoring a new frame.
  116908. * 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.
  116909. */
  116910. fetchNewFrame(): void;
  116911. /**
  116912. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  116913. * @param newCount the count value to add to the monitored count
  116914. * @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.
  116915. */
  116916. addCount(newCount: number, fetchResult: boolean): void;
  116917. /**
  116918. * Start monitoring this performance counter
  116919. */
  116920. beginMonitoring(): void;
  116921. /**
  116922. * Compute the time lapsed since the previous beginMonitoring() call.
  116923. * @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
  116924. */
  116925. endMonitoring(newFrame?: boolean): void;
  116926. private _fetchResult;
  116927. private _startMonitoringTime;
  116928. private _min;
  116929. private _max;
  116930. private _average;
  116931. private _current;
  116932. private _totalValueCount;
  116933. private _totalAccumulated;
  116934. private _lastSecAverage;
  116935. private _lastSecAccumulated;
  116936. private _lastSecTime;
  116937. private _lastSecValueCount;
  116938. }
  116939. }
  116940. declare module BABYLON {
  116941. interface ThinEngine {
  116942. /** @hidden */
  116943. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  116944. }
  116945. }
  116946. declare module BABYLON {
  116947. /**
  116948. * Defines the interface used by display changed events
  116949. */
  116950. export interface IDisplayChangedEventArgs {
  116951. /** Gets the vrDisplay object (if any) */
  116952. vrDisplay: Nullable<any>;
  116953. /** Gets a boolean indicating if webVR is supported */
  116954. vrSupported: boolean;
  116955. }
  116956. /**
  116957. * Defines the interface used by objects containing a viewport (like a camera)
  116958. */
  116959. interface IViewportOwnerLike {
  116960. /**
  116961. * Gets or sets the viewport
  116962. */
  116963. viewport: IViewportLike;
  116964. }
  116965. /**
  116966. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  116967. */
  116968. export class Engine extends ThinEngine {
  116969. /** Defines that alpha blending is disabled */
  116970. static readonly ALPHA_DISABLE: number;
  116971. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  116972. static readonly ALPHA_ADD: number;
  116973. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  116974. static readonly ALPHA_COMBINE: number;
  116975. /** Defines that alpha blending to DEST - SRC * DEST */
  116976. static readonly ALPHA_SUBTRACT: number;
  116977. /** Defines that alpha blending to SRC * DEST */
  116978. static readonly ALPHA_MULTIPLY: number;
  116979. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  116980. static readonly ALPHA_MAXIMIZED: number;
  116981. /** Defines that alpha blending to SRC + DEST */
  116982. static readonly ALPHA_ONEONE: number;
  116983. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  116984. static readonly ALPHA_PREMULTIPLIED: number;
  116985. /**
  116986. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  116987. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  116988. */
  116989. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  116990. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  116991. static readonly ALPHA_INTERPOLATE: number;
  116992. /**
  116993. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  116994. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  116995. */
  116996. static readonly ALPHA_SCREENMODE: number;
  116997. /** Defines that the ressource is not delayed*/
  116998. static readonly DELAYLOADSTATE_NONE: number;
  116999. /** Defines that the ressource was successfully delay loaded */
  117000. static readonly DELAYLOADSTATE_LOADED: number;
  117001. /** Defines that the ressource is currently delay loading */
  117002. static readonly DELAYLOADSTATE_LOADING: number;
  117003. /** Defines that the ressource is delayed and has not started loading */
  117004. static readonly DELAYLOADSTATE_NOTLOADED: number;
  117005. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  117006. static readonly NEVER: number;
  117007. /** 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 */
  117008. static readonly ALWAYS: number;
  117009. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  117010. static readonly LESS: number;
  117011. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  117012. static readonly EQUAL: number;
  117013. /** 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 */
  117014. static readonly LEQUAL: number;
  117015. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  117016. static readonly GREATER: number;
  117017. /** 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 */
  117018. static readonly GEQUAL: number;
  117019. /** 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 */
  117020. static readonly NOTEQUAL: number;
  117021. /** Passed to stencilOperation to specify that stencil value must be kept */
  117022. static readonly KEEP: number;
  117023. /** Passed to stencilOperation to specify that stencil value must be replaced */
  117024. static readonly REPLACE: number;
  117025. /** Passed to stencilOperation to specify that stencil value must be incremented */
  117026. static readonly INCR: number;
  117027. /** Passed to stencilOperation to specify that stencil value must be decremented */
  117028. static readonly DECR: number;
  117029. /** Passed to stencilOperation to specify that stencil value must be inverted */
  117030. static readonly INVERT: number;
  117031. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  117032. static readonly INCR_WRAP: number;
  117033. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  117034. static readonly DECR_WRAP: number;
  117035. /** Texture is not repeating outside of 0..1 UVs */
  117036. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  117037. /** Texture is repeating outside of 0..1 UVs */
  117038. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  117039. /** Texture is repeating and mirrored */
  117040. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  117041. /** ALPHA */
  117042. static readonly TEXTUREFORMAT_ALPHA: number;
  117043. /** LUMINANCE */
  117044. static readonly TEXTUREFORMAT_LUMINANCE: number;
  117045. /** LUMINANCE_ALPHA */
  117046. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  117047. /** RGB */
  117048. static readonly TEXTUREFORMAT_RGB: number;
  117049. /** RGBA */
  117050. static readonly TEXTUREFORMAT_RGBA: number;
  117051. /** RED */
  117052. static readonly TEXTUREFORMAT_RED: number;
  117053. /** RED (2nd reference) */
  117054. static readonly TEXTUREFORMAT_R: number;
  117055. /** RG */
  117056. static readonly TEXTUREFORMAT_RG: number;
  117057. /** RED_INTEGER */
  117058. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  117059. /** RED_INTEGER (2nd reference) */
  117060. static readonly TEXTUREFORMAT_R_INTEGER: number;
  117061. /** RG_INTEGER */
  117062. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  117063. /** RGB_INTEGER */
  117064. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  117065. /** RGBA_INTEGER */
  117066. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  117067. /** UNSIGNED_BYTE */
  117068. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  117069. /** UNSIGNED_BYTE (2nd reference) */
  117070. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  117071. /** FLOAT */
  117072. static readonly TEXTURETYPE_FLOAT: number;
  117073. /** HALF_FLOAT */
  117074. static readonly TEXTURETYPE_HALF_FLOAT: number;
  117075. /** BYTE */
  117076. static readonly TEXTURETYPE_BYTE: number;
  117077. /** SHORT */
  117078. static readonly TEXTURETYPE_SHORT: number;
  117079. /** UNSIGNED_SHORT */
  117080. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  117081. /** INT */
  117082. static readonly TEXTURETYPE_INT: number;
  117083. /** UNSIGNED_INT */
  117084. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  117085. /** UNSIGNED_SHORT_4_4_4_4 */
  117086. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  117087. /** UNSIGNED_SHORT_5_5_5_1 */
  117088. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  117089. /** UNSIGNED_SHORT_5_6_5 */
  117090. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  117091. /** UNSIGNED_INT_2_10_10_10_REV */
  117092. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  117093. /** UNSIGNED_INT_24_8 */
  117094. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  117095. /** UNSIGNED_INT_10F_11F_11F_REV */
  117096. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  117097. /** UNSIGNED_INT_5_9_9_9_REV */
  117098. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  117099. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  117100. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  117101. /** nearest is mag = nearest and min = nearest and mip = linear */
  117102. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  117103. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117104. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  117105. /** Trilinear is mag = linear and min = linear and mip = linear */
  117106. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  117107. /** nearest is mag = nearest and min = nearest and mip = linear */
  117108. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  117109. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117110. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  117111. /** Trilinear is mag = linear and min = linear and mip = linear */
  117112. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  117113. /** mag = nearest and min = nearest and mip = nearest */
  117114. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  117115. /** mag = nearest and min = linear and mip = nearest */
  117116. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  117117. /** mag = nearest and min = linear and mip = linear */
  117118. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  117119. /** mag = nearest and min = linear and mip = none */
  117120. static readonly TEXTURE_NEAREST_LINEAR: number;
  117121. /** mag = nearest and min = nearest and mip = none */
  117122. static readonly TEXTURE_NEAREST_NEAREST: number;
  117123. /** mag = linear and min = nearest and mip = nearest */
  117124. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  117125. /** mag = linear and min = nearest and mip = linear */
  117126. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  117127. /** mag = linear and min = linear and mip = none */
  117128. static readonly TEXTURE_LINEAR_LINEAR: number;
  117129. /** mag = linear and min = nearest and mip = none */
  117130. static readonly TEXTURE_LINEAR_NEAREST: number;
  117131. /** Explicit coordinates mode */
  117132. static readonly TEXTURE_EXPLICIT_MODE: number;
  117133. /** Spherical coordinates mode */
  117134. static readonly TEXTURE_SPHERICAL_MODE: number;
  117135. /** Planar coordinates mode */
  117136. static readonly TEXTURE_PLANAR_MODE: number;
  117137. /** Cubic coordinates mode */
  117138. static readonly TEXTURE_CUBIC_MODE: number;
  117139. /** Projection coordinates mode */
  117140. static readonly TEXTURE_PROJECTION_MODE: number;
  117141. /** Skybox coordinates mode */
  117142. static readonly TEXTURE_SKYBOX_MODE: number;
  117143. /** Inverse Cubic coordinates mode */
  117144. static readonly TEXTURE_INVCUBIC_MODE: number;
  117145. /** Equirectangular coordinates mode */
  117146. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  117147. /** Equirectangular Fixed coordinates mode */
  117148. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  117149. /** Equirectangular Fixed Mirrored coordinates mode */
  117150. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  117151. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  117152. static readonly SCALEMODE_FLOOR: number;
  117153. /** Defines that texture rescaling will look for the nearest power of 2 size */
  117154. static readonly SCALEMODE_NEAREST: number;
  117155. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  117156. static readonly SCALEMODE_CEILING: number;
  117157. /**
  117158. * Returns the current npm package of the sdk
  117159. */
  117160. static get NpmPackage(): string;
  117161. /**
  117162. * Returns the current version of the framework
  117163. */
  117164. static get Version(): string;
  117165. /** Gets the list of created engines */
  117166. static get Instances(): Engine[];
  117167. /**
  117168. * Gets the latest created engine
  117169. */
  117170. static get LastCreatedEngine(): Nullable<Engine>;
  117171. /**
  117172. * Gets the latest created scene
  117173. */
  117174. static get LastCreatedScene(): Nullable<Scene>;
  117175. /**
  117176. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  117177. * @param flag defines which part of the materials must be marked as dirty
  117178. * @param predicate defines a predicate used to filter which materials should be affected
  117179. */
  117180. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  117181. /**
  117182. * Method called to create the default loading screen.
  117183. * This can be overriden in your own app.
  117184. * @param canvas The rendering canvas element
  117185. * @returns The loading screen
  117186. */
  117187. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  117188. /**
  117189. * Method called to create the default rescale post process on each engine.
  117190. */
  117191. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  117192. /**
  117193. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  117194. **/
  117195. enableOfflineSupport: boolean;
  117196. /**
  117197. * 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)
  117198. **/
  117199. disableManifestCheck: boolean;
  117200. /**
  117201. * Gets the list of created scenes
  117202. */
  117203. scenes: Scene[];
  117204. /**
  117205. * Event raised when a new scene is created
  117206. */
  117207. onNewSceneAddedObservable: Observable<Scene>;
  117208. /**
  117209. * Gets the list of created postprocesses
  117210. */
  117211. postProcesses: PostProcess[];
  117212. /**
  117213. * Gets a boolean indicating if the pointer is currently locked
  117214. */
  117215. isPointerLock: boolean;
  117216. /**
  117217. * Observable event triggered each time the rendering canvas is resized
  117218. */
  117219. onResizeObservable: Observable<Engine>;
  117220. /**
  117221. * Observable event triggered each time the canvas loses focus
  117222. */
  117223. onCanvasBlurObservable: Observable<Engine>;
  117224. /**
  117225. * Observable event triggered each time the canvas gains focus
  117226. */
  117227. onCanvasFocusObservable: Observable<Engine>;
  117228. /**
  117229. * Observable event triggered each time the canvas receives pointerout event
  117230. */
  117231. onCanvasPointerOutObservable: Observable<PointerEvent>;
  117232. /**
  117233. * Observable raised when the engine begins a new frame
  117234. */
  117235. onBeginFrameObservable: Observable<Engine>;
  117236. /**
  117237. * If set, will be used to request the next animation frame for the render loop
  117238. */
  117239. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  117240. /**
  117241. * Observable raised when the engine ends the current frame
  117242. */
  117243. onEndFrameObservable: Observable<Engine>;
  117244. /**
  117245. * Observable raised when the engine is about to compile a shader
  117246. */
  117247. onBeforeShaderCompilationObservable: Observable<Engine>;
  117248. /**
  117249. * Observable raised when the engine has jsut compiled a shader
  117250. */
  117251. onAfterShaderCompilationObservable: Observable<Engine>;
  117252. /**
  117253. * Gets the audio engine
  117254. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117255. * @ignorenaming
  117256. */
  117257. static audioEngine: IAudioEngine;
  117258. /**
  117259. * Default AudioEngine factory responsible of creating the Audio Engine.
  117260. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  117261. */
  117262. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  117263. /**
  117264. * Default offline support factory responsible of creating a tool used to store data locally.
  117265. * By default, this will create a Database object if the workload has been embedded.
  117266. */
  117267. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  117268. private _loadingScreen;
  117269. private _pointerLockRequested;
  117270. private _rescalePostProcess;
  117271. private _deterministicLockstep;
  117272. private _lockstepMaxSteps;
  117273. private _timeStep;
  117274. protected get _supportsHardwareTextureRescaling(): boolean;
  117275. private _fps;
  117276. private _deltaTime;
  117277. /** @hidden */
  117278. _drawCalls: PerfCounter;
  117279. /** 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 */
  117280. canvasTabIndex: number;
  117281. /**
  117282. * Turn this value on if you want to pause FPS computation when in background
  117283. */
  117284. disablePerformanceMonitorInBackground: boolean;
  117285. private _performanceMonitor;
  117286. /**
  117287. * Gets the performance monitor attached to this engine
  117288. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117289. */
  117290. get performanceMonitor(): PerformanceMonitor;
  117291. private _onFocus;
  117292. private _onBlur;
  117293. private _onCanvasPointerOut;
  117294. private _onCanvasBlur;
  117295. private _onCanvasFocus;
  117296. private _onFullscreenChange;
  117297. private _onPointerLockChange;
  117298. /**
  117299. * Gets the HTML element used to attach event listeners
  117300. * @returns a HTML element
  117301. */
  117302. getInputElement(): Nullable<HTMLElement>;
  117303. /**
  117304. * Creates a new engine
  117305. * @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
  117306. * @param antialias defines enable antialiasing (default: false)
  117307. * @param options defines further options to be sent to the getContext() function
  117308. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  117309. */
  117310. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  117311. /**
  117312. * Gets current aspect ratio
  117313. * @param viewportOwner defines the camera to use to get the aspect ratio
  117314. * @param useScreen defines if screen size must be used (or the current render target if any)
  117315. * @returns a number defining the aspect ratio
  117316. */
  117317. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  117318. /**
  117319. * Gets current screen aspect ratio
  117320. * @returns a number defining the aspect ratio
  117321. */
  117322. getScreenAspectRatio(): number;
  117323. /**
  117324. * Gets the client rect of the HTML canvas attached with the current webGL context
  117325. * @returns a client rectanglee
  117326. */
  117327. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  117328. /**
  117329. * Gets the client rect of the HTML element used for events
  117330. * @returns a client rectanglee
  117331. */
  117332. getInputElementClientRect(): Nullable<ClientRect>;
  117333. /**
  117334. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  117335. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117336. * @returns true if engine is in deterministic lock step mode
  117337. */
  117338. isDeterministicLockStep(): boolean;
  117339. /**
  117340. * Gets the max steps when engine is running in deterministic lock step
  117341. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117342. * @returns the max steps
  117343. */
  117344. getLockstepMaxSteps(): number;
  117345. /**
  117346. * Returns the time in ms between steps when using deterministic lock step.
  117347. * @returns time step in (ms)
  117348. */
  117349. getTimeStep(): number;
  117350. /**
  117351. * Force the mipmap generation for the given render target texture
  117352. * @param texture defines the render target texture to use
  117353. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  117354. */
  117355. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  117356. /** States */
  117357. /**
  117358. * Set various states to the webGL context
  117359. * @param culling defines backface culling state
  117360. * @param zOffset defines the value to apply to zOffset (0 by default)
  117361. * @param force defines if states must be applied even if cache is up to date
  117362. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  117363. */
  117364. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  117365. /**
  117366. * Set the z offset to apply to current rendering
  117367. * @param value defines the offset to apply
  117368. */
  117369. setZOffset(value: number): void;
  117370. /**
  117371. * Gets the current value of the zOffset
  117372. * @returns the current zOffset state
  117373. */
  117374. getZOffset(): number;
  117375. /**
  117376. * Enable or disable depth buffering
  117377. * @param enable defines the state to set
  117378. */
  117379. setDepthBuffer(enable: boolean): void;
  117380. /**
  117381. * Gets a boolean indicating if depth writing is enabled
  117382. * @returns the current depth writing state
  117383. */
  117384. getDepthWrite(): boolean;
  117385. /**
  117386. * Enable or disable depth writing
  117387. * @param enable defines the state to set
  117388. */
  117389. setDepthWrite(enable: boolean): void;
  117390. /**
  117391. * Gets a boolean indicating if stencil buffer is enabled
  117392. * @returns the current stencil buffer state
  117393. */
  117394. getStencilBuffer(): boolean;
  117395. /**
  117396. * Enable or disable the stencil buffer
  117397. * @param enable defines if the stencil buffer must be enabled or disabled
  117398. */
  117399. setStencilBuffer(enable: boolean): void;
  117400. /**
  117401. * Gets the current stencil mask
  117402. * @returns a number defining the new stencil mask to use
  117403. */
  117404. getStencilMask(): number;
  117405. /**
  117406. * Sets the current stencil mask
  117407. * @param mask defines the new stencil mask to use
  117408. */
  117409. setStencilMask(mask: number): void;
  117410. /**
  117411. * Gets the current stencil function
  117412. * @returns a number defining the stencil function to use
  117413. */
  117414. getStencilFunction(): number;
  117415. /**
  117416. * Gets the current stencil reference value
  117417. * @returns a number defining the stencil reference value to use
  117418. */
  117419. getStencilFunctionReference(): number;
  117420. /**
  117421. * Gets the current stencil mask
  117422. * @returns a number defining the stencil mask to use
  117423. */
  117424. getStencilFunctionMask(): number;
  117425. /**
  117426. * Sets the current stencil function
  117427. * @param stencilFunc defines the new stencil function to use
  117428. */
  117429. setStencilFunction(stencilFunc: number): void;
  117430. /**
  117431. * Sets the current stencil reference
  117432. * @param reference defines the new stencil reference to use
  117433. */
  117434. setStencilFunctionReference(reference: number): void;
  117435. /**
  117436. * Sets the current stencil mask
  117437. * @param mask defines the new stencil mask to use
  117438. */
  117439. setStencilFunctionMask(mask: number): void;
  117440. /**
  117441. * Gets the current stencil operation when stencil fails
  117442. * @returns a number defining stencil operation to use when stencil fails
  117443. */
  117444. getStencilOperationFail(): number;
  117445. /**
  117446. * Gets the current stencil operation when depth fails
  117447. * @returns a number defining stencil operation to use when depth fails
  117448. */
  117449. getStencilOperationDepthFail(): number;
  117450. /**
  117451. * Gets the current stencil operation when stencil passes
  117452. * @returns a number defining stencil operation to use when stencil passes
  117453. */
  117454. getStencilOperationPass(): number;
  117455. /**
  117456. * Sets the stencil operation to use when stencil fails
  117457. * @param operation defines the stencil operation to use when stencil fails
  117458. */
  117459. setStencilOperationFail(operation: number): void;
  117460. /**
  117461. * Sets the stencil operation to use when depth fails
  117462. * @param operation defines the stencil operation to use when depth fails
  117463. */
  117464. setStencilOperationDepthFail(operation: number): void;
  117465. /**
  117466. * Sets the stencil operation to use when stencil passes
  117467. * @param operation defines the stencil operation to use when stencil passes
  117468. */
  117469. setStencilOperationPass(operation: number): void;
  117470. /**
  117471. * Sets a boolean indicating if the dithering state is enabled or disabled
  117472. * @param value defines the dithering state
  117473. */
  117474. setDitheringState(value: boolean): void;
  117475. /**
  117476. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  117477. * @param value defines the rasterizer state
  117478. */
  117479. setRasterizerState(value: boolean): void;
  117480. /**
  117481. * Gets the current depth function
  117482. * @returns a number defining the depth function
  117483. */
  117484. getDepthFunction(): Nullable<number>;
  117485. /**
  117486. * Sets the current depth function
  117487. * @param depthFunc defines the function to use
  117488. */
  117489. setDepthFunction(depthFunc: number): void;
  117490. /**
  117491. * Sets the current depth function to GREATER
  117492. */
  117493. setDepthFunctionToGreater(): void;
  117494. /**
  117495. * Sets the current depth function to GEQUAL
  117496. */
  117497. setDepthFunctionToGreaterOrEqual(): void;
  117498. /**
  117499. * Sets the current depth function to LESS
  117500. */
  117501. setDepthFunctionToLess(): void;
  117502. /**
  117503. * Sets the current depth function to LEQUAL
  117504. */
  117505. setDepthFunctionToLessOrEqual(): void;
  117506. private _cachedStencilBuffer;
  117507. private _cachedStencilFunction;
  117508. private _cachedStencilMask;
  117509. private _cachedStencilOperationPass;
  117510. private _cachedStencilOperationFail;
  117511. private _cachedStencilOperationDepthFail;
  117512. private _cachedStencilReference;
  117513. /**
  117514. * Caches the the state of the stencil buffer
  117515. */
  117516. cacheStencilState(): void;
  117517. /**
  117518. * Restores the state of the stencil buffer
  117519. */
  117520. restoreStencilState(): void;
  117521. /**
  117522. * Directly set the WebGL Viewport
  117523. * @param x defines the x coordinate of the viewport (in screen space)
  117524. * @param y defines the y coordinate of the viewport (in screen space)
  117525. * @param width defines the width of the viewport (in screen space)
  117526. * @param height defines the height of the viewport (in screen space)
  117527. * @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
  117528. */
  117529. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  117530. /**
  117531. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  117532. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117533. * @param y defines the y-coordinate of the corner of the clear rectangle
  117534. * @param width defines the width of the clear rectangle
  117535. * @param height defines the height of the clear rectangle
  117536. * @param clearColor defines the clear color
  117537. */
  117538. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  117539. /**
  117540. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  117541. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117542. * @param y defines the y-coordinate of the corner of the clear rectangle
  117543. * @param width defines the width of the clear rectangle
  117544. * @param height defines the height of the clear rectangle
  117545. */
  117546. enableScissor(x: number, y: number, width: number, height: number): void;
  117547. /**
  117548. * Disable previously set scissor test rectangle
  117549. */
  117550. disableScissor(): void;
  117551. protected _reportDrawCall(): void;
  117552. /**
  117553. * Initializes a webVR display and starts listening to display change events
  117554. * The onVRDisplayChangedObservable will be notified upon these changes
  117555. * @returns The onVRDisplayChangedObservable
  117556. */
  117557. initWebVR(): Observable<IDisplayChangedEventArgs>;
  117558. /** @hidden */
  117559. _prepareVRComponent(): void;
  117560. /** @hidden */
  117561. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  117562. /** @hidden */
  117563. _submitVRFrame(): void;
  117564. /**
  117565. * Call this function to leave webVR mode
  117566. * Will do nothing if webVR is not supported or if there is no webVR device
  117567. * @see https://doc.babylonjs.com/how_to/webvr_camera
  117568. */
  117569. disableVR(): void;
  117570. /**
  117571. * Gets a boolean indicating that the system is in VR mode and is presenting
  117572. * @returns true if VR mode is engaged
  117573. */
  117574. isVRPresenting(): boolean;
  117575. /** @hidden */
  117576. _requestVRFrame(): void;
  117577. /** @hidden */
  117578. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  117579. /**
  117580. * Gets the source code of the vertex shader associated with a specific webGL program
  117581. * @param program defines the program to use
  117582. * @returns a string containing the source code of the vertex shader associated with the program
  117583. */
  117584. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  117585. /**
  117586. * Gets the source code of the fragment shader associated with a specific webGL program
  117587. * @param program defines the program to use
  117588. * @returns a string containing the source code of the fragment shader associated with the program
  117589. */
  117590. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  117591. /**
  117592. * Sets a depth stencil texture from a render target to the according uniform.
  117593. * @param channel The texture channel
  117594. * @param uniform The uniform to set
  117595. * @param texture The render target texture containing the depth stencil texture to apply
  117596. */
  117597. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  117598. /**
  117599. * Sets a texture to the webGL context from a postprocess
  117600. * @param channel defines the channel to use
  117601. * @param postProcess defines the source postprocess
  117602. */
  117603. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  117604. /**
  117605. * Binds the output of the passed in post process to the texture channel specified
  117606. * @param channel The channel the texture should be bound to
  117607. * @param postProcess The post process which's output should be bound
  117608. */
  117609. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  117610. protected _rebuildBuffers(): void;
  117611. /** @hidden */
  117612. _renderFrame(): void;
  117613. _renderLoop(): void;
  117614. /** @hidden */
  117615. _renderViews(): boolean;
  117616. /**
  117617. * Toggle full screen mode
  117618. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117619. */
  117620. switchFullscreen(requestPointerLock: boolean): void;
  117621. /**
  117622. * Enters full screen mode
  117623. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117624. */
  117625. enterFullscreen(requestPointerLock: boolean): void;
  117626. /**
  117627. * Exits full screen mode
  117628. */
  117629. exitFullscreen(): void;
  117630. /**
  117631. * Enters Pointerlock mode
  117632. */
  117633. enterPointerlock(): void;
  117634. /**
  117635. * Exits Pointerlock mode
  117636. */
  117637. exitPointerlock(): void;
  117638. /**
  117639. * Begin a new frame
  117640. */
  117641. beginFrame(): void;
  117642. /**
  117643. * Enf the current frame
  117644. */
  117645. endFrame(): void;
  117646. resize(): void;
  117647. /**
  117648. * Force a specific size of the canvas
  117649. * @param width defines the new canvas' width
  117650. * @param height defines the new canvas' height
  117651. * @returns true if the size was changed
  117652. */
  117653. setSize(width: number, height: number): boolean;
  117654. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  117655. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117656. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117657. _releaseTexture(texture: InternalTexture): void;
  117658. /**
  117659. * @hidden
  117660. * Rescales a texture
  117661. * @param source input texutre
  117662. * @param destination destination texture
  117663. * @param scene scene to use to render the resize
  117664. * @param internalFormat format to use when resizing
  117665. * @param onComplete callback to be called when resize has completed
  117666. */
  117667. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  117668. /**
  117669. * Gets the current framerate
  117670. * @returns a number representing the framerate
  117671. */
  117672. getFps(): number;
  117673. /**
  117674. * Gets the time spent between current and previous frame
  117675. * @returns a number representing the delta time in ms
  117676. */
  117677. getDeltaTime(): number;
  117678. private _measureFps;
  117679. /** @hidden */
  117680. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  117681. /**
  117682. * Updates the sample count of a render target texture
  117683. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  117684. * @param texture defines the texture to update
  117685. * @param samples defines the sample count to set
  117686. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  117687. */
  117688. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  117689. /**
  117690. * Updates a depth texture Comparison Mode and Function.
  117691. * If the comparison Function is equal to 0, the mode will be set to none.
  117692. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  117693. * @param texture The texture to set the comparison function for
  117694. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  117695. */
  117696. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  117697. /**
  117698. * Creates a webGL buffer to use with instanciation
  117699. * @param capacity defines the size of the buffer
  117700. * @returns the webGL buffer
  117701. */
  117702. createInstancesBuffer(capacity: number): DataBuffer;
  117703. /**
  117704. * Delete a webGL buffer used with instanciation
  117705. * @param buffer defines the webGL buffer to delete
  117706. */
  117707. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  117708. private _clientWaitAsync;
  117709. /** @hidden */
  117710. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  117711. dispose(): void;
  117712. private _disableTouchAction;
  117713. /**
  117714. * Display the loading screen
  117715. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117716. */
  117717. displayLoadingUI(): void;
  117718. /**
  117719. * Hide the loading screen
  117720. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117721. */
  117722. hideLoadingUI(): void;
  117723. /**
  117724. * Gets the current loading screen object
  117725. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117726. */
  117727. get loadingScreen(): ILoadingScreen;
  117728. /**
  117729. * Sets the current loading screen object
  117730. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117731. */
  117732. set loadingScreen(loadingScreen: ILoadingScreen);
  117733. /**
  117734. * Sets the current loading screen text
  117735. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117736. */
  117737. set loadingUIText(text: string);
  117738. /**
  117739. * Sets the current loading screen background color
  117740. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117741. */
  117742. set loadingUIBackgroundColor(color: string);
  117743. /** Pointerlock and fullscreen */
  117744. /**
  117745. * Ask the browser to promote the current element to pointerlock mode
  117746. * @param element defines the DOM element to promote
  117747. */
  117748. static _RequestPointerlock(element: HTMLElement): void;
  117749. /**
  117750. * Asks the browser to exit pointerlock mode
  117751. */
  117752. static _ExitPointerlock(): void;
  117753. /**
  117754. * Ask the browser to promote the current element to fullscreen rendering mode
  117755. * @param element defines the DOM element to promote
  117756. */
  117757. static _RequestFullscreen(element: HTMLElement): void;
  117758. /**
  117759. * Asks the browser to exit fullscreen mode
  117760. */
  117761. static _ExitFullscreen(): void;
  117762. }
  117763. }
  117764. declare module BABYLON {
  117765. /**
  117766. * The engine store class is responsible to hold all the instances of Engine and Scene created
  117767. * during the life time of the application.
  117768. */
  117769. export class EngineStore {
  117770. /** Gets the list of created engines */
  117771. static Instances: Engine[];
  117772. /** @hidden */
  117773. static _LastCreatedScene: Nullable<Scene>;
  117774. /**
  117775. * Gets the latest created engine
  117776. */
  117777. static get LastCreatedEngine(): Nullable<Engine>;
  117778. /**
  117779. * Gets the latest created scene
  117780. */
  117781. static get LastCreatedScene(): Nullable<Scene>;
  117782. /**
  117783. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117784. * @ignorenaming
  117785. */
  117786. static UseFallbackTexture: boolean;
  117787. /**
  117788. * Texture content used if a texture cannot loaded
  117789. * @ignorenaming
  117790. */
  117791. static FallbackTexture: string;
  117792. }
  117793. }
  117794. declare module BABYLON {
  117795. /**
  117796. * Helper class that provides a small promise polyfill
  117797. */
  117798. export class PromisePolyfill {
  117799. /**
  117800. * Static function used to check if the polyfill is required
  117801. * If this is the case then the function will inject the polyfill to window.Promise
  117802. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  117803. */
  117804. static Apply(force?: boolean): void;
  117805. }
  117806. }
  117807. declare module BABYLON {
  117808. /**
  117809. * Interface for screenshot methods with describe argument called `size` as object with options
  117810. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  117811. */
  117812. export interface IScreenshotSize {
  117813. /**
  117814. * number in pixels for canvas height
  117815. */
  117816. height?: number;
  117817. /**
  117818. * multiplier allowing render at a higher or lower resolution
  117819. * If value is defined then height and width will be ignored and taken from camera
  117820. */
  117821. precision?: number;
  117822. /**
  117823. * number in pixels for canvas width
  117824. */
  117825. width?: number;
  117826. }
  117827. }
  117828. declare module BABYLON {
  117829. interface IColor4Like {
  117830. r: float;
  117831. g: float;
  117832. b: float;
  117833. a: float;
  117834. }
  117835. /**
  117836. * Class containing a set of static utilities functions
  117837. */
  117838. export class Tools {
  117839. /**
  117840. * Gets or sets the base URL to use to load assets
  117841. */
  117842. static get BaseUrl(): string;
  117843. static set BaseUrl(value: string);
  117844. /**
  117845. * Enable/Disable Custom HTTP Request Headers globally.
  117846. * default = false
  117847. * @see CustomRequestHeaders
  117848. */
  117849. static UseCustomRequestHeaders: boolean;
  117850. /**
  117851. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  117852. * i.e. when loading files, where the server/service expects an Authorization header
  117853. */
  117854. static CustomRequestHeaders: {
  117855. [key: string]: string;
  117856. };
  117857. /**
  117858. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  117859. */
  117860. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  117861. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  117862. /**
  117863. * Default behaviour for cors in the application.
  117864. * It can be a string if the expected behavior is identical in the entire app.
  117865. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  117866. */
  117867. static get CorsBehavior(): string | ((url: string | string[]) => string);
  117868. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  117869. /**
  117870. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117871. * @ignorenaming
  117872. */
  117873. static get UseFallbackTexture(): boolean;
  117874. static set UseFallbackTexture(value: boolean);
  117875. /**
  117876. * Use this object to register external classes like custom textures or material
  117877. * to allow the laoders to instantiate them
  117878. */
  117879. static get RegisteredExternalClasses(): {
  117880. [key: string]: Object;
  117881. };
  117882. static set RegisteredExternalClasses(classes: {
  117883. [key: string]: Object;
  117884. });
  117885. /**
  117886. * Texture content used if a texture cannot loaded
  117887. * @ignorenaming
  117888. */
  117889. static get fallbackTexture(): string;
  117890. static set fallbackTexture(value: string);
  117891. /**
  117892. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  117893. * @param u defines the coordinate on X axis
  117894. * @param v defines the coordinate on Y axis
  117895. * @param width defines the width of the source data
  117896. * @param height defines the height of the source data
  117897. * @param pixels defines the source byte array
  117898. * @param color defines the output color
  117899. */
  117900. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  117901. /**
  117902. * Interpolates between a and b via alpha
  117903. * @param a The lower value (returned when alpha = 0)
  117904. * @param b The upper value (returned when alpha = 1)
  117905. * @param alpha The interpolation-factor
  117906. * @return The mixed value
  117907. */
  117908. static Mix(a: number, b: number, alpha: number): number;
  117909. /**
  117910. * Tries to instantiate a new object from a given class name
  117911. * @param className defines the class name to instantiate
  117912. * @returns the new object or null if the system was not able to do the instantiation
  117913. */
  117914. static Instantiate(className: string): any;
  117915. /**
  117916. * Provides a slice function that will work even on IE
  117917. * @param data defines the array to slice
  117918. * @param start defines the start of the data (optional)
  117919. * @param end defines the end of the data (optional)
  117920. * @returns the new sliced array
  117921. */
  117922. static Slice<T>(data: T, start?: number, end?: number): T;
  117923. /**
  117924. * Polyfill for setImmediate
  117925. * @param action defines the action to execute after the current execution block
  117926. */
  117927. static SetImmediate(action: () => void): void;
  117928. /**
  117929. * Function indicating if a number is an exponent of 2
  117930. * @param value defines the value to test
  117931. * @returns true if the value is an exponent of 2
  117932. */
  117933. static IsExponentOfTwo(value: number): boolean;
  117934. private static _tmpFloatArray;
  117935. /**
  117936. * Returns the nearest 32-bit single precision float representation of a Number
  117937. * @param value A Number. If the parameter is of a different type, it will get converted
  117938. * to a number or to NaN if it cannot be converted
  117939. * @returns number
  117940. */
  117941. static FloatRound(value: number): number;
  117942. /**
  117943. * Extracts the filename from a path
  117944. * @param path defines the path to use
  117945. * @returns the filename
  117946. */
  117947. static GetFilename(path: string): string;
  117948. /**
  117949. * Extracts the "folder" part of a path (everything before the filename).
  117950. * @param uri The URI to extract the info from
  117951. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  117952. * @returns The "folder" part of the path
  117953. */
  117954. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  117955. /**
  117956. * Extracts text content from a DOM element hierarchy
  117957. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  117958. */
  117959. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  117960. /**
  117961. * Convert an angle in radians to degrees
  117962. * @param angle defines the angle to convert
  117963. * @returns the angle in degrees
  117964. */
  117965. static ToDegrees(angle: number): number;
  117966. /**
  117967. * Convert an angle in degrees to radians
  117968. * @param angle defines the angle to convert
  117969. * @returns the angle in radians
  117970. */
  117971. static ToRadians(angle: number): number;
  117972. /**
  117973. * Returns an array if obj is not an array
  117974. * @param obj defines the object to evaluate as an array
  117975. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  117976. * @returns either obj directly if obj is an array or a new array containing obj
  117977. */
  117978. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  117979. /**
  117980. * Gets the pointer prefix to use
  117981. * @param engine defines the engine we are finding the prefix for
  117982. * @returns "pointer" if touch is enabled. Else returns "mouse"
  117983. */
  117984. static GetPointerPrefix(engine: Engine): string;
  117985. /**
  117986. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  117987. * @param url define the url we are trying
  117988. * @param element define the dom element where to configure the cors policy
  117989. */
  117990. static SetCorsBehavior(url: string | string[], element: {
  117991. crossOrigin: string | null;
  117992. }): void;
  117993. /**
  117994. * Removes unwanted characters from an url
  117995. * @param url defines the url to clean
  117996. * @returns the cleaned url
  117997. */
  117998. static CleanUrl(url: string): string;
  117999. /**
  118000. * Gets or sets a function used to pre-process url before using them to load assets
  118001. */
  118002. static get PreprocessUrl(): (url: string) => string;
  118003. static set PreprocessUrl(processor: (url: string) => string);
  118004. /**
  118005. * Loads an image as an HTMLImageElement.
  118006. * @param input url string, ArrayBuffer, or Blob to load
  118007. * @param onLoad callback called when the image successfully loads
  118008. * @param onError callback called when the image fails to load
  118009. * @param offlineProvider offline provider for caching
  118010. * @param mimeType optional mime type
  118011. * @returns the HTMLImageElement of the loaded image
  118012. */
  118013. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  118014. /**
  118015. * Loads a file from a url
  118016. * @param url url string, ArrayBuffer, or Blob to load
  118017. * @param onSuccess callback called when the file successfully loads
  118018. * @param onProgress callback called while file is loading (if the server supports this mode)
  118019. * @param offlineProvider defines the offline provider for caching
  118020. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118021. * @param onError callback called when the file fails to load
  118022. * @returns a file request object
  118023. */
  118024. 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;
  118025. /**
  118026. * Loads a file from a url
  118027. * @param url the file url to load
  118028. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118029. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  118030. */
  118031. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  118032. /**
  118033. * Load a script (identified by an url). When the url returns, the
  118034. * content of this file is added into a new script element, attached to the DOM (body element)
  118035. * @param scriptUrl defines the url of the script to laod
  118036. * @param onSuccess defines the callback called when the script is loaded
  118037. * @param onError defines the callback to call if an error occurs
  118038. * @param scriptId defines the id of the script element
  118039. */
  118040. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  118041. /**
  118042. * Load an asynchronous script (identified by an url). When the url returns, the
  118043. * content of this file is added into a new script element, attached to the DOM (body element)
  118044. * @param scriptUrl defines the url of the script to laod
  118045. * @param scriptId defines the id of the script element
  118046. * @returns a promise request object
  118047. */
  118048. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  118049. /**
  118050. * Loads a file from a blob
  118051. * @param fileToLoad defines the blob to use
  118052. * @param callback defines the callback to call when data is loaded
  118053. * @param progressCallback defines the callback to call during loading process
  118054. * @returns a file request object
  118055. */
  118056. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  118057. /**
  118058. * Reads a file from a File object
  118059. * @param file defines the file to load
  118060. * @param onSuccess defines the callback to call when data is loaded
  118061. * @param onProgress defines the callback to call during loading process
  118062. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  118063. * @param onError defines the callback to call when an error occurs
  118064. * @returns a file request object
  118065. */
  118066. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  118067. /**
  118068. * Creates a data url from a given string content
  118069. * @param content defines the content to convert
  118070. * @returns the new data url link
  118071. */
  118072. static FileAsURL(content: string): string;
  118073. /**
  118074. * Format the given number to a specific decimal format
  118075. * @param value defines the number to format
  118076. * @param decimals defines the number of decimals to use
  118077. * @returns the formatted string
  118078. */
  118079. static Format(value: number, decimals?: number): string;
  118080. /**
  118081. * Tries to copy an object by duplicating every property
  118082. * @param source defines the source object
  118083. * @param destination defines the target object
  118084. * @param doNotCopyList defines a list of properties to avoid
  118085. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  118086. */
  118087. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  118088. /**
  118089. * Gets a boolean indicating if the given object has no own property
  118090. * @param obj defines the object to test
  118091. * @returns true if object has no own property
  118092. */
  118093. static IsEmpty(obj: any): boolean;
  118094. /**
  118095. * Function used to register events at window level
  118096. * @param windowElement defines the Window object to use
  118097. * @param events defines the events to register
  118098. */
  118099. static RegisterTopRootEvents(windowElement: Window, events: {
  118100. name: string;
  118101. handler: Nullable<(e: FocusEvent) => any>;
  118102. }[]): void;
  118103. /**
  118104. * Function used to unregister events from window level
  118105. * @param windowElement defines the Window object to use
  118106. * @param events defines the events to unregister
  118107. */
  118108. static UnregisterTopRootEvents(windowElement: Window, events: {
  118109. name: string;
  118110. handler: Nullable<(e: FocusEvent) => any>;
  118111. }[]): void;
  118112. /**
  118113. * @ignore
  118114. */
  118115. static _ScreenshotCanvas: HTMLCanvasElement;
  118116. /**
  118117. * Dumps the current bound framebuffer
  118118. * @param width defines the rendering width
  118119. * @param height defines the rendering height
  118120. * @param engine defines the hosting engine
  118121. * @param successCallback defines the callback triggered once the data are available
  118122. * @param mimeType defines the mime type of the result
  118123. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  118124. */
  118125. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118126. /**
  118127. * Converts the canvas data to blob.
  118128. * This acts as a polyfill for browsers not supporting the to blob function.
  118129. * @param canvas Defines the canvas to extract the data from
  118130. * @param successCallback Defines the callback triggered once the data are available
  118131. * @param mimeType Defines the mime type of the result
  118132. */
  118133. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  118134. /**
  118135. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  118136. * @param successCallback defines the callback triggered once the data are available
  118137. * @param mimeType defines the mime type of the result
  118138. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  118139. */
  118140. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118141. /**
  118142. * Downloads a blob in the browser
  118143. * @param blob defines the blob to download
  118144. * @param fileName defines the name of the downloaded file
  118145. */
  118146. static Download(blob: Blob, fileName: string): void;
  118147. /**
  118148. * Captures a screenshot of the current rendering
  118149. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118150. * @param engine defines the rendering engine
  118151. * @param camera defines the source camera
  118152. * @param size This parameter can be set to a single number or to an object with the
  118153. * following (optional) properties: precision, width, height. If a single number is passed,
  118154. * it will be used for both width and height. If an object is passed, the screenshot size
  118155. * will be derived from the parameters. The precision property is a multiplier allowing
  118156. * rendering at a higher or lower resolution
  118157. * @param successCallback defines the callback receives a single parameter which contains the
  118158. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118159. * src parameter of an <img> to display it
  118160. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118161. * Check your browser for supported MIME types
  118162. */
  118163. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  118164. /**
  118165. * Captures a screenshot of the current rendering
  118166. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118167. * @param engine defines the rendering engine
  118168. * @param camera defines the source camera
  118169. * @param size This parameter can be set to a single number or to an object with the
  118170. * following (optional) properties: precision, width, height. If a single number is passed,
  118171. * it will be used for both width and height. If an object is passed, the screenshot size
  118172. * will be derived from the parameters. The precision property is a multiplier allowing
  118173. * rendering at a higher or lower resolution
  118174. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118175. * Check your browser for supported MIME types
  118176. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118177. * to the src parameter of an <img> to display it
  118178. */
  118179. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  118180. /**
  118181. * Generates an image screenshot from the specified camera.
  118182. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118183. * @param engine The engine to use for rendering
  118184. * @param camera The camera to use for rendering
  118185. * @param size This parameter can be set to a single number or to an object with the
  118186. * following (optional) properties: precision, width, height. If a single number is passed,
  118187. * it will be used for both width and height. If an object is passed, the screenshot size
  118188. * will be derived from the parameters. The precision property is a multiplier allowing
  118189. * rendering at a higher or lower resolution
  118190. * @param successCallback The callback receives a single parameter which contains the
  118191. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118192. * src parameter of an <img> to display it
  118193. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118194. * Check your browser for supported MIME types
  118195. * @param samples Texture samples (default: 1)
  118196. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118197. * @param fileName A name for for the downloaded file.
  118198. */
  118199. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  118200. /**
  118201. * Generates an image screenshot from the specified camera.
  118202. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118203. * @param engine The engine to use for rendering
  118204. * @param camera The camera to use for rendering
  118205. * @param size This parameter can be set to a single number or to an object with the
  118206. * following (optional) properties: precision, width, height. If a single number is passed,
  118207. * it will be used for both width and height. If an object is passed, the screenshot size
  118208. * will be derived from the parameters. The precision property is a multiplier allowing
  118209. * rendering at a higher or lower resolution
  118210. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118211. * Check your browser for supported MIME types
  118212. * @param samples Texture samples (default: 1)
  118213. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118214. * @param fileName A name for for the downloaded file.
  118215. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118216. * to the src parameter of an <img> to display it
  118217. */
  118218. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  118219. /**
  118220. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  118221. * Be aware Math.random() could cause collisions, but:
  118222. * "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"
  118223. * @returns a pseudo random id
  118224. */
  118225. static RandomId(): string;
  118226. /**
  118227. * Test if the given uri is a base64 string
  118228. * @param uri The uri to test
  118229. * @return True if the uri is a base64 string or false otherwise
  118230. */
  118231. static IsBase64(uri: string): boolean;
  118232. /**
  118233. * Decode the given base64 uri.
  118234. * @param uri The uri to decode
  118235. * @return The decoded base64 data.
  118236. */
  118237. static DecodeBase64(uri: string): ArrayBuffer;
  118238. /**
  118239. * Gets the absolute url.
  118240. * @param url the input url
  118241. * @return the absolute url
  118242. */
  118243. static GetAbsoluteUrl(url: string): string;
  118244. /**
  118245. * No log
  118246. */
  118247. static readonly NoneLogLevel: number;
  118248. /**
  118249. * Only message logs
  118250. */
  118251. static readonly MessageLogLevel: number;
  118252. /**
  118253. * Only warning logs
  118254. */
  118255. static readonly WarningLogLevel: number;
  118256. /**
  118257. * Only error logs
  118258. */
  118259. static readonly ErrorLogLevel: number;
  118260. /**
  118261. * All logs
  118262. */
  118263. static readonly AllLogLevel: number;
  118264. /**
  118265. * Gets a value indicating the number of loading errors
  118266. * @ignorenaming
  118267. */
  118268. static get errorsCount(): number;
  118269. /**
  118270. * Callback called when a new log is added
  118271. */
  118272. static OnNewCacheEntry: (entry: string) => void;
  118273. /**
  118274. * Log a message to the console
  118275. * @param message defines the message to log
  118276. */
  118277. static Log(message: string): void;
  118278. /**
  118279. * Write a warning message to the console
  118280. * @param message defines the message to log
  118281. */
  118282. static Warn(message: string): void;
  118283. /**
  118284. * Write an error message to the console
  118285. * @param message defines the message to log
  118286. */
  118287. static Error(message: string): void;
  118288. /**
  118289. * Gets current log cache (list of logs)
  118290. */
  118291. static get LogCache(): string;
  118292. /**
  118293. * Clears the log cache
  118294. */
  118295. static ClearLogCache(): void;
  118296. /**
  118297. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  118298. */
  118299. static set LogLevels(level: number);
  118300. /**
  118301. * Checks if the window object exists
  118302. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  118303. */
  118304. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  118305. /**
  118306. * No performance log
  118307. */
  118308. static readonly PerformanceNoneLogLevel: number;
  118309. /**
  118310. * Use user marks to log performance
  118311. */
  118312. static readonly PerformanceUserMarkLogLevel: number;
  118313. /**
  118314. * Log performance to the console
  118315. */
  118316. static readonly PerformanceConsoleLogLevel: number;
  118317. private static _performance;
  118318. /**
  118319. * Sets the current performance log level
  118320. */
  118321. static set PerformanceLogLevel(level: number);
  118322. private static _StartPerformanceCounterDisabled;
  118323. private static _EndPerformanceCounterDisabled;
  118324. private static _StartUserMark;
  118325. private static _EndUserMark;
  118326. private static _StartPerformanceConsole;
  118327. private static _EndPerformanceConsole;
  118328. /**
  118329. * Starts a performance counter
  118330. */
  118331. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118332. /**
  118333. * Ends a specific performance coutner
  118334. */
  118335. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118336. /**
  118337. * Gets either window.performance.now() if supported or Date.now() else
  118338. */
  118339. static get Now(): number;
  118340. /**
  118341. * This method will return the name of the class used to create the instance of the given object.
  118342. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  118343. * @param object the object to get the class name from
  118344. * @param isType defines if the object is actually a type
  118345. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  118346. */
  118347. static GetClassName(object: any, isType?: boolean): string;
  118348. /**
  118349. * Gets the first element of an array satisfying a given predicate
  118350. * @param array defines the array to browse
  118351. * @param predicate defines the predicate to use
  118352. * @returns null if not found or the element
  118353. */
  118354. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  118355. /**
  118356. * This method will return the name of the full name of the class, including its owning module (if any).
  118357. * 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).
  118358. * @param object the object to get the class name from
  118359. * @param isType defines if the object is actually a type
  118360. * @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.
  118361. * @ignorenaming
  118362. */
  118363. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  118364. /**
  118365. * Returns a promise that resolves after the given amount of time.
  118366. * @param delay Number of milliseconds to delay
  118367. * @returns Promise that resolves after the given amount of time
  118368. */
  118369. static DelayAsync(delay: number): Promise<void>;
  118370. /**
  118371. * Utility function to detect if the current user agent is Safari
  118372. * @returns whether or not the current user agent is safari
  118373. */
  118374. static IsSafari(): boolean;
  118375. }
  118376. /**
  118377. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  118378. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  118379. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  118380. * @param name The name of the class, case should be preserved
  118381. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  118382. */
  118383. export function className(name: string, module?: string): (target: Object) => void;
  118384. /**
  118385. * An implementation of a loop for asynchronous functions.
  118386. */
  118387. export class AsyncLoop {
  118388. /**
  118389. * Defines the number of iterations for the loop
  118390. */
  118391. iterations: number;
  118392. /**
  118393. * Defines the current index of the loop.
  118394. */
  118395. index: number;
  118396. private _done;
  118397. private _fn;
  118398. private _successCallback;
  118399. /**
  118400. * Constructor.
  118401. * @param iterations the number of iterations.
  118402. * @param func the function to run each iteration
  118403. * @param successCallback the callback that will be called upon succesful execution
  118404. * @param offset starting offset.
  118405. */
  118406. constructor(
  118407. /**
  118408. * Defines the number of iterations for the loop
  118409. */
  118410. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  118411. /**
  118412. * Execute the next iteration. Must be called after the last iteration was finished.
  118413. */
  118414. executeNext(): void;
  118415. /**
  118416. * Break the loop and run the success callback.
  118417. */
  118418. breakLoop(): void;
  118419. /**
  118420. * Create and run an async loop.
  118421. * @param iterations the number of iterations.
  118422. * @param fn the function to run each iteration
  118423. * @param successCallback the callback that will be called upon succesful execution
  118424. * @param offset starting offset.
  118425. * @returns the created async loop object
  118426. */
  118427. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  118428. /**
  118429. * A for-loop that will run a given number of iterations synchronous and the rest async.
  118430. * @param iterations total number of iterations
  118431. * @param syncedIterations number of synchronous iterations in each async iteration.
  118432. * @param fn the function to call each iteration.
  118433. * @param callback a success call back that will be called when iterating stops.
  118434. * @param breakFunction a break condition (optional)
  118435. * @param timeout timeout settings for the setTimeout function. default - 0.
  118436. * @returns the created async loop object
  118437. */
  118438. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  118439. }
  118440. }
  118441. declare module BABYLON {
  118442. /**
  118443. * This class implement a typical dictionary using a string as key and the generic type T as value.
  118444. * The underlying implementation relies on an associative array to ensure the best performances.
  118445. * The value can be anything including 'null' but except 'undefined'
  118446. */
  118447. export class StringDictionary<T> {
  118448. /**
  118449. * This will clear this dictionary and copy the content from the 'source' one.
  118450. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  118451. * @param source the dictionary to take the content from and copy to this dictionary
  118452. */
  118453. copyFrom(source: StringDictionary<T>): void;
  118454. /**
  118455. * Get a value based from its key
  118456. * @param key the given key to get the matching value from
  118457. * @return the value if found, otherwise undefined is returned
  118458. */
  118459. get(key: string): T | undefined;
  118460. /**
  118461. * Get a value from its key or add it if it doesn't exist.
  118462. * This method will ensure you that a given key/data will be present in the dictionary.
  118463. * @param key the given key to get the matching value from
  118464. * @param factory the factory that will create the value if the key is not present in the dictionary.
  118465. * The factory will only be invoked if there's no data for the given key.
  118466. * @return the value corresponding to the key.
  118467. */
  118468. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  118469. /**
  118470. * Get a value from its key if present in the dictionary otherwise add it
  118471. * @param key the key to get the value from
  118472. * @param val if there's no such key/value pair in the dictionary add it with this value
  118473. * @return the value corresponding to the key
  118474. */
  118475. getOrAdd(key: string, val: T): T;
  118476. /**
  118477. * Check if there's a given key in the dictionary
  118478. * @param key the key to check for
  118479. * @return true if the key is present, false otherwise
  118480. */
  118481. contains(key: string): boolean;
  118482. /**
  118483. * Add a new key and its corresponding value
  118484. * @param key the key to add
  118485. * @param value the value corresponding to the key
  118486. * @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
  118487. */
  118488. add(key: string, value: T): boolean;
  118489. /**
  118490. * Update a specific value associated to a key
  118491. * @param key defines the key to use
  118492. * @param value defines the value to store
  118493. * @returns true if the value was updated (or false if the key was not found)
  118494. */
  118495. set(key: string, value: T): boolean;
  118496. /**
  118497. * Get the element of the given key and remove it from the dictionary
  118498. * @param key defines the key to search
  118499. * @returns the value associated with the key or null if not found
  118500. */
  118501. getAndRemove(key: string): Nullable<T>;
  118502. /**
  118503. * Remove a key/value from the dictionary.
  118504. * @param key the key to remove
  118505. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  118506. */
  118507. remove(key: string): boolean;
  118508. /**
  118509. * Clear the whole content of the dictionary
  118510. */
  118511. clear(): void;
  118512. /**
  118513. * Gets the current count
  118514. */
  118515. get count(): number;
  118516. /**
  118517. * Execute a callback on each key/val of the dictionary.
  118518. * Note that you can remove any element in this dictionary in the callback implementation
  118519. * @param callback the callback to execute on a given key/value pair
  118520. */
  118521. forEach(callback: (key: string, val: T) => void): void;
  118522. /**
  118523. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  118524. * If the callback returns null or undefined the method will iterate to the next key/value pair
  118525. * Note that you can remove any element in this dictionary in the callback implementation
  118526. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  118527. * @returns the first item
  118528. */
  118529. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  118530. private _count;
  118531. private _data;
  118532. }
  118533. }
  118534. declare module BABYLON {
  118535. /** @hidden */
  118536. export interface ICollisionCoordinator {
  118537. createCollider(): Collider;
  118538. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118539. init(scene: Scene): void;
  118540. }
  118541. /** @hidden */
  118542. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  118543. private _scene;
  118544. private _scaledPosition;
  118545. private _scaledVelocity;
  118546. private _finalPosition;
  118547. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118548. createCollider(): Collider;
  118549. init(scene: Scene): void;
  118550. private _collideWithWorld;
  118551. }
  118552. }
  118553. declare module BABYLON {
  118554. /**
  118555. * Class used to manage all inputs for the scene.
  118556. */
  118557. export class InputManager {
  118558. /** The distance in pixel that you have to move to prevent some events */
  118559. static DragMovementThreshold: number;
  118560. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  118561. static LongPressDelay: number;
  118562. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  118563. static DoubleClickDelay: number;
  118564. /** If you need to check double click without raising a single click at first click, enable this flag */
  118565. static ExclusiveDoubleClickMode: boolean;
  118566. /** 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. */
  118567. private _alreadyAttached;
  118568. private _wheelEventName;
  118569. private _onPointerMove;
  118570. private _onPointerDown;
  118571. private _onPointerUp;
  118572. private _initClickEvent;
  118573. private _initActionManager;
  118574. private _delayedSimpleClick;
  118575. private _delayedSimpleClickTimeout;
  118576. private _previousDelayedSimpleClickTimeout;
  118577. private _meshPickProceed;
  118578. private _previousButtonPressed;
  118579. private _currentPickResult;
  118580. private _previousPickResult;
  118581. private _totalPointersPressed;
  118582. private _doubleClickOccured;
  118583. private _pointerOverMesh;
  118584. private _pickedDownMesh;
  118585. private _pickedUpMesh;
  118586. private _pointerX;
  118587. private _pointerY;
  118588. private _unTranslatedPointerX;
  118589. private _unTranslatedPointerY;
  118590. private _startingPointerPosition;
  118591. private _previousStartingPointerPosition;
  118592. private _startingPointerTime;
  118593. private _previousStartingPointerTime;
  118594. private _pointerCaptures;
  118595. private _meshUnderPointerId;
  118596. private _onKeyDown;
  118597. private _onKeyUp;
  118598. private _onCanvasFocusObserver;
  118599. private _onCanvasBlurObserver;
  118600. private _scene;
  118601. /**
  118602. * Creates a new InputManager
  118603. * @param scene defines the hosting scene
  118604. */
  118605. constructor(scene: Scene);
  118606. /**
  118607. * Gets the mesh that is currently under the pointer
  118608. */
  118609. get meshUnderPointer(): Nullable<AbstractMesh>;
  118610. /**
  118611. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  118612. * @param pointerId the pointer id to use
  118613. * @returns The mesh under this pointer id or null if not found
  118614. */
  118615. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  118616. /**
  118617. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  118618. */
  118619. get unTranslatedPointer(): Vector2;
  118620. /**
  118621. * Gets or sets the current on-screen X position of the pointer
  118622. */
  118623. get pointerX(): number;
  118624. set pointerX(value: number);
  118625. /**
  118626. * Gets or sets the current on-screen Y position of the pointer
  118627. */
  118628. get pointerY(): number;
  118629. set pointerY(value: number);
  118630. private _updatePointerPosition;
  118631. private _processPointerMove;
  118632. private _setRayOnPointerInfo;
  118633. private _checkPrePointerObservable;
  118634. /**
  118635. * Use this method to simulate a pointer move on a mesh
  118636. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118637. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118638. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118639. */
  118640. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118641. /**
  118642. * Use this method to simulate a pointer down on a mesh
  118643. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118644. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118645. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118646. */
  118647. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118648. private _processPointerDown;
  118649. /** @hidden */
  118650. _isPointerSwiping(): boolean;
  118651. /**
  118652. * Use this method to simulate a pointer up on a mesh
  118653. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118654. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118655. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118656. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  118657. */
  118658. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  118659. private _processPointerUp;
  118660. /**
  118661. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  118662. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  118663. * @returns true if the pointer was captured
  118664. */
  118665. isPointerCaptured(pointerId?: number): boolean;
  118666. /**
  118667. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  118668. * @param attachUp defines if you want to attach events to pointerup
  118669. * @param attachDown defines if you want to attach events to pointerdown
  118670. * @param attachMove defines if you want to attach events to pointermove
  118671. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  118672. */
  118673. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  118674. /**
  118675. * Detaches all event handlers
  118676. */
  118677. detachControl(): void;
  118678. /**
  118679. * Force the value of meshUnderPointer
  118680. * @param mesh defines the mesh to use
  118681. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  118682. */
  118683. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  118684. /**
  118685. * Gets the mesh under the pointer
  118686. * @returns a Mesh or null if no mesh is under the pointer
  118687. */
  118688. getPointerOverMesh(): Nullable<AbstractMesh>;
  118689. }
  118690. }
  118691. declare module BABYLON {
  118692. /**
  118693. * This class defines the direct association between an animation and a target
  118694. */
  118695. export class TargetedAnimation {
  118696. /**
  118697. * Animation to perform
  118698. */
  118699. animation: Animation;
  118700. /**
  118701. * Target to animate
  118702. */
  118703. target: any;
  118704. /**
  118705. * Returns the string "TargetedAnimation"
  118706. * @returns "TargetedAnimation"
  118707. */
  118708. getClassName(): string;
  118709. /**
  118710. * Serialize the object
  118711. * @returns the JSON object representing the current entity
  118712. */
  118713. serialize(): any;
  118714. }
  118715. /**
  118716. * Use this class to create coordinated animations on multiple targets
  118717. */
  118718. export class AnimationGroup implements IDisposable {
  118719. /** The name of the animation group */
  118720. name: string;
  118721. private _scene;
  118722. private _targetedAnimations;
  118723. private _animatables;
  118724. private _from;
  118725. private _to;
  118726. private _isStarted;
  118727. private _isPaused;
  118728. private _speedRatio;
  118729. private _loopAnimation;
  118730. private _isAdditive;
  118731. /**
  118732. * Gets or sets the unique id of the node
  118733. */
  118734. uniqueId: number;
  118735. /**
  118736. * This observable will notify when one animation have ended
  118737. */
  118738. onAnimationEndObservable: Observable<TargetedAnimation>;
  118739. /**
  118740. * Observer raised when one animation loops
  118741. */
  118742. onAnimationLoopObservable: Observable<TargetedAnimation>;
  118743. /**
  118744. * Observer raised when all animations have looped
  118745. */
  118746. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  118747. /**
  118748. * This observable will notify when all animations have ended.
  118749. */
  118750. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  118751. /**
  118752. * This observable will notify when all animations have paused.
  118753. */
  118754. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  118755. /**
  118756. * This observable will notify when all animations are playing.
  118757. */
  118758. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  118759. /**
  118760. * Gets the first frame
  118761. */
  118762. get from(): number;
  118763. /**
  118764. * Gets the last frame
  118765. */
  118766. get to(): number;
  118767. /**
  118768. * Define if the animations are started
  118769. */
  118770. get isStarted(): boolean;
  118771. /**
  118772. * Gets a value indicating that the current group is playing
  118773. */
  118774. get isPlaying(): boolean;
  118775. /**
  118776. * Gets or sets the speed ratio to use for all animations
  118777. */
  118778. get speedRatio(): number;
  118779. /**
  118780. * Gets or sets the speed ratio to use for all animations
  118781. */
  118782. set speedRatio(value: number);
  118783. /**
  118784. * Gets or sets if all animations should loop or not
  118785. */
  118786. get loopAnimation(): boolean;
  118787. set loopAnimation(value: boolean);
  118788. /**
  118789. * Gets or sets if all animations should be evaluated additively
  118790. */
  118791. get isAdditive(): boolean;
  118792. set isAdditive(value: boolean);
  118793. /**
  118794. * Gets the targeted animations for this animation group
  118795. */
  118796. get targetedAnimations(): Array<TargetedAnimation>;
  118797. /**
  118798. * returning the list of animatables controlled by this animation group.
  118799. */
  118800. get animatables(): Array<Animatable>;
  118801. /**
  118802. * Gets the list of target animations
  118803. */
  118804. get children(): TargetedAnimation[];
  118805. /**
  118806. * Instantiates a new Animation Group.
  118807. * This helps managing several animations at once.
  118808. * @see https://doc.babylonjs.com/how_to/group
  118809. * @param name Defines the name of the group
  118810. * @param scene Defines the scene the group belongs to
  118811. */
  118812. constructor(
  118813. /** The name of the animation group */
  118814. name: string, scene?: Nullable<Scene>);
  118815. /**
  118816. * Add an animation (with its target) in the group
  118817. * @param animation defines the animation we want to add
  118818. * @param target defines the target of the animation
  118819. * @returns the TargetedAnimation object
  118820. */
  118821. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  118822. /**
  118823. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  118824. * It can add constant keys at begin or end
  118825. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  118826. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  118827. * @returns the animation group
  118828. */
  118829. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  118830. private _animationLoopCount;
  118831. private _animationLoopFlags;
  118832. private _processLoop;
  118833. /**
  118834. * Start all animations on given targets
  118835. * @param loop defines if animations must loop
  118836. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  118837. * @param from defines the from key (optional)
  118838. * @param to defines the to key (optional)
  118839. * @param isAdditive defines the additive state for the resulting animatables (optional)
  118840. * @returns the current animation group
  118841. */
  118842. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  118843. /**
  118844. * Pause all animations
  118845. * @returns the animation group
  118846. */
  118847. pause(): AnimationGroup;
  118848. /**
  118849. * Play all animations to initial state
  118850. * This function will start() the animations if they were not started or will restart() them if they were paused
  118851. * @param loop defines if animations must loop
  118852. * @returns the animation group
  118853. */
  118854. play(loop?: boolean): AnimationGroup;
  118855. /**
  118856. * Reset all animations to initial state
  118857. * @returns the animation group
  118858. */
  118859. reset(): AnimationGroup;
  118860. /**
  118861. * Restart animations from key 0
  118862. * @returns the animation group
  118863. */
  118864. restart(): AnimationGroup;
  118865. /**
  118866. * Stop all animations
  118867. * @returns the animation group
  118868. */
  118869. stop(): AnimationGroup;
  118870. /**
  118871. * Set animation weight for all animatables
  118872. * @param weight defines the weight to use
  118873. * @return the animationGroup
  118874. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118875. */
  118876. setWeightForAllAnimatables(weight: number): AnimationGroup;
  118877. /**
  118878. * Synchronize and normalize all animatables with a source animatable
  118879. * @param root defines the root animatable to synchronize with
  118880. * @return the animationGroup
  118881. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118882. */
  118883. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  118884. /**
  118885. * Goes to a specific frame in this animation group
  118886. * @param frame the frame number to go to
  118887. * @return the animationGroup
  118888. */
  118889. goToFrame(frame: number): AnimationGroup;
  118890. /**
  118891. * Dispose all associated resources
  118892. */
  118893. dispose(): void;
  118894. private _checkAnimationGroupEnded;
  118895. /**
  118896. * Clone the current animation group and returns a copy
  118897. * @param newName defines the name of the new group
  118898. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  118899. * @returns the new aniamtion group
  118900. */
  118901. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  118902. /**
  118903. * Serializes the animationGroup to an object
  118904. * @returns Serialized object
  118905. */
  118906. serialize(): any;
  118907. /**
  118908. * Returns a new AnimationGroup object parsed from the source provided.
  118909. * @param parsedAnimationGroup defines the source
  118910. * @param scene defines the scene that will receive the animationGroup
  118911. * @returns a new AnimationGroup
  118912. */
  118913. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  118914. /**
  118915. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  118916. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  118917. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  118918. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  118919. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  118920. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  118921. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  118922. */
  118923. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  118924. /**
  118925. * Returns the string "AnimationGroup"
  118926. * @returns "AnimationGroup"
  118927. */
  118928. getClassName(): string;
  118929. /**
  118930. * Creates a detailled string about the object
  118931. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  118932. * @returns a string representing the object
  118933. */
  118934. toString(fullDetails?: boolean): string;
  118935. }
  118936. }
  118937. declare module BABYLON {
  118938. /**
  118939. * Define an interface for all classes that will hold resources
  118940. */
  118941. export interface IDisposable {
  118942. /**
  118943. * Releases all held resources
  118944. */
  118945. dispose(): void;
  118946. }
  118947. /** Interface defining initialization parameters for Scene class */
  118948. export interface SceneOptions {
  118949. /**
  118950. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  118951. * It will improve performance when the number of geometries becomes important.
  118952. */
  118953. useGeometryUniqueIdsMap?: boolean;
  118954. /**
  118955. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  118956. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118957. */
  118958. useMaterialMeshMap?: boolean;
  118959. /**
  118960. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  118961. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118962. */
  118963. useClonedMeshMap?: boolean;
  118964. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  118965. virtual?: boolean;
  118966. }
  118967. /**
  118968. * Represents a scene to be rendered by the engine.
  118969. * @see https://doc.babylonjs.com/features/scene
  118970. */
  118971. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  118972. /** The fog is deactivated */
  118973. static readonly FOGMODE_NONE: number;
  118974. /** The fog density is following an exponential function */
  118975. static readonly FOGMODE_EXP: number;
  118976. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  118977. static readonly FOGMODE_EXP2: number;
  118978. /** The fog density is following a linear function. */
  118979. static readonly FOGMODE_LINEAR: number;
  118980. /**
  118981. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  118982. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118983. */
  118984. static MinDeltaTime: number;
  118985. /**
  118986. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  118987. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118988. */
  118989. static MaxDeltaTime: number;
  118990. /**
  118991. * Factory used to create the default material.
  118992. * @param name The name of the material to create
  118993. * @param scene The scene to create the material for
  118994. * @returns The default material
  118995. */
  118996. static DefaultMaterialFactory(scene: Scene): Material;
  118997. /**
  118998. * Factory used to create the a collision coordinator.
  118999. * @returns The collision coordinator
  119000. */
  119001. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  119002. /** @hidden */
  119003. _inputManager: InputManager;
  119004. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  119005. cameraToUseForPointers: Nullable<Camera>;
  119006. /** @hidden */
  119007. readonly _isScene: boolean;
  119008. /** @hidden */
  119009. _blockEntityCollection: boolean;
  119010. /**
  119011. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  119012. */
  119013. autoClear: boolean;
  119014. /**
  119015. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  119016. */
  119017. autoClearDepthAndStencil: boolean;
  119018. /**
  119019. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  119020. */
  119021. clearColor: Color4;
  119022. /**
  119023. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  119024. */
  119025. ambientColor: Color3;
  119026. /**
  119027. * This is use to store the default BRDF lookup for PBR materials in your scene.
  119028. * It should only be one of the following (if not the default embedded one):
  119029. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  119030. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  119031. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  119032. * The material properties need to be setup according to the type of texture in use.
  119033. */
  119034. environmentBRDFTexture: BaseTexture;
  119035. /**
  119036. * Texture used in all pbr material as the reflection texture.
  119037. * As in the majority of the scene they are the same (exception for multi room and so on),
  119038. * this is easier to reference from here than from all the materials.
  119039. */
  119040. get environmentTexture(): Nullable<BaseTexture>;
  119041. /**
  119042. * Texture used in all pbr material as the reflection texture.
  119043. * As in the majority of the scene they are the same (exception for multi room and so on),
  119044. * this is easier to set here than in all the materials.
  119045. */
  119046. set environmentTexture(value: Nullable<BaseTexture>);
  119047. /** @hidden */
  119048. protected _environmentIntensity: number;
  119049. /**
  119050. * Intensity of the environment in all pbr material.
  119051. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119052. * As in the majority of the scene they are the same (exception for multi room and so on),
  119053. * this is easier to reference from here than from all the materials.
  119054. */
  119055. get environmentIntensity(): number;
  119056. /**
  119057. * Intensity of the environment in all pbr material.
  119058. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119059. * As in the majority of the scene they are the same (exception for multi room and so on),
  119060. * this is easier to set here than in all the materials.
  119061. */
  119062. set environmentIntensity(value: number);
  119063. /** @hidden */
  119064. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  119065. /**
  119066. * Default image processing configuration used either in the rendering
  119067. * Forward main pass or through the imageProcessingPostProcess if present.
  119068. * As in the majority of the scene they are the same (exception for multi camera),
  119069. * this is easier to reference from here than from all the materials and post process.
  119070. *
  119071. * No setter as we it is a shared configuration, you can set the values instead.
  119072. */
  119073. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  119074. private _forceWireframe;
  119075. /**
  119076. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  119077. */
  119078. set forceWireframe(value: boolean);
  119079. get forceWireframe(): boolean;
  119080. private _skipFrustumClipping;
  119081. /**
  119082. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  119083. */
  119084. set skipFrustumClipping(value: boolean);
  119085. get skipFrustumClipping(): boolean;
  119086. private _forcePointsCloud;
  119087. /**
  119088. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  119089. */
  119090. set forcePointsCloud(value: boolean);
  119091. get forcePointsCloud(): boolean;
  119092. /**
  119093. * Gets or sets the active clipplane 1
  119094. */
  119095. clipPlane: Nullable<Plane>;
  119096. /**
  119097. * Gets or sets the active clipplane 2
  119098. */
  119099. clipPlane2: Nullable<Plane>;
  119100. /**
  119101. * Gets or sets the active clipplane 3
  119102. */
  119103. clipPlane3: Nullable<Plane>;
  119104. /**
  119105. * Gets or sets the active clipplane 4
  119106. */
  119107. clipPlane4: Nullable<Plane>;
  119108. /**
  119109. * Gets or sets the active clipplane 5
  119110. */
  119111. clipPlane5: Nullable<Plane>;
  119112. /**
  119113. * Gets or sets the active clipplane 6
  119114. */
  119115. clipPlane6: Nullable<Plane>;
  119116. /**
  119117. * Gets or sets a boolean indicating if animations are enabled
  119118. */
  119119. animationsEnabled: boolean;
  119120. private _animationPropertiesOverride;
  119121. /**
  119122. * Gets or sets the animation properties override
  119123. */
  119124. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  119125. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  119126. /**
  119127. * Gets or sets a boolean indicating if a constant deltatime has to be used
  119128. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  119129. */
  119130. useConstantAnimationDeltaTime: boolean;
  119131. /**
  119132. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  119133. * Please note that it requires to run a ray cast through the scene on every frame
  119134. */
  119135. constantlyUpdateMeshUnderPointer: boolean;
  119136. /**
  119137. * Defines the HTML cursor to use when hovering over interactive elements
  119138. */
  119139. hoverCursor: string;
  119140. /**
  119141. * Defines the HTML default cursor to use (empty by default)
  119142. */
  119143. defaultCursor: string;
  119144. /**
  119145. * Defines whether cursors are handled by the scene.
  119146. */
  119147. doNotHandleCursors: boolean;
  119148. /**
  119149. * This is used to call preventDefault() on pointer down
  119150. * in order to block unwanted artifacts like system double clicks
  119151. */
  119152. preventDefaultOnPointerDown: boolean;
  119153. /**
  119154. * This is used to call preventDefault() on pointer up
  119155. * in order to block unwanted artifacts like system double clicks
  119156. */
  119157. preventDefaultOnPointerUp: boolean;
  119158. /**
  119159. * Gets or sets user defined metadata
  119160. */
  119161. metadata: any;
  119162. /**
  119163. * For internal use only. Please do not use.
  119164. */
  119165. reservedDataStore: any;
  119166. /**
  119167. * Gets the name of the plugin used to load this scene (null by default)
  119168. */
  119169. loadingPluginName: string;
  119170. /**
  119171. * Use this array to add regular expressions used to disable offline support for specific urls
  119172. */
  119173. disableOfflineSupportExceptionRules: RegExp[];
  119174. /**
  119175. * An event triggered when the scene is disposed.
  119176. */
  119177. onDisposeObservable: Observable<Scene>;
  119178. private _onDisposeObserver;
  119179. /** Sets a function to be executed when this scene is disposed. */
  119180. set onDispose(callback: () => void);
  119181. /**
  119182. * An event triggered before rendering the scene (right after animations and physics)
  119183. */
  119184. onBeforeRenderObservable: Observable<Scene>;
  119185. private _onBeforeRenderObserver;
  119186. /** Sets a function to be executed before rendering this scene */
  119187. set beforeRender(callback: Nullable<() => void>);
  119188. /**
  119189. * An event triggered after rendering the scene
  119190. */
  119191. onAfterRenderObservable: Observable<Scene>;
  119192. /**
  119193. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  119194. */
  119195. onAfterRenderCameraObservable: Observable<Camera>;
  119196. private _onAfterRenderObserver;
  119197. /** Sets a function to be executed after rendering this scene */
  119198. set afterRender(callback: Nullable<() => void>);
  119199. /**
  119200. * An event triggered before animating the scene
  119201. */
  119202. onBeforeAnimationsObservable: Observable<Scene>;
  119203. /**
  119204. * An event triggered after animations processing
  119205. */
  119206. onAfterAnimationsObservable: Observable<Scene>;
  119207. /**
  119208. * An event triggered before draw calls are ready to be sent
  119209. */
  119210. onBeforeDrawPhaseObservable: Observable<Scene>;
  119211. /**
  119212. * An event triggered after draw calls have been sent
  119213. */
  119214. onAfterDrawPhaseObservable: Observable<Scene>;
  119215. /**
  119216. * An event triggered when the scene is ready
  119217. */
  119218. onReadyObservable: Observable<Scene>;
  119219. /**
  119220. * An event triggered before rendering a camera
  119221. */
  119222. onBeforeCameraRenderObservable: Observable<Camera>;
  119223. private _onBeforeCameraRenderObserver;
  119224. /** Sets a function to be executed before rendering a camera*/
  119225. set beforeCameraRender(callback: () => void);
  119226. /**
  119227. * An event triggered after rendering a camera
  119228. */
  119229. onAfterCameraRenderObservable: Observable<Camera>;
  119230. private _onAfterCameraRenderObserver;
  119231. /** Sets a function to be executed after rendering a camera*/
  119232. set afterCameraRender(callback: () => void);
  119233. /**
  119234. * An event triggered when active meshes evaluation is about to start
  119235. */
  119236. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  119237. /**
  119238. * An event triggered when active meshes evaluation is done
  119239. */
  119240. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  119241. /**
  119242. * An event triggered when particles rendering is about to start
  119243. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119244. */
  119245. onBeforeParticlesRenderingObservable: Observable<Scene>;
  119246. /**
  119247. * An event triggered when particles rendering is done
  119248. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119249. */
  119250. onAfterParticlesRenderingObservable: Observable<Scene>;
  119251. /**
  119252. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  119253. */
  119254. onDataLoadedObservable: Observable<Scene>;
  119255. /**
  119256. * An event triggered when a camera is created
  119257. */
  119258. onNewCameraAddedObservable: Observable<Camera>;
  119259. /**
  119260. * An event triggered when a camera is removed
  119261. */
  119262. onCameraRemovedObservable: Observable<Camera>;
  119263. /**
  119264. * An event triggered when a light is created
  119265. */
  119266. onNewLightAddedObservable: Observable<Light>;
  119267. /**
  119268. * An event triggered when a light is removed
  119269. */
  119270. onLightRemovedObservable: Observable<Light>;
  119271. /**
  119272. * An event triggered when a geometry is created
  119273. */
  119274. onNewGeometryAddedObservable: Observable<Geometry>;
  119275. /**
  119276. * An event triggered when a geometry is removed
  119277. */
  119278. onGeometryRemovedObservable: Observable<Geometry>;
  119279. /**
  119280. * An event triggered when a transform node is created
  119281. */
  119282. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  119283. /**
  119284. * An event triggered when a transform node is removed
  119285. */
  119286. onTransformNodeRemovedObservable: Observable<TransformNode>;
  119287. /**
  119288. * An event triggered when a mesh is created
  119289. */
  119290. onNewMeshAddedObservable: Observable<AbstractMesh>;
  119291. /**
  119292. * An event triggered when a mesh is removed
  119293. */
  119294. onMeshRemovedObservable: Observable<AbstractMesh>;
  119295. /**
  119296. * An event triggered when a skeleton is created
  119297. */
  119298. onNewSkeletonAddedObservable: Observable<Skeleton>;
  119299. /**
  119300. * An event triggered when a skeleton is removed
  119301. */
  119302. onSkeletonRemovedObservable: Observable<Skeleton>;
  119303. /**
  119304. * An event triggered when a material is created
  119305. */
  119306. onNewMaterialAddedObservable: Observable<Material>;
  119307. /**
  119308. * An event triggered when a material is removed
  119309. */
  119310. onMaterialRemovedObservable: Observable<Material>;
  119311. /**
  119312. * An event triggered when a texture is created
  119313. */
  119314. onNewTextureAddedObservable: Observable<BaseTexture>;
  119315. /**
  119316. * An event triggered when a texture is removed
  119317. */
  119318. onTextureRemovedObservable: Observable<BaseTexture>;
  119319. /**
  119320. * An event triggered when render targets are about to be rendered
  119321. * Can happen multiple times per frame.
  119322. */
  119323. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  119324. /**
  119325. * An event triggered when render targets were rendered.
  119326. * Can happen multiple times per frame.
  119327. */
  119328. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  119329. /**
  119330. * An event triggered before calculating deterministic simulation step
  119331. */
  119332. onBeforeStepObservable: Observable<Scene>;
  119333. /**
  119334. * An event triggered after calculating deterministic simulation step
  119335. */
  119336. onAfterStepObservable: Observable<Scene>;
  119337. /**
  119338. * An event triggered when the activeCamera property is updated
  119339. */
  119340. onActiveCameraChanged: Observable<Scene>;
  119341. /**
  119342. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  119343. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119344. * 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)
  119345. */
  119346. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119347. /**
  119348. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  119349. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119350. * 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)
  119351. */
  119352. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119353. /**
  119354. * This Observable will when a mesh has been imported into the scene.
  119355. */
  119356. onMeshImportedObservable: Observable<AbstractMesh>;
  119357. /**
  119358. * This Observable will when an animation file has been imported into the scene.
  119359. */
  119360. onAnimationFileImportedObservable: Observable<Scene>;
  119361. /**
  119362. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  119363. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  119364. */
  119365. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  119366. /** @hidden */
  119367. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  119368. /**
  119369. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  119370. */
  119371. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  119372. /**
  119373. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  119374. */
  119375. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  119376. /**
  119377. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  119378. */
  119379. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  119380. /** Callback called when a pointer move is detected */
  119381. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119382. /** Callback called when a pointer down is detected */
  119383. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119384. /** Callback called when a pointer up is detected */
  119385. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  119386. /** Callback called when a pointer pick is detected */
  119387. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  119388. /**
  119389. * 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).
  119390. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  119391. */
  119392. onPrePointerObservable: Observable<PointerInfoPre>;
  119393. /**
  119394. * Observable event triggered each time an input event is received from the rendering canvas
  119395. */
  119396. onPointerObservable: Observable<PointerInfo>;
  119397. /**
  119398. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  119399. */
  119400. get unTranslatedPointer(): Vector2;
  119401. /**
  119402. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  119403. */
  119404. static get DragMovementThreshold(): number;
  119405. static set DragMovementThreshold(value: number);
  119406. /**
  119407. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  119408. */
  119409. static get LongPressDelay(): number;
  119410. static set LongPressDelay(value: number);
  119411. /**
  119412. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  119413. */
  119414. static get DoubleClickDelay(): number;
  119415. static set DoubleClickDelay(value: number);
  119416. /** If you need to check double click without raising a single click at first click, enable this flag */
  119417. static get ExclusiveDoubleClickMode(): boolean;
  119418. static set ExclusiveDoubleClickMode(value: boolean);
  119419. /** @hidden */
  119420. _mirroredCameraPosition: Nullable<Vector3>;
  119421. /**
  119422. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  119423. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  119424. */
  119425. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  119426. /**
  119427. * Observable event triggered each time an keyboard event is received from the hosting window
  119428. */
  119429. onKeyboardObservable: Observable<KeyboardInfo>;
  119430. private _useRightHandedSystem;
  119431. /**
  119432. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  119433. */
  119434. set useRightHandedSystem(value: boolean);
  119435. get useRightHandedSystem(): boolean;
  119436. private _timeAccumulator;
  119437. private _currentStepId;
  119438. private _currentInternalStep;
  119439. /**
  119440. * Sets the step Id used by deterministic lock step
  119441. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119442. * @param newStepId defines the step Id
  119443. */
  119444. setStepId(newStepId: number): void;
  119445. /**
  119446. * Gets the step Id used by deterministic lock step
  119447. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119448. * @returns the step Id
  119449. */
  119450. getStepId(): number;
  119451. /**
  119452. * Gets the internal step used by deterministic lock step
  119453. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119454. * @returns the internal step
  119455. */
  119456. getInternalStep(): number;
  119457. private _fogEnabled;
  119458. /**
  119459. * Gets or sets a boolean indicating if fog is enabled on this scene
  119460. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119461. * (Default is true)
  119462. */
  119463. set fogEnabled(value: boolean);
  119464. get fogEnabled(): boolean;
  119465. private _fogMode;
  119466. /**
  119467. * Gets or sets the fog mode to use
  119468. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119469. * | mode | value |
  119470. * | --- | --- |
  119471. * | FOGMODE_NONE | 0 |
  119472. * | FOGMODE_EXP | 1 |
  119473. * | FOGMODE_EXP2 | 2 |
  119474. * | FOGMODE_LINEAR | 3 |
  119475. */
  119476. set fogMode(value: number);
  119477. get fogMode(): number;
  119478. /**
  119479. * Gets or sets the fog color to use
  119480. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119481. * (Default is Color3(0.2, 0.2, 0.3))
  119482. */
  119483. fogColor: Color3;
  119484. /**
  119485. * Gets or sets the fog density to use
  119486. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119487. * (Default is 0.1)
  119488. */
  119489. fogDensity: number;
  119490. /**
  119491. * Gets or sets the fog start distance to use
  119492. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119493. * (Default is 0)
  119494. */
  119495. fogStart: number;
  119496. /**
  119497. * Gets or sets the fog end distance to use
  119498. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119499. * (Default is 1000)
  119500. */
  119501. fogEnd: number;
  119502. /**
  119503. * Flag indicating that the frame buffer binding is handled by another component
  119504. */
  119505. prePass: boolean;
  119506. private _shadowsEnabled;
  119507. /**
  119508. * Gets or sets a boolean indicating if shadows are enabled on this scene
  119509. */
  119510. set shadowsEnabled(value: boolean);
  119511. get shadowsEnabled(): boolean;
  119512. private _lightsEnabled;
  119513. /**
  119514. * Gets or sets a boolean indicating if lights are enabled on this scene
  119515. */
  119516. set lightsEnabled(value: boolean);
  119517. get lightsEnabled(): boolean;
  119518. /** All of the active cameras added to this scene. */
  119519. activeCameras: Camera[];
  119520. /** @hidden */
  119521. _activeCamera: Nullable<Camera>;
  119522. /** Gets or sets the current active camera */
  119523. get activeCamera(): Nullable<Camera>;
  119524. set activeCamera(value: Nullable<Camera>);
  119525. private _defaultMaterial;
  119526. /** The default material used on meshes when no material is affected */
  119527. get defaultMaterial(): Material;
  119528. /** The default material used on meshes when no material is affected */
  119529. set defaultMaterial(value: Material);
  119530. private _texturesEnabled;
  119531. /**
  119532. * Gets or sets a boolean indicating if textures are enabled on this scene
  119533. */
  119534. set texturesEnabled(value: boolean);
  119535. get texturesEnabled(): boolean;
  119536. /**
  119537. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  119538. */
  119539. physicsEnabled: boolean;
  119540. /**
  119541. * Gets or sets a boolean indicating if particles are enabled on this scene
  119542. */
  119543. particlesEnabled: boolean;
  119544. /**
  119545. * Gets or sets a boolean indicating if sprites are enabled on this scene
  119546. */
  119547. spritesEnabled: boolean;
  119548. private _skeletonsEnabled;
  119549. /**
  119550. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  119551. */
  119552. set skeletonsEnabled(value: boolean);
  119553. get skeletonsEnabled(): boolean;
  119554. /**
  119555. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  119556. */
  119557. lensFlaresEnabled: boolean;
  119558. /**
  119559. * Gets or sets a boolean indicating if collisions are enabled on this scene
  119560. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119561. */
  119562. collisionsEnabled: boolean;
  119563. private _collisionCoordinator;
  119564. /** @hidden */
  119565. get collisionCoordinator(): ICollisionCoordinator;
  119566. /**
  119567. * Defines the gravity applied to this scene (used only for collisions)
  119568. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119569. */
  119570. gravity: Vector3;
  119571. /**
  119572. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  119573. */
  119574. postProcessesEnabled: boolean;
  119575. /**
  119576. * Gets the current postprocess manager
  119577. */
  119578. postProcessManager: PostProcessManager;
  119579. /**
  119580. * Gets or sets a boolean indicating if render targets are enabled on this scene
  119581. */
  119582. renderTargetsEnabled: boolean;
  119583. /**
  119584. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  119585. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  119586. */
  119587. dumpNextRenderTargets: boolean;
  119588. /**
  119589. * The list of user defined render targets added to the scene
  119590. */
  119591. customRenderTargets: RenderTargetTexture[];
  119592. /**
  119593. * Defines if texture loading must be delayed
  119594. * If true, textures will only be loaded when they need to be rendered
  119595. */
  119596. useDelayedTextureLoading: boolean;
  119597. /**
  119598. * Gets the list of meshes imported to the scene through SceneLoader
  119599. */
  119600. importedMeshesFiles: String[];
  119601. /**
  119602. * Gets or sets a boolean indicating if probes are enabled on this scene
  119603. */
  119604. probesEnabled: boolean;
  119605. /**
  119606. * Gets or sets the current offline provider to use to store scene data
  119607. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  119608. */
  119609. offlineProvider: IOfflineProvider;
  119610. /**
  119611. * Gets or sets the action manager associated with the scene
  119612. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  119613. */
  119614. actionManager: AbstractActionManager;
  119615. private _meshesForIntersections;
  119616. /**
  119617. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  119618. */
  119619. proceduralTexturesEnabled: boolean;
  119620. private _engine;
  119621. private _totalVertices;
  119622. /** @hidden */
  119623. _activeIndices: PerfCounter;
  119624. /** @hidden */
  119625. _activeParticles: PerfCounter;
  119626. /** @hidden */
  119627. _activeBones: PerfCounter;
  119628. private _animationRatio;
  119629. /** @hidden */
  119630. _animationTimeLast: number;
  119631. /** @hidden */
  119632. _animationTime: number;
  119633. /**
  119634. * Gets or sets a general scale for animation speed
  119635. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  119636. */
  119637. animationTimeScale: number;
  119638. /** @hidden */
  119639. _cachedMaterial: Nullable<Material>;
  119640. /** @hidden */
  119641. _cachedEffect: Nullable<Effect>;
  119642. /** @hidden */
  119643. _cachedVisibility: Nullable<number>;
  119644. private _renderId;
  119645. private _frameId;
  119646. private _executeWhenReadyTimeoutId;
  119647. private _intermediateRendering;
  119648. private _viewUpdateFlag;
  119649. private _projectionUpdateFlag;
  119650. /** @hidden */
  119651. _toBeDisposed: Nullable<IDisposable>[];
  119652. private _activeRequests;
  119653. /** @hidden */
  119654. _pendingData: any[];
  119655. private _isDisposed;
  119656. /**
  119657. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  119658. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  119659. */
  119660. dispatchAllSubMeshesOfActiveMeshes: boolean;
  119661. private _activeMeshes;
  119662. private _processedMaterials;
  119663. private _renderTargets;
  119664. /** @hidden */
  119665. _activeParticleSystems: SmartArray<IParticleSystem>;
  119666. private _activeSkeletons;
  119667. private _softwareSkinnedMeshes;
  119668. private _renderingManager;
  119669. /** @hidden */
  119670. _activeAnimatables: Animatable[];
  119671. private _transformMatrix;
  119672. private _sceneUbo;
  119673. /** @hidden */
  119674. _viewMatrix: Matrix;
  119675. private _projectionMatrix;
  119676. /** @hidden */
  119677. _forcedViewPosition: Nullable<Vector3>;
  119678. /** @hidden */
  119679. _frustumPlanes: Plane[];
  119680. /**
  119681. * Gets the list of frustum planes (built from the active camera)
  119682. */
  119683. get frustumPlanes(): Plane[];
  119684. /**
  119685. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  119686. * This is useful if there are more lights that the maximum simulteanous authorized
  119687. */
  119688. requireLightSorting: boolean;
  119689. /** @hidden */
  119690. readonly useMaterialMeshMap: boolean;
  119691. /** @hidden */
  119692. readonly useClonedMeshMap: boolean;
  119693. private _externalData;
  119694. private _uid;
  119695. /**
  119696. * @hidden
  119697. * Backing store of defined scene components.
  119698. */
  119699. _components: ISceneComponent[];
  119700. /**
  119701. * @hidden
  119702. * Backing store of defined scene components.
  119703. */
  119704. _serializableComponents: ISceneSerializableComponent[];
  119705. /**
  119706. * List of components to register on the next registration step.
  119707. */
  119708. private _transientComponents;
  119709. /**
  119710. * Registers the transient components if needed.
  119711. */
  119712. private _registerTransientComponents;
  119713. /**
  119714. * @hidden
  119715. * Add a component to the scene.
  119716. * Note that the ccomponent could be registered on th next frame if this is called after
  119717. * the register component stage.
  119718. * @param component Defines the component to add to the scene
  119719. */
  119720. _addComponent(component: ISceneComponent): void;
  119721. /**
  119722. * @hidden
  119723. * Gets a component from the scene.
  119724. * @param name defines the name of the component to retrieve
  119725. * @returns the component or null if not present
  119726. */
  119727. _getComponent(name: string): Nullable<ISceneComponent>;
  119728. /**
  119729. * @hidden
  119730. * Defines the actions happening before camera updates.
  119731. */
  119732. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  119733. /**
  119734. * @hidden
  119735. * Defines the actions happening before clear the canvas.
  119736. */
  119737. _beforeClearStage: Stage<SimpleStageAction>;
  119738. /**
  119739. * @hidden
  119740. * Defines the actions when collecting render targets for the frame.
  119741. */
  119742. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119743. /**
  119744. * @hidden
  119745. * Defines the actions happening for one camera in the frame.
  119746. */
  119747. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119748. /**
  119749. * @hidden
  119750. * Defines the actions happening during the per mesh ready checks.
  119751. */
  119752. _isReadyForMeshStage: Stage<MeshStageAction>;
  119753. /**
  119754. * @hidden
  119755. * Defines the actions happening before evaluate active mesh checks.
  119756. */
  119757. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  119758. /**
  119759. * @hidden
  119760. * Defines the actions happening during the evaluate sub mesh checks.
  119761. */
  119762. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  119763. /**
  119764. * @hidden
  119765. * Defines the actions happening during the active mesh stage.
  119766. */
  119767. _activeMeshStage: Stage<ActiveMeshStageAction>;
  119768. /**
  119769. * @hidden
  119770. * Defines the actions happening during the per camera render target step.
  119771. */
  119772. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  119773. /**
  119774. * @hidden
  119775. * Defines the actions happening just before the active camera is drawing.
  119776. */
  119777. _beforeCameraDrawStage: Stage<CameraStageAction>;
  119778. /**
  119779. * @hidden
  119780. * Defines the actions happening just before a render target is drawing.
  119781. */
  119782. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119783. /**
  119784. * @hidden
  119785. * Defines the actions happening just before a rendering group is drawing.
  119786. */
  119787. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119788. /**
  119789. * @hidden
  119790. * Defines the actions happening just before a mesh is drawing.
  119791. */
  119792. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119793. /**
  119794. * @hidden
  119795. * Defines the actions happening just after a mesh has been drawn.
  119796. */
  119797. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119798. /**
  119799. * @hidden
  119800. * Defines the actions happening just after a rendering group has been drawn.
  119801. */
  119802. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119803. /**
  119804. * @hidden
  119805. * Defines the actions happening just after the active camera has been drawn.
  119806. */
  119807. _afterCameraDrawStage: Stage<CameraStageAction>;
  119808. /**
  119809. * @hidden
  119810. * Defines the actions happening just after a render target has been drawn.
  119811. */
  119812. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119813. /**
  119814. * @hidden
  119815. * Defines the actions happening just after rendering all cameras and computing intersections.
  119816. */
  119817. _afterRenderStage: Stage<SimpleStageAction>;
  119818. /**
  119819. * @hidden
  119820. * Defines the actions happening when a pointer move event happens.
  119821. */
  119822. _pointerMoveStage: Stage<PointerMoveStageAction>;
  119823. /**
  119824. * @hidden
  119825. * Defines the actions happening when a pointer down event happens.
  119826. */
  119827. _pointerDownStage: Stage<PointerUpDownStageAction>;
  119828. /**
  119829. * @hidden
  119830. * Defines the actions happening when a pointer up event happens.
  119831. */
  119832. _pointerUpStage: Stage<PointerUpDownStageAction>;
  119833. /**
  119834. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  119835. */
  119836. private geometriesByUniqueId;
  119837. /**
  119838. * Creates a new Scene
  119839. * @param engine defines the engine to use to render this scene
  119840. * @param options defines the scene options
  119841. */
  119842. constructor(engine: Engine, options?: SceneOptions);
  119843. /**
  119844. * Gets a string identifying the name of the class
  119845. * @returns "Scene" string
  119846. */
  119847. getClassName(): string;
  119848. private _defaultMeshCandidates;
  119849. /**
  119850. * @hidden
  119851. */
  119852. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  119853. private _defaultSubMeshCandidates;
  119854. /**
  119855. * @hidden
  119856. */
  119857. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  119858. /**
  119859. * Sets the default candidate providers for the scene.
  119860. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  119861. * and getCollidingSubMeshCandidates to their default function
  119862. */
  119863. setDefaultCandidateProviders(): void;
  119864. /**
  119865. * Gets the mesh that is currently under the pointer
  119866. */
  119867. get meshUnderPointer(): Nullable<AbstractMesh>;
  119868. /**
  119869. * Gets or sets the current on-screen X position of the pointer
  119870. */
  119871. get pointerX(): number;
  119872. set pointerX(value: number);
  119873. /**
  119874. * Gets or sets the current on-screen Y position of the pointer
  119875. */
  119876. get pointerY(): number;
  119877. set pointerY(value: number);
  119878. /**
  119879. * Gets the cached material (ie. the latest rendered one)
  119880. * @returns the cached material
  119881. */
  119882. getCachedMaterial(): Nullable<Material>;
  119883. /**
  119884. * Gets the cached effect (ie. the latest rendered one)
  119885. * @returns the cached effect
  119886. */
  119887. getCachedEffect(): Nullable<Effect>;
  119888. /**
  119889. * Gets the cached visibility state (ie. the latest rendered one)
  119890. * @returns the cached visibility state
  119891. */
  119892. getCachedVisibility(): Nullable<number>;
  119893. /**
  119894. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  119895. * @param material defines the current material
  119896. * @param effect defines the current effect
  119897. * @param visibility defines the current visibility state
  119898. * @returns true if one parameter is not cached
  119899. */
  119900. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  119901. /**
  119902. * Gets the engine associated with the scene
  119903. * @returns an Engine
  119904. */
  119905. getEngine(): Engine;
  119906. /**
  119907. * Gets the total number of vertices rendered per frame
  119908. * @returns the total number of vertices rendered per frame
  119909. */
  119910. getTotalVertices(): number;
  119911. /**
  119912. * Gets the performance counter for total vertices
  119913. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119914. */
  119915. get totalVerticesPerfCounter(): PerfCounter;
  119916. /**
  119917. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  119918. * @returns the total number of active indices rendered per frame
  119919. */
  119920. getActiveIndices(): number;
  119921. /**
  119922. * Gets the performance counter for active indices
  119923. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119924. */
  119925. get totalActiveIndicesPerfCounter(): PerfCounter;
  119926. /**
  119927. * Gets the total number of active particles rendered per frame
  119928. * @returns the total number of active particles rendered per frame
  119929. */
  119930. getActiveParticles(): number;
  119931. /**
  119932. * Gets the performance counter for active particles
  119933. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119934. */
  119935. get activeParticlesPerfCounter(): PerfCounter;
  119936. /**
  119937. * Gets the total number of active bones rendered per frame
  119938. * @returns the total number of active bones rendered per frame
  119939. */
  119940. getActiveBones(): number;
  119941. /**
  119942. * Gets the performance counter for active bones
  119943. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119944. */
  119945. get activeBonesPerfCounter(): PerfCounter;
  119946. /**
  119947. * Gets the array of active meshes
  119948. * @returns an array of AbstractMesh
  119949. */
  119950. getActiveMeshes(): SmartArray<AbstractMesh>;
  119951. /**
  119952. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  119953. * @returns a number
  119954. */
  119955. getAnimationRatio(): number;
  119956. /**
  119957. * Gets an unique Id for the current render phase
  119958. * @returns a number
  119959. */
  119960. getRenderId(): number;
  119961. /**
  119962. * Gets an unique Id for the current frame
  119963. * @returns a number
  119964. */
  119965. getFrameId(): number;
  119966. /** Call this function if you want to manually increment the render Id*/
  119967. incrementRenderId(): void;
  119968. private _createUbo;
  119969. /**
  119970. * Use this method to simulate a pointer move on a mesh
  119971. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119972. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119973. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119974. * @returns the current scene
  119975. */
  119976. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119977. /**
  119978. * Use this method to simulate a pointer down on a mesh
  119979. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119980. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119981. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119982. * @returns the current scene
  119983. */
  119984. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119985. /**
  119986. * Use this method to simulate a pointer up on a mesh
  119987. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119988. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119989. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119990. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  119991. * @returns the current scene
  119992. */
  119993. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  119994. /**
  119995. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  119996. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  119997. * @returns true if the pointer was captured
  119998. */
  119999. isPointerCaptured(pointerId?: number): boolean;
  120000. /**
  120001. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  120002. * @param attachUp defines if you want to attach events to pointerup
  120003. * @param attachDown defines if you want to attach events to pointerdown
  120004. * @param attachMove defines if you want to attach events to pointermove
  120005. */
  120006. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  120007. /** Detaches all event handlers*/
  120008. detachControl(): void;
  120009. /**
  120010. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  120011. * Delay loaded resources are not taking in account
  120012. * @return true if all required resources are ready
  120013. */
  120014. isReady(): boolean;
  120015. /** Resets all cached information relative to material (including effect and visibility) */
  120016. resetCachedMaterial(): void;
  120017. /**
  120018. * Registers a function to be called before every frame render
  120019. * @param func defines the function to register
  120020. */
  120021. registerBeforeRender(func: () => void): void;
  120022. /**
  120023. * Unregisters a function called before every frame render
  120024. * @param func defines the function to unregister
  120025. */
  120026. unregisterBeforeRender(func: () => void): void;
  120027. /**
  120028. * Registers a function to be called after every frame render
  120029. * @param func defines the function to register
  120030. */
  120031. registerAfterRender(func: () => void): void;
  120032. /**
  120033. * Unregisters a function called after every frame render
  120034. * @param func defines the function to unregister
  120035. */
  120036. unregisterAfterRender(func: () => void): void;
  120037. private _executeOnceBeforeRender;
  120038. /**
  120039. * The provided function will run before render once and will be disposed afterwards.
  120040. * A timeout delay can be provided so that the function will be executed in N ms.
  120041. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  120042. * @param func The function to be executed.
  120043. * @param timeout optional delay in ms
  120044. */
  120045. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  120046. /** @hidden */
  120047. _addPendingData(data: any): void;
  120048. /** @hidden */
  120049. _removePendingData(data: any): void;
  120050. /**
  120051. * Returns the number of items waiting to be loaded
  120052. * @returns the number of items waiting to be loaded
  120053. */
  120054. getWaitingItemsCount(): number;
  120055. /**
  120056. * Returns a boolean indicating if the scene is still loading data
  120057. */
  120058. get isLoading(): boolean;
  120059. /**
  120060. * Registers a function to be executed when the scene is ready
  120061. * @param {Function} func - the function to be executed
  120062. */
  120063. executeWhenReady(func: () => void): void;
  120064. /**
  120065. * Returns a promise that resolves when the scene is ready
  120066. * @returns A promise that resolves when the scene is ready
  120067. */
  120068. whenReadyAsync(): Promise<void>;
  120069. /** @hidden */
  120070. _checkIsReady(): void;
  120071. /**
  120072. * Gets all animatable attached to the scene
  120073. */
  120074. get animatables(): Animatable[];
  120075. /**
  120076. * Resets the last animation time frame.
  120077. * Useful to override when animations start running when loading a scene for the first time.
  120078. */
  120079. resetLastAnimationTimeFrame(): void;
  120080. /**
  120081. * Gets the current view matrix
  120082. * @returns a Matrix
  120083. */
  120084. getViewMatrix(): Matrix;
  120085. /**
  120086. * Gets the current projection matrix
  120087. * @returns a Matrix
  120088. */
  120089. getProjectionMatrix(): Matrix;
  120090. /**
  120091. * Gets the current transform matrix
  120092. * @returns a Matrix made of View * Projection
  120093. */
  120094. getTransformMatrix(): Matrix;
  120095. /**
  120096. * Sets the current transform matrix
  120097. * @param viewL defines the View matrix to use
  120098. * @param projectionL defines the Projection matrix to use
  120099. * @param viewR defines the right View matrix to use (if provided)
  120100. * @param projectionR defines the right Projection matrix to use (if provided)
  120101. */
  120102. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  120103. /**
  120104. * Gets the uniform buffer used to store scene data
  120105. * @returns a UniformBuffer
  120106. */
  120107. getSceneUniformBuffer(): UniformBuffer;
  120108. /**
  120109. * Gets an unique (relatively to the current scene) Id
  120110. * @returns an unique number for the scene
  120111. */
  120112. getUniqueId(): number;
  120113. /**
  120114. * Add a mesh to the list of scene's meshes
  120115. * @param newMesh defines the mesh to add
  120116. * @param recursive if all child meshes should also be added to the scene
  120117. */
  120118. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  120119. /**
  120120. * Remove a mesh for the list of scene's meshes
  120121. * @param toRemove defines the mesh to remove
  120122. * @param recursive if all child meshes should also be removed from the scene
  120123. * @returns the index where the mesh was in the mesh list
  120124. */
  120125. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  120126. /**
  120127. * Add a transform node to the list of scene's transform nodes
  120128. * @param newTransformNode defines the transform node to add
  120129. */
  120130. addTransformNode(newTransformNode: TransformNode): void;
  120131. /**
  120132. * Remove a transform node for the list of scene's transform nodes
  120133. * @param toRemove defines the transform node to remove
  120134. * @returns the index where the transform node was in the transform node list
  120135. */
  120136. removeTransformNode(toRemove: TransformNode): number;
  120137. /**
  120138. * Remove a skeleton for the list of scene's skeletons
  120139. * @param toRemove defines the skeleton to remove
  120140. * @returns the index where the skeleton was in the skeleton list
  120141. */
  120142. removeSkeleton(toRemove: Skeleton): number;
  120143. /**
  120144. * Remove a morph target for the list of scene's morph targets
  120145. * @param toRemove defines the morph target to remove
  120146. * @returns the index where the morph target was in the morph target list
  120147. */
  120148. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  120149. /**
  120150. * Remove a light for the list of scene's lights
  120151. * @param toRemove defines the light to remove
  120152. * @returns the index where the light was in the light list
  120153. */
  120154. removeLight(toRemove: Light): number;
  120155. /**
  120156. * Remove a camera for the list of scene's cameras
  120157. * @param toRemove defines the camera to remove
  120158. * @returns the index where the camera was in the camera list
  120159. */
  120160. removeCamera(toRemove: Camera): number;
  120161. /**
  120162. * Remove a particle system for the list of scene's particle systems
  120163. * @param toRemove defines the particle system to remove
  120164. * @returns the index where the particle system was in the particle system list
  120165. */
  120166. removeParticleSystem(toRemove: IParticleSystem): number;
  120167. /**
  120168. * Remove a animation for the list of scene's animations
  120169. * @param toRemove defines the animation to remove
  120170. * @returns the index where the animation was in the animation list
  120171. */
  120172. removeAnimation(toRemove: Animation): number;
  120173. /**
  120174. * Will stop the animation of the given target
  120175. * @param target - the target
  120176. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  120177. * @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)
  120178. */
  120179. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  120180. /**
  120181. * Removes the given animation group from this scene.
  120182. * @param toRemove The animation group to remove
  120183. * @returns The index of the removed animation group
  120184. */
  120185. removeAnimationGroup(toRemove: AnimationGroup): number;
  120186. /**
  120187. * Removes the given multi-material from this scene.
  120188. * @param toRemove The multi-material to remove
  120189. * @returns The index of the removed multi-material
  120190. */
  120191. removeMultiMaterial(toRemove: MultiMaterial): number;
  120192. /**
  120193. * Removes the given material from this scene.
  120194. * @param toRemove The material to remove
  120195. * @returns The index of the removed material
  120196. */
  120197. removeMaterial(toRemove: Material): number;
  120198. /**
  120199. * Removes the given action manager from this scene.
  120200. * @param toRemove The action manager to remove
  120201. * @returns The index of the removed action manager
  120202. */
  120203. removeActionManager(toRemove: AbstractActionManager): number;
  120204. /**
  120205. * Removes the given texture from this scene.
  120206. * @param toRemove The texture to remove
  120207. * @returns The index of the removed texture
  120208. */
  120209. removeTexture(toRemove: BaseTexture): number;
  120210. /**
  120211. * Adds the given light to this scene
  120212. * @param newLight The light to add
  120213. */
  120214. addLight(newLight: Light): void;
  120215. /**
  120216. * Sorts the list list based on light priorities
  120217. */
  120218. sortLightsByPriority(): void;
  120219. /**
  120220. * Adds the given camera to this scene
  120221. * @param newCamera The camera to add
  120222. */
  120223. addCamera(newCamera: Camera): void;
  120224. /**
  120225. * Adds the given skeleton to this scene
  120226. * @param newSkeleton The skeleton to add
  120227. */
  120228. addSkeleton(newSkeleton: Skeleton): void;
  120229. /**
  120230. * Adds the given particle system to this scene
  120231. * @param newParticleSystem The particle system to add
  120232. */
  120233. addParticleSystem(newParticleSystem: IParticleSystem): void;
  120234. /**
  120235. * Adds the given animation to this scene
  120236. * @param newAnimation The animation to add
  120237. */
  120238. addAnimation(newAnimation: Animation): void;
  120239. /**
  120240. * Adds the given animation group to this scene.
  120241. * @param newAnimationGroup The animation group to add
  120242. */
  120243. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  120244. /**
  120245. * Adds the given multi-material to this scene
  120246. * @param newMultiMaterial The multi-material to add
  120247. */
  120248. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  120249. /**
  120250. * Adds the given material to this scene
  120251. * @param newMaterial The material to add
  120252. */
  120253. addMaterial(newMaterial: Material): void;
  120254. /**
  120255. * Adds the given morph target to this scene
  120256. * @param newMorphTargetManager The morph target to add
  120257. */
  120258. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  120259. /**
  120260. * Adds the given geometry to this scene
  120261. * @param newGeometry The geometry to add
  120262. */
  120263. addGeometry(newGeometry: Geometry): void;
  120264. /**
  120265. * Adds the given action manager to this scene
  120266. * @param newActionManager The action manager to add
  120267. */
  120268. addActionManager(newActionManager: AbstractActionManager): void;
  120269. /**
  120270. * Adds the given texture to this scene.
  120271. * @param newTexture The texture to add
  120272. */
  120273. addTexture(newTexture: BaseTexture): void;
  120274. /**
  120275. * Switch active camera
  120276. * @param newCamera defines the new active camera
  120277. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  120278. */
  120279. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  120280. /**
  120281. * sets the active camera of the scene using its ID
  120282. * @param id defines the camera's ID
  120283. * @return the new active camera or null if none found.
  120284. */
  120285. setActiveCameraByID(id: string): Nullable<Camera>;
  120286. /**
  120287. * sets the active camera of the scene using its name
  120288. * @param name defines the camera's name
  120289. * @returns the new active camera or null if none found.
  120290. */
  120291. setActiveCameraByName(name: string): Nullable<Camera>;
  120292. /**
  120293. * get an animation group using its name
  120294. * @param name defines the material's name
  120295. * @return the animation group or null if none found.
  120296. */
  120297. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  120298. /**
  120299. * Get a material using its unique id
  120300. * @param uniqueId defines the material's unique id
  120301. * @return the material or null if none found.
  120302. */
  120303. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  120304. /**
  120305. * get a material using its id
  120306. * @param id defines the material's ID
  120307. * @return the material or null if none found.
  120308. */
  120309. getMaterialByID(id: string): Nullable<Material>;
  120310. /**
  120311. * Gets a the last added material using a given id
  120312. * @param id defines the material's ID
  120313. * @return the last material with the given id or null if none found.
  120314. */
  120315. getLastMaterialByID(id: string): Nullable<Material>;
  120316. /**
  120317. * Gets a material using its name
  120318. * @param name defines the material's name
  120319. * @return the material or null if none found.
  120320. */
  120321. getMaterialByName(name: string): Nullable<Material>;
  120322. /**
  120323. * Get a texture using its unique id
  120324. * @param uniqueId defines the texture's unique id
  120325. * @return the texture or null if none found.
  120326. */
  120327. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  120328. /**
  120329. * Gets a camera using its id
  120330. * @param id defines the id to look for
  120331. * @returns the camera or null if not found
  120332. */
  120333. getCameraByID(id: string): Nullable<Camera>;
  120334. /**
  120335. * Gets a camera using its unique id
  120336. * @param uniqueId defines the unique id to look for
  120337. * @returns the camera or null if not found
  120338. */
  120339. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  120340. /**
  120341. * Gets a camera using its name
  120342. * @param name defines the camera's name
  120343. * @return the camera or null if none found.
  120344. */
  120345. getCameraByName(name: string): Nullable<Camera>;
  120346. /**
  120347. * Gets a bone using its id
  120348. * @param id defines the bone's id
  120349. * @return the bone or null if not found
  120350. */
  120351. getBoneByID(id: string): Nullable<Bone>;
  120352. /**
  120353. * Gets a bone using its id
  120354. * @param name defines the bone's name
  120355. * @return the bone or null if not found
  120356. */
  120357. getBoneByName(name: string): Nullable<Bone>;
  120358. /**
  120359. * Gets a light node using its name
  120360. * @param name defines the the light's name
  120361. * @return the light or null if none found.
  120362. */
  120363. getLightByName(name: string): Nullable<Light>;
  120364. /**
  120365. * Gets a light node using its id
  120366. * @param id defines the light's id
  120367. * @return the light or null if none found.
  120368. */
  120369. getLightByID(id: string): Nullable<Light>;
  120370. /**
  120371. * Gets a light node using its scene-generated unique ID
  120372. * @param uniqueId defines the light's unique id
  120373. * @return the light or null if none found.
  120374. */
  120375. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  120376. /**
  120377. * Gets a particle system by id
  120378. * @param id defines the particle system id
  120379. * @return the corresponding system or null if none found
  120380. */
  120381. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  120382. /**
  120383. * Gets a geometry using its ID
  120384. * @param id defines the geometry's id
  120385. * @return the geometry or null if none found.
  120386. */
  120387. getGeometryByID(id: string): Nullable<Geometry>;
  120388. private _getGeometryByUniqueID;
  120389. /**
  120390. * Add a new geometry to this scene
  120391. * @param geometry defines the geometry to be added to the scene.
  120392. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  120393. * @return a boolean defining if the geometry was added or not
  120394. */
  120395. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  120396. /**
  120397. * Removes an existing geometry
  120398. * @param geometry defines the geometry to be removed from the scene
  120399. * @return a boolean defining if the geometry was removed or not
  120400. */
  120401. removeGeometry(geometry: Geometry): boolean;
  120402. /**
  120403. * Gets the list of geometries attached to the scene
  120404. * @returns an array of Geometry
  120405. */
  120406. getGeometries(): Geometry[];
  120407. /**
  120408. * Gets the first added mesh found of a given ID
  120409. * @param id defines the id to search for
  120410. * @return the mesh found or null if not found at all
  120411. */
  120412. getMeshByID(id: string): Nullable<AbstractMesh>;
  120413. /**
  120414. * Gets a list of meshes using their id
  120415. * @param id defines the id to search for
  120416. * @returns a list of meshes
  120417. */
  120418. getMeshesByID(id: string): Array<AbstractMesh>;
  120419. /**
  120420. * Gets the first added transform node found of a given ID
  120421. * @param id defines the id to search for
  120422. * @return the found transform node or null if not found at all.
  120423. */
  120424. getTransformNodeByID(id: string): Nullable<TransformNode>;
  120425. /**
  120426. * Gets a transform node with its auto-generated unique id
  120427. * @param uniqueId efines the unique id to search for
  120428. * @return the found transform node or null if not found at all.
  120429. */
  120430. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  120431. /**
  120432. * Gets a list of transform nodes using their id
  120433. * @param id defines the id to search for
  120434. * @returns a list of transform nodes
  120435. */
  120436. getTransformNodesByID(id: string): Array<TransformNode>;
  120437. /**
  120438. * Gets a mesh with its auto-generated unique id
  120439. * @param uniqueId defines the unique id to search for
  120440. * @return the found mesh or null if not found at all.
  120441. */
  120442. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  120443. /**
  120444. * Gets a the last added mesh using a given id
  120445. * @param id defines the id to search for
  120446. * @return the found mesh or null if not found at all.
  120447. */
  120448. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  120449. /**
  120450. * Gets a the last added node (Mesh, Camera, Light) using a given id
  120451. * @param id defines the id to search for
  120452. * @return the found node or null if not found at all
  120453. */
  120454. getLastEntryByID(id: string): Nullable<Node>;
  120455. /**
  120456. * Gets a node (Mesh, Camera, Light) using a given id
  120457. * @param id defines the id to search for
  120458. * @return the found node or null if not found at all
  120459. */
  120460. getNodeByID(id: string): Nullable<Node>;
  120461. /**
  120462. * Gets a node (Mesh, Camera, Light) using a given name
  120463. * @param name defines the name to search for
  120464. * @return the found node or null if not found at all.
  120465. */
  120466. getNodeByName(name: string): Nullable<Node>;
  120467. /**
  120468. * Gets a mesh using a given name
  120469. * @param name defines the name to search for
  120470. * @return the found mesh or null if not found at all.
  120471. */
  120472. getMeshByName(name: string): Nullable<AbstractMesh>;
  120473. /**
  120474. * Gets a transform node using a given name
  120475. * @param name defines the name to search for
  120476. * @return the found transform node or null if not found at all.
  120477. */
  120478. getTransformNodeByName(name: string): Nullable<TransformNode>;
  120479. /**
  120480. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  120481. * @param id defines the id to search for
  120482. * @return the found skeleton or null if not found at all.
  120483. */
  120484. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  120485. /**
  120486. * Gets a skeleton using a given auto generated unique id
  120487. * @param uniqueId defines the unique id to search for
  120488. * @return the found skeleton or null if not found at all.
  120489. */
  120490. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  120491. /**
  120492. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  120493. * @param id defines the id to search for
  120494. * @return the found skeleton or null if not found at all.
  120495. */
  120496. getSkeletonById(id: string): Nullable<Skeleton>;
  120497. /**
  120498. * Gets a skeleton using a given name
  120499. * @param name defines the name to search for
  120500. * @return the found skeleton or null if not found at all.
  120501. */
  120502. getSkeletonByName(name: string): Nullable<Skeleton>;
  120503. /**
  120504. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  120505. * @param id defines the id to search for
  120506. * @return the found morph target manager or null if not found at all.
  120507. */
  120508. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  120509. /**
  120510. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  120511. * @param id defines the id to search for
  120512. * @return the found morph target or null if not found at all.
  120513. */
  120514. getMorphTargetById(id: string): Nullable<MorphTarget>;
  120515. /**
  120516. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  120517. * @param name defines the name to search for
  120518. * @return the found morph target or null if not found at all.
  120519. */
  120520. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  120521. /**
  120522. * Gets a post process using a given name (if many are found, this function will pick the first one)
  120523. * @param name defines the name to search for
  120524. * @return the found post process or null if not found at all.
  120525. */
  120526. getPostProcessByName(name: string): Nullable<PostProcess>;
  120527. /**
  120528. * Gets a boolean indicating if the given mesh is active
  120529. * @param mesh defines the mesh to look for
  120530. * @returns true if the mesh is in the active list
  120531. */
  120532. isActiveMesh(mesh: AbstractMesh): boolean;
  120533. /**
  120534. * Return a unique id as a string which can serve as an identifier for the scene
  120535. */
  120536. get uid(): string;
  120537. /**
  120538. * Add an externaly attached data from its key.
  120539. * This method call will fail and return false, if such key already exists.
  120540. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  120541. * @param key the unique key that identifies the data
  120542. * @param data the data object to associate to the key for this Engine instance
  120543. * @return true if no such key were already present and the data was added successfully, false otherwise
  120544. */
  120545. addExternalData<T>(key: string, data: T): boolean;
  120546. /**
  120547. * Get an externaly attached data from its key
  120548. * @param key the unique key that identifies the data
  120549. * @return the associated data, if present (can be null), or undefined if not present
  120550. */
  120551. getExternalData<T>(key: string): Nullable<T>;
  120552. /**
  120553. * Get an externaly attached data from its key, create it using a factory if it's not already present
  120554. * @param key the unique key that identifies the data
  120555. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  120556. * @return the associated data, can be null if the factory returned null.
  120557. */
  120558. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  120559. /**
  120560. * Remove an externaly attached data from the Engine instance
  120561. * @param key the unique key that identifies the data
  120562. * @return true if the data was successfully removed, false if it doesn't exist
  120563. */
  120564. removeExternalData(key: string): boolean;
  120565. private _evaluateSubMesh;
  120566. /**
  120567. * Clear the processed materials smart array preventing retention point in material dispose.
  120568. */
  120569. freeProcessedMaterials(): void;
  120570. private _preventFreeActiveMeshesAndRenderingGroups;
  120571. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  120572. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  120573. * when disposing several meshes in a row or a hierarchy of meshes.
  120574. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  120575. */
  120576. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  120577. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  120578. /**
  120579. * Clear the active meshes smart array preventing retention point in mesh dispose.
  120580. */
  120581. freeActiveMeshes(): void;
  120582. /**
  120583. * Clear the info related to rendering groups preventing retention points during dispose.
  120584. */
  120585. freeRenderingGroups(): void;
  120586. /** @hidden */
  120587. _isInIntermediateRendering(): boolean;
  120588. /**
  120589. * Lambda returning the list of potentially active meshes.
  120590. */
  120591. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  120592. /**
  120593. * Lambda returning the list of potentially active sub meshes.
  120594. */
  120595. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  120596. /**
  120597. * Lambda returning the list of potentially intersecting sub meshes.
  120598. */
  120599. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  120600. /**
  120601. * Lambda returning the list of potentially colliding sub meshes.
  120602. */
  120603. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  120604. private _activeMeshesFrozen;
  120605. private _skipEvaluateActiveMeshesCompletely;
  120606. /**
  120607. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  120608. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  120609. * @returns the current scene
  120610. */
  120611. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  120612. /**
  120613. * Use this function to restart evaluating active meshes on every frame
  120614. * @returns the current scene
  120615. */
  120616. unfreezeActiveMeshes(): Scene;
  120617. private _evaluateActiveMeshes;
  120618. private _activeMesh;
  120619. /**
  120620. * Update the transform matrix to update from the current active camera
  120621. * @param force defines a boolean used to force the update even if cache is up to date
  120622. */
  120623. updateTransformMatrix(force?: boolean): void;
  120624. private _bindFrameBuffer;
  120625. /** @hidden */
  120626. _allowPostProcessClearColor: boolean;
  120627. /** @hidden */
  120628. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  120629. private _processSubCameras;
  120630. private _checkIntersections;
  120631. /** @hidden */
  120632. _advancePhysicsEngineStep(step: number): void;
  120633. /**
  120634. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  120635. */
  120636. getDeterministicFrameTime: () => number;
  120637. /** @hidden */
  120638. _animate(): void;
  120639. /** Execute all animations (for a frame) */
  120640. animate(): void;
  120641. /**
  120642. * Render the scene
  120643. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  120644. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  120645. */
  120646. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  120647. /**
  120648. * Freeze all materials
  120649. * A frozen material will not be updatable but should be faster to render
  120650. */
  120651. freezeMaterials(): void;
  120652. /**
  120653. * Unfreeze all materials
  120654. * A frozen material will not be updatable but should be faster to render
  120655. */
  120656. unfreezeMaterials(): void;
  120657. /**
  120658. * Releases all held ressources
  120659. */
  120660. dispose(): void;
  120661. /**
  120662. * Gets if the scene is already disposed
  120663. */
  120664. get isDisposed(): boolean;
  120665. /**
  120666. * Call this function to reduce memory footprint of the scene.
  120667. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  120668. */
  120669. clearCachedVertexData(): void;
  120670. /**
  120671. * This function will remove the local cached buffer data from texture.
  120672. * It will save memory but will prevent the texture from being rebuilt
  120673. */
  120674. cleanCachedTextureBuffer(): void;
  120675. /**
  120676. * Get the world extend vectors with an optional filter
  120677. *
  120678. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  120679. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  120680. */
  120681. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  120682. min: Vector3;
  120683. max: Vector3;
  120684. };
  120685. /**
  120686. * Creates a ray that can be used to pick in the scene
  120687. * @param x defines the x coordinate of the origin (on-screen)
  120688. * @param y defines the y coordinate of the origin (on-screen)
  120689. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120690. * @param camera defines the camera to use for the picking
  120691. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120692. * @returns a Ray
  120693. */
  120694. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  120695. /**
  120696. * Creates a ray that can be used to pick in the scene
  120697. * @param x defines the x coordinate of the origin (on-screen)
  120698. * @param y defines the y coordinate of the origin (on-screen)
  120699. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120700. * @param result defines the ray where to store the picking ray
  120701. * @param camera defines the camera to use for the picking
  120702. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120703. * @returns the current scene
  120704. */
  120705. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  120706. /**
  120707. * Creates a ray that can be used to pick in the scene
  120708. * @param x defines the x coordinate of the origin (on-screen)
  120709. * @param y defines the y coordinate of the origin (on-screen)
  120710. * @param camera defines the camera to use for the picking
  120711. * @returns a Ray
  120712. */
  120713. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  120714. /**
  120715. * Creates a ray that can be used to pick in the scene
  120716. * @param x defines the x coordinate of the origin (on-screen)
  120717. * @param y defines the y coordinate of the origin (on-screen)
  120718. * @param result defines the ray where to store the picking ray
  120719. * @param camera defines the camera to use for the picking
  120720. * @returns the current scene
  120721. */
  120722. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  120723. /** Launch a ray to try to pick a mesh in the scene
  120724. * @param x position on screen
  120725. * @param y position on screen
  120726. * @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
  120727. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120728. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120729. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120730. * @returns a PickingInfo
  120731. */
  120732. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120733. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  120734. * @param x position on screen
  120735. * @param y position on screen
  120736. * @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
  120737. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120738. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120739. * @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)
  120740. */
  120741. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  120742. /** Use the given ray to pick a mesh in the scene
  120743. * @param ray The ray to use to pick meshes
  120744. * @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
  120745. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120746. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120747. * @returns a PickingInfo
  120748. */
  120749. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120750. /**
  120751. * Launch a ray to try to pick a mesh in the scene
  120752. * @param x X position on screen
  120753. * @param y Y position on screen
  120754. * @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
  120755. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120756. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120757. * @returns an array of PickingInfo
  120758. */
  120759. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120760. /**
  120761. * Launch a ray to try to pick a mesh in the scene
  120762. * @param ray Ray to use
  120763. * @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
  120764. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120765. * @returns an array of PickingInfo
  120766. */
  120767. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120768. /**
  120769. * Force the value of meshUnderPointer
  120770. * @param mesh defines the mesh to use
  120771. * @param pointerId optional pointer id when using more than one pointer
  120772. */
  120773. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  120774. /**
  120775. * Gets the mesh under the pointer
  120776. * @returns a Mesh or null if no mesh is under the pointer
  120777. */
  120778. getPointerOverMesh(): Nullable<AbstractMesh>;
  120779. /** @hidden */
  120780. _rebuildGeometries(): void;
  120781. /** @hidden */
  120782. _rebuildTextures(): void;
  120783. private _getByTags;
  120784. /**
  120785. * Get a list of meshes by tags
  120786. * @param tagsQuery defines the tags query to use
  120787. * @param forEach defines a predicate used to filter results
  120788. * @returns an array of Mesh
  120789. */
  120790. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  120791. /**
  120792. * Get a list of cameras by tags
  120793. * @param tagsQuery defines the tags query to use
  120794. * @param forEach defines a predicate used to filter results
  120795. * @returns an array of Camera
  120796. */
  120797. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  120798. /**
  120799. * Get a list of lights by tags
  120800. * @param tagsQuery defines the tags query to use
  120801. * @param forEach defines a predicate used to filter results
  120802. * @returns an array of Light
  120803. */
  120804. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  120805. /**
  120806. * Get a list of materials by tags
  120807. * @param tagsQuery defines the tags query to use
  120808. * @param forEach defines a predicate used to filter results
  120809. * @returns an array of Material
  120810. */
  120811. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  120812. /**
  120813. * Get a list of transform nodes by tags
  120814. * @param tagsQuery defines the tags query to use
  120815. * @param forEach defines a predicate used to filter results
  120816. * @returns an array of TransformNode
  120817. */
  120818. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  120819. /**
  120820. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  120821. * This allowed control for front to back rendering or reversly depending of the special needs.
  120822. *
  120823. * @param renderingGroupId The rendering group id corresponding to its index
  120824. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  120825. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  120826. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  120827. */
  120828. 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;
  120829. /**
  120830. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  120831. *
  120832. * @param renderingGroupId The rendering group id corresponding to its index
  120833. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120834. * @param depth Automatically clears depth between groups if true and autoClear is true.
  120835. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  120836. */
  120837. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  120838. /**
  120839. * Gets the current auto clear configuration for one rendering group of the rendering
  120840. * manager.
  120841. * @param index the rendering group index to get the information for
  120842. * @returns The auto clear setup for the requested rendering group
  120843. */
  120844. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  120845. private _blockMaterialDirtyMechanism;
  120846. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  120847. get blockMaterialDirtyMechanism(): boolean;
  120848. set blockMaterialDirtyMechanism(value: boolean);
  120849. /**
  120850. * Will flag all materials as dirty to trigger new shader compilation
  120851. * @param flag defines the flag used to specify which material part must be marked as dirty
  120852. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  120853. */
  120854. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  120855. /** @hidden */
  120856. _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;
  120857. /** @hidden */
  120858. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120859. /** @hidden */
  120860. _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;
  120861. /** @hidden */
  120862. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  120863. /** @hidden */
  120864. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  120865. /** @hidden */
  120866. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120867. }
  120868. }
  120869. declare module BABYLON {
  120870. /**
  120871. * Set of assets to keep when moving a scene into an asset container.
  120872. */
  120873. export class KeepAssets extends AbstractScene {
  120874. }
  120875. /**
  120876. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  120877. */
  120878. export class InstantiatedEntries {
  120879. /**
  120880. * List of new root nodes (eg. nodes with no parent)
  120881. */
  120882. rootNodes: TransformNode[];
  120883. /**
  120884. * List of new skeletons
  120885. */
  120886. skeletons: Skeleton[];
  120887. /**
  120888. * List of new animation groups
  120889. */
  120890. animationGroups: AnimationGroup[];
  120891. }
  120892. /**
  120893. * Container with a set of assets that can be added or removed from a scene.
  120894. */
  120895. export class AssetContainer extends AbstractScene {
  120896. private _wasAddedToScene;
  120897. /**
  120898. * The scene the AssetContainer belongs to.
  120899. */
  120900. scene: Scene;
  120901. /**
  120902. * Instantiates an AssetContainer.
  120903. * @param scene The scene the AssetContainer belongs to.
  120904. */
  120905. constructor(scene: Scene);
  120906. /**
  120907. * Instantiate or clone all meshes and add the new ones to the scene.
  120908. * Skeletons and animation groups will all be cloned
  120909. * @param nameFunction defines an optional function used to get new names for clones
  120910. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  120911. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  120912. */
  120913. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  120914. /**
  120915. * Adds all the assets from the container to the scene.
  120916. */
  120917. addAllToScene(): void;
  120918. /**
  120919. * Removes all the assets in the container from the scene
  120920. */
  120921. removeAllFromScene(): void;
  120922. /**
  120923. * Disposes all the assets in the container
  120924. */
  120925. dispose(): void;
  120926. private _moveAssets;
  120927. /**
  120928. * Removes all the assets contained in the scene and adds them to the container.
  120929. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  120930. */
  120931. moveAllFromScene(keepAssets?: KeepAssets): void;
  120932. /**
  120933. * 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.
  120934. * @returns the root mesh
  120935. */
  120936. createRootMesh(): Mesh;
  120937. /**
  120938. * Merge animations (direct and animation groups) from this asset container into a scene
  120939. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  120940. * @param animatables set of animatables to retarget to a node from the scene
  120941. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  120942. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  120943. */
  120944. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  120945. }
  120946. }
  120947. declare module BABYLON {
  120948. /**
  120949. * Defines how the parser contract is defined.
  120950. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  120951. */
  120952. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  120953. /**
  120954. * Defines how the individual parser contract is defined.
  120955. * These parser can parse an individual asset
  120956. */
  120957. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  120958. /**
  120959. * Base class of the scene acting as a container for the different elements composing a scene.
  120960. * This class is dynamically extended by the different components of the scene increasing
  120961. * flexibility and reducing coupling
  120962. */
  120963. export abstract class AbstractScene {
  120964. /**
  120965. * Stores the list of available parsers in the application.
  120966. */
  120967. private static _BabylonFileParsers;
  120968. /**
  120969. * Stores the list of available individual parsers in the application.
  120970. */
  120971. private static _IndividualBabylonFileParsers;
  120972. /**
  120973. * Adds a parser in the list of available ones
  120974. * @param name Defines the name of the parser
  120975. * @param parser Defines the parser to add
  120976. */
  120977. static AddParser(name: string, parser: BabylonFileParser): void;
  120978. /**
  120979. * Gets a general parser from the list of avaialble ones
  120980. * @param name Defines the name of the parser
  120981. * @returns the requested parser or null
  120982. */
  120983. static GetParser(name: string): Nullable<BabylonFileParser>;
  120984. /**
  120985. * Adds n individual parser in the list of available ones
  120986. * @param name Defines the name of the parser
  120987. * @param parser Defines the parser to add
  120988. */
  120989. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  120990. /**
  120991. * Gets an individual parser from the list of avaialble ones
  120992. * @param name Defines the name of the parser
  120993. * @returns the requested parser or null
  120994. */
  120995. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  120996. /**
  120997. * Parser json data and populate both a scene and its associated container object
  120998. * @param jsonData Defines the data to parse
  120999. * @param scene Defines the scene to parse the data for
  121000. * @param container Defines the container attached to the parsing sequence
  121001. * @param rootUrl Defines the root url of the data
  121002. */
  121003. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  121004. /**
  121005. * Gets the list of root nodes (ie. nodes with no parent)
  121006. */
  121007. rootNodes: Node[];
  121008. /** All of the cameras added to this scene
  121009. * @see https://doc.babylonjs.com/babylon101/cameras
  121010. */
  121011. cameras: Camera[];
  121012. /**
  121013. * All of the lights added to this scene
  121014. * @see https://doc.babylonjs.com/babylon101/lights
  121015. */
  121016. lights: Light[];
  121017. /**
  121018. * All of the (abstract) meshes added to this scene
  121019. */
  121020. meshes: AbstractMesh[];
  121021. /**
  121022. * The list of skeletons added to the scene
  121023. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  121024. */
  121025. skeletons: Skeleton[];
  121026. /**
  121027. * All of the particle systems added to this scene
  121028. * @see https://doc.babylonjs.com/babylon101/particles
  121029. */
  121030. particleSystems: IParticleSystem[];
  121031. /**
  121032. * Gets a list of Animations associated with the scene
  121033. */
  121034. animations: Animation[];
  121035. /**
  121036. * All of the animation groups added to this scene
  121037. * @see https://doc.babylonjs.com/how_to/group
  121038. */
  121039. animationGroups: AnimationGroup[];
  121040. /**
  121041. * All of the multi-materials added to this scene
  121042. * @see https://doc.babylonjs.com/how_to/multi_materials
  121043. */
  121044. multiMaterials: MultiMaterial[];
  121045. /**
  121046. * All of the materials added to this scene
  121047. * In the context of a Scene, it is not supposed to be modified manually.
  121048. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  121049. * Note also that the order of the Material within the array is not significant and might change.
  121050. * @see https://doc.babylonjs.com/babylon101/materials
  121051. */
  121052. materials: Material[];
  121053. /**
  121054. * The list of morph target managers added to the scene
  121055. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  121056. */
  121057. morphTargetManagers: MorphTargetManager[];
  121058. /**
  121059. * The list of geometries used in the scene.
  121060. */
  121061. geometries: Geometry[];
  121062. /**
  121063. * All of the tranform nodes added to this scene
  121064. * In the context of a Scene, it is not supposed to be modified manually.
  121065. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  121066. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  121067. * @see https://doc.babylonjs.com/how_to/transformnode
  121068. */
  121069. transformNodes: TransformNode[];
  121070. /**
  121071. * ActionManagers available on the scene.
  121072. */
  121073. actionManagers: AbstractActionManager[];
  121074. /**
  121075. * Textures to keep.
  121076. */
  121077. textures: BaseTexture[];
  121078. /** @hidden */
  121079. protected _environmentTexture: Nullable<BaseTexture>;
  121080. /**
  121081. * Texture used in all pbr material as the reflection texture.
  121082. * As in the majority of the scene they are the same (exception for multi room and so on),
  121083. * this is easier to reference from here than from all the materials.
  121084. */
  121085. get environmentTexture(): Nullable<BaseTexture>;
  121086. set environmentTexture(value: Nullable<BaseTexture>);
  121087. /**
  121088. * The list of postprocesses added to the scene
  121089. */
  121090. postProcesses: PostProcess[];
  121091. /**
  121092. * @returns all meshes, lights, cameras, transformNodes and bones
  121093. */
  121094. getNodes(): Array<Node>;
  121095. }
  121096. }
  121097. declare module BABYLON {
  121098. /**
  121099. * Interface used to define options for Sound class
  121100. */
  121101. export interface ISoundOptions {
  121102. /**
  121103. * Does the sound autoplay once loaded.
  121104. */
  121105. autoplay?: boolean;
  121106. /**
  121107. * Does the sound loop after it finishes playing once.
  121108. */
  121109. loop?: boolean;
  121110. /**
  121111. * Sound's volume
  121112. */
  121113. volume?: number;
  121114. /**
  121115. * Is it a spatial sound?
  121116. */
  121117. spatialSound?: boolean;
  121118. /**
  121119. * Maximum distance to hear that sound
  121120. */
  121121. maxDistance?: number;
  121122. /**
  121123. * Uses user defined attenuation function
  121124. */
  121125. useCustomAttenuation?: boolean;
  121126. /**
  121127. * Define the roll off factor of spatial sounds.
  121128. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121129. */
  121130. rolloffFactor?: number;
  121131. /**
  121132. * Define the reference distance the sound should be heard perfectly.
  121133. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121134. */
  121135. refDistance?: number;
  121136. /**
  121137. * Define the distance attenuation model the sound will follow.
  121138. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121139. */
  121140. distanceModel?: string;
  121141. /**
  121142. * Defines the playback speed (1 by default)
  121143. */
  121144. playbackRate?: number;
  121145. /**
  121146. * Defines if the sound is from a streaming source
  121147. */
  121148. streaming?: boolean;
  121149. /**
  121150. * Defines an optional length (in seconds) inside the sound file
  121151. */
  121152. length?: number;
  121153. /**
  121154. * Defines an optional offset (in seconds) inside the sound file
  121155. */
  121156. offset?: number;
  121157. /**
  121158. * If true, URLs will not be required to state the audio file codec to use.
  121159. */
  121160. skipCodecCheck?: boolean;
  121161. }
  121162. /**
  121163. * Defines a sound that can be played in the application.
  121164. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  121165. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121166. */
  121167. export class Sound {
  121168. /**
  121169. * The name of the sound in the scene.
  121170. */
  121171. name: string;
  121172. /**
  121173. * Does the sound autoplay once loaded.
  121174. */
  121175. autoplay: boolean;
  121176. /**
  121177. * Does the sound loop after it finishes playing once.
  121178. */
  121179. loop: boolean;
  121180. /**
  121181. * Does the sound use a custom attenuation curve to simulate the falloff
  121182. * happening when the source gets further away from the camera.
  121183. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121184. */
  121185. useCustomAttenuation: boolean;
  121186. /**
  121187. * The sound track id this sound belongs to.
  121188. */
  121189. soundTrackId: number;
  121190. /**
  121191. * Is this sound currently played.
  121192. */
  121193. isPlaying: boolean;
  121194. /**
  121195. * Is this sound currently paused.
  121196. */
  121197. isPaused: boolean;
  121198. /**
  121199. * Does this sound enables spatial sound.
  121200. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121201. */
  121202. spatialSound: boolean;
  121203. /**
  121204. * Define the reference distance the sound should be heard perfectly.
  121205. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121206. */
  121207. refDistance: number;
  121208. /**
  121209. * Define the roll off factor of spatial sounds.
  121210. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121211. */
  121212. rolloffFactor: number;
  121213. /**
  121214. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  121215. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121216. */
  121217. maxDistance: number;
  121218. /**
  121219. * Define the distance attenuation model the sound will follow.
  121220. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121221. */
  121222. distanceModel: string;
  121223. /**
  121224. * @hidden
  121225. * Back Compat
  121226. **/
  121227. onended: () => any;
  121228. /**
  121229. * Gets or sets an object used to store user defined information for the sound.
  121230. */
  121231. metadata: any;
  121232. /**
  121233. * Observable event when the current playing sound finishes.
  121234. */
  121235. onEndedObservable: Observable<Sound>;
  121236. private _panningModel;
  121237. private _playbackRate;
  121238. private _streaming;
  121239. private _startTime;
  121240. private _startOffset;
  121241. private _position;
  121242. /** @hidden */
  121243. _positionInEmitterSpace: boolean;
  121244. private _localDirection;
  121245. private _volume;
  121246. private _isReadyToPlay;
  121247. private _isDirectional;
  121248. private _readyToPlayCallback;
  121249. private _audioBuffer;
  121250. private _soundSource;
  121251. private _streamingSource;
  121252. private _soundPanner;
  121253. private _soundGain;
  121254. private _inputAudioNode;
  121255. private _outputAudioNode;
  121256. private _coneInnerAngle;
  121257. private _coneOuterAngle;
  121258. private _coneOuterGain;
  121259. private _scene;
  121260. private _connectedTransformNode;
  121261. private _customAttenuationFunction;
  121262. private _registerFunc;
  121263. private _isOutputConnected;
  121264. private _htmlAudioElement;
  121265. private _urlType;
  121266. private _length?;
  121267. private _offset?;
  121268. /** @hidden */
  121269. static _SceneComponentInitialization: (scene: Scene) => void;
  121270. /**
  121271. * Create a sound and attach it to a scene
  121272. * @param name Name of your sound
  121273. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  121274. * @param scene defines the scene the sound belongs to
  121275. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  121276. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  121277. */
  121278. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  121279. /**
  121280. * Release the sound and its associated resources
  121281. */
  121282. dispose(): void;
  121283. /**
  121284. * Gets if the sounds is ready to be played or not.
  121285. * @returns true if ready, otherwise false
  121286. */
  121287. isReady(): boolean;
  121288. private _soundLoaded;
  121289. /**
  121290. * Sets the data of the sound from an audiobuffer
  121291. * @param audioBuffer The audioBuffer containing the data
  121292. */
  121293. setAudioBuffer(audioBuffer: AudioBuffer): void;
  121294. /**
  121295. * Updates the current sounds options such as maxdistance, loop...
  121296. * @param options A JSON object containing values named as the object properties
  121297. */
  121298. updateOptions(options: ISoundOptions): void;
  121299. private _createSpatialParameters;
  121300. private _updateSpatialParameters;
  121301. /**
  121302. * Switch the panning model to HRTF:
  121303. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121304. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121305. */
  121306. switchPanningModelToHRTF(): void;
  121307. /**
  121308. * Switch the panning model to Equal Power:
  121309. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121310. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121311. */
  121312. switchPanningModelToEqualPower(): void;
  121313. private _switchPanningModel;
  121314. /**
  121315. * Connect this sound to a sound track audio node like gain...
  121316. * @param soundTrackAudioNode the sound track audio node to connect to
  121317. */
  121318. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  121319. /**
  121320. * Transform this sound into a directional source
  121321. * @param coneInnerAngle Size of the inner cone in degree
  121322. * @param coneOuterAngle Size of the outer cone in degree
  121323. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  121324. */
  121325. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  121326. /**
  121327. * Gets or sets the inner angle for the directional cone.
  121328. */
  121329. get directionalConeInnerAngle(): number;
  121330. /**
  121331. * Gets or sets the inner angle for the directional cone.
  121332. */
  121333. set directionalConeInnerAngle(value: number);
  121334. /**
  121335. * Gets or sets the outer angle for the directional cone.
  121336. */
  121337. get directionalConeOuterAngle(): number;
  121338. /**
  121339. * Gets or sets the outer angle for the directional cone.
  121340. */
  121341. set directionalConeOuterAngle(value: number);
  121342. /**
  121343. * Sets the position of the emitter if spatial sound is enabled
  121344. * @param newPosition Defines the new posisiton
  121345. */
  121346. setPosition(newPosition: Vector3): void;
  121347. /**
  121348. * Sets the local direction of the emitter if spatial sound is enabled
  121349. * @param newLocalDirection Defines the new local direction
  121350. */
  121351. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  121352. private _updateDirection;
  121353. /** @hidden */
  121354. updateDistanceFromListener(): void;
  121355. /**
  121356. * Sets a new custom attenuation function for the sound.
  121357. * @param callback Defines the function used for the attenuation
  121358. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121359. */
  121360. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  121361. /**
  121362. * Play the sound
  121363. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  121364. * @param offset (optional) Start the sound at a specific time in seconds
  121365. * @param length (optional) Sound duration (in seconds)
  121366. */
  121367. play(time?: number, offset?: number, length?: number): void;
  121368. private _onended;
  121369. /**
  121370. * Stop the sound
  121371. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  121372. */
  121373. stop(time?: number): void;
  121374. /**
  121375. * Put the sound in pause
  121376. */
  121377. pause(): void;
  121378. /**
  121379. * Sets a dedicated volume for this sounds
  121380. * @param newVolume Define the new volume of the sound
  121381. * @param time Define time for gradual change to new volume
  121382. */
  121383. setVolume(newVolume: number, time?: number): void;
  121384. /**
  121385. * Set the sound play back rate
  121386. * @param newPlaybackRate Define the playback rate the sound should be played at
  121387. */
  121388. setPlaybackRate(newPlaybackRate: number): void;
  121389. /**
  121390. * Gets the volume of the sound.
  121391. * @returns the volume of the sound
  121392. */
  121393. getVolume(): number;
  121394. /**
  121395. * Attach the sound to a dedicated mesh
  121396. * @param transformNode The transform node to connect the sound with
  121397. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121398. */
  121399. attachToMesh(transformNode: TransformNode): void;
  121400. /**
  121401. * Detach the sound from the previously attached mesh
  121402. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121403. */
  121404. detachFromMesh(): void;
  121405. private _onRegisterAfterWorldMatrixUpdate;
  121406. /**
  121407. * Clone the current sound in the scene.
  121408. * @returns the new sound clone
  121409. */
  121410. clone(): Nullable<Sound>;
  121411. /**
  121412. * Gets the current underlying audio buffer containing the data
  121413. * @returns the audio buffer
  121414. */
  121415. getAudioBuffer(): Nullable<AudioBuffer>;
  121416. /**
  121417. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  121418. * @returns the source node
  121419. */
  121420. getSoundSource(): Nullable<AudioBufferSourceNode>;
  121421. /**
  121422. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  121423. * @returns the gain node
  121424. */
  121425. getSoundGain(): Nullable<GainNode>;
  121426. /**
  121427. * Serializes the Sound in a JSON representation
  121428. * @returns the JSON representation of the sound
  121429. */
  121430. serialize(): any;
  121431. /**
  121432. * Parse a JSON representation of a sound to innstantiate in a given scene
  121433. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  121434. * @param scene Define the scene the new parsed sound should be created in
  121435. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  121436. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  121437. * @returns the newly parsed sound
  121438. */
  121439. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  121440. }
  121441. }
  121442. declare module BABYLON {
  121443. /**
  121444. * This defines an action helpful to play a defined sound on a triggered action.
  121445. */
  121446. export class PlaySoundAction extends Action {
  121447. private _sound;
  121448. /**
  121449. * Instantiate the action
  121450. * @param triggerOptions defines the trigger options
  121451. * @param sound defines the sound to play
  121452. * @param condition defines the trigger related conditions
  121453. */
  121454. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121455. /** @hidden */
  121456. _prepare(): void;
  121457. /**
  121458. * Execute the action and play the sound.
  121459. */
  121460. execute(): void;
  121461. /**
  121462. * Serializes the actions and its related information.
  121463. * @param parent defines the object to serialize in
  121464. * @returns the serialized object
  121465. */
  121466. serialize(parent: any): any;
  121467. }
  121468. /**
  121469. * This defines an action helpful to stop a defined sound on a triggered action.
  121470. */
  121471. export class StopSoundAction extends Action {
  121472. private _sound;
  121473. /**
  121474. * Instantiate the action
  121475. * @param triggerOptions defines the trigger options
  121476. * @param sound defines the sound to stop
  121477. * @param condition defines the trigger related conditions
  121478. */
  121479. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121480. /** @hidden */
  121481. _prepare(): void;
  121482. /**
  121483. * Execute the action and stop the sound.
  121484. */
  121485. execute(): void;
  121486. /**
  121487. * Serializes the actions and its related information.
  121488. * @param parent defines the object to serialize in
  121489. * @returns the serialized object
  121490. */
  121491. serialize(parent: any): any;
  121492. }
  121493. }
  121494. declare module BABYLON {
  121495. /**
  121496. * This defines an action responsible to change the value of a property
  121497. * by interpolating between its current value and the newly set one once triggered.
  121498. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  121499. */
  121500. export class InterpolateValueAction extends Action {
  121501. /**
  121502. * Defines the path of the property where the value should be interpolated
  121503. */
  121504. propertyPath: string;
  121505. /**
  121506. * Defines the target value at the end of the interpolation.
  121507. */
  121508. value: any;
  121509. /**
  121510. * Defines the time it will take for the property to interpolate to the value.
  121511. */
  121512. duration: number;
  121513. /**
  121514. * Defines if the other scene animations should be stopped when the action has been triggered
  121515. */
  121516. stopOtherAnimations?: boolean;
  121517. /**
  121518. * Defines a callback raised once the interpolation animation has been done.
  121519. */
  121520. onInterpolationDone?: () => void;
  121521. /**
  121522. * Observable triggered once the interpolation animation has been done.
  121523. */
  121524. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  121525. private _target;
  121526. private _effectiveTarget;
  121527. private _property;
  121528. /**
  121529. * Instantiate the action
  121530. * @param triggerOptions defines the trigger options
  121531. * @param target defines the object containing the value to interpolate
  121532. * @param propertyPath defines the path to the property in the target object
  121533. * @param value defines the target value at the end of the interpolation
  121534. * @param duration deines the time it will take for the property to interpolate to the value.
  121535. * @param condition defines the trigger related conditions
  121536. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  121537. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  121538. */
  121539. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  121540. /** @hidden */
  121541. _prepare(): void;
  121542. /**
  121543. * Execute the action starts the value interpolation.
  121544. */
  121545. execute(): void;
  121546. /**
  121547. * Serializes the actions and its related information.
  121548. * @param parent defines the object to serialize in
  121549. * @returns the serialized object
  121550. */
  121551. serialize(parent: any): any;
  121552. }
  121553. }
  121554. declare module BABYLON {
  121555. /**
  121556. * Options allowed during the creation of a sound track.
  121557. */
  121558. export interface ISoundTrackOptions {
  121559. /**
  121560. * The volume the sound track should take during creation
  121561. */
  121562. volume?: number;
  121563. /**
  121564. * Define if the sound track is the main sound track of the scene
  121565. */
  121566. mainTrack?: boolean;
  121567. }
  121568. /**
  121569. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  121570. * It will be also used in a future release to apply effects on a specific track.
  121571. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121572. */
  121573. export class SoundTrack {
  121574. /**
  121575. * The unique identifier of the sound track in the scene.
  121576. */
  121577. id: number;
  121578. /**
  121579. * The list of sounds included in the sound track.
  121580. */
  121581. soundCollection: Array<Sound>;
  121582. private _outputAudioNode;
  121583. private _scene;
  121584. private _connectedAnalyser;
  121585. private _options;
  121586. private _isInitialized;
  121587. /**
  121588. * Creates a new sound track.
  121589. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121590. * @param scene Define the scene the sound track belongs to
  121591. * @param options
  121592. */
  121593. constructor(scene: Scene, options?: ISoundTrackOptions);
  121594. private _initializeSoundTrackAudioGraph;
  121595. /**
  121596. * Release the sound track and its associated resources
  121597. */
  121598. dispose(): void;
  121599. /**
  121600. * Adds a sound to this sound track
  121601. * @param sound define the cound to add
  121602. * @ignoreNaming
  121603. */
  121604. AddSound(sound: Sound): void;
  121605. /**
  121606. * Removes a sound to this sound track
  121607. * @param sound define the cound to remove
  121608. * @ignoreNaming
  121609. */
  121610. RemoveSound(sound: Sound): void;
  121611. /**
  121612. * Set a global volume for the full sound track.
  121613. * @param newVolume Define the new volume of the sound track
  121614. */
  121615. setVolume(newVolume: number): void;
  121616. /**
  121617. * Switch the panning model to HRTF:
  121618. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121619. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121620. */
  121621. switchPanningModelToHRTF(): void;
  121622. /**
  121623. * Switch the panning model to Equal Power:
  121624. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121625. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121626. */
  121627. switchPanningModelToEqualPower(): void;
  121628. /**
  121629. * Connect the sound track to an audio analyser allowing some amazing
  121630. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  121631. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  121632. * @param analyser The analyser to connect to the engine
  121633. */
  121634. connectToAnalyser(analyser: Analyser): void;
  121635. }
  121636. }
  121637. declare module BABYLON {
  121638. interface AbstractScene {
  121639. /**
  121640. * The list of sounds used in the scene.
  121641. */
  121642. sounds: Nullable<Array<Sound>>;
  121643. }
  121644. interface Scene {
  121645. /**
  121646. * @hidden
  121647. * Backing field
  121648. */
  121649. _mainSoundTrack: SoundTrack;
  121650. /**
  121651. * The main sound track played by the scene.
  121652. * It cotains your primary collection of sounds.
  121653. */
  121654. mainSoundTrack: SoundTrack;
  121655. /**
  121656. * The list of sound tracks added to the scene
  121657. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121658. */
  121659. soundTracks: Nullable<Array<SoundTrack>>;
  121660. /**
  121661. * Gets a sound using a given name
  121662. * @param name defines the name to search for
  121663. * @return the found sound or null if not found at all.
  121664. */
  121665. getSoundByName(name: string): Nullable<Sound>;
  121666. /**
  121667. * Gets or sets if audio support is enabled
  121668. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121669. */
  121670. audioEnabled: boolean;
  121671. /**
  121672. * Gets or sets if audio will be output to headphones
  121673. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121674. */
  121675. headphone: boolean;
  121676. /**
  121677. * Gets or sets custom audio listener position provider
  121678. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121679. */
  121680. audioListenerPositionProvider: Nullable<() => Vector3>;
  121681. /**
  121682. * Gets or sets a refresh rate when using 3D audio positioning
  121683. */
  121684. audioPositioningRefreshRate: number;
  121685. }
  121686. /**
  121687. * Defines the sound scene component responsible to manage any sounds
  121688. * in a given scene.
  121689. */
  121690. export class AudioSceneComponent implements ISceneSerializableComponent {
  121691. /**
  121692. * The component name helpfull to identify the component in the list of scene components.
  121693. */
  121694. readonly name: string;
  121695. /**
  121696. * The scene the component belongs to.
  121697. */
  121698. scene: Scene;
  121699. private _audioEnabled;
  121700. /**
  121701. * Gets whether audio is enabled or not.
  121702. * Please use related enable/disable method to switch state.
  121703. */
  121704. get audioEnabled(): boolean;
  121705. private _headphone;
  121706. /**
  121707. * Gets whether audio is outputing to headphone or not.
  121708. * Please use the according Switch methods to change output.
  121709. */
  121710. get headphone(): boolean;
  121711. /**
  121712. * Gets or sets a refresh rate when using 3D audio positioning
  121713. */
  121714. audioPositioningRefreshRate: number;
  121715. private _audioListenerPositionProvider;
  121716. /**
  121717. * Gets the current audio listener position provider
  121718. */
  121719. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  121720. /**
  121721. * Sets a custom listener position for all sounds in the scene
  121722. * By default, this is the position of the first active camera
  121723. */
  121724. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  121725. /**
  121726. * Creates a new instance of the component for the given scene
  121727. * @param scene Defines the scene to register the component in
  121728. */
  121729. constructor(scene: Scene);
  121730. /**
  121731. * Registers the component in a given scene
  121732. */
  121733. register(): void;
  121734. /**
  121735. * Rebuilds the elements related to this component in case of
  121736. * context lost for instance.
  121737. */
  121738. rebuild(): void;
  121739. /**
  121740. * Serializes the component data to the specified json object
  121741. * @param serializationObject The object to serialize to
  121742. */
  121743. serialize(serializationObject: any): void;
  121744. /**
  121745. * Adds all the elements from the container to the scene
  121746. * @param container the container holding the elements
  121747. */
  121748. addFromContainer(container: AbstractScene): void;
  121749. /**
  121750. * Removes all the elements in the container from the scene
  121751. * @param container contains the elements to remove
  121752. * @param dispose if the removed element should be disposed (default: false)
  121753. */
  121754. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  121755. /**
  121756. * Disposes the component and the associated ressources.
  121757. */
  121758. dispose(): void;
  121759. /**
  121760. * Disables audio in the associated scene.
  121761. */
  121762. disableAudio(): void;
  121763. /**
  121764. * Enables audio in the associated scene.
  121765. */
  121766. enableAudio(): void;
  121767. /**
  121768. * Switch audio to headphone output.
  121769. */
  121770. switchAudioModeForHeadphones(): void;
  121771. /**
  121772. * Switch audio to normal speakers.
  121773. */
  121774. switchAudioModeForNormalSpeakers(): void;
  121775. private _cachedCameraDirection;
  121776. private _cachedCameraPosition;
  121777. private _lastCheck;
  121778. private _afterRender;
  121779. }
  121780. }
  121781. declare module BABYLON {
  121782. /**
  121783. * Wraps one or more Sound objects and selects one with random weight for playback.
  121784. */
  121785. export class WeightedSound {
  121786. /** When true a Sound will be selected and played when the current playing Sound completes. */
  121787. loop: boolean;
  121788. private _coneInnerAngle;
  121789. private _coneOuterAngle;
  121790. private _volume;
  121791. /** A Sound is currently playing. */
  121792. isPlaying: boolean;
  121793. /** A Sound is currently paused. */
  121794. isPaused: boolean;
  121795. private _sounds;
  121796. private _weights;
  121797. private _currentIndex?;
  121798. /**
  121799. * Creates a new WeightedSound from the list of sounds given.
  121800. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  121801. * @param sounds Array of Sounds that will be selected from.
  121802. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  121803. */
  121804. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  121805. /**
  121806. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  121807. */
  121808. get directionalConeInnerAngle(): number;
  121809. /**
  121810. * The size of cone in degress for a directional sound in which there will be no attenuation.
  121811. */
  121812. set directionalConeInnerAngle(value: number);
  121813. /**
  121814. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121815. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121816. */
  121817. get directionalConeOuterAngle(): number;
  121818. /**
  121819. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121820. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121821. */
  121822. set directionalConeOuterAngle(value: number);
  121823. /**
  121824. * Playback volume.
  121825. */
  121826. get volume(): number;
  121827. /**
  121828. * Playback volume.
  121829. */
  121830. set volume(value: number);
  121831. private _onended;
  121832. /**
  121833. * Suspend playback
  121834. */
  121835. pause(): void;
  121836. /**
  121837. * Stop playback
  121838. */
  121839. stop(): void;
  121840. /**
  121841. * Start playback.
  121842. * @param startOffset Position the clip head at a specific time in seconds.
  121843. */
  121844. play(startOffset?: number): void;
  121845. }
  121846. }
  121847. declare module BABYLON {
  121848. /**
  121849. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  121850. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121851. */
  121852. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  121853. /**
  121854. * Gets the name of the behavior.
  121855. */
  121856. get name(): string;
  121857. /**
  121858. * The easing function used by animations
  121859. */
  121860. static EasingFunction: BackEase;
  121861. /**
  121862. * The easing mode used by animations
  121863. */
  121864. static EasingMode: number;
  121865. /**
  121866. * The duration of the animation, in milliseconds
  121867. */
  121868. transitionDuration: number;
  121869. /**
  121870. * Length of the distance animated by the transition when lower radius is reached
  121871. */
  121872. lowerRadiusTransitionRange: number;
  121873. /**
  121874. * Length of the distance animated by the transition when upper radius is reached
  121875. */
  121876. upperRadiusTransitionRange: number;
  121877. private _autoTransitionRange;
  121878. /**
  121879. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121880. */
  121881. get autoTransitionRange(): boolean;
  121882. /**
  121883. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121884. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  121885. */
  121886. set autoTransitionRange(value: boolean);
  121887. private _attachedCamera;
  121888. private _onAfterCheckInputsObserver;
  121889. private _onMeshTargetChangedObserver;
  121890. /**
  121891. * Initializes the behavior.
  121892. */
  121893. init(): void;
  121894. /**
  121895. * Attaches the behavior to its arc rotate camera.
  121896. * @param camera Defines the camera to attach the behavior to
  121897. */
  121898. attach(camera: ArcRotateCamera): void;
  121899. /**
  121900. * Detaches the behavior from its current arc rotate camera.
  121901. */
  121902. detach(): void;
  121903. private _radiusIsAnimating;
  121904. private _radiusBounceTransition;
  121905. private _animatables;
  121906. private _cachedWheelPrecision;
  121907. /**
  121908. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  121909. * @param radiusLimit The limit to check against.
  121910. * @return Bool to indicate if at limit.
  121911. */
  121912. private _isRadiusAtLimit;
  121913. /**
  121914. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  121915. * @param radiusDelta The delta by which to animate to. Can be negative.
  121916. */
  121917. private _applyBoundRadiusAnimation;
  121918. /**
  121919. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  121920. */
  121921. protected _clearAnimationLocks(): void;
  121922. /**
  121923. * Stops and removes all animations that have been applied to the camera
  121924. */
  121925. stopAllAnimations(): void;
  121926. }
  121927. }
  121928. declare module BABYLON {
  121929. /**
  121930. * 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.
  121931. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  121932. */
  121933. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  121934. /**
  121935. * Gets the name of the behavior.
  121936. */
  121937. get name(): string;
  121938. private _mode;
  121939. private _radiusScale;
  121940. private _positionScale;
  121941. private _defaultElevation;
  121942. private _elevationReturnTime;
  121943. private _elevationReturnWaitTime;
  121944. private _zoomStopsAnimation;
  121945. private _framingTime;
  121946. /**
  121947. * The easing function used by animations
  121948. */
  121949. static EasingFunction: ExponentialEase;
  121950. /**
  121951. * The easing mode used by animations
  121952. */
  121953. static EasingMode: number;
  121954. /**
  121955. * Sets the current mode used by the behavior
  121956. */
  121957. set mode(mode: number);
  121958. /**
  121959. * Gets current mode used by the behavior.
  121960. */
  121961. get mode(): number;
  121962. /**
  121963. * Sets the scale applied to the radius (1 by default)
  121964. */
  121965. set radiusScale(radius: number);
  121966. /**
  121967. * Gets the scale applied to the radius
  121968. */
  121969. get radiusScale(): number;
  121970. /**
  121971. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121972. */
  121973. set positionScale(scale: number);
  121974. /**
  121975. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121976. */
  121977. get positionScale(): number;
  121978. /**
  121979. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121980. * behaviour is triggered, in radians.
  121981. */
  121982. set defaultElevation(elevation: number);
  121983. /**
  121984. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121985. * behaviour is triggered, in radians.
  121986. */
  121987. get defaultElevation(): number;
  121988. /**
  121989. * Sets the time (in milliseconds) taken to return to the default beta position.
  121990. * Negative value indicates camera should not return to default.
  121991. */
  121992. set elevationReturnTime(speed: number);
  121993. /**
  121994. * Gets the time (in milliseconds) taken to return to the default beta position.
  121995. * Negative value indicates camera should not return to default.
  121996. */
  121997. get elevationReturnTime(): number;
  121998. /**
  121999. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  122000. */
  122001. set elevationReturnWaitTime(time: number);
  122002. /**
  122003. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  122004. */
  122005. get elevationReturnWaitTime(): number;
  122006. /**
  122007. * Sets the flag that indicates if user zooming should stop animation.
  122008. */
  122009. set zoomStopsAnimation(flag: boolean);
  122010. /**
  122011. * Gets the flag that indicates if user zooming should stop animation.
  122012. */
  122013. get zoomStopsAnimation(): boolean;
  122014. /**
  122015. * Sets the transition time when framing the mesh, in milliseconds
  122016. */
  122017. set framingTime(time: number);
  122018. /**
  122019. * Gets the transition time when framing the mesh, in milliseconds
  122020. */
  122021. get framingTime(): number;
  122022. /**
  122023. * Define if the behavior should automatically change the configured
  122024. * camera limits and sensibilities.
  122025. */
  122026. autoCorrectCameraLimitsAndSensibility: boolean;
  122027. private _onPrePointerObservableObserver;
  122028. private _onAfterCheckInputsObserver;
  122029. private _onMeshTargetChangedObserver;
  122030. private _attachedCamera;
  122031. private _isPointerDown;
  122032. private _lastInteractionTime;
  122033. /**
  122034. * Initializes the behavior.
  122035. */
  122036. init(): void;
  122037. /**
  122038. * Attaches the behavior to its arc rotate camera.
  122039. * @param camera Defines the camera to attach the behavior to
  122040. */
  122041. attach(camera: ArcRotateCamera): void;
  122042. /**
  122043. * Detaches the behavior from its current arc rotate camera.
  122044. */
  122045. detach(): void;
  122046. private _animatables;
  122047. private _betaIsAnimating;
  122048. private _betaTransition;
  122049. private _radiusTransition;
  122050. private _vectorTransition;
  122051. /**
  122052. * Targets the given mesh and updates zoom level accordingly.
  122053. * @param mesh The mesh to target.
  122054. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122055. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122056. */
  122057. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122058. /**
  122059. * Targets the given mesh with its children and updates zoom level accordingly.
  122060. * @param mesh The mesh to target.
  122061. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122062. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122063. */
  122064. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122065. /**
  122066. * Targets the given meshes with their children and updates zoom level accordingly.
  122067. * @param meshes The mesh to target.
  122068. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122069. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122070. */
  122071. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122072. /**
  122073. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  122074. * @param minimumWorld Determines the smaller position of the bounding box extend
  122075. * @param maximumWorld Determines the bigger position of the bounding box extend
  122076. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122077. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122078. */
  122079. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122080. /**
  122081. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  122082. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  122083. * frustum width.
  122084. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  122085. * to fully enclose the mesh in the viewing frustum.
  122086. */
  122087. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  122088. /**
  122089. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  122090. * is automatically returned to its default position (expected to be above ground plane).
  122091. */
  122092. private _maintainCameraAboveGround;
  122093. /**
  122094. * Returns the frustum slope based on the canvas ratio and camera FOV
  122095. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  122096. */
  122097. private _getFrustumSlope;
  122098. /**
  122099. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  122100. */
  122101. private _clearAnimationLocks;
  122102. /**
  122103. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122104. */
  122105. private _applyUserInteraction;
  122106. /**
  122107. * Stops and removes all animations that have been applied to the camera
  122108. */
  122109. stopAllAnimations(): void;
  122110. /**
  122111. * Gets a value indicating if the user is moving the camera
  122112. */
  122113. get isUserIsMoving(): boolean;
  122114. /**
  122115. * The camera can move all the way towards the mesh.
  122116. */
  122117. static IgnoreBoundsSizeMode: number;
  122118. /**
  122119. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  122120. */
  122121. static FitFrustumSidesMode: number;
  122122. }
  122123. }
  122124. declare module BABYLON {
  122125. /**
  122126. * Base class for Camera Pointer Inputs.
  122127. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  122128. * for example usage.
  122129. */
  122130. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  122131. /**
  122132. * Defines the camera the input is attached to.
  122133. */
  122134. abstract camera: Camera;
  122135. /**
  122136. * Whether keyboard modifier keys are pressed at time of last mouse event.
  122137. */
  122138. protected _altKey: boolean;
  122139. protected _ctrlKey: boolean;
  122140. protected _metaKey: boolean;
  122141. protected _shiftKey: boolean;
  122142. /**
  122143. * Which mouse buttons were pressed at time of last mouse event.
  122144. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  122145. */
  122146. protected _buttonsPressed: number;
  122147. /**
  122148. * Defines the buttons associated with the input to handle camera move.
  122149. */
  122150. buttons: number[];
  122151. /**
  122152. * Attach the input controls to a specific dom element to get the input from.
  122153. * @param element Defines the element the controls should be listened from
  122154. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122155. */
  122156. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122157. /**
  122158. * Detach the current controls from the specified dom element.
  122159. * @param element Defines the element to stop listening the inputs from
  122160. */
  122161. detachControl(element: Nullable<HTMLElement>): void;
  122162. /**
  122163. * Gets the class name of the current input.
  122164. * @returns the class name
  122165. */
  122166. getClassName(): string;
  122167. /**
  122168. * Get the friendly name associated with the input class.
  122169. * @returns the input friendly name
  122170. */
  122171. getSimpleName(): string;
  122172. /**
  122173. * Called on pointer POINTERDOUBLETAP event.
  122174. * Override this method to provide functionality on POINTERDOUBLETAP event.
  122175. */
  122176. protected onDoubleTap(type: string): void;
  122177. /**
  122178. * Called on pointer POINTERMOVE event if only a single touch is active.
  122179. * Override this method to provide functionality.
  122180. */
  122181. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122182. /**
  122183. * Called on pointer POINTERMOVE event if multiple touches are active.
  122184. * Override this method to provide functionality.
  122185. */
  122186. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122187. /**
  122188. * Called on JS contextmenu event.
  122189. * Override this method to provide functionality.
  122190. */
  122191. protected onContextMenu(evt: PointerEvent): void;
  122192. /**
  122193. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122194. * press.
  122195. * Override this method to provide functionality.
  122196. */
  122197. protected onButtonDown(evt: PointerEvent): void;
  122198. /**
  122199. * Called each time a new POINTERUP event occurs. Ie, for each button
  122200. * release.
  122201. * Override this method to provide functionality.
  122202. */
  122203. protected onButtonUp(evt: PointerEvent): void;
  122204. /**
  122205. * Called when window becomes inactive.
  122206. * Override this method to provide functionality.
  122207. */
  122208. protected onLostFocus(): void;
  122209. private _pointerInput;
  122210. private _observer;
  122211. private _onLostFocus;
  122212. private pointA;
  122213. private pointB;
  122214. }
  122215. }
  122216. declare module BABYLON {
  122217. /**
  122218. * Manage the pointers inputs to control an arc rotate camera.
  122219. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122220. */
  122221. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  122222. /**
  122223. * Defines the camera the input is attached to.
  122224. */
  122225. camera: ArcRotateCamera;
  122226. /**
  122227. * Gets the class name of the current input.
  122228. * @returns the class name
  122229. */
  122230. getClassName(): string;
  122231. /**
  122232. * Defines the buttons associated with the input to handle camera move.
  122233. */
  122234. buttons: number[];
  122235. /**
  122236. * Defines the pointer angular sensibility along the X axis or how fast is
  122237. * the camera rotating.
  122238. */
  122239. angularSensibilityX: number;
  122240. /**
  122241. * Defines the pointer angular sensibility along the Y axis or how fast is
  122242. * the camera rotating.
  122243. */
  122244. angularSensibilityY: number;
  122245. /**
  122246. * Defines the pointer pinch precision or how fast is the camera zooming.
  122247. */
  122248. pinchPrecision: number;
  122249. /**
  122250. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  122251. * from 0.
  122252. * It defines the percentage of current camera.radius to use as delta when
  122253. * pinch zoom is used.
  122254. */
  122255. pinchDeltaPercentage: number;
  122256. /**
  122257. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122258. * that any object in the plane at the camera's target point will scale
  122259. * perfectly with finger motion.
  122260. * Overrides pinchDeltaPercentage and pinchPrecision.
  122261. */
  122262. useNaturalPinchZoom: boolean;
  122263. /**
  122264. * Defines the pointer panning sensibility or how fast is the camera moving.
  122265. */
  122266. panningSensibility: number;
  122267. /**
  122268. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  122269. */
  122270. multiTouchPanning: boolean;
  122271. /**
  122272. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  122273. * zoom (pinch) through multitouch.
  122274. */
  122275. multiTouchPanAndZoom: boolean;
  122276. /**
  122277. * Revers pinch action direction.
  122278. */
  122279. pinchInwards: boolean;
  122280. private _isPanClick;
  122281. private _twoFingerActivityCount;
  122282. private _isPinching;
  122283. /**
  122284. * Called on pointer POINTERMOVE event if only a single touch is active.
  122285. */
  122286. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122287. /**
  122288. * Called on pointer POINTERDOUBLETAP event.
  122289. */
  122290. protected onDoubleTap(type: string): void;
  122291. /**
  122292. * Called on pointer POINTERMOVE event if multiple touches are active.
  122293. */
  122294. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122295. /**
  122296. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122297. * press.
  122298. */
  122299. protected onButtonDown(evt: PointerEvent): void;
  122300. /**
  122301. * Called each time a new POINTERUP event occurs. Ie, for each button
  122302. * release.
  122303. */
  122304. protected onButtonUp(evt: PointerEvent): void;
  122305. /**
  122306. * Called when window becomes inactive.
  122307. */
  122308. protected onLostFocus(): void;
  122309. }
  122310. }
  122311. declare module BABYLON {
  122312. /**
  122313. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  122314. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122315. */
  122316. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  122317. /**
  122318. * Defines the camera the input is attached to.
  122319. */
  122320. camera: ArcRotateCamera;
  122321. /**
  122322. * Defines the list of key codes associated with the up action (increase alpha)
  122323. */
  122324. keysUp: number[];
  122325. /**
  122326. * Defines the list of key codes associated with the down action (decrease alpha)
  122327. */
  122328. keysDown: number[];
  122329. /**
  122330. * Defines the list of key codes associated with the left action (increase beta)
  122331. */
  122332. keysLeft: number[];
  122333. /**
  122334. * Defines the list of key codes associated with the right action (decrease beta)
  122335. */
  122336. keysRight: number[];
  122337. /**
  122338. * Defines the list of key codes associated with the reset action.
  122339. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  122340. */
  122341. keysReset: number[];
  122342. /**
  122343. * Defines the panning sensibility of the inputs.
  122344. * (How fast is the camera panning)
  122345. */
  122346. panningSensibility: number;
  122347. /**
  122348. * Defines the zooming sensibility of the inputs.
  122349. * (How fast is the camera zooming)
  122350. */
  122351. zoomingSensibility: number;
  122352. /**
  122353. * Defines whether maintaining the alt key down switch the movement mode from
  122354. * orientation to zoom.
  122355. */
  122356. useAltToZoom: boolean;
  122357. /**
  122358. * Rotation speed of the camera
  122359. */
  122360. angularSpeed: number;
  122361. private _keys;
  122362. private _ctrlPressed;
  122363. private _altPressed;
  122364. private _onCanvasBlurObserver;
  122365. private _onKeyboardObserver;
  122366. private _engine;
  122367. private _scene;
  122368. /**
  122369. * Attach the input controls to a specific dom element to get the input from.
  122370. * @param element Defines the element the controls should be listened from
  122371. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122372. */
  122373. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122374. /**
  122375. * Detach the current controls from the specified dom element.
  122376. * @param element Defines the element to stop listening the inputs from
  122377. */
  122378. detachControl(element: Nullable<HTMLElement>): void;
  122379. /**
  122380. * Update the current camera state depending on the inputs that have been used this frame.
  122381. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122382. */
  122383. checkInputs(): void;
  122384. /**
  122385. * Gets the class name of the current intput.
  122386. * @returns the class name
  122387. */
  122388. getClassName(): string;
  122389. /**
  122390. * Get the friendly name associated with the input class.
  122391. * @returns the input friendly name
  122392. */
  122393. getSimpleName(): string;
  122394. }
  122395. }
  122396. declare module BABYLON {
  122397. /**
  122398. * Manage the mouse wheel inputs to control an arc rotate camera.
  122399. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122400. */
  122401. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  122402. /**
  122403. * Defines the camera the input is attached to.
  122404. */
  122405. camera: ArcRotateCamera;
  122406. /**
  122407. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122408. */
  122409. wheelPrecision: number;
  122410. /**
  122411. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  122412. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  122413. */
  122414. wheelDeltaPercentage: number;
  122415. private _wheel;
  122416. private _observer;
  122417. private computeDeltaFromMouseWheelLegacyEvent;
  122418. /**
  122419. * Attach the input controls to a specific dom element to get the input from.
  122420. * @param element Defines the element the controls should be listened from
  122421. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122422. */
  122423. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122424. /**
  122425. * Detach the current controls from the specified dom element.
  122426. * @param element Defines the element to stop listening the inputs from
  122427. */
  122428. detachControl(element: Nullable<HTMLElement>): void;
  122429. /**
  122430. * Gets the class name of the current intput.
  122431. * @returns the class name
  122432. */
  122433. getClassName(): string;
  122434. /**
  122435. * Get the friendly name associated with the input class.
  122436. * @returns the input friendly name
  122437. */
  122438. getSimpleName(): string;
  122439. }
  122440. }
  122441. declare module BABYLON {
  122442. /**
  122443. * Default Inputs manager for the ArcRotateCamera.
  122444. * It groups all the default supported inputs for ease of use.
  122445. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122446. */
  122447. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  122448. /**
  122449. * Instantiates a new ArcRotateCameraInputsManager.
  122450. * @param camera Defines the camera the inputs belong to
  122451. */
  122452. constructor(camera: ArcRotateCamera);
  122453. /**
  122454. * Add mouse wheel input support to the input manager.
  122455. * @returns the current input manager
  122456. */
  122457. addMouseWheel(): ArcRotateCameraInputsManager;
  122458. /**
  122459. * Add pointers input support to the input manager.
  122460. * @returns the current input manager
  122461. */
  122462. addPointers(): ArcRotateCameraInputsManager;
  122463. /**
  122464. * Add keyboard input support to the input manager.
  122465. * @returns the current input manager
  122466. */
  122467. addKeyboard(): ArcRotateCameraInputsManager;
  122468. }
  122469. }
  122470. declare module BABYLON {
  122471. /**
  122472. * This represents an orbital type of camera.
  122473. *
  122474. * 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.
  122475. * 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.
  122476. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  122477. */
  122478. export class ArcRotateCamera extends TargetCamera {
  122479. /**
  122480. * Defines the rotation angle of the camera along the longitudinal axis.
  122481. */
  122482. alpha: number;
  122483. /**
  122484. * Defines the rotation angle of the camera along the latitudinal axis.
  122485. */
  122486. beta: number;
  122487. /**
  122488. * Defines the radius of the camera from it s target point.
  122489. */
  122490. radius: number;
  122491. protected _target: Vector3;
  122492. protected _targetHost: Nullable<AbstractMesh>;
  122493. /**
  122494. * Defines the target point of the camera.
  122495. * The camera looks towards it form the radius distance.
  122496. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  122497. */
  122498. get target(): Vector3;
  122499. set target(value: Vector3);
  122500. /**
  122501. * Define the current local position of the camera in the scene
  122502. */
  122503. get position(): Vector3;
  122504. set position(newPosition: Vector3);
  122505. protected _upToYMatrix: Matrix;
  122506. protected _YToUpMatrix: Matrix;
  122507. /**
  122508. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  122509. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  122510. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  122511. */
  122512. set upVector(vec: Vector3);
  122513. get upVector(): Vector3;
  122514. /**
  122515. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  122516. */
  122517. setMatUp(): void;
  122518. /**
  122519. * Current inertia value on the longitudinal axis.
  122520. * The bigger this number the longer it will take for the camera to stop.
  122521. */
  122522. inertialAlphaOffset: number;
  122523. /**
  122524. * Current inertia value on the latitudinal axis.
  122525. * The bigger this number the longer it will take for the camera to stop.
  122526. */
  122527. inertialBetaOffset: number;
  122528. /**
  122529. * Current inertia value on the radius axis.
  122530. * The bigger this number the longer it will take for the camera to stop.
  122531. */
  122532. inertialRadiusOffset: number;
  122533. /**
  122534. * Minimum allowed angle on the longitudinal axis.
  122535. * This can help limiting how the Camera is able to move in the scene.
  122536. */
  122537. lowerAlphaLimit: Nullable<number>;
  122538. /**
  122539. * Maximum allowed angle on the longitudinal axis.
  122540. * This can help limiting how the Camera is able to move in the scene.
  122541. */
  122542. upperAlphaLimit: Nullable<number>;
  122543. /**
  122544. * Minimum allowed angle on the latitudinal axis.
  122545. * This can help limiting how the Camera is able to move in the scene.
  122546. */
  122547. lowerBetaLimit: number;
  122548. /**
  122549. * Maximum allowed angle on the latitudinal axis.
  122550. * This can help limiting how the Camera is able to move in the scene.
  122551. */
  122552. upperBetaLimit: number;
  122553. /**
  122554. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  122555. * This can help limiting how the Camera is able to move in the scene.
  122556. */
  122557. lowerRadiusLimit: Nullable<number>;
  122558. /**
  122559. * Maximum allowed distance of the camera to the target (The camera can not get further).
  122560. * This can help limiting how the Camera is able to move in the scene.
  122561. */
  122562. upperRadiusLimit: Nullable<number>;
  122563. /**
  122564. * Defines the current inertia value used during panning of the camera along the X axis.
  122565. */
  122566. inertialPanningX: number;
  122567. /**
  122568. * Defines the current inertia value used during panning of the camera along the Y axis.
  122569. */
  122570. inertialPanningY: number;
  122571. /**
  122572. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  122573. * Basically if your fingers moves away from more than this distance you will be considered
  122574. * in pinch mode.
  122575. */
  122576. pinchToPanMaxDistance: number;
  122577. /**
  122578. * Defines the maximum distance the camera can pan.
  122579. * This could help keeping the cammera always in your scene.
  122580. */
  122581. panningDistanceLimit: Nullable<number>;
  122582. /**
  122583. * Defines the target of the camera before paning.
  122584. */
  122585. panningOriginTarget: Vector3;
  122586. /**
  122587. * Defines the value of the inertia used during panning.
  122588. * 0 would mean stop inertia and one would mean no decelleration at all.
  122589. */
  122590. panningInertia: number;
  122591. /**
  122592. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  122593. */
  122594. get angularSensibilityX(): number;
  122595. set angularSensibilityX(value: number);
  122596. /**
  122597. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  122598. */
  122599. get angularSensibilityY(): number;
  122600. set angularSensibilityY(value: number);
  122601. /**
  122602. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  122603. */
  122604. get pinchPrecision(): number;
  122605. set pinchPrecision(value: number);
  122606. /**
  122607. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  122608. * It will be used instead of pinchDeltaPrecision if different from 0.
  122609. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122610. */
  122611. get pinchDeltaPercentage(): number;
  122612. set pinchDeltaPercentage(value: number);
  122613. /**
  122614. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  122615. * and pinch delta percentage.
  122616. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122617. * that any object in the plane at the camera's target point will scale
  122618. * perfectly with finger motion.
  122619. */
  122620. get useNaturalPinchZoom(): boolean;
  122621. set useNaturalPinchZoom(value: boolean);
  122622. /**
  122623. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  122624. */
  122625. get panningSensibility(): number;
  122626. set panningSensibility(value: number);
  122627. /**
  122628. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  122629. */
  122630. get keysUp(): number[];
  122631. set keysUp(value: number[]);
  122632. /**
  122633. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  122634. */
  122635. get keysDown(): number[];
  122636. set keysDown(value: number[]);
  122637. /**
  122638. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  122639. */
  122640. get keysLeft(): number[];
  122641. set keysLeft(value: number[]);
  122642. /**
  122643. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  122644. */
  122645. get keysRight(): number[];
  122646. set keysRight(value: number[]);
  122647. /**
  122648. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122649. */
  122650. get wheelPrecision(): number;
  122651. set wheelPrecision(value: number);
  122652. /**
  122653. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  122654. * It will be used instead of pinchDeltaPrecision if different from 0.
  122655. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122656. */
  122657. get wheelDeltaPercentage(): number;
  122658. set wheelDeltaPercentage(value: number);
  122659. /**
  122660. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  122661. */
  122662. zoomOnFactor: number;
  122663. /**
  122664. * Defines a screen offset for the camera position.
  122665. */
  122666. targetScreenOffset: Vector2;
  122667. /**
  122668. * Allows the camera to be completely reversed.
  122669. * If false the camera can not arrive upside down.
  122670. */
  122671. allowUpsideDown: boolean;
  122672. /**
  122673. * Define if double tap/click is used to restore the previously saved state of the camera.
  122674. */
  122675. useInputToRestoreState: boolean;
  122676. /** @hidden */
  122677. _viewMatrix: Matrix;
  122678. /** @hidden */
  122679. _useCtrlForPanning: boolean;
  122680. /** @hidden */
  122681. _panningMouseButton: number;
  122682. /**
  122683. * Defines the input associated to the camera.
  122684. */
  122685. inputs: ArcRotateCameraInputsManager;
  122686. /** @hidden */
  122687. _reset: () => void;
  122688. /**
  122689. * Defines the allowed panning axis.
  122690. */
  122691. panningAxis: Vector3;
  122692. protected _localDirection: Vector3;
  122693. protected _transformedDirection: Vector3;
  122694. private _bouncingBehavior;
  122695. /**
  122696. * Gets the bouncing behavior of the camera if it has been enabled.
  122697. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122698. */
  122699. get bouncingBehavior(): Nullable<BouncingBehavior>;
  122700. /**
  122701. * Defines if the bouncing behavior of the camera is enabled on the camera.
  122702. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122703. */
  122704. get useBouncingBehavior(): boolean;
  122705. set useBouncingBehavior(value: boolean);
  122706. private _framingBehavior;
  122707. /**
  122708. * Gets the framing behavior of the camera if it has been enabled.
  122709. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122710. */
  122711. get framingBehavior(): Nullable<FramingBehavior>;
  122712. /**
  122713. * Defines if the framing behavior of the camera is enabled on the camera.
  122714. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122715. */
  122716. get useFramingBehavior(): boolean;
  122717. set useFramingBehavior(value: boolean);
  122718. private _autoRotationBehavior;
  122719. /**
  122720. * Gets the auto rotation behavior of the camera if it has been enabled.
  122721. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122722. */
  122723. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  122724. /**
  122725. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  122726. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122727. */
  122728. get useAutoRotationBehavior(): boolean;
  122729. set useAutoRotationBehavior(value: boolean);
  122730. /**
  122731. * Observable triggered when the mesh target has been changed on the camera.
  122732. */
  122733. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  122734. /**
  122735. * Event raised when the camera is colliding with a mesh.
  122736. */
  122737. onCollide: (collidedMesh: AbstractMesh) => void;
  122738. /**
  122739. * Defines whether the camera should check collision with the objects oh the scene.
  122740. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  122741. */
  122742. checkCollisions: boolean;
  122743. /**
  122744. * Defines the collision radius of the camera.
  122745. * This simulates a sphere around the camera.
  122746. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  122747. */
  122748. collisionRadius: Vector3;
  122749. protected _collider: Collider;
  122750. protected _previousPosition: Vector3;
  122751. protected _collisionVelocity: Vector3;
  122752. protected _newPosition: Vector3;
  122753. protected _previousAlpha: number;
  122754. protected _previousBeta: number;
  122755. protected _previousRadius: number;
  122756. protected _collisionTriggered: boolean;
  122757. protected _targetBoundingCenter: Nullable<Vector3>;
  122758. private _computationVector;
  122759. /**
  122760. * Instantiates a new ArcRotateCamera in a given scene
  122761. * @param name Defines the name of the camera
  122762. * @param alpha Defines the camera rotation along the logitudinal axis
  122763. * @param beta Defines the camera rotation along the latitudinal axis
  122764. * @param radius Defines the camera distance from its target
  122765. * @param target Defines the camera target
  122766. * @param scene Defines the scene the camera belongs to
  122767. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  122768. */
  122769. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  122770. /** @hidden */
  122771. _initCache(): void;
  122772. /** @hidden */
  122773. _updateCache(ignoreParentClass?: boolean): void;
  122774. protected _getTargetPosition(): Vector3;
  122775. private _storedAlpha;
  122776. private _storedBeta;
  122777. private _storedRadius;
  122778. private _storedTarget;
  122779. private _storedTargetScreenOffset;
  122780. /**
  122781. * Stores the current state of the camera (alpha, beta, radius and target)
  122782. * @returns the camera itself
  122783. */
  122784. storeState(): Camera;
  122785. /**
  122786. * @hidden
  122787. * Restored camera state. You must call storeState() first
  122788. */
  122789. _restoreStateValues(): boolean;
  122790. /** @hidden */
  122791. _isSynchronizedViewMatrix(): boolean;
  122792. /**
  122793. * Attached controls to the current camera.
  122794. * @param element Defines the element the controls should be listened from
  122795. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122796. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  122797. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  122798. */
  122799. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  122800. /**
  122801. * Detach the current controls from the camera.
  122802. * The camera will stop reacting to inputs.
  122803. * @param element Defines the element to stop listening the inputs from
  122804. */
  122805. detachControl(element: HTMLElement): void;
  122806. /** @hidden */
  122807. _checkInputs(): void;
  122808. protected _checkLimits(): void;
  122809. /**
  122810. * Rebuilds angles (alpha, beta) and radius from the give position and target
  122811. */
  122812. rebuildAnglesAndRadius(): void;
  122813. /**
  122814. * Use a position to define the current camera related information like alpha, beta and radius
  122815. * @param position Defines the position to set the camera at
  122816. */
  122817. setPosition(position: Vector3): void;
  122818. /**
  122819. * Defines the target the camera should look at.
  122820. * This will automatically adapt alpha beta and radius to fit within the new target.
  122821. * @param target Defines the new target as a Vector or a mesh
  122822. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  122823. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  122824. */
  122825. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  122826. /** @hidden */
  122827. _getViewMatrix(): Matrix;
  122828. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  122829. /**
  122830. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  122831. * @param meshes Defines the mesh to zoom on
  122832. * @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)
  122833. */
  122834. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  122835. /**
  122836. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  122837. * The target will be changed but the radius
  122838. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  122839. * @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)
  122840. */
  122841. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  122842. min: Vector3;
  122843. max: Vector3;
  122844. distance: number;
  122845. }, doNotUpdateMaxZ?: boolean): void;
  122846. /**
  122847. * @override
  122848. * Override Camera.createRigCamera
  122849. */
  122850. createRigCamera(name: string, cameraIndex: number): Camera;
  122851. /**
  122852. * @hidden
  122853. * @override
  122854. * Override Camera._updateRigCameras
  122855. */
  122856. _updateRigCameras(): void;
  122857. /**
  122858. * Destroy the camera and release the current resources hold by it.
  122859. */
  122860. dispose(): void;
  122861. /**
  122862. * Gets the current object class name.
  122863. * @return the class name
  122864. */
  122865. getClassName(): string;
  122866. }
  122867. }
  122868. declare module BABYLON {
  122869. /**
  122870. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  122871. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122872. */
  122873. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  122874. /**
  122875. * Gets the name of the behavior.
  122876. */
  122877. get name(): string;
  122878. private _zoomStopsAnimation;
  122879. private _idleRotationSpeed;
  122880. private _idleRotationWaitTime;
  122881. private _idleRotationSpinupTime;
  122882. /**
  122883. * Sets the flag that indicates if user zooming should stop animation.
  122884. */
  122885. set zoomStopsAnimation(flag: boolean);
  122886. /**
  122887. * Gets the flag that indicates if user zooming should stop animation.
  122888. */
  122889. get zoomStopsAnimation(): boolean;
  122890. /**
  122891. * Sets the default speed at which the camera rotates around the model.
  122892. */
  122893. set idleRotationSpeed(speed: number);
  122894. /**
  122895. * Gets the default speed at which the camera rotates around the model.
  122896. */
  122897. get idleRotationSpeed(): number;
  122898. /**
  122899. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  122900. */
  122901. set idleRotationWaitTime(time: number);
  122902. /**
  122903. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  122904. */
  122905. get idleRotationWaitTime(): number;
  122906. /**
  122907. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122908. */
  122909. set idleRotationSpinupTime(time: number);
  122910. /**
  122911. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122912. */
  122913. get idleRotationSpinupTime(): number;
  122914. /**
  122915. * Gets a value indicating if the camera is currently rotating because of this behavior
  122916. */
  122917. get rotationInProgress(): boolean;
  122918. private _onPrePointerObservableObserver;
  122919. private _onAfterCheckInputsObserver;
  122920. private _attachedCamera;
  122921. private _isPointerDown;
  122922. private _lastFrameTime;
  122923. private _lastInteractionTime;
  122924. private _cameraRotationSpeed;
  122925. /**
  122926. * Initializes the behavior.
  122927. */
  122928. init(): void;
  122929. /**
  122930. * Attaches the behavior to its arc rotate camera.
  122931. * @param camera Defines the camera to attach the behavior to
  122932. */
  122933. attach(camera: ArcRotateCamera): void;
  122934. /**
  122935. * Detaches the behavior from its current arc rotate camera.
  122936. */
  122937. detach(): void;
  122938. /**
  122939. * Returns true if user is scrolling.
  122940. * @return true if user is scrolling.
  122941. */
  122942. private _userIsZooming;
  122943. private _lastFrameRadius;
  122944. private _shouldAnimationStopForInteraction;
  122945. /**
  122946. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122947. */
  122948. private _applyUserInteraction;
  122949. private _userIsMoving;
  122950. }
  122951. }
  122952. declare module BABYLON {
  122953. /**
  122954. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  122955. */
  122956. export class AttachToBoxBehavior implements Behavior<Mesh> {
  122957. private ui;
  122958. /**
  122959. * The name of the behavior
  122960. */
  122961. name: string;
  122962. /**
  122963. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  122964. */
  122965. distanceAwayFromFace: number;
  122966. /**
  122967. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  122968. */
  122969. distanceAwayFromBottomOfFace: number;
  122970. private _faceVectors;
  122971. private _target;
  122972. private _scene;
  122973. private _onRenderObserver;
  122974. private _tmpMatrix;
  122975. private _tmpVector;
  122976. /**
  122977. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  122978. * @param ui The transform node that should be attched to the mesh
  122979. */
  122980. constructor(ui: TransformNode);
  122981. /**
  122982. * Initializes the behavior
  122983. */
  122984. init(): void;
  122985. private _closestFace;
  122986. private _zeroVector;
  122987. private _lookAtTmpMatrix;
  122988. private _lookAtToRef;
  122989. /**
  122990. * Attaches the AttachToBoxBehavior to the passed in mesh
  122991. * @param target The mesh that the specified node will be attached to
  122992. */
  122993. attach(target: Mesh): void;
  122994. /**
  122995. * Detaches the behavior from the mesh
  122996. */
  122997. detach(): void;
  122998. }
  122999. }
  123000. declare module BABYLON {
  123001. /**
  123002. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  123003. */
  123004. export class FadeInOutBehavior implements Behavior<Mesh> {
  123005. /**
  123006. * Time in milliseconds to delay before fading in (Default: 0)
  123007. */
  123008. delay: number;
  123009. /**
  123010. * Time in milliseconds for the mesh to fade in (Default: 300)
  123011. */
  123012. fadeInTime: number;
  123013. private _millisecondsPerFrame;
  123014. private _hovered;
  123015. private _hoverValue;
  123016. private _ownerNode;
  123017. /**
  123018. * Instatiates the FadeInOutBehavior
  123019. */
  123020. constructor();
  123021. /**
  123022. * The name of the behavior
  123023. */
  123024. get name(): string;
  123025. /**
  123026. * Initializes the behavior
  123027. */
  123028. init(): void;
  123029. /**
  123030. * Attaches the fade behavior on the passed in mesh
  123031. * @param ownerNode The mesh that will be faded in/out once attached
  123032. */
  123033. attach(ownerNode: Mesh): void;
  123034. /**
  123035. * Detaches the behavior from the mesh
  123036. */
  123037. detach(): void;
  123038. /**
  123039. * Triggers the mesh to begin fading in or out
  123040. * @param value if the object should fade in or out (true to fade in)
  123041. */
  123042. fadeIn(value: boolean): void;
  123043. private _update;
  123044. private _setAllVisibility;
  123045. }
  123046. }
  123047. declare module BABYLON {
  123048. /**
  123049. * Class containing a set of static utilities functions for managing Pivots
  123050. * @hidden
  123051. */
  123052. export class PivotTools {
  123053. private static _PivotCached;
  123054. private static _OldPivotPoint;
  123055. private static _PivotTranslation;
  123056. private static _PivotTmpVector;
  123057. /** @hidden */
  123058. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  123059. /** @hidden */
  123060. static _RestorePivotPoint(mesh: AbstractMesh): void;
  123061. }
  123062. }
  123063. declare module BABYLON {
  123064. /**
  123065. * Class containing static functions to help procedurally build meshes
  123066. */
  123067. export class PlaneBuilder {
  123068. /**
  123069. * Creates a plane mesh
  123070. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  123071. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  123072. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  123073. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  123074. * * 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
  123075. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  123076. * @param name defines the name of the mesh
  123077. * @param options defines the options used to create the mesh
  123078. * @param scene defines the hosting scene
  123079. * @returns the plane mesh
  123080. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  123081. */
  123082. static CreatePlane(name: string, options: {
  123083. size?: number;
  123084. width?: number;
  123085. height?: number;
  123086. sideOrientation?: number;
  123087. frontUVs?: Vector4;
  123088. backUVs?: Vector4;
  123089. updatable?: boolean;
  123090. sourcePlane?: Plane;
  123091. }, scene?: Nullable<Scene>): Mesh;
  123092. }
  123093. }
  123094. declare module BABYLON {
  123095. /**
  123096. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  123097. */
  123098. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  123099. private static _AnyMouseID;
  123100. /**
  123101. * Abstract mesh the behavior is set on
  123102. */
  123103. attachedNode: AbstractMesh;
  123104. private _dragPlane;
  123105. private _scene;
  123106. private _pointerObserver;
  123107. private _beforeRenderObserver;
  123108. private static _planeScene;
  123109. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  123110. /**
  123111. * 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)
  123112. */
  123113. maxDragAngle: number;
  123114. /**
  123115. * @hidden
  123116. */
  123117. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  123118. /**
  123119. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123120. */
  123121. currentDraggingPointerID: number;
  123122. /**
  123123. * The last position where the pointer hit the drag plane in world space
  123124. */
  123125. lastDragPosition: Vector3;
  123126. /**
  123127. * If the behavior is currently in a dragging state
  123128. */
  123129. dragging: boolean;
  123130. /**
  123131. * 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)
  123132. */
  123133. dragDeltaRatio: number;
  123134. /**
  123135. * If the drag plane orientation should be updated during the dragging (Default: true)
  123136. */
  123137. updateDragPlane: boolean;
  123138. private _debugMode;
  123139. private _moving;
  123140. /**
  123141. * Fires each time the attached mesh is dragged with the pointer
  123142. * * delta between last drag position and current drag position in world space
  123143. * * dragDistance along the drag axis
  123144. * * dragPlaneNormal normal of the current drag plane used during the drag
  123145. * * dragPlanePoint in world space where the drag intersects the drag plane
  123146. */
  123147. onDragObservable: Observable<{
  123148. delta: Vector3;
  123149. dragPlanePoint: Vector3;
  123150. dragPlaneNormal: Vector3;
  123151. dragDistance: number;
  123152. pointerId: number;
  123153. }>;
  123154. /**
  123155. * Fires each time a drag begins (eg. mouse down on mesh)
  123156. */
  123157. onDragStartObservable: Observable<{
  123158. dragPlanePoint: Vector3;
  123159. pointerId: number;
  123160. }>;
  123161. /**
  123162. * Fires each time a drag ends (eg. mouse release after drag)
  123163. */
  123164. onDragEndObservable: Observable<{
  123165. dragPlanePoint: Vector3;
  123166. pointerId: number;
  123167. }>;
  123168. /**
  123169. * If the attached mesh should be moved when dragged
  123170. */
  123171. moveAttached: boolean;
  123172. /**
  123173. * If the drag behavior will react to drag events (Default: true)
  123174. */
  123175. enabled: boolean;
  123176. /**
  123177. * If pointer events should start and release the drag (Default: true)
  123178. */
  123179. startAndReleaseDragOnPointerEvents: boolean;
  123180. /**
  123181. * If camera controls should be detached during the drag
  123182. */
  123183. detachCameraControls: boolean;
  123184. /**
  123185. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  123186. */
  123187. useObjectOrientationForDragging: boolean;
  123188. private _options;
  123189. /**
  123190. * Gets the options used by the behavior
  123191. */
  123192. get options(): {
  123193. dragAxis?: Vector3;
  123194. dragPlaneNormal?: Vector3;
  123195. };
  123196. /**
  123197. * Sets the options used by the behavior
  123198. */
  123199. set options(options: {
  123200. dragAxis?: Vector3;
  123201. dragPlaneNormal?: Vector3;
  123202. });
  123203. /**
  123204. * Creates a pointer drag behavior that can be attached to a mesh
  123205. * @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)
  123206. */
  123207. constructor(options?: {
  123208. dragAxis?: Vector3;
  123209. dragPlaneNormal?: Vector3;
  123210. });
  123211. /**
  123212. * Predicate to determine if it is valid to move the object to a new position when it is moved
  123213. */
  123214. validateDrag: (targetPosition: Vector3) => boolean;
  123215. /**
  123216. * The name of the behavior
  123217. */
  123218. get name(): string;
  123219. /**
  123220. * Initializes the behavior
  123221. */
  123222. init(): void;
  123223. private _tmpVector;
  123224. private _alternatePickedPoint;
  123225. private _worldDragAxis;
  123226. private _targetPosition;
  123227. private _attachedElement;
  123228. /**
  123229. * Attaches the drag behavior the passed in mesh
  123230. * @param ownerNode The mesh that will be dragged around once attached
  123231. * @param predicate Predicate to use for pick filtering
  123232. */
  123233. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  123234. /**
  123235. * Force relase the drag action by code.
  123236. */
  123237. releaseDrag(): void;
  123238. private _startDragRay;
  123239. private _lastPointerRay;
  123240. /**
  123241. * Simulates the start of a pointer drag event on the behavior
  123242. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  123243. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  123244. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  123245. */
  123246. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  123247. private _startDrag;
  123248. private _dragDelta;
  123249. private _moveDrag;
  123250. private _pickWithRayOnDragPlane;
  123251. private _pointA;
  123252. private _pointC;
  123253. private _localAxis;
  123254. private _lookAt;
  123255. private _updateDragPlanePosition;
  123256. /**
  123257. * Detaches the behavior from the mesh
  123258. */
  123259. detach(): void;
  123260. }
  123261. }
  123262. declare module BABYLON {
  123263. /**
  123264. * A behavior that when attached to a mesh will allow the mesh to be scaled
  123265. */
  123266. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  123267. private _dragBehaviorA;
  123268. private _dragBehaviorB;
  123269. private _startDistance;
  123270. private _initialScale;
  123271. private _targetScale;
  123272. private _ownerNode;
  123273. private _sceneRenderObserver;
  123274. /**
  123275. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  123276. */
  123277. constructor();
  123278. /**
  123279. * The name of the behavior
  123280. */
  123281. get name(): string;
  123282. /**
  123283. * Initializes the behavior
  123284. */
  123285. init(): void;
  123286. private _getCurrentDistance;
  123287. /**
  123288. * Attaches the scale behavior the passed in mesh
  123289. * @param ownerNode The mesh that will be scaled around once attached
  123290. */
  123291. attach(ownerNode: Mesh): void;
  123292. /**
  123293. * Detaches the behavior from the mesh
  123294. */
  123295. detach(): void;
  123296. }
  123297. }
  123298. declare module BABYLON {
  123299. /**
  123300. * 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
  123301. */
  123302. export class SixDofDragBehavior implements Behavior<Mesh> {
  123303. private static _virtualScene;
  123304. private _ownerNode;
  123305. private _sceneRenderObserver;
  123306. private _scene;
  123307. private _targetPosition;
  123308. private _virtualOriginMesh;
  123309. private _virtualDragMesh;
  123310. private _pointerObserver;
  123311. private _moving;
  123312. private _startingOrientation;
  123313. private _attachedElement;
  123314. /**
  123315. * 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)
  123316. */
  123317. private zDragFactor;
  123318. /**
  123319. * If the object should rotate to face the drag origin
  123320. */
  123321. rotateDraggedObject: boolean;
  123322. /**
  123323. * If the behavior is currently in a dragging state
  123324. */
  123325. dragging: boolean;
  123326. /**
  123327. * 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)
  123328. */
  123329. dragDeltaRatio: number;
  123330. /**
  123331. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123332. */
  123333. currentDraggingPointerID: number;
  123334. /**
  123335. * If camera controls should be detached during the drag
  123336. */
  123337. detachCameraControls: boolean;
  123338. /**
  123339. * Fires each time a drag starts
  123340. */
  123341. onDragStartObservable: Observable<{}>;
  123342. /**
  123343. * Fires each time a drag ends (eg. mouse release after drag)
  123344. */
  123345. onDragEndObservable: Observable<{}>;
  123346. /**
  123347. * 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
  123348. */
  123349. constructor();
  123350. /**
  123351. * The name of the behavior
  123352. */
  123353. get name(): string;
  123354. /**
  123355. * Initializes the behavior
  123356. */
  123357. init(): void;
  123358. /**
  123359. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  123360. */
  123361. private get _pointerCamera();
  123362. /**
  123363. * Attaches the scale behavior the passed in mesh
  123364. * @param ownerNode The mesh that will be scaled around once attached
  123365. */
  123366. attach(ownerNode: Mesh): void;
  123367. /**
  123368. * Detaches the behavior from the mesh
  123369. */
  123370. detach(): void;
  123371. }
  123372. }
  123373. declare module BABYLON {
  123374. /**
  123375. * Class used to apply inverse kinematics to bones
  123376. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  123377. */
  123378. export class BoneIKController {
  123379. private static _tmpVecs;
  123380. private static _tmpQuat;
  123381. private static _tmpMats;
  123382. /**
  123383. * Gets or sets the target mesh
  123384. */
  123385. targetMesh: AbstractMesh;
  123386. /** Gets or sets the mesh used as pole */
  123387. poleTargetMesh: AbstractMesh;
  123388. /**
  123389. * Gets or sets the bone used as pole
  123390. */
  123391. poleTargetBone: Nullable<Bone>;
  123392. /**
  123393. * Gets or sets the target position
  123394. */
  123395. targetPosition: Vector3;
  123396. /**
  123397. * Gets or sets the pole target position
  123398. */
  123399. poleTargetPosition: Vector3;
  123400. /**
  123401. * Gets or sets the pole target local offset
  123402. */
  123403. poleTargetLocalOffset: Vector3;
  123404. /**
  123405. * Gets or sets the pole angle
  123406. */
  123407. poleAngle: number;
  123408. /**
  123409. * Gets or sets the mesh associated with the controller
  123410. */
  123411. mesh: AbstractMesh;
  123412. /**
  123413. * 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)
  123414. */
  123415. slerpAmount: number;
  123416. private _bone1Quat;
  123417. private _bone1Mat;
  123418. private _bone2Ang;
  123419. private _bone1;
  123420. private _bone2;
  123421. private _bone1Length;
  123422. private _bone2Length;
  123423. private _maxAngle;
  123424. private _maxReach;
  123425. private _rightHandedSystem;
  123426. private _bendAxis;
  123427. private _slerping;
  123428. private _adjustRoll;
  123429. /**
  123430. * Gets or sets maximum allowed angle
  123431. */
  123432. get maxAngle(): number;
  123433. set maxAngle(value: number);
  123434. /**
  123435. * Creates a new BoneIKController
  123436. * @param mesh defines the mesh to control
  123437. * @param bone defines the bone to control
  123438. * @param options defines options to set up the controller
  123439. */
  123440. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  123441. targetMesh?: AbstractMesh;
  123442. poleTargetMesh?: AbstractMesh;
  123443. poleTargetBone?: Bone;
  123444. poleTargetLocalOffset?: Vector3;
  123445. poleAngle?: number;
  123446. bendAxis?: Vector3;
  123447. maxAngle?: number;
  123448. slerpAmount?: number;
  123449. });
  123450. private _setMaxAngle;
  123451. /**
  123452. * Force the controller to update the bones
  123453. */
  123454. update(): void;
  123455. }
  123456. }
  123457. declare module BABYLON {
  123458. /**
  123459. * Class used to make a bone look toward a point in space
  123460. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  123461. */
  123462. export class BoneLookController {
  123463. private static _tmpVecs;
  123464. private static _tmpQuat;
  123465. private static _tmpMats;
  123466. /**
  123467. * The target Vector3 that the bone will look at
  123468. */
  123469. target: Vector3;
  123470. /**
  123471. * The mesh that the bone is attached to
  123472. */
  123473. mesh: AbstractMesh;
  123474. /**
  123475. * The bone that will be looking to the target
  123476. */
  123477. bone: Bone;
  123478. /**
  123479. * The up axis of the coordinate system that is used when the bone is rotated
  123480. */
  123481. upAxis: Vector3;
  123482. /**
  123483. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  123484. */
  123485. upAxisSpace: Space;
  123486. /**
  123487. * Used to make an adjustment to the yaw of the bone
  123488. */
  123489. adjustYaw: number;
  123490. /**
  123491. * Used to make an adjustment to the pitch of the bone
  123492. */
  123493. adjustPitch: number;
  123494. /**
  123495. * Used to make an adjustment to the roll of the bone
  123496. */
  123497. adjustRoll: number;
  123498. /**
  123499. * 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)
  123500. */
  123501. slerpAmount: number;
  123502. private _minYaw;
  123503. private _maxYaw;
  123504. private _minPitch;
  123505. private _maxPitch;
  123506. private _minYawSin;
  123507. private _minYawCos;
  123508. private _maxYawSin;
  123509. private _maxYawCos;
  123510. private _midYawConstraint;
  123511. private _minPitchTan;
  123512. private _maxPitchTan;
  123513. private _boneQuat;
  123514. private _slerping;
  123515. private _transformYawPitch;
  123516. private _transformYawPitchInv;
  123517. private _firstFrameSkipped;
  123518. private _yawRange;
  123519. private _fowardAxis;
  123520. /**
  123521. * Gets or sets the minimum yaw angle that the bone can look to
  123522. */
  123523. get minYaw(): number;
  123524. set minYaw(value: number);
  123525. /**
  123526. * Gets or sets the maximum yaw angle that the bone can look to
  123527. */
  123528. get maxYaw(): number;
  123529. set maxYaw(value: number);
  123530. /**
  123531. * Gets or sets the minimum pitch angle that the bone can look to
  123532. */
  123533. get minPitch(): number;
  123534. set minPitch(value: number);
  123535. /**
  123536. * Gets or sets the maximum pitch angle that the bone can look to
  123537. */
  123538. get maxPitch(): number;
  123539. set maxPitch(value: number);
  123540. /**
  123541. * Create a BoneLookController
  123542. * @param mesh the mesh that the bone belongs to
  123543. * @param bone the bone that will be looking to the target
  123544. * @param target the target Vector3 to look at
  123545. * @param options optional settings:
  123546. * * maxYaw: the maximum angle the bone will yaw to
  123547. * * minYaw: the minimum angle the bone will yaw to
  123548. * * maxPitch: the maximum angle the bone will pitch to
  123549. * * minPitch: the minimum angle the bone will yaw to
  123550. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  123551. * * upAxis: the up axis of the coordinate system
  123552. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  123553. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  123554. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  123555. * * adjustYaw: used to make an adjustment to the yaw of the bone
  123556. * * adjustPitch: used to make an adjustment to the pitch of the bone
  123557. * * adjustRoll: used to make an adjustment to the roll of the bone
  123558. **/
  123559. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  123560. maxYaw?: number;
  123561. minYaw?: number;
  123562. maxPitch?: number;
  123563. minPitch?: number;
  123564. slerpAmount?: number;
  123565. upAxis?: Vector3;
  123566. upAxisSpace?: Space;
  123567. yawAxis?: Vector3;
  123568. pitchAxis?: Vector3;
  123569. adjustYaw?: number;
  123570. adjustPitch?: number;
  123571. adjustRoll?: number;
  123572. });
  123573. /**
  123574. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  123575. */
  123576. update(): void;
  123577. private _getAngleDiff;
  123578. private _getAngleBetween;
  123579. private _isAngleBetween;
  123580. }
  123581. }
  123582. declare module BABYLON {
  123583. /**
  123584. * Manage the gamepad inputs to control an arc rotate camera.
  123585. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123586. */
  123587. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  123588. /**
  123589. * Defines the camera the input is attached to.
  123590. */
  123591. camera: ArcRotateCamera;
  123592. /**
  123593. * Defines the gamepad the input is gathering event from.
  123594. */
  123595. gamepad: Nullable<Gamepad>;
  123596. /**
  123597. * Defines the gamepad rotation sensiblity.
  123598. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  123599. */
  123600. gamepadRotationSensibility: number;
  123601. /**
  123602. * Defines the gamepad move sensiblity.
  123603. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  123604. */
  123605. gamepadMoveSensibility: number;
  123606. private _yAxisScale;
  123607. /**
  123608. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  123609. */
  123610. get invertYAxis(): boolean;
  123611. set invertYAxis(value: boolean);
  123612. private _onGamepadConnectedObserver;
  123613. private _onGamepadDisconnectedObserver;
  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. /**
  123621. * Detach the current controls from the specified dom element.
  123622. * @param element Defines the element to stop listening the inputs from
  123623. */
  123624. detachControl(element: Nullable<HTMLElement>): void;
  123625. /**
  123626. * Update the current camera state depending on the inputs that have been used this frame.
  123627. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123628. */
  123629. checkInputs(): void;
  123630. /**
  123631. * Gets the class name of the current intput.
  123632. * @returns the class name
  123633. */
  123634. getClassName(): string;
  123635. /**
  123636. * Get the friendly name associated with the input class.
  123637. * @returns the input friendly name
  123638. */
  123639. getSimpleName(): string;
  123640. }
  123641. }
  123642. declare module BABYLON {
  123643. interface ArcRotateCameraInputsManager {
  123644. /**
  123645. * Add orientation input support to the input manager.
  123646. * @returns the current input manager
  123647. */
  123648. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  123649. }
  123650. /**
  123651. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  123652. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123653. */
  123654. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  123655. /**
  123656. * Defines the camera the input is attached to.
  123657. */
  123658. camera: ArcRotateCamera;
  123659. /**
  123660. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  123661. */
  123662. alphaCorrection: number;
  123663. /**
  123664. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  123665. */
  123666. gammaCorrection: number;
  123667. private _alpha;
  123668. private _gamma;
  123669. private _dirty;
  123670. private _deviceOrientationHandler;
  123671. /**
  123672. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  123673. */
  123674. constructor();
  123675. /**
  123676. * Attach the input controls to a specific dom element to get the input from.
  123677. * @param element Defines the element the controls should be listened from
  123678. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123679. */
  123680. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123681. /** @hidden */
  123682. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  123683. /**
  123684. * Update the current camera state depending on the inputs that have been used this frame.
  123685. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123686. */
  123687. checkInputs(): void;
  123688. /**
  123689. * Detach the current controls from the specified dom element.
  123690. * @param element Defines the element to stop listening the inputs from
  123691. */
  123692. detachControl(element: Nullable<HTMLElement>): void;
  123693. /**
  123694. * Gets the class name of the current intput.
  123695. * @returns the class name
  123696. */
  123697. getClassName(): string;
  123698. /**
  123699. * Get the friendly name associated with the input class.
  123700. * @returns the input friendly name
  123701. */
  123702. getSimpleName(): string;
  123703. }
  123704. }
  123705. declare module BABYLON {
  123706. /**
  123707. * Listen to mouse events to control the camera.
  123708. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123709. */
  123710. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  123711. /**
  123712. * Defines the camera the input is attached to.
  123713. */
  123714. camera: FlyCamera;
  123715. /**
  123716. * Defines if touch is enabled. (Default is true.)
  123717. */
  123718. touchEnabled: boolean;
  123719. /**
  123720. * Defines the buttons associated with the input to handle camera rotation.
  123721. */
  123722. buttons: number[];
  123723. /**
  123724. * Assign buttons for Yaw control.
  123725. */
  123726. buttonsYaw: number[];
  123727. /**
  123728. * Assign buttons for Pitch control.
  123729. */
  123730. buttonsPitch: number[];
  123731. /**
  123732. * Assign buttons for Roll control.
  123733. */
  123734. buttonsRoll: number[];
  123735. /**
  123736. * Detect if any button is being pressed while mouse is moved.
  123737. * -1 = Mouse locked.
  123738. * 0 = Left button.
  123739. * 1 = Middle Button.
  123740. * 2 = Right Button.
  123741. */
  123742. activeButton: number;
  123743. /**
  123744. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  123745. * Higher values reduce its sensitivity.
  123746. */
  123747. angularSensibility: number;
  123748. private _mousemoveCallback;
  123749. private _observer;
  123750. private _rollObserver;
  123751. private previousPosition;
  123752. private noPreventDefault;
  123753. private element;
  123754. /**
  123755. * Listen to mouse events to control the camera.
  123756. * @param touchEnabled Define if touch is enabled. (Default is true.)
  123757. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123758. */
  123759. constructor(touchEnabled?: boolean);
  123760. /**
  123761. * Attach the mouse control to the HTML DOM element.
  123762. * @param element Defines the element that listens to the input events.
  123763. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  123764. */
  123765. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123766. /**
  123767. * Detach the current controls from the specified dom element.
  123768. * @param element Defines the element to stop listening the inputs from
  123769. */
  123770. detachControl(element: Nullable<HTMLElement>): void;
  123771. /**
  123772. * Gets the class name of the current input.
  123773. * @returns the class name.
  123774. */
  123775. getClassName(): string;
  123776. /**
  123777. * Get the friendly name associated with the input class.
  123778. * @returns the input's friendly name.
  123779. */
  123780. getSimpleName(): string;
  123781. private _pointerInput;
  123782. private _onMouseMove;
  123783. /**
  123784. * Rotate camera by mouse offset.
  123785. */
  123786. private rotateCamera;
  123787. }
  123788. }
  123789. declare module BABYLON {
  123790. /**
  123791. * Default Inputs manager for the FlyCamera.
  123792. * It groups all the default supported inputs for ease of use.
  123793. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123794. */
  123795. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  123796. /**
  123797. * Instantiates a new FlyCameraInputsManager.
  123798. * @param camera Defines the camera the inputs belong to.
  123799. */
  123800. constructor(camera: FlyCamera);
  123801. /**
  123802. * Add keyboard input support to the input manager.
  123803. * @returns the new FlyCameraKeyboardMoveInput().
  123804. */
  123805. addKeyboard(): FlyCameraInputsManager;
  123806. /**
  123807. * Add mouse input support to the input manager.
  123808. * @param touchEnabled Enable touch screen support.
  123809. * @returns the new FlyCameraMouseInput().
  123810. */
  123811. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  123812. }
  123813. }
  123814. declare module BABYLON {
  123815. /**
  123816. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123817. * such as in a 3D Space Shooter or a Flight Simulator.
  123818. */
  123819. export class FlyCamera extends TargetCamera {
  123820. /**
  123821. * Define the collision ellipsoid of the camera.
  123822. * This is helpful for simulating a camera body, like a player's body.
  123823. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  123824. */
  123825. ellipsoid: Vector3;
  123826. /**
  123827. * Define an offset for the position of the ellipsoid around the camera.
  123828. * This can be helpful if the camera is attached away from the player's body center,
  123829. * such as at its head.
  123830. */
  123831. ellipsoidOffset: Vector3;
  123832. /**
  123833. * Enable or disable collisions of the camera with the rest of the scene objects.
  123834. */
  123835. checkCollisions: boolean;
  123836. /**
  123837. * Enable or disable gravity on the camera.
  123838. */
  123839. applyGravity: boolean;
  123840. /**
  123841. * Define the current direction the camera is moving to.
  123842. */
  123843. cameraDirection: Vector3;
  123844. /**
  123845. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  123846. * This overrides and empties cameraRotation.
  123847. */
  123848. rotationQuaternion: Quaternion;
  123849. /**
  123850. * Track Roll to maintain the wanted Rolling when looking around.
  123851. */
  123852. _trackRoll: number;
  123853. /**
  123854. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  123855. */
  123856. rollCorrect: number;
  123857. /**
  123858. * Mimic a banked turn, Rolling the camera when Yawing.
  123859. * It's recommended to use rollCorrect = 10 for faster banking correction.
  123860. */
  123861. bankedTurn: boolean;
  123862. /**
  123863. * Limit in radians for how much Roll banking will add. (Default: 90°)
  123864. */
  123865. bankedTurnLimit: number;
  123866. /**
  123867. * Value of 0 disables the banked Roll.
  123868. * Value of 1 is equal to the Yaw angle in radians.
  123869. */
  123870. bankedTurnMultiplier: number;
  123871. /**
  123872. * The inputs manager loads all the input sources, such as keyboard and mouse.
  123873. */
  123874. inputs: FlyCameraInputsManager;
  123875. /**
  123876. * Gets the input sensibility for mouse input.
  123877. * Higher values reduce sensitivity.
  123878. */
  123879. get angularSensibility(): number;
  123880. /**
  123881. * Sets the input sensibility for a mouse input.
  123882. * Higher values reduce sensitivity.
  123883. */
  123884. set angularSensibility(value: number);
  123885. /**
  123886. * Get the keys for camera movement forward.
  123887. */
  123888. get keysForward(): number[];
  123889. /**
  123890. * Set the keys for camera movement forward.
  123891. */
  123892. set keysForward(value: number[]);
  123893. /**
  123894. * Get the keys for camera movement backward.
  123895. */
  123896. get keysBackward(): number[];
  123897. set keysBackward(value: number[]);
  123898. /**
  123899. * Get the keys for camera movement up.
  123900. */
  123901. get keysUp(): number[];
  123902. /**
  123903. * Set the keys for camera movement up.
  123904. */
  123905. set keysUp(value: number[]);
  123906. /**
  123907. * Get the keys for camera movement down.
  123908. */
  123909. get keysDown(): number[];
  123910. /**
  123911. * Set the keys for camera movement down.
  123912. */
  123913. set keysDown(value: number[]);
  123914. /**
  123915. * Get the keys for camera movement left.
  123916. */
  123917. get keysLeft(): number[];
  123918. /**
  123919. * Set the keys for camera movement left.
  123920. */
  123921. set keysLeft(value: number[]);
  123922. /**
  123923. * Set the keys for camera movement right.
  123924. */
  123925. get keysRight(): number[];
  123926. /**
  123927. * Set the keys for camera movement right.
  123928. */
  123929. set keysRight(value: number[]);
  123930. /**
  123931. * Event raised when the camera collides with a mesh in the scene.
  123932. */
  123933. onCollide: (collidedMesh: AbstractMesh) => void;
  123934. private _collider;
  123935. private _needMoveForGravity;
  123936. private _oldPosition;
  123937. private _diffPosition;
  123938. private _newPosition;
  123939. /** @hidden */
  123940. _localDirection: Vector3;
  123941. /** @hidden */
  123942. _transformedDirection: Vector3;
  123943. /**
  123944. * Instantiates a FlyCamera.
  123945. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123946. * such as in a 3D Space Shooter or a Flight Simulator.
  123947. * @param name Define the name of the camera in the scene.
  123948. * @param position Define the starting position of the camera in the scene.
  123949. * @param scene Define the scene the camera belongs to.
  123950. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  123951. */
  123952. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  123953. /**
  123954. * Attach a control to the HTML DOM element.
  123955. * @param element Defines the element that listens to the input events.
  123956. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  123957. */
  123958. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123959. /**
  123960. * Detach a control from the HTML DOM element.
  123961. * The camera will stop reacting to that input.
  123962. * @param element Defines the element that listens to the input events.
  123963. */
  123964. detachControl(element: HTMLElement): void;
  123965. private _collisionMask;
  123966. /**
  123967. * Get the mask that the camera ignores in collision events.
  123968. */
  123969. get collisionMask(): number;
  123970. /**
  123971. * Set the mask that the camera ignores in collision events.
  123972. */
  123973. set collisionMask(mask: number);
  123974. /** @hidden */
  123975. _collideWithWorld(displacement: Vector3): void;
  123976. /** @hidden */
  123977. private _onCollisionPositionChange;
  123978. /** @hidden */
  123979. _checkInputs(): void;
  123980. /** @hidden */
  123981. _decideIfNeedsToMove(): boolean;
  123982. /** @hidden */
  123983. _updatePosition(): void;
  123984. /**
  123985. * Restore the Roll to its target value at the rate specified.
  123986. * @param rate - Higher means slower restoring.
  123987. * @hidden
  123988. */
  123989. restoreRoll(rate: number): void;
  123990. /**
  123991. * Destroy the camera and release the current resources held by it.
  123992. */
  123993. dispose(): void;
  123994. /**
  123995. * Get the current object class name.
  123996. * @returns the class name.
  123997. */
  123998. getClassName(): string;
  123999. }
  124000. }
  124001. declare module BABYLON {
  124002. /**
  124003. * Listen to keyboard events to control the camera.
  124004. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124005. */
  124006. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  124007. /**
  124008. * Defines the camera the input is attached to.
  124009. */
  124010. camera: FlyCamera;
  124011. /**
  124012. * The list of keyboard keys used to control the forward move of the camera.
  124013. */
  124014. keysForward: number[];
  124015. /**
  124016. * The list of keyboard keys used to control the backward move of the camera.
  124017. */
  124018. keysBackward: number[];
  124019. /**
  124020. * The list of keyboard keys used to control the forward move of the camera.
  124021. */
  124022. keysUp: number[];
  124023. /**
  124024. * The list of keyboard keys used to control the backward move of the camera.
  124025. */
  124026. keysDown: number[];
  124027. /**
  124028. * The list of keyboard keys used to control the right strafe move of the camera.
  124029. */
  124030. keysRight: number[];
  124031. /**
  124032. * The list of keyboard keys used to control the left strafe move of the camera.
  124033. */
  124034. keysLeft: number[];
  124035. private _keys;
  124036. private _onCanvasBlurObserver;
  124037. private _onKeyboardObserver;
  124038. private _engine;
  124039. private _scene;
  124040. /**
  124041. * Attach the input controls to a specific dom element to get the input from.
  124042. * @param element Defines the element the controls should be listened from
  124043. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124044. */
  124045. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124046. /**
  124047. * Detach the current controls from the specified dom element.
  124048. * @param element Defines the element to stop listening the inputs from
  124049. */
  124050. detachControl(element: Nullable<HTMLElement>): void;
  124051. /**
  124052. * Gets the class name of the current intput.
  124053. * @returns the class name
  124054. */
  124055. getClassName(): string;
  124056. /** @hidden */
  124057. _onLostFocus(e: FocusEvent): void;
  124058. /**
  124059. * Get the friendly name associated with the input class.
  124060. * @returns the input friendly name
  124061. */
  124062. getSimpleName(): string;
  124063. /**
  124064. * Update the current camera state depending on the inputs that have been used this frame.
  124065. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124066. */
  124067. checkInputs(): void;
  124068. }
  124069. }
  124070. declare module BABYLON {
  124071. /**
  124072. * Manage the mouse wheel inputs to control a follow camera.
  124073. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124074. */
  124075. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  124076. /**
  124077. * Defines the camera the input is attached to.
  124078. */
  124079. camera: FollowCamera;
  124080. /**
  124081. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  124082. */
  124083. axisControlRadius: boolean;
  124084. /**
  124085. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  124086. */
  124087. axisControlHeight: boolean;
  124088. /**
  124089. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  124090. */
  124091. axisControlRotation: boolean;
  124092. /**
  124093. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  124094. * relation to mouseWheel events.
  124095. */
  124096. wheelPrecision: number;
  124097. /**
  124098. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  124099. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  124100. */
  124101. wheelDeltaPercentage: number;
  124102. private _wheel;
  124103. private _observer;
  124104. /**
  124105. * Attach the input controls to a specific dom element to get the input from.
  124106. * @param element Defines the element the controls should be listened from
  124107. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124108. */
  124109. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124110. /**
  124111. * Detach the current controls from the specified dom element.
  124112. * @param element Defines the element to stop listening the inputs from
  124113. */
  124114. detachControl(element: Nullable<HTMLElement>): void;
  124115. /**
  124116. * Gets the class name of the current intput.
  124117. * @returns the class name
  124118. */
  124119. getClassName(): string;
  124120. /**
  124121. * Get the friendly name associated with the input class.
  124122. * @returns the input friendly name
  124123. */
  124124. getSimpleName(): string;
  124125. }
  124126. }
  124127. declare module BABYLON {
  124128. /**
  124129. * Manage the pointers inputs to control an follow camera.
  124130. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124131. */
  124132. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  124133. /**
  124134. * Defines the camera the input is attached to.
  124135. */
  124136. camera: FollowCamera;
  124137. /**
  124138. * Gets the class name of the current input.
  124139. * @returns the class name
  124140. */
  124141. getClassName(): string;
  124142. /**
  124143. * Defines the pointer angular sensibility along the X axis or how fast is
  124144. * the camera rotating.
  124145. * A negative number will reverse the axis direction.
  124146. */
  124147. angularSensibilityX: number;
  124148. /**
  124149. * Defines the pointer angular sensibility along the Y axis or how fast is
  124150. * the camera rotating.
  124151. * A negative number will reverse the axis direction.
  124152. */
  124153. angularSensibilityY: number;
  124154. /**
  124155. * Defines the pointer pinch precision or how fast is the camera zooming.
  124156. * A negative number will reverse the axis direction.
  124157. */
  124158. pinchPrecision: number;
  124159. /**
  124160. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  124161. * from 0.
  124162. * It defines the percentage of current camera.radius to use as delta when
  124163. * pinch zoom is used.
  124164. */
  124165. pinchDeltaPercentage: number;
  124166. /**
  124167. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  124168. */
  124169. axisXControlRadius: boolean;
  124170. /**
  124171. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  124172. */
  124173. axisXControlHeight: boolean;
  124174. /**
  124175. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  124176. */
  124177. axisXControlRotation: boolean;
  124178. /**
  124179. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  124180. */
  124181. axisYControlRadius: boolean;
  124182. /**
  124183. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  124184. */
  124185. axisYControlHeight: boolean;
  124186. /**
  124187. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  124188. */
  124189. axisYControlRotation: boolean;
  124190. /**
  124191. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  124192. */
  124193. axisPinchControlRadius: boolean;
  124194. /**
  124195. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  124196. */
  124197. axisPinchControlHeight: boolean;
  124198. /**
  124199. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  124200. */
  124201. axisPinchControlRotation: boolean;
  124202. /**
  124203. * Log error messages if basic misconfiguration has occurred.
  124204. */
  124205. warningEnable: boolean;
  124206. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  124207. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  124208. private _warningCounter;
  124209. private _warning;
  124210. }
  124211. }
  124212. declare module BABYLON {
  124213. /**
  124214. * Default Inputs manager for the FollowCamera.
  124215. * It groups all the default supported inputs for ease of use.
  124216. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124217. */
  124218. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  124219. /**
  124220. * Instantiates a new FollowCameraInputsManager.
  124221. * @param camera Defines the camera the inputs belong to
  124222. */
  124223. constructor(camera: FollowCamera);
  124224. /**
  124225. * Add keyboard input support to the input manager.
  124226. * @returns the current input manager
  124227. */
  124228. addKeyboard(): FollowCameraInputsManager;
  124229. /**
  124230. * Add mouse wheel input support to the input manager.
  124231. * @returns the current input manager
  124232. */
  124233. addMouseWheel(): FollowCameraInputsManager;
  124234. /**
  124235. * Add pointers input support to the input manager.
  124236. * @returns the current input manager
  124237. */
  124238. addPointers(): FollowCameraInputsManager;
  124239. /**
  124240. * Add orientation input support to the input manager.
  124241. * @returns the current input manager
  124242. */
  124243. addVRDeviceOrientation(): FollowCameraInputsManager;
  124244. }
  124245. }
  124246. declare module BABYLON {
  124247. /**
  124248. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  124249. * an arc rotate version arcFollowCamera are available.
  124250. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124251. */
  124252. export class FollowCamera extends TargetCamera {
  124253. /**
  124254. * Distance the follow camera should follow an object at
  124255. */
  124256. radius: number;
  124257. /**
  124258. * Minimum allowed distance of the camera to the axis of rotation
  124259. * (The camera can not get closer).
  124260. * This can help limiting how the Camera is able to move in the scene.
  124261. */
  124262. lowerRadiusLimit: Nullable<number>;
  124263. /**
  124264. * Maximum allowed distance of the camera to the axis of rotation
  124265. * (The camera can not get further).
  124266. * This can help limiting how the Camera is able to move in the scene.
  124267. */
  124268. upperRadiusLimit: Nullable<number>;
  124269. /**
  124270. * Define a rotation offset between the camera and the object it follows
  124271. */
  124272. rotationOffset: number;
  124273. /**
  124274. * Minimum allowed angle to camera position relative to target object.
  124275. * This can help limiting how the Camera is able to move in the scene.
  124276. */
  124277. lowerRotationOffsetLimit: Nullable<number>;
  124278. /**
  124279. * Maximum allowed angle to camera position relative to target object.
  124280. * This can help limiting how the Camera is able to move in the scene.
  124281. */
  124282. upperRotationOffsetLimit: Nullable<number>;
  124283. /**
  124284. * Define a height offset between the camera and the object it follows.
  124285. * It can help following an object from the top (like a car chaing a plane)
  124286. */
  124287. heightOffset: number;
  124288. /**
  124289. * Minimum allowed height of camera position relative to target object.
  124290. * This can help limiting how the Camera is able to move in the scene.
  124291. */
  124292. lowerHeightOffsetLimit: Nullable<number>;
  124293. /**
  124294. * Maximum allowed height of camera position relative to target object.
  124295. * This can help limiting how the Camera is able to move in the scene.
  124296. */
  124297. upperHeightOffsetLimit: Nullable<number>;
  124298. /**
  124299. * Define how fast the camera can accelerate to follow it s target.
  124300. */
  124301. cameraAcceleration: number;
  124302. /**
  124303. * Define the speed limit of the camera following an object.
  124304. */
  124305. maxCameraSpeed: number;
  124306. /**
  124307. * Define the target of the camera.
  124308. */
  124309. lockedTarget: Nullable<AbstractMesh>;
  124310. /**
  124311. * Defines the input associated with the camera.
  124312. */
  124313. inputs: FollowCameraInputsManager;
  124314. /**
  124315. * Instantiates the follow camera.
  124316. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124317. * @param name Define the name of the camera in the scene
  124318. * @param position Define the position of the camera
  124319. * @param scene Define the scene the camera belong to
  124320. * @param lockedTarget Define the target of the camera
  124321. */
  124322. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  124323. private _follow;
  124324. /**
  124325. * Attached controls to the current camera.
  124326. * @param element Defines the element the controls should be listened from
  124327. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124328. */
  124329. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124330. /**
  124331. * Detach the current controls from the camera.
  124332. * The camera will stop reacting to inputs.
  124333. * @param element Defines the element to stop listening the inputs from
  124334. */
  124335. detachControl(element: HTMLElement): void;
  124336. /** @hidden */
  124337. _checkInputs(): void;
  124338. private _checkLimits;
  124339. /**
  124340. * Gets the camera class name.
  124341. * @returns the class name
  124342. */
  124343. getClassName(): string;
  124344. }
  124345. /**
  124346. * Arc Rotate version of the follow camera.
  124347. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  124348. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124349. */
  124350. export class ArcFollowCamera extends TargetCamera {
  124351. /** The longitudinal angle of the camera */
  124352. alpha: number;
  124353. /** The latitudinal angle of the camera */
  124354. beta: number;
  124355. /** The radius of the camera from its target */
  124356. radius: number;
  124357. private _cartesianCoordinates;
  124358. /** Define the camera target (the mesh it should follow) */
  124359. private _meshTarget;
  124360. /**
  124361. * Instantiates a new ArcFollowCamera
  124362. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124363. * @param name Define the name of the camera
  124364. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  124365. * @param beta Define the rotation angle of the camera around the elevation axis
  124366. * @param radius Define the radius of the camera from its target point
  124367. * @param target Define the target of the camera
  124368. * @param scene Define the scene the camera belongs to
  124369. */
  124370. constructor(name: string,
  124371. /** The longitudinal angle of the camera */
  124372. alpha: number,
  124373. /** The latitudinal angle of the camera */
  124374. beta: number,
  124375. /** The radius of the camera from its target */
  124376. radius: number,
  124377. /** Define the camera target (the mesh it should follow) */
  124378. target: Nullable<AbstractMesh>, scene: Scene);
  124379. private _follow;
  124380. /** @hidden */
  124381. _checkInputs(): void;
  124382. /**
  124383. * Returns the class name of the object.
  124384. * It is mostly used internally for serialization purposes.
  124385. */
  124386. getClassName(): string;
  124387. }
  124388. }
  124389. declare module BABYLON {
  124390. /**
  124391. * Manage the keyboard inputs to control the movement of a follow camera.
  124392. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124393. */
  124394. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  124395. /**
  124396. * Defines the camera the input is attached to.
  124397. */
  124398. camera: FollowCamera;
  124399. /**
  124400. * Defines the list of key codes associated with the up action (increase heightOffset)
  124401. */
  124402. keysHeightOffsetIncr: number[];
  124403. /**
  124404. * Defines the list of key codes associated with the down action (decrease heightOffset)
  124405. */
  124406. keysHeightOffsetDecr: number[];
  124407. /**
  124408. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  124409. */
  124410. keysHeightOffsetModifierAlt: boolean;
  124411. /**
  124412. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  124413. */
  124414. keysHeightOffsetModifierCtrl: boolean;
  124415. /**
  124416. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  124417. */
  124418. keysHeightOffsetModifierShift: boolean;
  124419. /**
  124420. * Defines the list of key codes associated with the left action (increase rotationOffset)
  124421. */
  124422. keysRotationOffsetIncr: number[];
  124423. /**
  124424. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  124425. */
  124426. keysRotationOffsetDecr: number[];
  124427. /**
  124428. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  124429. */
  124430. keysRotationOffsetModifierAlt: boolean;
  124431. /**
  124432. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  124433. */
  124434. keysRotationOffsetModifierCtrl: boolean;
  124435. /**
  124436. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  124437. */
  124438. keysRotationOffsetModifierShift: boolean;
  124439. /**
  124440. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  124441. */
  124442. keysRadiusIncr: number[];
  124443. /**
  124444. * Defines the list of key codes associated with the zoom-out action (increase radius)
  124445. */
  124446. keysRadiusDecr: number[];
  124447. /**
  124448. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  124449. */
  124450. keysRadiusModifierAlt: boolean;
  124451. /**
  124452. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  124453. */
  124454. keysRadiusModifierCtrl: boolean;
  124455. /**
  124456. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  124457. */
  124458. keysRadiusModifierShift: boolean;
  124459. /**
  124460. * Defines the rate of change of heightOffset.
  124461. */
  124462. heightSensibility: number;
  124463. /**
  124464. * Defines the rate of change of rotationOffset.
  124465. */
  124466. rotationSensibility: number;
  124467. /**
  124468. * Defines the rate of change of radius.
  124469. */
  124470. radiusSensibility: number;
  124471. private _keys;
  124472. private _ctrlPressed;
  124473. private _altPressed;
  124474. private _shiftPressed;
  124475. private _onCanvasBlurObserver;
  124476. private _onKeyboardObserver;
  124477. private _engine;
  124478. private _scene;
  124479. /**
  124480. * Attach the input controls to a specific dom element to get the input from.
  124481. * @param element Defines the element the controls should be listened from
  124482. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124483. */
  124484. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124485. /**
  124486. * Detach the current controls from the specified dom element.
  124487. * @param element Defines the element to stop listening the inputs from
  124488. */
  124489. detachControl(element: Nullable<HTMLElement>): void;
  124490. /**
  124491. * Update the current camera state depending on the inputs that have been used this frame.
  124492. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124493. */
  124494. checkInputs(): void;
  124495. /**
  124496. * Gets the class name of the current input.
  124497. * @returns the class name
  124498. */
  124499. getClassName(): string;
  124500. /**
  124501. * Get the friendly name associated with the input class.
  124502. * @returns the input friendly name
  124503. */
  124504. getSimpleName(): string;
  124505. /**
  124506. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124507. * allow modification of the heightOffset value.
  124508. */
  124509. private _modifierHeightOffset;
  124510. /**
  124511. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124512. * allow modification of the rotationOffset value.
  124513. */
  124514. private _modifierRotationOffset;
  124515. /**
  124516. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124517. * allow modification of the radius value.
  124518. */
  124519. private _modifierRadius;
  124520. }
  124521. }
  124522. declare module BABYLON {
  124523. interface FreeCameraInputsManager {
  124524. /**
  124525. * @hidden
  124526. */
  124527. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  124528. /**
  124529. * Add orientation input support to the input manager.
  124530. * @returns the current input manager
  124531. */
  124532. addDeviceOrientation(): FreeCameraInputsManager;
  124533. }
  124534. /**
  124535. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  124536. * Screen rotation is taken into account.
  124537. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124538. */
  124539. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  124540. private _camera;
  124541. private _screenOrientationAngle;
  124542. private _constantTranform;
  124543. private _screenQuaternion;
  124544. private _alpha;
  124545. private _beta;
  124546. private _gamma;
  124547. /**
  124548. * Can be used to detect if a device orientation sensor is available on a device
  124549. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  124550. * @returns a promise that will resolve on orientation change
  124551. */
  124552. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  124553. /**
  124554. * @hidden
  124555. */
  124556. _onDeviceOrientationChangedObservable: Observable<void>;
  124557. /**
  124558. * Instantiates a new input
  124559. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124560. */
  124561. constructor();
  124562. /**
  124563. * Define the camera controlled by the input.
  124564. */
  124565. get camera(): FreeCamera;
  124566. set camera(camera: FreeCamera);
  124567. /**
  124568. * Attach the input controls to a specific dom element to get the input from.
  124569. * @param element Defines the element the controls should be listened from
  124570. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124571. */
  124572. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124573. private _orientationChanged;
  124574. private _deviceOrientation;
  124575. /**
  124576. * Detach the current controls from the specified dom element.
  124577. * @param element Defines the element to stop listening the inputs from
  124578. */
  124579. detachControl(element: Nullable<HTMLElement>): void;
  124580. /**
  124581. * Update the current camera state depending on the inputs that have been used this frame.
  124582. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124583. */
  124584. checkInputs(): void;
  124585. /**
  124586. * Gets the class name of the current intput.
  124587. * @returns the class name
  124588. */
  124589. getClassName(): string;
  124590. /**
  124591. * Get the friendly name associated with the input class.
  124592. * @returns the input friendly name
  124593. */
  124594. getSimpleName(): string;
  124595. }
  124596. }
  124597. declare module BABYLON {
  124598. /**
  124599. * Manage the gamepad inputs to control a free camera.
  124600. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124601. */
  124602. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  124603. /**
  124604. * Define the camera the input is attached to.
  124605. */
  124606. camera: FreeCamera;
  124607. /**
  124608. * Define the Gamepad controlling the input
  124609. */
  124610. gamepad: Nullable<Gamepad>;
  124611. /**
  124612. * Defines the gamepad rotation sensiblity.
  124613. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124614. */
  124615. gamepadAngularSensibility: number;
  124616. /**
  124617. * Defines the gamepad move sensiblity.
  124618. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124619. */
  124620. gamepadMoveSensibility: number;
  124621. private _yAxisScale;
  124622. /**
  124623. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  124624. */
  124625. get invertYAxis(): boolean;
  124626. set invertYAxis(value: boolean);
  124627. private _onGamepadConnectedObserver;
  124628. private _onGamepadDisconnectedObserver;
  124629. private _cameraTransform;
  124630. private _deltaTransform;
  124631. private _vector3;
  124632. private _vector2;
  124633. /**
  124634. * Attach the input controls to a specific dom element to get the input from.
  124635. * @param element Defines the element the controls should be listened from
  124636. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124637. */
  124638. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124639. /**
  124640. * Detach the current controls from the specified dom element.
  124641. * @param element Defines the element to stop listening the inputs from
  124642. */
  124643. detachControl(element: Nullable<HTMLElement>): void;
  124644. /**
  124645. * Update the current camera state depending on the inputs that have been used this frame.
  124646. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124647. */
  124648. checkInputs(): void;
  124649. /**
  124650. * Gets the class name of the current intput.
  124651. * @returns the class name
  124652. */
  124653. getClassName(): string;
  124654. /**
  124655. * Get the friendly name associated with the input class.
  124656. * @returns the input friendly name
  124657. */
  124658. getSimpleName(): string;
  124659. }
  124660. }
  124661. declare module BABYLON {
  124662. /**
  124663. * Defines the potential axis of a Joystick
  124664. */
  124665. export enum JoystickAxis {
  124666. /** X axis */
  124667. X = 0,
  124668. /** Y axis */
  124669. Y = 1,
  124670. /** Z axis */
  124671. Z = 2
  124672. }
  124673. /**
  124674. * Represents the different customization options available
  124675. * for VirtualJoystick
  124676. */
  124677. interface VirtualJoystickCustomizations {
  124678. /**
  124679. * Size of the joystick's puck
  124680. */
  124681. puckSize: number;
  124682. /**
  124683. * Size of the joystick's container
  124684. */
  124685. containerSize: number;
  124686. /**
  124687. * Color of the joystick && puck
  124688. */
  124689. color: string;
  124690. /**
  124691. * Image URL for the joystick's puck
  124692. */
  124693. puckImage?: string;
  124694. /**
  124695. * Image URL for the joystick's container
  124696. */
  124697. containerImage?: string;
  124698. /**
  124699. * Defines the unmoving position of the joystick container
  124700. */
  124701. position?: {
  124702. x: number;
  124703. y: number;
  124704. };
  124705. /**
  124706. * Defines whether or not the joystick container is always visible
  124707. */
  124708. alwaysVisible: boolean;
  124709. /**
  124710. * Defines whether or not to limit the movement of the puck to the joystick's container
  124711. */
  124712. limitToContainer: boolean;
  124713. }
  124714. /**
  124715. * Class used to define virtual joystick (used in touch mode)
  124716. */
  124717. export class VirtualJoystick {
  124718. /**
  124719. * Gets or sets a boolean indicating that left and right values must be inverted
  124720. */
  124721. reverseLeftRight: boolean;
  124722. /**
  124723. * Gets or sets a boolean indicating that up and down values must be inverted
  124724. */
  124725. reverseUpDown: boolean;
  124726. /**
  124727. * Gets the offset value for the position (ie. the change of the position value)
  124728. */
  124729. deltaPosition: Vector3;
  124730. /**
  124731. * Gets a boolean indicating if the virtual joystick was pressed
  124732. */
  124733. pressed: boolean;
  124734. /**
  124735. * Canvas the virtual joystick will render onto, default z-index of this is 5
  124736. */
  124737. static Canvas: Nullable<HTMLCanvasElement>;
  124738. /**
  124739. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  124740. */
  124741. limitToContainer: boolean;
  124742. private static _globalJoystickIndex;
  124743. private static _alwaysVisibleSticks;
  124744. private static vjCanvasContext;
  124745. private static vjCanvasWidth;
  124746. private static vjCanvasHeight;
  124747. private static halfWidth;
  124748. private static _GetDefaultOptions;
  124749. private _action;
  124750. private _axisTargetedByLeftAndRight;
  124751. private _axisTargetedByUpAndDown;
  124752. private _joystickSensibility;
  124753. private _inversedSensibility;
  124754. private _joystickPointerID;
  124755. private _joystickColor;
  124756. private _joystickPointerPos;
  124757. private _joystickPreviousPointerPos;
  124758. private _joystickPointerStartPos;
  124759. private _deltaJoystickVector;
  124760. private _leftJoystick;
  124761. private _touches;
  124762. private _joystickPosition;
  124763. private _alwaysVisible;
  124764. private _puckImage;
  124765. private _containerImage;
  124766. private _joystickPuckSize;
  124767. private _joystickContainerSize;
  124768. private _clearPuckSize;
  124769. private _clearContainerSize;
  124770. private _clearPuckSizeOffset;
  124771. private _clearContainerSizeOffset;
  124772. private _onPointerDownHandlerRef;
  124773. private _onPointerMoveHandlerRef;
  124774. private _onPointerUpHandlerRef;
  124775. private _onResize;
  124776. /**
  124777. * Creates a new virtual joystick
  124778. * @param leftJoystick defines that the joystick is for left hand (false by default)
  124779. * @param customizations Defines the options we want to customize the VirtualJoystick
  124780. */
  124781. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  124782. /**
  124783. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  124784. * @param newJoystickSensibility defines the new sensibility
  124785. */
  124786. setJoystickSensibility(newJoystickSensibility: number): void;
  124787. private _onPointerDown;
  124788. private _onPointerMove;
  124789. private _onPointerUp;
  124790. /**
  124791. * Change the color of the virtual joystick
  124792. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  124793. */
  124794. setJoystickColor(newColor: string): void;
  124795. /**
  124796. * Size of the joystick's container
  124797. */
  124798. set containerSize(newSize: number);
  124799. get containerSize(): number;
  124800. /**
  124801. * Size of the joystick's puck
  124802. */
  124803. set puckSize(newSize: number);
  124804. get puckSize(): number;
  124805. /**
  124806. * Clears the set position of the joystick
  124807. */
  124808. clearPosition(): void;
  124809. /**
  124810. * Defines whether or not the joystick container is always visible
  124811. */
  124812. set alwaysVisible(value: boolean);
  124813. get alwaysVisible(): boolean;
  124814. /**
  124815. * Sets the constant position of the Joystick container
  124816. * @param x X axis coordinate
  124817. * @param y Y axis coordinate
  124818. */
  124819. setPosition(x: number, y: number): void;
  124820. /**
  124821. * Defines a callback to call when the joystick is touched
  124822. * @param action defines the callback
  124823. */
  124824. setActionOnTouch(action: () => any): void;
  124825. /**
  124826. * Defines which axis you'd like to control for left & right
  124827. * @param axis defines the axis to use
  124828. */
  124829. setAxisForLeftRight(axis: JoystickAxis): void;
  124830. /**
  124831. * Defines which axis you'd like to control for up & down
  124832. * @param axis defines the axis to use
  124833. */
  124834. setAxisForUpDown(axis: JoystickAxis): void;
  124835. /**
  124836. * Clears the canvas from the previous puck / container draw
  124837. */
  124838. private _clearPreviousDraw;
  124839. /**
  124840. * Loads `urlPath` to be used for the container's image
  124841. * @param urlPath defines the urlPath of an image to use
  124842. */
  124843. setContainerImage(urlPath: string): void;
  124844. /**
  124845. * Loads `urlPath` to be used for the puck's image
  124846. * @param urlPath defines the urlPath of an image to use
  124847. */
  124848. setPuckImage(urlPath: string): void;
  124849. /**
  124850. * Draws the Virtual Joystick's container
  124851. */
  124852. private _drawContainer;
  124853. /**
  124854. * Draws the Virtual Joystick's puck
  124855. */
  124856. private _drawPuck;
  124857. private _drawVirtualJoystick;
  124858. /**
  124859. * Release internal HTML canvas
  124860. */
  124861. releaseCanvas(): void;
  124862. }
  124863. }
  124864. declare module BABYLON {
  124865. interface FreeCameraInputsManager {
  124866. /**
  124867. * Add virtual joystick input support to the input manager.
  124868. * @returns the current input manager
  124869. */
  124870. addVirtualJoystick(): FreeCameraInputsManager;
  124871. }
  124872. /**
  124873. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  124874. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124875. */
  124876. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  124877. /**
  124878. * Defines the camera the input is attached to.
  124879. */
  124880. camera: FreeCamera;
  124881. private _leftjoystick;
  124882. private _rightjoystick;
  124883. /**
  124884. * Gets the left stick of the virtual joystick.
  124885. * @returns The virtual Joystick
  124886. */
  124887. getLeftJoystick(): VirtualJoystick;
  124888. /**
  124889. * Gets the right stick of the virtual joystick.
  124890. * @returns The virtual Joystick
  124891. */
  124892. getRightJoystick(): VirtualJoystick;
  124893. /**
  124894. * Update the current camera state depending on the inputs that have been used this frame.
  124895. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124896. */
  124897. checkInputs(): void;
  124898. /**
  124899. * Attach the input controls to a specific dom element to get the input from.
  124900. * @param element Defines the element the controls should be listened from
  124901. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124902. */
  124903. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124904. /**
  124905. * Detach the current controls from the specified dom element.
  124906. * @param element Defines the element to stop listening the inputs from
  124907. */
  124908. detachControl(element: Nullable<HTMLElement>): void;
  124909. /**
  124910. * Gets the class name of the current intput.
  124911. * @returns the class name
  124912. */
  124913. getClassName(): string;
  124914. /**
  124915. * Get the friendly name associated with the input class.
  124916. * @returns the input friendly name
  124917. */
  124918. getSimpleName(): string;
  124919. }
  124920. }
  124921. declare module BABYLON {
  124922. /**
  124923. * This represents a FPS type of camera controlled by touch.
  124924. * This is like a universal camera minus the Gamepad controls.
  124925. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124926. */
  124927. export class TouchCamera extends FreeCamera {
  124928. /**
  124929. * Defines the touch sensibility for rotation.
  124930. * The higher the faster.
  124931. */
  124932. get touchAngularSensibility(): number;
  124933. set touchAngularSensibility(value: number);
  124934. /**
  124935. * Defines the touch sensibility for move.
  124936. * The higher the faster.
  124937. */
  124938. get touchMoveSensibility(): number;
  124939. set touchMoveSensibility(value: number);
  124940. /**
  124941. * Instantiates a new touch camera.
  124942. * This represents a FPS type of camera controlled by touch.
  124943. * This is like a universal camera minus the Gamepad controls.
  124944. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124945. * @param name Define the name of the camera in the scene
  124946. * @param position Define the start position of the camera in the scene
  124947. * @param scene Define the scene the camera belongs to
  124948. */
  124949. constructor(name: string, position: Vector3, scene: Scene);
  124950. /**
  124951. * Gets the current object class name.
  124952. * @return the class name
  124953. */
  124954. getClassName(): string;
  124955. /** @hidden */
  124956. _setupInputs(): void;
  124957. }
  124958. }
  124959. declare module BABYLON {
  124960. /**
  124961. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  124962. * being tilted forward or back and left or right.
  124963. */
  124964. export class DeviceOrientationCamera extends FreeCamera {
  124965. private _initialQuaternion;
  124966. private _quaternionCache;
  124967. private _tmpDragQuaternion;
  124968. private _disablePointerInputWhenUsingDeviceOrientation;
  124969. /**
  124970. * Creates a new device orientation camera
  124971. * @param name The name of the camera
  124972. * @param position The start position camera
  124973. * @param scene The scene the camera belongs to
  124974. */
  124975. constructor(name: string, position: Vector3, scene: Scene);
  124976. /**
  124977. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  124978. */
  124979. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  124980. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  124981. private _dragFactor;
  124982. /**
  124983. * Enabled turning on the y axis when the orientation sensor is active
  124984. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  124985. */
  124986. enableHorizontalDragging(dragFactor?: number): void;
  124987. /**
  124988. * Gets the current instance class name ("DeviceOrientationCamera").
  124989. * This helps avoiding instanceof at run time.
  124990. * @returns the class name
  124991. */
  124992. getClassName(): string;
  124993. /**
  124994. * @hidden
  124995. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  124996. */
  124997. _checkInputs(): void;
  124998. /**
  124999. * Reset the camera to its default orientation on the specified axis only.
  125000. * @param axis The axis to reset
  125001. */
  125002. resetToCurrentRotation(axis?: Axis): void;
  125003. }
  125004. }
  125005. declare module BABYLON {
  125006. /**
  125007. * Defines supported buttons for XBox360 compatible gamepads
  125008. */
  125009. export enum Xbox360Button {
  125010. /** A */
  125011. A = 0,
  125012. /** B */
  125013. B = 1,
  125014. /** X */
  125015. X = 2,
  125016. /** Y */
  125017. Y = 3,
  125018. /** Left button */
  125019. LB = 4,
  125020. /** Right button */
  125021. RB = 5,
  125022. /** Back */
  125023. Back = 8,
  125024. /** Start */
  125025. Start = 9,
  125026. /** Left stick */
  125027. LeftStick = 10,
  125028. /** Right stick */
  125029. RightStick = 11
  125030. }
  125031. /** Defines values for XBox360 DPad */
  125032. export enum Xbox360Dpad {
  125033. /** Up */
  125034. Up = 12,
  125035. /** Down */
  125036. Down = 13,
  125037. /** Left */
  125038. Left = 14,
  125039. /** Right */
  125040. Right = 15
  125041. }
  125042. /**
  125043. * Defines a XBox360 gamepad
  125044. */
  125045. export class Xbox360Pad extends Gamepad {
  125046. private _leftTrigger;
  125047. private _rightTrigger;
  125048. private _onlefttriggerchanged;
  125049. private _onrighttriggerchanged;
  125050. private _onbuttondown;
  125051. private _onbuttonup;
  125052. private _ondpaddown;
  125053. private _ondpadup;
  125054. /** Observable raised when a button is pressed */
  125055. onButtonDownObservable: Observable<Xbox360Button>;
  125056. /** Observable raised when a button is released */
  125057. onButtonUpObservable: Observable<Xbox360Button>;
  125058. /** Observable raised when a pad is pressed */
  125059. onPadDownObservable: Observable<Xbox360Dpad>;
  125060. /** Observable raised when a pad is released */
  125061. onPadUpObservable: Observable<Xbox360Dpad>;
  125062. private _buttonA;
  125063. private _buttonB;
  125064. private _buttonX;
  125065. private _buttonY;
  125066. private _buttonBack;
  125067. private _buttonStart;
  125068. private _buttonLB;
  125069. private _buttonRB;
  125070. private _buttonLeftStick;
  125071. private _buttonRightStick;
  125072. private _dPadUp;
  125073. private _dPadDown;
  125074. private _dPadLeft;
  125075. private _dPadRight;
  125076. private _isXboxOnePad;
  125077. /**
  125078. * Creates a new XBox360 gamepad object
  125079. * @param id defines the id of this gamepad
  125080. * @param index defines its index
  125081. * @param gamepad defines the internal HTML gamepad object
  125082. * @param xboxOne defines if it is a XBox One gamepad
  125083. */
  125084. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  125085. /**
  125086. * Defines the callback to call when left trigger is pressed
  125087. * @param callback defines the callback to use
  125088. */
  125089. onlefttriggerchanged(callback: (value: number) => void): void;
  125090. /**
  125091. * Defines the callback to call when right trigger is pressed
  125092. * @param callback defines the callback to use
  125093. */
  125094. onrighttriggerchanged(callback: (value: number) => void): void;
  125095. /**
  125096. * Gets the left trigger value
  125097. */
  125098. get leftTrigger(): number;
  125099. /**
  125100. * Sets the left trigger value
  125101. */
  125102. set leftTrigger(newValue: number);
  125103. /**
  125104. * Gets the right trigger value
  125105. */
  125106. get rightTrigger(): number;
  125107. /**
  125108. * Sets the right trigger value
  125109. */
  125110. set rightTrigger(newValue: number);
  125111. /**
  125112. * Defines the callback to call when a button is pressed
  125113. * @param callback defines the callback to use
  125114. */
  125115. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  125116. /**
  125117. * Defines the callback to call when a button is released
  125118. * @param callback defines the callback to use
  125119. */
  125120. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  125121. /**
  125122. * Defines the callback to call when a pad is pressed
  125123. * @param callback defines the callback to use
  125124. */
  125125. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  125126. /**
  125127. * Defines the callback to call when a pad is released
  125128. * @param callback defines the callback to use
  125129. */
  125130. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  125131. private _setButtonValue;
  125132. private _setDPadValue;
  125133. /**
  125134. * Gets the value of the `A` button
  125135. */
  125136. get buttonA(): number;
  125137. /**
  125138. * Sets the value of the `A` button
  125139. */
  125140. set buttonA(value: number);
  125141. /**
  125142. * Gets the value of the `B` button
  125143. */
  125144. get buttonB(): number;
  125145. /**
  125146. * Sets the value of the `B` button
  125147. */
  125148. set buttonB(value: number);
  125149. /**
  125150. * Gets the value of the `X` button
  125151. */
  125152. get buttonX(): number;
  125153. /**
  125154. * Sets the value of the `X` button
  125155. */
  125156. set buttonX(value: number);
  125157. /**
  125158. * Gets the value of the `Y` button
  125159. */
  125160. get buttonY(): number;
  125161. /**
  125162. * Sets the value of the `Y` button
  125163. */
  125164. set buttonY(value: number);
  125165. /**
  125166. * Gets the value of the `Start` button
  125167. */
  125168. get buttonStart(): number;
  125169. /**
  125170. * Sets the value of the `Start` button
  125171. */
  125172. set buttonStart(value: number);
  125173. /**
  125174. * Gets the value of the `Back` button
  125175. */
  125176. get buttonBack(): number;
  125177. /**
  125178. * Sets the value of the `Back` button
  125179. */
  125180. set buttonBack(value: number);
  125181. /**
  125182. * Gets the value of the `Left` button
  125183. */
  125184. get buttonLB(): number;
  125185. /**
  125186. * Sets the value of the `Left` button
  125187. */
  125188. set buttonLB(value: number);
  125189. /**
  125190. * Gets the value of the `Right` button
  125191. */
  125192. get buttonRB(): number;
  125193. /**
  125194. * Sets the value of the `Right` button
  125195. */
  125196. set buttonRB(value: number);
  125197. /**
  125198. * Gets the value of the Left joystick
  125199. */
  125200. get buttonLeftStick(): number;
  125201. /**
  125202. * Sets the value of the Left joystick
  125203. */
  125204. set buttonLeftStick(value: number);
  125205. /**
  125206. * Gets the value of the Right joystick
  125207. */
  125208. get buttonRightStick(): number;
  125209. /**
  125210. * Sets the value of the Right joystick
  125211. */
  125212. set buttonRightStick(value: number);
  125213. /**
  125214. * Gets the value of D-pad up
  125215. */
  125216. get dPadUp(): number;
  125217. /**
  125218. * Sets the value of D-pad up
  125219. */
  125220. set dPadUp(value: number);
  125221. /**
  125222. * Gets the value of D-pad down
  125223. */
  125224. get dPadDown(): number;
  125225. /**
  125226. * Sets the value of D-pad down
  125227. */
  125228. set dPadDown(value: number);
  125229. /**
  125230. * Gets the value of D-pad left
  125231. */
  125232. get dPadLeft(): number;
  125233. /**
  125234. * Sets the value of D-pad left
  125235. */
  125236. set dPadLeft(value: number);
  125237. /**
  125238. * Gets the value of D-pad right
  125239. */
  125240. get dPadRight(): number;
  125241. /**
  125242. * Sets the value of D-pad right
  125243. */
  125244. set dPadRight(value: number);
  125245. /**
  125246. * Force the gamepad to synchronize with device values
  125247. */
  125248. update(): void;
  125249. /**
  125250. * Disposes the gamepad
  125251. */
  125252. dispose(): void;
  125253. }
  125254. }
  125255. declare module BABYLON {
  125256. /**
  125257. * Defines supported buttons for DualShock compatible gamepads
  125258. */
  125259. export enum DualShockButton {
  125260. /** Cross */
  125261. Cross = 0,
  125262. /** Circle */
  125263. Circle = 1,
  125264. /** Square */
  125265. Square = 2,
  125266. /** Triangle */
  125267. Triangle = 3,
  125268. /** L1 */
  125269. L1 = 4,
  125270. /** R1 */
  125271. R1 = 5,
  125272. /** Share */
  125273. Share = 8,
  125274. /** Options */
  125275. Options = 9,
  125276. /** Left stick */
  125277. LeftStick = 10,
  125278. /** Right stick */
  125279. RightStick = 11
  125280. }
  125281. /** Defines values for DualShock DPad */
  125282. export enum DualShockDpad {
  125283. /** Up */
  125284. Up = 12,
  125285. /** Down */
  125286. Down = 13,
  125287. /** Left */
  125288. Left = 14,
  125289. /** Right */
  125290. Right = 15
  125291. }
  125292. /**
  125293. * Defines a DualShock gamepad
  125294. */
  125295. export class DualShockPad extends Gamepad {
  125296. private _leftTrigger;
  125297. private _rightTrigger;
  125298. private _onlefttriggerchanged;
  125299. private _onrighttriggerchanged;
  125300. private _onbuttondown;
  125301. private _onbuttonup;
  125302. private _ondpaddown;
  125303. private _ondpadup;
  125304. /** Observable raised when a button is pressed */
  125305. onButtonDownObservable: Observable<DualShockButton>;
  125306. /** Observable raised when a button is released */
  125307. onButtonUpObservable: Observable<DualShockButton>;
  125308. /** Observable raised when a pad is pressed */
  125309. onPadDownObservable: Observable<DualShockDpad>;
  125310. /** Observable raised when a pad is released */
  125311. onPadUpObservable: Observable<DualShockDpad>;
  125312. private _buttonCross;
  125313. private _buttonCircle;
  125314. private _buttonSquare;
  125315. private _buttonTriangle;
  125316. private _buttonShare;
  125317. private _buttonOptions;
  125318. private _buttonL1;
  125319. private _buttonR1;
  125320. private _buttonLeftStick;
  125321. private _buttonRightStick;
  125322. private _dPadUp;
  125323. private _dPadDown;
  125324. private _dPadLeft;
  125325. private _dPadRight;
  125326. /**
  125327. * Creates a new DualShock gamepad object
  125328. * @param id defines the id of this gamepad
  125329. * @param index defines its index
  125330. * @param gamepad defines the internal HTML gamepad object
  125331. */
  125332. constructor(id: string, index: number, gamepad: any);
  125333. /**
  125334. * Defines the callback to call when left trigger is pressed
  125335. * @param callback defines the callback to use
  125336. */
  125337. onlefttriggerchanged(callback: (value: number) => void): void;
  125338. /**
  125339. * Defines the callback to call when right trigger is pressed
  125340. * @param callback defines the callback to use
  125341. */
  125342. onrighttriggerchanged(callback: (value: number) => void): void;
  125343. /**
  125344. * Gets the left trigger value
  125345. */
  125346. get leftTrigger(): number;
  125347. /**
  125348. * Sets the left trigger value
  125349. */
  125350. set leftTrigger(newValue: number);
  125351. /**
  125352. * Gets the right trigger value
  125353. */
  125354. get rightTrigger(): number;
  125355. /**
  125356. * Sets the right trigger value
  125357. */
  125358. set rightTrigger(newValue: number);
  125359. /**
  125360. * Defines the callback to call when a button is pressed
  125361. * @param callback defines the callback to use
  125362. */
  125363. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  125364. /**
  125365. * Defines the callback to call when a button is released
  125366. * @param callback defines the callback to use
  125367. */
  125368. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  125369. /**
  125370. * Defines the callback to call when a pad is pressed
  125371. * @param callback defines the callback to use
  125372. */
  125373. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  125374. /**
  125375. * Defines the callback to call when a pad is released
  125376. * @param callback defines the callback to use
  125377. */
  125378. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  125379. private _setButtonValue;
  125380. private _setDPadValue;
  125381. /**
  125382. * Gets the value of the `Cross` button
  125383. */
  125384. get buttonCross(): number;
  125385. /**
  125386. * Sets the value of the `Cross` button
  125387. */
  125388. set buttonCross(value: number);
  125389. /**
  125390. * Gets the value of the `Circle` button
  125391. */
  125392. get buttonCircle(): number;
  125393. /**
  125394. * Sets the value of the `Circle` button
  125395. */
  125396. set buttonCircle(value: number);
  125397. /**
  125398. * Gets the value of the `Square` button
  125399. */
  125400. get buttonSquare(): number;
  125401. /**
  125402. * Sets the value of the `Square` button
  125403. */
  125404. set buttonSquare(value: number);
  125405. /**
  125406. * Gets the value of the `Triangle` button
  125407. */
  125408. get buttonTriangle(): number;
  125409. /**
  125410. * Sets the value of the `Triangle` button
  125411. */
  125412. set buttonTriangle(value: number);
  125413. /**
  125414. * Gets the value of the `Options` button
  125415. */
  125416. get buttonOptions(): number;
  125417. /**
  125418. * Sets the value of the `Options` button
  125419. */
  125420. set buttonOptions(value: number);
  125421. /**
  125422. * Gets the value of the `Share` button
  125423. */
  125424. get buttonShare(): number;
  125425. /**
  125426. * Sets the value of the `Share` button
  125427. */
  125428. set buttonShare(value: number);
  125429. /**
  125430. * Gets the value of the `L1` button
  125431. */
  125432. get buttonL1(): number;
  125433. /**
  125434. * Sets the value of the `L1` button
  125435. */
  125436. set buttonL1(value: number);
  125437. /**
  125438. * Gets the value of the `R1` button
  125439. */
  125440. get buttonR1(): number;
  125441. /**
  125442. * Sets the value of the `R1` button
  125443. */
  125444. set buttonR1(value: number);
  125445. /**
  125446. * Gets the value of the Left joystick
  125447. */
  125448. get buttonLeftStick(): number;
  125449. /**
  125450. * Sets the value of the Left joystick
  125451. */
  125452. set buttonLeftStick(value: number);
  125453. /**
  125454. * Gets the value of the Right joystick
  125455. */
  125456. get buttonRightStick(): number;
  125457. /**
  125458. * Sets the value of the Right joystick
  125459. */
  125460. set buttonRightStick(value: number);
  125461. /**
  125462. * Gets the value of D-pad up
  125463. */
  125464. get dPadUp(): number;
  125465. /**
  125466. * Sets the value of D-pad up
  125467. */
  125468. set dPadUp(value: number);
  125469. /**
  125470. * Gets the value of D-pad down
  125471. */
  125472. get dPadDown(): number;
  125473. /**
  125474. * Sets the value of D-pad down
  125475. */
  125476. set dPadDown(value: number);
  125477. /**
  125478. * Gets the value of D-pad left
  125479. */
  125480. get dPadLeft(): number;
  125481. /**
  125482. * Sets the value of D-pad left
  125483. */
  125484. set dPadLeft(value: number);
  125485. /**
  125486. * Gets the value of D-pad right
  125487. */
  125488. get dPadRight(): number;
  125489. /**
  125490. * Sets the value of D-pad right
  125491. */
  125492. set dPadRight(value: number);
  125493. /**
  125494. * Force the gamepad to synchronize with device values
  125495. */
  125496. update(): void;
  125497. /**
  125498. * Disposes the gamepad
  125499. */
  125500. dispose(): void;
  125501. }
  125502. }
  125503. declare module BABYLON {
  125504. /**
  125505. * Manager for handling gamepads
  125506. */
  125507. export class GamepadManager {
  125508. private _scene?;
  125509. private _babylonGamepads;
  125510. private _oneGamepadConnected;
  125511. /** @hidden */
  125512. _isMonitoring: boolean;
  125513. private _gamepadEventSupported;
  125514. private _gamepadSupport?;
  125515. /**
  125516. * observable to be triggered when the gamepad controller has been connected
  125517. */
  125518. onGamepadConnectedObservable: Observable<Gamepad>;
  125519. /**
  125520. * observable to be triggered when the gamepad controller has been disconnected
  125521. */
  125522. onGamepadDisconnectedObservable: Observable<Gamepad>;
  125523. private _onGamepadConnectedEvent;
  125524. private _onGamepadDisconnectedEvent;
  125525. /**
  125526. * Initializes the gamepad manager
  125527. * @param _scene BabylonJS scene
  125528. */
  125529. constructor(_scene?: Scene | undefined);
  125530. /**
  125531. * The gamepads in the game pad manager
  125532. */
  125533. get gamepads(): Gamepad[];
  125534. /**
  125535. * Get the gamepad controllers based on type
  125536. * @param type The type of gamepad controller
  125537. * @returns Nullable gamepad
  125538. */
  125539. getGamepadByType(type?: number): Nullable<Gamepad>;
  125540. /**
  125541. * Disposes the gamepad manager
  125542. */
  125543. dispose(): void;
  125544. private _addNewGamepad;
  125545. private _startMonitoringGamepads;
  125546. private _stopMonitoringGamepads;
  125547. /** @hidden */
  125548. _checkGamepadsStatus(): void;
  125549. private _updateGamepadObjects;
  125550. }
  125551. }
  125552. declare module BABYLON {
  125553. interface Scene {
  125554. /** @hidden */
  125555. _gamepadManager: Nullable<GamepadManager>;
  125556. /**
  125557. * Gets the gamepad manager associated with the scene
  125558. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  125559. */
  125560. gamepadManager: GamepadManager;
  125561. }
  125562. /**
  125563. * Interface representing a free camera inputs manager
  125564. */
  125565. interface FreeCameraInputsManager {
  125566. /**
  125567. * Adds gamepad input support to the FreeCameraInputsManager.
  125568. * @returns the FreeCameraInputsManager
  125569. */
  125570. addGamepad(): FreeCameraInputsManager;
  125571. }
  125572. /**
  125573. * Interface representing an arc rotate camera inputs manager
  125574. */
  125575. interface ArcRotateCameraInputsManager {
  125576. /**
  125577. * Adds gamepad input support to the ArcRotateCamera InputManager.
  125578. * @returns the camera inputs manager
  125579. */
  125580. addGamepad(): ArcRotateCameraInputsManager;
  125581. }
  125582. /**
  125583. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  125584. */
  125585. export class GamepadSystemSceneComponent implements ISceneComponent {
  125586. /**
  125587. * The component name helpfull to identify the component in the list of scene components.
  125588. */
  125589. readonly name: string;
  125590. /**
  125591. * The scene the component belongs to.
  125592. */
  125593. scene: Scene;
  125594. /**
  125595. * Creates a new instance of the component for the given scene
  125596. * @param scene Defines the scene to register the component in
  125597. */
  125598. constructor(scene: Scene);
  125599. /**
  125600. * Registers the component in a given scene
  125601. */
  125602. register(): void;
  125603. /**
  125604. * Rebuilds the elements related to this component in case of
  125605. * context lost for instance.
  125606. */
  125607. rebuild(): void;
  125608. /**
  125609. * Disposes the component and the associated ressources
  125610. */
  125611. dispose(): void;
  125612. private _beforeCameraUpdate;
  125613. }
  125614. }
  125615. declare module BABYLON {
  125616. /**
  125617. * 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,
  125618. * which still works and will still be found in many Playgrounds.
  125619. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125620. */
  125621. export class UniversalCamera extends TouchCamera {
  125622. /**
  125623. * Defines the gamepad rotation sensiblity.
  125624. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  125625. */
  125626. get gamepadAngularSensibility(): number;
  125627. set gamepadAngularSensibility(value: number);
  125628. /**
  125629. * Defines the gamepad move sensiblity.
  125630. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  125631. */
  125632. get gamepadMoveSensibility(): number;
  125633. set gamepadMoveSensibility(value: number);
  125634. /**
  125635. * 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,
  125636. * which still works and will still be found in many Playgrounds.
  125637. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125638. * @param name Define the name of the camera in the scene
  125639. * @param position Define the start position of the camera in the scene
  125640. * @param scene Define the scene the camera belongs to
  125641. */
  125642. constructor(name: string, position: Vector3, scene: Scene);
  125643. /**
  125644. * Gets the current object class name.
  125645. * @return the class name
  125646. */
  125647. getClassName(): string;
  125648. }
  125649. }
  125650. declare module BABYLON {
  125651. /**
  125652. * This represents a FPS type of camera. This is only here for back compat purpose.
  125653. * Please use the UniversalCamera instead as both are identical.
  125654. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125655. */
  125656. export class GamepadCamera extends UniversalCamera {
  125657. /**
  125658. * Instantiates a new Gamepad Camera
  125659. * This represents a FPS type of camera. This is only here for back compat purpose.
  125660. * Please use the UniversalCamera instead as both are identical.
  125661. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125662. * @param name Define the name of the camera in the scene
  125663. * @param position Define the start position of the camera in the scene
  125664. * @param scene Define the scene the camera belongs to
  125665. */
  125666. constructor(name: string, position: Vector3, scene: Scene);
  125667. /**
  125668. * Gets the current object class name.
  125669. * @return the class name
  125670. */
  125671. getClassName(): string;
  125672. }
  125673. }
  125674. declare module BABYLON {
  125675. /** @hidden */
  125676. export var passPixelShader: {
  125677. name: string;
  125678. shader: string;
  125679. };
  125680. }
  125681. declare module BABYLON {
  125682. /** @hidden */
  125683. export var passCubePixelShader: {
  125684. name: string;
  125685. shader: string;
  125686. };
  125687. }
  125688. declare module BABYLON {
  125689. /**
  125690. * PassPostProcess which produces an output the same as it's input
  125691. */
  125692. export class PassPostProcess extends PostProcess {
  125693. /**
  125694. * Gets a string identifying the name of the class
  125695. * @returns "PassPostProcess" string
  125696. */
  125697. getClassName(): string;
  125698. /**
  125699. * Creates the PassPostProcess
  125700. * @param name The name of the effect.
  125701. * @param options The required width/height ratio to downsize to before computing the render pass.
  125702. * @param camera The camera to apply the render pass to.
  125703. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125704. * @param engine The engine which the post process will be applied. (default: current engine)
  125705. * @param reusable If the post process can be reused on the same frame. (default: false)
  125706. * @param textureType The type of texture to be used when performing the post processing.
  125707. * @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)
  125708. */
  125709. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125710. /** @hidden */
  125711. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  125712. }
  125713. /**
  125714. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  125715. */
  125716. export class PassCubePostProcess extends PostProcess {
  125717. private _face;
  125718. /**
  125719. * Gets or sets the cube face to display.
  125720. * * 0 is +X
  125721. * * 1 is -X
  125722. * * 2 is +Y
  125723. * * 3 is -Y
  125724. * * 4 is +Z
  125725. * * 5 is -Z
  125726. */
  125727. get face(): number;
  125728. set face(value: number);
  125729. /**
  125730. * Gets a string identifying the name of the class
  125731. * @returns "PassCubePostProcess" string
  125732. */
  125733. getClassName(): string;
  125734. /**
  125735. * Creates the PassCubePostProcess
  125736. * @param name The name of the effect.
  125737. * @param options The required width/height ratio to downsize to before computing the render pass.
  125738. * @param camera The camera to apply the render pass to.
  125739. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125740. * @param engine The engine which the post process will be applied. (default: current engine)
  125741. * @param reusable If the post process can be reused on the same frame. (default: false)
  125742. * @param textureType The type of texture to be used when performing the post processing.
  125743. * @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)
  125744. */
  125745. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125746. /** @hidden */
  125747. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  125748. }
  125749. }
  125750. declare module BABYLON {
  125751. /** @hidden */
  125752. export var anaglyphPixelShader: {
  125753. name: string;
  125754. shader: string;
  125755. };
  125756. }
  125757. declare module BABYLON {
  125758. /**
  125759. * Postprocess used to generate anaglyphic rendering
  125760. */
  125761. export class AnaglyphPostProcess extends PostProcess {
  125762. private _passedProcess;
  125763. /**
  125764. * Gets a string identifying the name of the class
  125765. * @returns "AnaglyphPostProcess" string
  125766. */
  125767. getClassName(): string;
  125768. /**
  125769. * Creates a new AnaglyphPostProcess
  125770. * @param name defines postprocess name
  125771. * @param options defines creation options or target ratio scale
  125772. * @param rigCameras defines cameras using this postprocess
  125773. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  125774. * @param engine defines hosting engine
  125775. * @param reusable defines if the postprocess will be reused multiple times per frame
  125776. */
  125777. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  125778. }
  125779. }
  125780. declare module BABYLON {
  125781. /**
  125782. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  125783. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125784. */
  125785. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  125786. /**
  125787. * Creates a new AnaglyphArcRotateCamera
  125788. * @param name defines camera name
  125789. * @param alpha defines alpha angle (in radians)
  125790. * @param beta defines beta angle (in radians)
  125791. * @param radius defines radius
  125792. * @param target defines camera target
  125793. * @param interaxialDistance defines distance between each color axis
  125794. * @param scene defines the hosting scene
  125795. */
  125796. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  125797. /**
  125798. * Gets camera class name
  125799. * @returns AnaglyphArcRotateCamera
  125800. */
  125801. getClassName(): string;
  125802. }
  125803. }
  125804. declare module BABYLON {
  125805. /**
  125806. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  125807. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125808. */
  125809. export class AnaglyphFreeCamera extends FreeCamera {
  125810. /**
  125811. * Creates a new AnaglyphFreeCamera
  125812. * @param name defines camera name
  125813. * @param position defines initial position
  125814. * @param interaxialDistance defines distance between each color axis
  125815. * @param scene defines the hosting scene
  125816. */
  125817. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125818. /**
  125819. * Gets camera class name
  125820. * @returns AnaglyphFreeCamera
  125821. */
  125822. getClassName(): string;
  125823. }
  125824. }
  125825. declare module BABYLON {
  125826. /**
  125827. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  125828. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125829. */
  125830. export class AnaglyphGamepadCamera extends GamepadCamera {
  125831. /**
  125832. * Creates a new AnaglyphGamepadCamera
  125833. * @param name defines camera name
  125834. * @param position defines initial position
  125835. * @param interaxialDistance defines distance between each color axis
  125836. * @param scene defines the hosting scene
  125837. */
  125838. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125839. /**
  125840. * Gets camera class name
  125841. * @returns AnaglyphGamepadCamera
  125842. */
  125843. getClassName(): string;
  125844. }
  125845. }
  125846. declare module BABYLON {
  125847. /**
  125848. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  125849. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125850. */
  125851. export class AnaglyphUniversalCamera extends UniversalCamera {
  125852. /**
  125853. * Creates a new AnaglyphUniversalCamera
  125854. * @param name defines camera name
  125855. * @param position defines initial position
  125856. * @param interaxialDistance defines distance between each color axis
  125857. * @param scene defines the hosting scene
  125858. */
  125859. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125860. /**
  125861. * Gets camera class name
  125862. * @returns AnaglyphUniversalCamera
  125863. */
  125864. getClassName(): string;
  125865. }
  125866. }
  125867. declare module BABYLON {
  125868. /**
  125869. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  125870. * @see https://doc.babylonjs.com/features/cameras
  125871. */
  125872. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  125873. /**
  125874. * Creates a new StereoscopicArcRotateCamera
  125875. * @param name defines camera name
  125876. * @param alpha defines alpha angle (in radians)
  125877. * @param beta defines beta angle (in radians)
  125878. * @param radius defines radius
  125879. * @param target defines camera target
  125880. * @param interaxialDistance defines distance between each color axis
  125881. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125882. * @param scene defines the hosting scene
  125883. */
  125884. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125885. /**
  125886. * Gets camera class name
  125887. * @returns StereoscopicArcRotateCamera
  125888. */
  125889. getClassName(): string;
  125890. }
  125891. }
  125892. declare module BABYLON {
  125893. /**
  125894. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  125895. * @see https://doc.babylonjs.com/features/cameras
  125896. */
  125897. export class StereoscopicFreeCamera extends FreeCamera {
  125898. /**
  125899. * Creates a new StereoscopicFreeCamera
  125900. * @param name defines camera name
  125901. * @param position defines initial position
  125902. * @param interaxialDistance defines distance between each color axis
  125903. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125904. * @param scene defines the hosting scene
  125905. */
  125906. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125907. /**
  125908. * Gets camera class name
  125909. * @returns StereoscopicFreeCamera
  125910. */
  125911. getClassName(): string;
  125912. }
  125913. }
  125914. declare module BABYLON {
  125915. /**
  125916. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  125917. * @see https://doc.babylonjs.com/features/cameras
  125918. */
  125919. export class StereoscopicGamepadCamera extends GamepadCamera {
  125920. /**
  125921. * Creates a new StereoscopicGamepadCamera
  125922. * @param name defines camera name
  125923. * @param position defines initial position
  125924. * @param interaxialDistance defines distance between each color axis
  125925. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125926. * @param scene defines the hosting scene
  125927. */
  125928. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125929. /**
  125930. * Gets camera class name
  125931. * @returns StereoscopicGamepadCamera
  125932. */
  125933. getClassName(): string;
  125934. }
  125935. }
  125936. declare module BABYLON {
  125937. /**
  125938. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  125939. * @see https://doc.babylonjs.com/features/cameras
  125940. */
  125941. export class StereoscopicUniversalCamera extends UniversalCamera {
  125942. /**
  125943. * Creates a new StereoscopicUniversalCamera
  125944. * @param name defines camera name
  125945. * @param position defines initial position
  125946. * @param interaxialDistance defines distance between each color axis
  125947. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125948. * @param scene defines the hosting scene
  125949. */
  125950. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125951. /**
  125952. * Gets camera class name
  125953. * @returns StereoscopicUniversalCamera
  125954. */
  125955. getClassName(): string;
  125956. }
  125957. }
  125958. declare module BABYLON {
  125959. /**
  125960. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  125961. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125962. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125963. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125964. */
  125965. export class VirtualJoysticksCamera extends FreeCamera {
  125966. /**
  125967. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  125968. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125969. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125970. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125971. * @param name Define the name of the camera in the scene
  125972. * @param position Define the start position of the camera in the scene
  125973. * @param scene Define the scene the camera belongs to
  125974. */
  125975. constructor(name: string, position: Vector3, scene: Scene);
  125976. /**
  125977. * Gets the current object class name.
  125978. * @return the class name
  125979. */
  125980. getClassName(): string;
  125981. }
  125982. }
  125983. declare module BABYLON {
  125984. /**
  125985. * This represents all the required metrics to create a VR camera.
  125986. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  125987. */
  125988. export class VRCameraMetrics {
  125989. /**
  125990. * Define the horizontal resolution off the screen.
  125991. */
  125992. hResolution: number;
  125993. /**
  125994. * Define the vertical resolution off the screen.
  125995. */
  125996. vResolution: number;
  125997. /**
  125998. * Define the horizontal screen size.
  125999. */
  126000. hScreenSize: number;
  126001. /**
  126002. * Define the vertical screen size.
  126003. */
  126004. vScreenSize: number;
  126005. /**
  126006. * Define the vertical screen center position.
  126007. */
  126008. vScreenCenter: number;
  126009. /**
  126010. * Define the distance of the eyes to the screen.
  126011. */
  126012. eyeToScreenDistance: number;
  126013. /**
  126014. * Define the distance between both lenses
  126015. */
  126016. lensSeparationDistance: number;
  126017. /**
  126018. * Define the distance between both viewer's eyes.
  126019. */
  126020. interpupillaryDistance: number;
  126021. /**
  126022. * Define the distortion factor of the VR postprocess.
  126023. * Please, touch with care.
  126024. */
  126025. distortionK: number[];
  126026. /**
  126027. * Define the chromatic aberration correction factors for the VR post process.
  126028. */
  126029. chromaAbCorrection: number[];
  126030. /**
  126031. * Define the scale factor of the post process.
  126032. * The smaller the better but the slower.
  126033. */
  126034. postProcessScaleFactor: number;
  126035. /**
  126036. * Define an offset for the lens center.
  126037. */
  126038. lensCenterOffset: number;
  126039. /**
  126040. * Define if the current vr camera should compensate the distortion of the lense or not.
  126041. */
  126042. compensateDistortion: boolean;
  126043. /**
  126044. * Defines if multiview should be enabled when rendering (Default: false)
  126045. */
  126046. multiviewEnabled: boolean;
  126047. /**
  126048. * Gets the rendering aspect ratio based on the provided resolutions.
  126049. */
  126050. get aspectRatio(): number;
  126051. /**
  126052. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  126053. */
  126054. get aspectRatioFov(): number;
  126055. /**
  126056. * @hidden
  126057. */
  126058. get leftHMatrix(): Matrix;
  126059. /**
  126060. * @hidden
  126061. */
  126062. get rightHMatrix(): Matrix;
  126063. /**
  126064. * @hidden
  126065. */
  126066. get leftPreViewMatrix(): Matrix;
  126067. /**
  126068. * @hidden
  126069. */
  126070. get rightPreViewMatrix(): Matrix;
  126071. /**
  126072. * Get the default VRMetrics based on the most generic setup.
  126073. * @returns the default vr metrics
  126074. */
  126075. static GetDefault(): VRCameraMetrics;
  126076. }
  126077. }
  126078. declare module BABYLON {
  126079. /** @hidden */
  126080. export var vrDistortionCorrectionPixelShader: {
  126081. name: string;
  126082. shader: string;
  126083. };
  126084. }
  126085. declare module BABYLON {
  126086. /**
  126087. * VRDistortionCorrectionPostProcess used for mobile VR
  126088. */
  126089. export class VRDistortionCorrectionPostProcess extends PostProcess {
  126090. private _isRightEye;
  126091. private _distortionFactors;
  126092. private _postProcessScaleFactor;
  126093. private _lensCenterOffset;
  126094. private _scaleIn;
  126095. private _scaleFactor;
  126096. private _lensCenter;
  126097. /**
  126098. * Gets a string identifying the name of the class
  126099. * @returns "VRDistortionCorrectionPostProcess" string
  126100. */
  126101. getClassName(): string;
  126102. /**
  126103. * Initializes the VRDistortionCorrectionPostProcess
  126104. * @param name The name of the effect.
  126105. * @param camera The camera to apply the render pass to.
  126106. * @param isRightEye If this is for the right eye distortion
  126107. * @param vrMetrics All the required metrics for the VR camera
  126108. */
  126109. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  126110. }
  126111. }
  126112. declare module BABYLON {
  126113. /**
  126114. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  126115. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126116. */
  126117. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  126118. /**
  126119. * Creates a new VRDeviceOrientationArcRotateCamera
  126120. * @param name defines camera name
  126121. * @param alpha defines the camera rotation along the logitudinal axis
  126122. * @param beta defines the camera rotation along the latitudinal axis
  126123. * @param radius defines the camera distance from its target
  126124. * @param target defines the camera target
  126125. * @param scene defines the scene the camera belongs to
  126126. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126127. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126128. */
  126129. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126130. /**
  126131. * Gets camera class name
  126132. * @returns VRDeviceOrientationArcRotateCamera
  126133. */
  126134. getClassName(): string;
  126135. }
  126136. }
  126137. declare module BABYLON {
  126138. /**
  126139. * Camera used to simulate VR rendering (based on FreeCamera)
  126140. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126141. */
  126142. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  126143. /**
  126144. * Creates a new VRDeviceOrientationFreeCamera
  126145. * @param name defines camera name
  126146. * @param position defines the start position of the camera
  126147. * @param scene defines the scene the camera belongs to
  126148. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126149. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126150. */
  126151. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126152. /**
  126153. * Gets camera class name
  126154. * @returns VRDeviceOrientationFreeCamera
  126155. */
  126156. getClassName(): string;
  126157. }
  126158. }
  126159. declare module BABYLON {
  126160. /**
  126161. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  126162. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126163. */
  126164. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  126165. /**
  126166. * Creates a new VRDeviceOrientationGamepadCamera
  126167. * @param name defines camera name
  126168. * @param position defines the start position of the camera
  126169. * @param scene defines the scene the camera belongs to
  126170. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126171. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126172. */
  126173. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126174. /**
  126175. * Gets camera class name
  126176. * @returns VRDeviceOrientationGamepadCamera
  126177. */
  126178. getClassName(): string;
  126179. }
  126180. }
  126181. declare module BABYLON {
  126182. /**
  126183. * A class extending Texture allowing drawing on a texture
  126184. * @see https://doc.babylonjs.com/how_to/dynamictexture
  126185. */
  126186. export class DynamicTexture extends Texture {
  126187. private _generateMipMaps;
  126188. private _canvas;
  126189. private _context;
  126190. /**
  126191. * Creates a DynamicTexture
  126192. * @param name defines the name of the texture
  126193. * @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
  126194. * @param scene defines the scene where you want the texture
  126195. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  126196. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126197. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  126198. */
  126199. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  126200. /**
  126201. * Get the current class name of the texture useful for serialization or dynamic coding.
  126202. * @returns "DynamicTexture"
  126203. */
  126204. getClassName(): string;
  126205. /**
  126206. * Gets the current state of canRescale
  126207. */
  126208. get canRescale(): boolean;
  126209. private _recreate;
  126210. /**
  126211. * Scales the texture
  126212. * @param ratio the scale factor to apply to both width and height
  126213. */
  126214. scale(ratio: number): void;
  126215. /**
  126216. * Resizes the texture
  126217. * @param width the new width
  126218. * @param height the new height
  126219. */
  126220. scaleTo(width: number, height: number): void;
  126221. /**
  126222. * Gets the context of the canvas used by the texture
  126223. * @returns the canvas context of the dynamic texture
  126224. */
  126225. getContext(): CanvasRenderingContext2D;
  126226. /**
  126227. * Clears the texture
  126228. */
  126229. clear(): void;
  126230. /**
  126231. * Updates the texture
  126232. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126233. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  126234. */
  126235. update(invertY?: boolean, premulAlpha?: boolean): void;
  126236. /**
  126237. * Draws text onto the texture
  126238. * @param text defines the text to be drawn
  126239. * @param x defines the placement of the text from the left
  126240. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  126241. * @param font defines the font to be used with font-style, font-size, font-name
  126242. * @param color defines the color used for the text
  126243. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  126244. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126245. * @param update defines whether texture is immediately update (default is true)
  126246. */
  126247. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  126248. /**
  126249. * Clones the texture
  126250. * @returns the clone of the texture.
  126251. */
  126252. clone(): DynamicTexture;
  126253. /**
  126254. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  126255. * @returns a serialized dynamic texture object
  126256. */
  126257. serialize(): any;
  126258. private _IsCanvasElement;
  126259. /** @hidden */
  126260. _rebuild(): void;
  126261. }
  126262. }
  126263. declare module BABYLON {
  126264. /**
  126265. * Class containing static functions to help procedurally build meshes
  126266. */
  126267. export class GroundBuilder {
  126268. /**
  126269. * Creates a ground mesh
  126270. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  126271. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  126272. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126273. * @param name defines the name of the mesh
  126274. * @param options defines the options used to create the mesh
  126275. * @param scene defines the hosting scene
  126276. * @returns the ground mesh
  126277. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  126278. */
  126279. static CreateGround(name: string, options: {
  126280. width?: number;
  126281. height?: number;
  126282. subdivisions?: number;
  126283. subdivisionsX?: number;
  126284. subdivisionsY?: number;
  126285. updatable?: boolean;
  126286. }, scene: any): Mesh;
  126287. /**
  126288. * Creates a tiled ground mesh
  126289. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  126290. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  126291. * * 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
  126292. * * 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
  126293. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126294. * @param name defines the name of the mesh
  126295. * @param options defines the options used to create the mesh
  126296. * @param scene defines the hosting scene
  126297. * @returns the tiled ground mesh
  126298. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  126299. */
  126300. static CreateTiledGround(name: string, options: {
  126301. xmin: number;
  126302. zmin: number;
  126303. xmax: number;
  126304. zmax: number;
  126305. subdivisions?: {
  126306. w: number;
  126307. h: number;
  126308. };
  126309. precision?: {
  126310. w: number;
  126311. h: number;
  126312. };
  126313. updatable?: boolean;
  126314. }, scene?: Nullable<Scene>): Mesh;
  126315. /**
  126316. * Creates a ground mesh from a height map
  126317. * * The parameter `url` sets the URL of the height map image resource.
  126318. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  126319. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  126320. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  126321. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  126322. * * 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.
  126323. * * 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).
  126324. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  126325. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126326. * @param name defines the name of the mesh
  126327. * @param url defines the url to the height map
  126328. * @param options defines the options used to create the mesh
  126329. * @param scene defines the hosting scene
  126330. * @returns the ground mesh
  126331. * @see https://doc.babylonjs.com/babylon101/height_map
  126332. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  126333. */
  126334. static CreateGroundFromHeightMap(name: string, url: string, options: {
  126335. width?: number;
  126336. height?: number;
  126337. subdivisions?: number;
  126338. minHeight?: number;
  126339. maxHeight?: number;
  126340. colorFilter?: Color3;
  126341. alphaFilter?: number;
  126342. updatable?: boolean;
  126343. onReady?: (mesh: GroundMesh) => void;
  126344. }, scene?: Nullable<Scene>): GroundMesh;
  126345. }
  126346. }
  126347. declare module BABYLON {
  126348. /**
  126349. * Class containing static functions to help procedurally build meshes
  126350. */
  126351. export class TorusBuilder {
  126352. /**
  126353. * Creates a torus mesh
  126354. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  126355. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  126356. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  126357. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126358. * * 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
  126359. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126360. * @param name defines the name of the mesh
  126361. * @param options defines the options used to create the mesh
  126362. * @param scene defines the hosting scene
  126363. * @returns the torus mesh
  126364. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  126365. */
  126366. static CreateTorus(name: string, options: {
  126367. diameter?: number;
  126368. thickness?: number;
  126369. tessellation?: number;
  126370. updatable?: boolean;
  126371. sideOrientation?: number;
  126372. frontUVs?: Vector4;
  126373. backUVs?: Vector4;
  126374. }, scene: any): Mesh;
  126375. }
  126376. }
  126377. declare module BABYLON {
  126378. /**
  126379. * Class containing static functions to help procedurally build meshes
  126380. */
  126381. export class CylinderBuilder {
  126382. /**
  126383. * Creates a cylinder or a cone mesh
  126384. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  126385. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  126386. * * 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.
  126387. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  126388. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  126389. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  126390. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  126391. * * 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).
  126392. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  126393. * * 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).
  126394. * * 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
  126395. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  126396. * * 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
  126397. * * 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.
  126398. * * If `enclose` is false, a ring surface is one element.
  126399. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  126400. * * 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
  126401. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126402. * * 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
  126403. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126404. * @param name defines the name of the mesh
  126405. * @param options defines the options used to create the mesh
  126406. * @param scene defines the hosting scene
  126407. * @returns the cylinder mesh
  126408. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  126409. */
  126410. static CreateCylinder(name: string, options: {
  126411. height?: number;
  126412. diameterTop?: number;
  126413. diameterBottom?: number;
  126414. diameter?: number;
  126415. tessellation?: number;
  126416. subdivisions?: number;
  126417. arc?: number;
  126418. faceColors?: Color4[];
  126419. faceUV?: Vector4[];
  126420. updatable?: boolean;
  126421. hasRings?: boolean;
  126422. enclose?: boolean;
  126423. cap?: number;
  126424. sideOrientation?: number;
  126425. frontUVs?: Vector4;
  126426. backUVs?: Vector4;
  126427. }, scene: any): Mesh;
  126428. }
  126429. }
  126430. declare module BABYLON {
  126431. /**
  126432. * States of the webXR experience
  126433. */
  126434. export enum WebXRState {
  126435. /**
  126436. * Transitioning to being in XR mode
  126437. */
  126438. ENTERING_XR = 0,
  126439. /**
  126440. * Transitioning to non XR mode
  126441. */
  126442. EXITING_XR = 1,
  126443. /**
  126444. * In XR mode and presenting
  126445. */
  126446. IN_XR = 2,
  126447. /**
  126448. * Not entered XR mode
  126449. */
  126450. NOT_IN_XR = 3
  126451. }
  126452. /**
  126453. * Abstraction of the XR render target
  126454. */
  126455. export interface WebXRRenderTarget extends IDisposable {
  126456. /**
  126457. * xrpresent context of the canvas which can be used to display/mirror xr content
  126458. */
  126459. canvasContext: WebGLRenderingContext;
  126460. /**
  126461. * xr layer for the canvas
  126462. */
  126463. xrLayer: Nullable<XRWebGLLayer>;
  126464. /**
  126465. * Initializes the xr layer for the session
  126466. * @param xrSession xr session
  126467. * @returns a promise that will resolve once the XR Layer has been created
  126468. */
  126469. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126470. }
  126471. }
  126472. declare module BABYLON {
  126473. /**
  126474. * COnfiguration object for WebXR output canvas
  126475. */
  126476. export class WebXRManagedOutputCanvasOptions {
  126477. /**
  126478. * An optional canvas in case you wish to create it yourself and provide it here.
  126479. * If not provided, a new canvas will be created
  126480. */
  126481. canvasElement?: HTMLCanvasElement;
  126482. /**
  126483. * Options for this XR Layer output
  126484. */
  126485. canvasOptions?: XRWebGLLayerOptions;
  126486. /**
  126487. * CSS styling for a newly created canvas (if not provided)
  126488. */
  126489. newCanvasCssStyle?: string;
  126490. /**
  126491. * Get the default values of the configuration object
  126492. * @param engine defines the engine to use (can be null)
  126493. * @returns default values of this configuration object
  126494. */
  126495. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  126496. }
  126497. /**
  126498. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  126499. */
  126500. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  126501. private _options;
  126502. private _canvas;
  126503. private _engine;
  126504. private _originalCanvasSize;
  126505. /**
  126506. * Rendering context of the canvas which can be used to display/mirror xr content
  126507. */
  126508. canvasContext: WebGLRenderingContext;
  126509. /**
  126510. * xr layer for the canvas
  126511. */
  126512. xrLayer: Nullable<XRWebGLLayer>;
  126513. /**
  126514. * Obseervers registered here will be triggered when the xr layer was initialized
  126515. */
  126516. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  126517. /**
  126518. * Initializes the canvas to be added/removed upon entering/exiting xr
  126519. * @param _xrSessionManager The XR Session manager
  126520. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  126521. */
  126522. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  126523. /**
  126524. * Disposes of the object
  126525. */
  126526. dispose(): void;
  126527. /**
  126528. * Initializes the xr layer for the session
  126529. * @param xrSession xr session
  126530. * @returns a promise that will resolve once the XR Layer has been created
  126531. */
  126532. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126533. private _addCanvas;
  126534. private _removeCanvas;
  126535. private _setCanvasSize;
  126536. private _setManagedOutputCanvas;
  126537. }
  126538. }
  126539. declare module BABYLON {
  126540. /**
  126541. * Manages an XRSession to work with Babylon's engine
  126542. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  126543. */
  126544. export class WebXRSessionManager implements IDisposable {
  126545. /** The scene which the session should be created for */
  126546. scene: Scene;
  126547. private _referenceSpace;
  126548. private _rttProvider;
  126549. private _sessionEnded;
  126550. private _xrNavigator;
  126551. private baseLayer;
  126552. /**
  126553. * The base reference space from which the session started. good if you want to reset your
  126554. * reference space
  126555. */
  126556. baseReferenceSpace: XRReferenceSpace;
  126557. /**
  126558. * Current XR frame
  126559. */
  126560. currentFrame: Nullable<XRFrame>;
  126561. /** WebXR timestamp updated every frame */
  126562. currentTimestamp: number;
  126563. /**
  126564. * Used just in case of a failure to initialize an immersive session.
  126565. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  126566. */
  126567. defaultHeightCompensation: number;
  126568. /**
  126569. * Fires every time a new xrFrame arrives which can be used to update the camera
  126570. */
  126571. onXRFrameObservable: Observable<XRFrame>;
  126572. /**
  126573. * Fires when the reference space changed
  126574. */
  126575. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  126576. /**
  126577. * Fires when the xr session is ended either by the device or manually done
  126578. */
  126579. onXRSessionEnded: Observable<any>;
  126580. /**
  126581. * Fires when the xr session is ended either by the device or manually done
  126582. */
  126583. onXRSessionInit: Observable<XRSession>;
  126584. /**
  126585. * Underlying xr session
  126586. */
  126587. session: XRSession;
  126588. /**
  126589. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  126590. * or get the offset the player is currently at.
  126591. */
  126592. viewerReferenceSpace: XRReferenceSpace;
  126593. /**
  126594. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  126595. * @param scene The scene which the session should be created for
  126596. */
  126597. constructor(
  126598. /** The scene which the session should be created for */
  126599. scene: Scene);
  126600. /**
  126601. * The current reference space used in this session. This reference space can constantly change!
  126602. * It is mainly used to offset the camera's position.
  126603. */
  126604. get referenceSpace(): XRReferenceSpace;
  126605. /**
  126606. * Set a new reference space and triggers the observable
  126607. */
  126608. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  126609. /**
  126610. * Disposes of the session manager
  126611. */
  126612. dispose(): void;
  126613. /**
  126614. * Stops the xrSession and restores the render loop
  126615. * @returns Promise which resolves after it exits XR
  126616. */
  126617. exitXRAsync(): Promise<void>;
  126618. /**
  126619. * Gets the correct render target texture to be rendered this frame for this eye
  126620. * @param eye the eye for which to get the render target
  126621. * @returns the render target for the specified eye
  126622. */
  126623. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  126624. /**
  126625. * Creates a WebXRRenderTarget object for the XR session
  126626. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  126627. * @param options optional options to provide when creating a new render target
  126628. * @returns a WebXR render target to which the session can render
  126629. */
  126630. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  126631. /**
  126632. * Initializes the manager
  126633. * After initialization enterXR can be called to start an XR session
  126634. * @returns Promise which resolves after it is initialized
  126635. */
  126636. initializeAsync(): Promise<void>;
  126637. /**
  126638. * Initializes an xr session
  126639. * @param xrSessionMode mode to initialize
  126640. * @param xrSessionInit defines optional and required values to pass to the session builder
  126641. * @returns a promise which will resolve once the session has been initialized
  126642. */
  126643. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  126644. /**
  126645. * Checks if a session would be supported for the creation options specified
  126646. * @param sessionMode session mode to check if supported eg. immersive-vr
  126647. * @returns A Promise that resolves to true if supported and false if not
  126648. */
  126649. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126650. /**
  126651. * Resets the reference space to the one started the session
  126652. */
  126653. resetReferenceSpace(): void;
  126654. /**
  126655. * Starts rendering to the xr layer
  126656. */
  126657. runXRRenderLoop(): void;
  126658. /**
  126659. * Sets the reference space on the xr session
  126660. * @param referenceSpaceType space to set
  126661. * @returns a promise that will resolve once the reference space has been set
  126662. */
  126663. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  126664. /**
  126665. * Updates the render state of the session
  126666. * @param state state to set
  126667. * @returns a promise that resolves once the render state has been updated
  126668. */
  126669. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  126670. /**
  126671. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  126672. * @param sessionMode defines the session to test
  126673. * @returns a promise with boolean as final value
  126674. */
  126675. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126676. private _createRenderTargetTexture;
  126677. }
  126678. }
  126679. declare module BABYLON {
  126680. /**
  126681. * WebXR Camera which holds the views for the xrSession
  126682. * @see https://doc.babylonjs.com/how_to/webxr_camera
  126683. */
  126684. export class WebXRCamera extends FreeCamera {
  126685. private _xrSessionManager;
  126686. private _firstFrame;
  126687. private _referenceQuaternion;
  126688. private _referencedPosition;
  126689. private _xrInvPositionCache;
  126690. private _xrInvQuaternionCache;
  126691. /**
  126692. * Observable raised before camera teleportation
  126693. */
  126694. onBeforeCameraTeleport: Observable<Vector3>;
  126695. /**
  126696. * Observable raised after camera teleportation
  126697. */
  126698. onAfterCameraTeleport: Observable<Vector3>;
  126699. /**
  126700. * Should position compensation execute on first frame.
  126701. * This is used when copying the position from a native (non XR) camera
  126702. */
  126703. compensateOnFirstFrame: boolean;
  126704. /**
  126705. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  126706. * @param name the name of the camera
  126707. * @param scene the scene to add the camera to
  126708. * @param _xrSessionManager a constructed xr session manager
  126709. */
  126710. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  126711. /**
  126712. * Return the user's height, unrelated to the current ground.
  126713. * This will be the y position of this camera, when ground level is 0.
  126714. */
  126715. get realWorldHeight(): number;
  126716. /** @hidden */
  126717. _updateForDualEyeDebugging(): void;
  126718. /**
  126719. * Sets this camera's transformation based on a non-vr camera
  126720. * @param otherCamera the non-vr camera to copy the transformation from
  126721. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  126722. */
  126723. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  126724. /**
  126725. * Gets the current instance class name ("WebXRCamera").
  126726. * @returns the class name
  126727. */
  126728. getClassName(): string;
  126729. private _rotate180;
  126730. private _updateFromXRSession;
  126731. private _updateNumberOfRigCameras;
  126732. private _updateReferenceSpace;
  126733. private _updateReferenceSpaceOffset;
  126734. }
  126735. }
  126736. declare module BABYLON {
  126737. /**
  126738. * Defining the interface required for a (webxr) feature
  126739. */
  126740. export interface IWebXRFeature extends IDisposable {
  126741. /**
  126742. * Is this feature attached
  126743. */
  126744. attached: boolean;
  126745. /**
  126746. * Should auto-attach be disabled?
  126747. */
  126748. disableAutoAttach: boolean;
  126749. /**
  126750. * Attach the feature to the session
  126751. * Will usually be called by the features manager
  126752. *
  126753. * @param force should attachment be forced (even when already attached)
  126754. * @returns true if successful.
  126755. */
  126756. attach(force?: boolean): boolean;
  126757. /**
  126758. * Detach the feature from the session
  126759. * Will usually be called by the features manager
  126760. *
  126761. * @returns true if successful.
  126762. */
  126763. detach(): boolean;
  126764. /**
  126765. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  126766. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  126767. *
  126768. * @returns whether or not the feature is compatible in this environment
  126769. */
  126770. isCompatible(): boolean;
  126771. /**
  126772. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  126773. */
  126774. xrNativeFeatureName?: string;
  126775. /**
  126776. * A list of (Babylon WebXR) features this feature depends on
  126777. */
  126778. dependsOn?: string[];
  126779. }
  126780. /**
  126781. * A list of the currently available features without referencing them
  126782. */
  126783. export class WebXRFeatureName {
  126784. /**
  126785. * The name of the anchor system feature
  126786. */
  126787. static readonly ANCHOR_SYSTEM: string;
  126788. /**
  126789. * The name of the background remover feature
  126790. */
  126791. static readonly BACKGROUND_REMOVER: string;
  126792. /**
  126793. * The name of the hit test feature
  126794. */
  126795. static readonly HIT_TEST: string;
  126796. /**
  126797. * physics impostors for xr controllers feature
  126798. */
  126799. static readonly PHYSICS_CONTROLLERS: string;
  126800. /**
  126801. * The name of the plane detection feature
  126802. */
  126803. static readonly PLANE_DETECTION: string;
  126804. /**
  126805. * The name of the pointer selection feature
  126806. */
  126807. static readonly POINTER_SELECTION: string;
  126808. /**
  126809. * The name of the teleportation feature
  126810. */
  126811. static readonly TELEPORTATION: string;
  126812. /**
  126813. * The name of the feature points feature.
  126814. */
  126815. static readonly FEATURE_POINTS: string;
  126816. /**
  126817. * The name of the hand tracking feature.
  126818. */
  126819. static readonly HAND_TRACKING: string;
  126820. }
  126821. /**
  126822. * Defining the constructor of a feature. Used to register the modules.
  126823. */
  126824. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  126825. /**
  126826. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  126827. * It is mainly used in AR sessions.
  126828. *
  126829. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  126830. */
  126831. export class WebXRFeaturesManager implements IDisposable {
  126832. private _xrSessionManager;
  126833. private static readonly _AvailableFeatures;
  126834. private _features;
  126835. /**
  126836. * constructs a new features manages.
  126837. *
  126838. * @param _xrSessionManager an instance of WebXRSessionManager
  126839. */
  126840. constructor(_xrSessionManager: WebXRSessionManager);
  126841. /**
  126842. * Used to register a module. After calling this function a developer can use this feature in the scene.
  126843. * Mainly used internally.
  126844. *
  126845. * @param featureName the name of the feature to register
  126846. * @param constructorFunction the function used to construct the module
  126847. * @param version the (babylon) version of the module
  126848. * @param stable is that a stable version of this module
  126849. */
  126850. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  126851. /**
  126852. * Returns a constructor of a specific feature.
  126853. *
  126854. * @param featureName the name of the feature to construct
  126855. * @param version the version of the feature to load
  126856. * @param xrSessionManager the xrSessionManager. Used to construct the module
  126857. * @param options optional options provided to the module.
  126858. * @returns a function that, when called, will return a new instance of this feature
  126859. */
  126860. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  126861. /**
  126862. * Can be used to return the list of features currently registered
  126863. *
  126864. * @returns an Array of available features
  126865. */
  126866. static GetAvailableFeatures(): string[];
  126867. /**
  126868. * Gets the versions available for a specific feature
  126869. * @param featureName the name of the feature
  126870. * @returns an array with the available versions
  126871. */
  126872. static GetAvailableVersions(featureName: string): string[];
  126873. /**
  126874. * Return the latest unstable version of this feature
  126875. * @param featureName the name of the feature to search
  126876. * @returns the version number. if not found will return -1
  126877. */
  126878. static GetLatestVersionOfFeature(featureName: string): number;
  126879. /**
  126880. * Return the latest stable version of this feature
  126881. * @param featureName the name of the feature to search
  126882. * @returns the version number. if not found will return -1
  126883. */
  126884. static GetStableVersionOfFeature(featureName: string): number;
  126885. /**
  126886. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  126887. * Can be used during a session to start a feature
  126888. * @param featureName the name of feature to attach
  126889. */
  126890. attachFeature(featureName: string): void;
  126891. /**
  126892. * Can be used inside a session or when the session ends to detach a specific feature
  126893. * @param featureName the name of the feature to detach
  126894. */
  126895. detachFeature(featureName: string): void;
  126896. /**
  126897. * Used to disable an already-enabled feature
  126898. * The feature will be disposed and will be recreated once enabled.
  126899. * @param featureName the feature to disable
  126900. * @returns true if disable was successful
  126901. */
  126902. disableFeature(featureName: string | {
  126903. Name: string;
  126904. }): boolean;
  126905. /**
  126906. * dispose this features manager
  126907. */
  126908. dispose(): void;
  126909. /**
  126910. * 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.
  126911. * 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.
  126912. *
  126913. * @param featureName the name of the feature to load or the class of the feature
  126914. * @param version optional version to load. if not provided the latest version will be enabled
  126915. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  126916. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  126917. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  126918. * @returns a new constructed feature or throws an error if feature not found.
  126919. */
  126920. enableFeature(featureName: string | {
  126921. Name: string;
  126922. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  126923. /**
  126924. * get the implementation of an enabled feature.
  126925. * @param featureName the name of the feature to load
  126926. * @returns the feature class, if found
  126927. */
  126928. getEnabledFeature(featureName: string): IWebXRFeature;
  126929. /**
  126930. * Get the list of enabled features
  126931. * @returns an array of enabled features
  126932. */
  126933. getEnabledFeatures(): string[];
  126934. /**
  126935. * This function will exten the session creation configuration object with enabled features.
  126936. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  126937. * according to the defined "required" variable, provided during enableFeature call
  126938. * @param xrSessionInit the xr Session init object to extend
  126939. *
  126940. * @returns an extended XRSessionInit object
  126941. */
  126942. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  126943. }
  126944. }
  126945. declare module BABYLON {
  126946. /**
  126947. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  126948. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  126949. */
  126950. export class WebXRExperienceHelper implements IDisposable {
  126951. private scene;
  126952. private _nonVRCamera;
  126953. private _originalSceneAutoClear;
  126954. private _supported;
  126955. /**
  126956. * Camera used to render xr content
  126957. */
  126958. camera: WebXRCamera;
  126959. /** A features manager for this xr session */
  126960. featuresManager: WebXRFeaturesManager;
  126961. /**
  126962. * Observers registered here will be triggered after the camera's initial transformation is set
  126963. * This can be used to set a different ground level or an extra rotation.
  126964. *
  126965. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  126966. * to the position set after this observable is done executing.
  126967. */
  126968. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  126969. /**
  126970. * Fires when the state of the experience helper has changed
  126971. */
  126972. onStateChangedObservable: Observable<WebXRState>;
  126973. /** Session manager used to keep track of xr session */
  126974. sessionManager: WebXRSessionManager;
  126975. /**
  126976. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  126977. */
  126978. state: WebXRState;
  126979. /**
  126980. * Creates a WebXRExperienceHelper
  126981. * @param scene The scene the helper should be created in
  126982. */
  126983. private constructor();
  126984. /**
  126985. * Creates the experience helper
  126986. * @param scene the scene to attach the experience helper to
  126987. * @returns a promise for the experience helper
  126988. */
  126989. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  126990. /**
  126991. * Disposes of the experience helper
  126992. */
  126993. dispose(): void;
  126994. /**
  126995. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  126996. * @param sessionMode options for the XR session
  126997. * @param referenceSpaceType frame of reference of the XR session
  126998. * @param renderTarget the output canvas that will be used to enter XR mode
  126999. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  127000. * @returns promise that resolves after xr mode has entered
  127001. */
  127002. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  127003. /**
  127004. * Exits XR mode and returns the scene to its original state
  127005. * @returns promise that resolves after xr mode has exited
  127006. */
  127007. exitXRAsync(): Promise<void>;
  127008. private _nonXRToXRCamera;
  127009. private _setState;
  127010. }
  127011. }
  127012. declare module BABYLON {
  127013. /**
  127014. * X-Y values for axes in WebXR
  127015. */
  127016. export interface IWebXRMotionControllerAxesValue {
  127017. /**
  127018. * The value of the x axis
  127019. */
  127020. x: number;
  127021. /**
  127022. * The value of the y-axis
  127023. */
  127024. y: number;
  127025. }
  127026. /**
  127027. * changed / previous values for the values of this component
  127028. */
  127029. export interface IWebXRMotionControllerComponentChangesValues<T> {
  127030. /**
  127031. * current (this frame) value
  127032. */
  127033. current: T;
  127034. /**
  127035. * previous (last change) value
  127036. */
  127037. previous: T;
  127038. }
  127039. /**
  127040. * Represents changes in the component between current frame and last values recorded
  127041. */
  127042. export interface IWebXRMotionControllerComponentChanges {
  127043. /**
  127044. * will be populated with previous and current values if axes changed
  127045. */
  127046. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  127047. /**
  127048. * will be populated with previous and current values if pressed changed
  127049. */
  127050. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127051. /**
  127052. * will be populated with previous and current values if touched changed
  127053. */
  127054. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127055. /**
  127056. * will be populated with previous and current values if value changed
  127057. */
  127058. value?: IWebXRMotionControllerComponentChangesValues<number>;
  127059. }
  127060. /**
  127061. * This class represents a single component (for example button or thumbstick) of a motion controller
  127062. */
  127063. export class WebXRControllerComponent implements IDisposable {
  127064. /**
  127065. * the id of this component
  127066. */
  127067. id: string;
  127068. /**
  127069. * the type of the component
  127070. */
  127071. type: MotionControllerComponentType;
  127072. private _buttonIndex;
  127073. private _axesIndices;
  127074. private _axes;
  127075. private _changes;
  127076. private _currentValue;
  127077. private _hasChanges;
  127078. private _pressed;
  127079. private _touched;
  127080. /**
  127081. * button component type
  127082. */
  127083. static BUTTON_TYPE: MotionControllerComponentType;
  127084. /**
  127085. * squeeze component type
  127086. */
  127087. static SQUEEZE_TYPE: MotionControllerComponentType;
  127088. /**
  127089. * Thumbstick component type
  127090. */
  127091. static THUMBSTICK_TYPE: MotionControllerComponentType;
  127092. /**
  127093. * Touchpad component type
  127094. */
  127095. static TOUCHPAD_TYPE: MotionControllerComponentType;
  127096. /**
  127097. * trigger component type
  127098. */
  127099. static TRIGGER_TYPE: MotionControllerComponentType;
  127100. /**
  127101. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  127102. * the axes data changes
  127103. */
  127104. onAxisValueChangedObservable: Observable<{
  127105. x: number;
  127106. y: number;
  127107. }>;
  127108. /**
  127109. * Observers registered here will be triggered when the state of a button changes
  127110. * State change is either pressed / touched / value
  127111. */
  127112. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  127113. /**
  127114. * Creates a new component for a motion controller.
  127115. * It is created by the motion controller itself
  127116. *
  127117. * @param id the id of this component
  127118. * @param type the type of the component
  127119. * @param _buttonIndex index in the buttons array of the gamepad
  127120. * @param _axesIndices indices of the values in the axes array of the gamepad
  127121. */
  127122. constructor(
  127123. /**
  127124. * the id of this component
  127125. */
  127126. id: string,
  127127. /**
  127128. * the type of the component
  127129. */
  127130. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  127131. /**
  127132. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  127133. */
  127134. get axes(): IWebXRMotionControllerAxesValue;
  127135. /**
  127136. * Get the changes. Elements will be populated only if they changed with their previous and current value
  127137. */
  127138. get changes(): IWebXRMotionControllerComponentChanges;
  127139. /**
  127140. * Return whether or not the component changed the last frame
  127141. */
  127142. get hasChanges(): boolean;
  127143. /**
  127144. * is the button currently pressed
  127145. */
  127146. get pressed(): boolean;
  127147. /**
  127148. * is the button currently touched
  127149. */
  127150. get touched(): boolean;
  127151. /**
  127152. * Get the current value of this component
  127153. */
  127154. get value(): number;
  127155. /**
  127156. * Dispose this component
  127157. */
  127158. dispose(): void;
  127159. /**
  127160. * Are there axes correlating to this component
  127161. * @return true is axes data is available
  127162. */
  127163. isAxes(): boolean;
  127164. /**
  127165. * Is this component a button (hence - pressable)
  127166. * @returns true if can be pressed
  127167. */
  127168. isButton(): boolean;
  127169. /**
  127170. * update this component using the gamepad object it is in. Called on every frame
  127171. * @param nativeController the native gamepad controller object
  127172. */
  127173. update(nativeController: IMinimalMotionControllerObject): void;
  127174. }
  127175. }
  127176. declare module BABYLON {
  127177. /**
  127178. * Interface used to represent data loading progression
  127179. */
  127180. export interface ISceneLoaderProgressEvent {
  127181. /**
  127182. * Defines if data length to load can be evaluated
  127183. */
  127184. readonly lengthComputable: boolean;
  127185. /**
  127186. * Defines the loaded data length
  127187. */
  127188. readonly loaded: number;
  127189. /**
  127190. * Defines the data length to load
  127191. */
  127192. readonly total: number;
  127193. }
  127194. /**
  127195. * Interface used by SceneLoader plugins to define supported file extensions
  127196. */
  127197. export interface ISceneLoaderPluginExtensions {
  127198. /**
  127199. * Defines the list of supported extensions
  127200. */
  127201. [extension: string]: {
  127202. isBinary: boolean;
  127203. };
  127204. }
  127205. /**
  127206. * Interface used by SceneLoader plugin factory
  127207. */
  127208. export interface ISceneLoaderPluginFactory {
  127209. /**
  127210. * Defines the name of the factory
  127211. */
  127212. name: string;
  127213. /**
  127214. * Function called to create a new plugin
  127215. * @return the new plugin
  127216. */
  127217. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  127218. /**
  127219. * The callback that returns true if the data can be directly loaded.
  127220. * @param data string containing the file data
  127221. * @returns if the data can be loaded directly
  127222. */
  127223. canDirectLoad?(data: string): boolean;
  127224. }
  127225. /**
  127226. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  127227. */
  127228. export interface ISceneLoaderPluginBase {
  127229. /**
  127230. * The friendly name of this plugin.
  127231. */
  127232. name: string;
  127233. /**
  127234. * The file extensions supported by this plugin.
  127235. */
  127236. extensions: string | ISceneLoaderPluginExtensions;
  127237. /**
  127238. * The callback called when loading from a url.
  127239. * @param scene scene loading this url
  127240. * @param url url to load
  127241. * @param onSuccess callback called when the file successfully loads
  127242. * @param onProgress callback called while file is loading (if the server supports this mode)
  127243. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  127244. * @param onError callback called when the file fails to load
  127245. * @returns a file request object
  127246. */
  127247. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127248. /**
  127249. * The callback called when loading from a file object.
  127250. * @param scene scene loading this file
  127251. * @param file defines the file to load
  127252. * @param onSuccess defines the callback to call when data is loaded
  127253. * @param onProgress defines the callback to call during loading process
  127254. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  127255. * @param onError defines the callback to call when an error occurs
  127256. * @returns a file request object
  127257. */
  127258. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127259. /**
  127260. * The callback that returns true if the data can be directly loaded.
  127261. * @param data string containing the file data
  127262. * @returns if the data can be loaded directly
  127263. */
  127264. canDirectLoad?(data: string): boolean;
  127265. /**
  127266. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  127267. * @param scene scene loading this data
  127268. * @param data string containing the data
  127269. * @returns data to pass to the plugin
  127270. */
  127271. directLoad?(scene: Scene, data: string): any;
  127272. /**
  127273. * The callback that allows custom handling of the root url based on the response url.
  127274. * @param rootUrl the original root url
  127275. * @param responseURL the response url if available
  127276. * @returns the new root url
  127277. */
  127278. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  127279. }
  127280. /**
  127281. * Interface used to define a SceneLoader plugin
  127282. */
  127283. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  127284. /**
  127285. * Import meshes into a scene.
  127286. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127287. * @param scene The scene to import into
  127288. * @param data The data to import
  127289. * @param rootUrl The root url for scene and resources
  127290. * @param meshes The meshes array to import into
  127291. * @param particleSystems The particle systems array to import into
  127292. * @param skeletons The skeletons array to import into
  127293. * @param onError The callback when import fails
  127294. * @returns True if successful or false otherwise
  127295. */
  127296. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  127297. /**
  127298. * Load into a scene.
  127299. * @param scene The scene to load into
  127300. * @param data The data to import
  127301. * @param rootUrl The root url for scene and resources
  127302. * @param onError The callback when import fails
  127303. * @returns True if successful or false otherwise
  127304. */
  127305. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  127306. /**
  127307. * Load into an asset container.
  127308. * @param scene The scene to load into
  127309. * @param data The data to import
  127310. * @param rootUrl The root url for scene and resources
  127311. * @param onError The callback when import fails
  127312. * @returns The loaded asset container
  127313. */
  127314. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  127315. }
  127316. /**
  127317. * Interface used to define an async SceneLoader plugin
  127318. */
  127319. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  127320. /**
  127321. * Import meshes into a scene.
  127322. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127323. * @param scene The scene to import into
  127324. * @param data The data to import
  127325. * @param rootUrl The root url for scene and resources
  127326. * @param onProgress The callback when the load progresses
  127327. * @param fileName Defines the name of the file to load
  127328. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  127329. */
  127330. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  127331. meshes: AbstractMesh[];
  127332. particleSystems: IParticleSystem[];
  127333. skeletons: Skeleton[];
  127334. animationGroups: AnimationGroup[];
  127335. }>;
  127336. /**
  127337. * Load into a scene.
  127338. * @param scene The scene to load into
  127339. * @param data The data to import
  127340. * @param rootUrl The root url for scene and resources
  127341. * @param onProgress The callback when the load progresses
  127342. * @param fileName Defines the name of the file to load
  127343. * @returns Nothing
  127344. */
  127345. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  127346. /**
  127347. * Load into an asset container.
  127348. * @param scene The scene to load into
  127349. * @param data The data to import
  127350. * @param rootUrl The root url for scene and resources
  127351. * @param onProgress The callback when the load progresses
  127352. * @param fileName Defines the name of the file to load
  127353. * @returns The loaded asset container
  127354. */
  127355. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  127356. }
  127357. /**
  127358. * Mode that determines how to handle old animation groups before loading new ones.
  127359. */
  127360. export enum SceneLoaderAnimationGroupLoadingMode {
  127361. /**
  127362. * Reset all old animations to initial state then dispose them.
  127363. */
  127364. Clean = 0,
  127365. /**
  127366. * Stop all old animations.
  127367. */
  127368. Stop = 1,
  127369. /**
  127370. * Restart old animations from first frame.
  127371. */
  127372. Sync = 2,
  127373. /**
  127374. * Old animations remains untouched.
  127375. */
  127376. NoSync = 3
  127377. }
  127378. /**
  127379. * Defines a plugin registered by the SceneLoader
  127380. */
  127381. interface IRegisteredPlugin {
  127382. /**
  127383. * Defines the plugin to use
  127384. */
  127385. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127386. /**
  127387. * Defines if the plugin supports binary data
  127388. */
  127389. isBinary: boolean;
  127390. }
  127391. /**
  127392. * Class used to load scene from various file formats using registered plugins
  127393. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  127394. */
  127395. export class SceneLoader {
  127396. /**
  127397. * No logging while loading
  127398. */
  127399. static readonly NO_LOGGING: number;
  127400. /**
  127401. * Minimal logging while loading
  127402. */
  127403. static readonly MINIMAL_LOGGING: number;
  127404. /**
  127405. * Summary logging while loading
  127406. */
  127407. static readonly SUMMARY_LOGGING: number;
  127408. /**
  127409. * Detailled logging while loading
  127410. */
  127411. static readonly DETAILED_LOGGING: number;
  127412. /**
  127413. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  127414. */
  127415. static get ForceFullSceneLoadingForIncremental(): boolean;
  127416. static set ForceFullSceneLoadingForIncremental(value: boolean);
  127417. /**
  127418. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  127419. */
  127420. static get ShowLoadingScreen(): boolean;
  127421. static set ShowLoadingScreen(value: boolean);
  127422. /**
  127423. * Defines the current logging level (while loading the scene)
  127424. * @ignorenaming
  127425. */
  127426. static get loggingLevel(): number;
  127427. static set loggingLevel(value: number);
  127428. /**
  127429. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  127430. */
  127431. static get CleanBoneMatrixWeights(): boolean;
  127432. static set CleanBoneMatrixWeights(value: boolean);
  127433. /**
  127434. * Event raised when a plugin is used to load a scene
  127435. */
  127436. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127437. private static _registeredPlugins;
  127438. private static _showingLoadingScreen;
  127439. /**
  127440. * Gets the default plugin (used to load Babylon files)
  127441. * @returns the .babylon plugin
  127442. */
  127443. static GetDefaultPlugin(): IRegisteredPlugin;
  127444. private static _GetPluginForExtension;
  127445. private static _GetPluginForDirectLoad;
  127446. private static _GetPluginForFilename;
  127447. private static _GetDirectLoad;
  127448. private static _LoadData;
  127449. private static _GetFileInfo;
  127450. /**
  127451. * Gets a plugin that can load the given extension
  127452. * @param extension defines the extension to load
  127453. * @returns a plugin or null if none works
  127454. */
  127455. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127456. /**
  127457. * Gets a boolean indicating that the given extension can be loaded
  127458. * @param extension defines the extension to load
  127459. * @returns true if the extension is supported
  127460. */
  127461. static IsPluginForExtensionAvailable(extension: string): boolean;
  127462. /**
  127463. * Adds a new plugin to the list of registered plugins
  127464. * @param plugin defines the plugin to add
  127465. */
  127466. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  127467. /**
  127468. * Import meshes into a scene
  127469. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127470. * @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)
  127471. * @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)
  127472. * @param scene the instance of BABYLON.Scene to append to
  127473. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  127474. * @param onProgress a callback with a progress event for each file being loaded
  127475. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127476. * @param pluginExtension the extension used to determine the plugin
  127477. * @returns The loaded plugin
  127478. */
  127479. 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>;
  127480. /**
  127481. * Import meshes into a scene
  127482. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127483. * @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)
  127484. * @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)
  127485. * @param scene the instance of BABYLON.Scene to append to
  127486. * @param onProgress a callback with a progress event for each file being loaded
  127487. * @param pluginExtension the extension used to determine the plugin
  127488. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  127489. */
  127490. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  127491. meshes: AbstractMesh[];
  127492. particleSystems: IParticleSystem[];
  127493. skeletons: Skeleton[];
  127494. animationGroups: AnimationGroup[];
  127495. }>;
  127496. /**
  127497. * Load a scene
  127498. * @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)
  127499. * @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)
  127500. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127501. * @param onSuccess a callback with the scene when import succeeds
  127502. * @param onProgress a callback with a progress event for each file being loaded
  127503. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127504. * @param pluginExtension the extension used to determine the plugin
  127505. * @returns The loaded plugin
  127506. */
  127507. 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>;
  127508. /**
  127509. * Load a scene
  127510. * @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)
  127511. * @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)
  127512. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127513. * @param onProgress a callback with a progress event for each file being loaded
  127514. * @param pluginExtension the extension used to determine the plugin
  127515. * @returns The loaded scene
  127516. */
  127517. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127518. /**
  127519. * Append a scene
  127520. * @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)
  127521. * @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)
  127522. * @param scene is the instance of BABYLON.Scene to append to
  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 loaded plugin
  127528. */
  127529. 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>;
  127530. /**
  127531. * Append a scene
  127532. * @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)
  127533. * @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)
  127534. * @param scene is the instance of BABYLON.Scene to append to
  127535. * @param onProgress a callback with a progress event for each file being loaded
  127536. * @param pluginExtension the extension used to determine the plugin
  127537. * @returns The given scene
  127538. */
  127539. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127540. /**
  127541. * Load a scene into an asset container
  127542. * @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)
  127543. * @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)
  127544. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127545. * @param onSuccess a callback with the scene when import succeeds
  127546. * @param onProgress a callback with a progress event for each file being loaded
  127547. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127548. * @param pluginExtension the extension used to determine the plugin
  127549. * @returns The loaded plugin
  127550. */
  127551. 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>;
  127552. /**
  127553. * Load a scene into an asset container
  127554. * @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)
  127555. * @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)
  127556. * @param scene is the instance of Scene to append to
  127557. * @param onProgress a callback with a progress event for each file being loaded
  127558. * @param pluginExtension the extension used to determine the plugin
  127559. * @returns The loaded asset container
  127560. */
  127561. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  127562. /**
  127563. * Import animations from a file into a scene
  127564. * @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)
  127565. * @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)
  127566. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127567. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127568. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127569. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127570. * @param onSuccess a callback with the scene when import succeeds
  127571. * @param onProgress a callback with a progress event for each file being loaded
  127572. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127573. * @param pluginExtension the extension used to determine the plugin
  127574. */
  127575. 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;
  127576. /**
  127577. * Import animations from a file into a scene
  127578. * @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)
  127579. * @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)
  127580. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127581. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127582. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127583. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127584. * @param onSuccess a callback with the scene when import succeeds
  127585. * @param onProgress a callback with a progress event for each file being loaded
  127586. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127587. * @param pluginExtension the extension used to determine the plugin
  127588. * @returns the updated scene with imported animations
  127589. */
  127590. 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>;
  127591. }
  127592. }
  127593. declare module BABYLON {
  127594. /**
  127595. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  127596. */
  127597. export type MotionControllerHandedness = "none" | "left" | "right";
  127598. /**
  127599. * The type of components available in motion controllers.
  127600. * This is not the name of the component.
  127601. */
  127602. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  127603. /**
  127604. * The state of a controller component
  127605. */
  127606. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  127607. /**
  127608. * The schema of motion controller layout.
  127609. * No object will be initialized using this interface
  127610. * This is used just to define the profile.
  127611. */
  127612. export interface IMotionControllerLayout {
  127613. /**
  127614. * Path to load the assets. Usually relative to the base path
  127615. */
  127616. assetPath: string;
  127617. /**
  127618. * Available components (unsorted)
  127619. */
  127620. components: {
  127621. /**
  127622. * A map of component Ids
  127623. */
  127624. [componentId: string]: {
  127625. /**
  127626. * The type of input the component outputs
  127627. */
  127628. type: MotionControllerComponentType;
  127629. /**
  127630. * The indices of this component in the gamepad object
  127631. */
  127632. gamepadIndices: {
  127633. /**
  127634. * Index of button
  127635. */
  127636. button?: number;
  127637. /**
  127638. * If available, index of x-axis
  127639. */
  127640. xAxis?: number;
  127641. /**
  127642. * If available, index of y-axis
  127643. */
  127644. yAxis?: number;
  127645. };
  127646. /**
  127647. * The mesh's root node name
  127648. */
  127649. rootNodeName: string;
  127650. /**
  127651. * Animation definitions for this model
  127652. */
  127653. visualResponses: {
  127654. [stateKey: string]: {
  127655. /**
  127656. * What property will be animated
  127657. */
  127658. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  127659. /**
  127660. * What states influence this visual response
  127661. */
  127662. states: MotionControllerComponentStateType[];
  127663. /**
  127664. * Type of animation - movement or visibility
  127665. */
  127666. valueNodeProperty: "transform" | "visibility";
  127667. /**
  127668. * Base node name to move. Its position will be calculated according to the min and max nodes
  127669. */
  127670. valueNodeName?: string;
  127671. /**
  127672. * Minimum movement node
  127673. */
  127674. minNodeName?: string;
  127675. /**
  127676. * Max movement node
  127677. */
  127678. maxNodeName?: string;
  127679. };
  127680. };
  127681. /**
  127682. * If touch enabled, what is the name of node to display user feedback
  127683. */
  127684. touchPointNodeName?: string;
  127685. };
  127686. };
  127687. /**
  127688. * Is it xr standard mapping or not
  127689. */
  127690. gamepadMapping: "" | "xr-standard";
  127691. /**
  127692. * Base root node of this entire model
  127693. */
  127694. rootNodeName: string;
  127695. /**
  127696. * Defines the main button component id
  127697. */
  127698. selectComponentId: string;
  127699. }
  127700. /**
  127701. * A definition for the layout map in the input profile
  127702. */
  127703. export interface IMotionControllerLayoutMap {
  127704. /**
  127705. * Layouts with handedness type as a key
  127706. */
  127707. [handedness: string]: IMotionControllerLayout;
  127708. }
  127709. /**
  127710. * The XR Input profile schema
  127711. * Profiles can be found here:
  127712. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  127713. */
  127714. export interface IMotionControllerProfile {
  127715. /**
  127716. * fallback profiles for this profileId
  127717. */
  127718. fallbackProfileIds: string[];
  127719. /**
  127720. * The layout map, with handedness as key
  127721. */
  127722. layouts: IMotionControllerLayoutMap;
  127723. /**
  127724. * The id of this profile
  127725. * correlates to the profile(s) in the xrInput.profiles array
  127726. */
  127727. profileId: string;
  127728. }
  127729. /**
  127730. * A helper-interface for the 3 meshes needed for controller button animation
  127731. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  127732. */
  127733. export interface IMotionControllerButtonMeshMap {
  127734. /**
  127735. * the mesh that defines the pressed value mesh position.
  127736. * This is used to find the max-position of this button
  127737. */
  127738. pressedMesh: AbstractMesh;
  127739. /**
  127740. * the mesh that defines the unpressed value mesh position.
  127741. * This is used to find the min (or initial) position of this button
  127742. */
  127743. unpressedMesh: AbstractMesh;
  127744. /**
  127745. * The mesh that will be changed when value changes
  127746. */
  127747. valueMesh: AbstractMesh;
  127748. }
  127749. /**
  127750. * A helper-interface for the 3 meshes needed for controller axis animation.
  127751. * This will be expanded when touchpad animations are fully supported
  127752. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  127753. */
  127754. export interface IMotionControllerMeshMap {
  127755. /**
  127756. * the mesh that defines the maximum value mesh position.
  127757. */
  127758. maxMesh?: AbstractMesh;
  127759. /**
  127760. * the mesh that defines the minimum value mesh position.
  127761. */
  127762. minMesh?: AbstractMesh;
  127763. /**
  127764. * The mesh that will be changed when axis value changes
  127765. */
  127766. valueMesh?: AbstractMesh;
  127767. }
  127768. /**
  127769. * The elements needed for change-detection of the gamepad objects in motion controllers
  127770. */
  127771. export interface IMinimalMotionControllerObject {
  127772. /**
  127773. * Available axes of this controller
  127774. */
  127775. axes: number[];
  127776. /**
  127777. * An array of available buttons
  127778. */
  127779. buttons: Array<{
  127780. /**
  127781. * Value of the button/trigger
  127782. */
  127783. value: number;
  127784. /**
  127785. * If the button/trigger is currently touched
  127786. */
  127787. touched: boolean;
  127788. /**
  127789. * If the button/trigger is currently pressed
  127790. */
  127791. pressed: boolean;
  127792. }>;
  127793. /**
  127794. * EXPERIMENTAL haptic support.
  127795. */
  127796. hapticActuators?: Array<{
  127797. pulse: (value: number, duration: number) => Promise<boolean>;
  127798. }>;
  127799. }
  127800. /**
  127801. * An Abstract Motion controller
  127802. * This class receives an xrInput and a profile layout and uses those to initialize the components
  127803. * Each component has an observable to check for changes in value and state
  127804. */
  127805. export abstract class WebXRAbstractMotionController implements IDisposable {
  127806. protected scene: Scene;
  127807. protected layout: IMotionControllerLayout;
  127808. /**
  127809. * The gamepad object correlating to this controller
  127810. */
  127811. gamepadObject: IMinimalMotionControllerObject;
  127812. /**
  127813. * handedness (left/right/none) of this controller
  127814. */
  127815. handedness: MotionControllerHandedness;
  127816. private _initComponent;
  127817. private _modelReady;
  127818. /**
  127819. * A map of components (WebXRControllerComponent) in this motion controller
  127820. * Components have a ComponentType and can also have both button and axis definitions
  127821. */
  127822. readonly components: {
  127823. [id: string]: WebXRControllerComponent;
  127824. };
  127825. /**
  127826. * Disable the model's animation. Can be set at any time.
  127827. */
  127828. disableAnimation: boolean;
  127829. /**
  127830. * Observers registered here will be triggered when the model of this controller is done loading
  127831. */
  127832. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  127833. /**
  127834. * The profile id of this motion controller
  127835. */
  127836. abstract profileId: string;
  127837. /**
  127838. * The root mesh of the model. It is null if the model was not yet initialized
  127839. */
  127840. rootMesh: Nullable<AbstractMesh>;
  127841. /**
  127842. * constructs a new abstract motion controller
  127843. * @param scene the scene to which the model of the controller will be added
  127844. * @param layout The profile layout to load
  127845. * @param gamepadObject The gamepad object correlating to this controller
  127846. * @param handedness handedness (left/right/none) of this controller
  127847. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  127848. */
  127849. constructor(scene: Scene, layout: IMotionControllerLayout,
  127850. /**
  127851. * The gamepad object correlating to this controller
  127852. */
  127853. gamepadObject: IMinimalMotionControllerObject,
  127854. /**
  127855. * handedness (left/right/none) of this controller
  127856. */
  127857. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  127858. /**
  127859. * Dispose this controller, the model mesh and all its components
  127860. */
  127861. dispose(): void;
  127862. /**
  127863. * Returns all components of specific type
  127864. * @param type the type to search for
  127865. * @return an array of components with this type
  127866. */
  127867. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  127868. /**
  127869. * get a component based an its component id as defined in layout.components
  127870. * @param id the id of the component
  127871. * @returns the component correlates to the id or undefined if not found
  127872. */
  127873. getComponent(id: string): WebXRControllerComponent;
  127874. /**
  127875. * Get the list of components available in this motion controller
  127876. * @returns an array of strings correlating to available components
  127877. */
  127878. getComponentIds(): string[];
  127879. /**
  127880. * Get the first component of specific type
  127881. * @param type type of component to find
  127882. * @return a controller component or null if not found
  127883. */
  127884. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  127885. /**
  127886. * Get the main (Select) component of this controller as defined in the layout
  127887. * @returns the main component of this controller
  127888. */
  127889. getMainComponent(): WebXRControllerComponent;
  127890. /**
  127891. * Loads the model correlating to this controller
  127892. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  127893. * @returns A promise fulfilled with the result of the model loading
  127894. */
  127895. loadModel(): Promise<boolean>;
  127896. /**
  127897. * Update this model using the current XRFrame
  127898. * @param xrFrame the current xr frame to use and update the model
  127899. */
  127900. updateFromXRFrame(xrFrame: XRFrame): void;
  127901. /**
  127902. * Backwards compatibility due to a deeply-integrated typo
  127903. */
  127904. get handness(): XREye;
  127905. /**
  127906. * Pulse (vibrate) this controller
  127907. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  127908. * Consecutive calls to this function will cancel the last pulse call
  127909. *
  127910. * @param value the strength of the pulse in 0.0...1.0 range
  127911. * @param duration Duration of the pulse in milliseconds
  127912. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  127913. * @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
  127914. */
  127915. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  127916. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  127917. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  127918. /**
  127919. * Moves the axis on the controller mesh based on its current state
  127920. * @param axis the index of the axis
  127921. * @param axisValue the value of the axis which determines the meshes new position
  127922. * @hidden
  127923. */
  127924. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  127925. /**
  127926. * Update the model itself with the current frame data
  127927. * @param xrFrame the frame to use for updating the model mesh
  127928. */
  127929. protected updateModel(xrFrame: XRFrame): void;
  127930. /**
  127931. * Get the filename and path for this controller's model
  127932. * @returns a map of filename and path
  127933. */
  127934. protected abstract _getFilenameAndPath(): {
  127935. filename: string;
  127936. path: string;
  127937. };
  127938. /**
  127939. * This function is called before the mesh is loaded. It checks for loading constraints.
  127940. * For example, this function can check if the GLB loader is available
  127941. * If this function returns false, the generic controller will be loaded instead
  127942. * @returns Is the client ready to load the mesh
  127943. */
  127944. protected abstract _getModelLoadingConstraints(): boolean;
  127945. /**
  127946. * This function will be called after the model was successfully loaded and can be used
  127947. * for mesh transformations before it is available for the user
  127948. * @param meshes the loaded meshes
  127949. */
  127950. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  127951. /**
  127952. * Set the root mesh for this controller. Important for the WebXR controller class
  127953. * @param meshes the loaded meshes
  127954. */
  127955. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  127956. /**
  127957. * A function executed each frame that updates the mesh (if needed)
  127958. * @param xrFrame the current xrFrame
  127959. */
  127960. protected abstract _updateModel(xrFrame: XRFrame): void;
  127961. private _getGenericFilenameAndPath;
  127962. private _getGenericParentMesh;
  127963. }
  127964. }
  127965. declare module BABYLON {
  127966. /**
  127967. * A generic trigger-only motion controller for WebXR
  127968. */
  127969. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  127970. /**
  127971. * Static version of the profile id of this controller
  127972. */
  127973. static ProfileId: string;
  127974. profileId: string;
  127975. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  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(): void;
  127984. }
  127985. }
  127986. declare module BABYLON {
  127987. /**
  127988. * Class containing static functions to help procedurally build meshes
  127989. */
  127990. export class SphereBuilder {
  127991. /**
  127992. * Creates a sphere mesh
  127993. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  127994. * * 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`)
  127995. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  127996. * * 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
  127997. * * 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)
  127998. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127999. * * 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
  128000. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128001. * @param name defines the name of the mesh
  128002. * @param options defines the options used to create the mesh
  128003. * @param scene defines the hosting scene
  128004. * @returns the sphere mesh
  128005. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  128006. */
  128007. static CreateSphere(name: string, options: {
  128008. segments?: number;
  128009. diameter?: number;
  128010. diameterX?: number;
  128011. diameterY?: number;
  128012. diameterZ?: number;
  128013. arc?: number;
  128014. slice?: number;
  128015. sideOrientation?: number;
  128016. frontUVs?: Vector4;
  128017. backUVs?: Vector4;
  128018. updatable?: boolean;
  128019. }, scene?: Nullable<Scene>): Mesh;
  128020. }
  128021. }
  128022. declare module BABYLON {
  128023. /**
  128024. * A profiled motion controller has its profile loaded from an online repository.
  128025. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  128026. */
  128027. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  128028. private _repositoryUrl;
  128029. private _buttonMeshMapping;
  128030. private _touchDots;
  128031. /**
  128032. * The profile ID of this controller. Will be populated when the controller initializes.
  128033. */
  128034. profileId: string;
  128035. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  128036. dispose(): void;
  128037. protected _getFilenameAndPath(): {
  128038. filename: string;
  128039. path: string;
  128040. };
  128041. protected _getModelLoadingConstraints(): boolean;
  128042. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  128043. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128044. protected _updateModel(_xrFrame: XRFrame): void;
  128045. }
  128046. }
  128047. declare module BABYLON {
  128048. /**
  128049. * A construction function type to create a new controller based on an xrInput object
  128050. */
  128051. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  128052. /**
  128053. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  128054. *
  128055. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  128056. * it should be replaced with auto-loaded controllers.
  128057. *
  128058. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  128059. */
  128060. export class WebXRMotionControllerManager {
  128061. private static _AvailableControllers;
  128062. private static _Fallbacks;
  128063. private static _ProfileLoadingPromises;
  128064. private static _ProfilesList;
  128065. /**
  128066. * The base URL of the online controller repository. Can be changed at any time.
  128067. */
  128068. static BaseRepositoryUrl: string;
  128069. /**
  128070. * Which repository gets priority - local or online
  128071. */
  128072. static PrioritizeOnlineRepository: boolean;
  128073. /**
  128074. * Use the online repository, or use only locally-defined controllers
  128075. */
  128076. static UseOnlineRepository: boolean;
  128077. /**
  128078. * Clear the cache used for profile loading and reload when requested again
  128079. */
  128080. static ClearProfilesCache(): void;
  128081. /**
  128082. * Register the default fallbacks.
  128083. * This function is called automatically when this file is imported.
  128084. */
  128085. static DefaultFallbacks(): void;
  128086. /**
  128087. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  128088. * @param profileId the profile to which a fallback needs to be found
  128089. * @return an array with corresponding fallback profiles
  128090. */
  128091. static FindFallbackWithProfileId(profileId: string): string[];
  128092. /**
  128093. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  128094. * The order of search:
  128095. *
  128096. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  128097. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  128098. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  128099. * 4) return the generic trigger controller if none were found
  128100. *
  128101. * @param xrInput the xrInput to which a new controller is initialized
  128102. * @param scene the scene to which the model will be added
  128103. * @param forceProfile force a certain profile for this controller
  128104. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  128105. */
  128106. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  128107. /**
  128108. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  128109. *
  128110. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  128111. *
  128112. * @param type the profile type to register
  128113. * @param constructFunction the function to be called when loading this profile
  128114. */
  128115. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  128116. /**
  128117. * Register a fallback to a specific profile.
  128118. * @param profileId the profileId that will receive the fallbacks
  128119. * @param fallbacks A list of fallback profiles
  128120. */
  128121. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  128122. /**
  128123. * Will update the list of profiles available in the repository
  128124. * @return a promise that resolves to a map of profiles available online
  128125. */
  128126. static UpdateProfilesList(): Promise<{
  128127. [profile: string]: string;
  128128. }>;
  128129. private static _LoadProfileFromRepository;
  128130. private static _LoadProfilesFromAvailableControllers;
  128131. }
  128132. }
  128133. declare module BABYLON {
  128134. /**
  128135. * Configuration options for the WebXR controller creation
  128136. */
  128137. export interface IWebXRControllerOptions {
  128138. /**
  128139. * Should the controller mesh be animated when a user interacts with it
  128140. * The pressed buttons / thumbstick and touchpad animations will be disabled
  128141. */
  128142. disableMotionControllerAnimation?: boolean;
  128143. /**
  128144. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  128145. */
  128146. doNotLoadControllerMesh?: boolean;
  128147. /**
  128148. * Force a specific controller type for this controller.
  128149. * This can be used when creating your own profile or when testing different controllers
  128150. */
  128151. forceControllerProfile?: string;
  128152. /**
  128153. * Defines a rendering group ID for meshes that will be loaded.
  128154. * This is for the default controllers only.
  128155. */
  128156. renderingGroupId?: number;
  128157. }
  128158. /**
  128159. * Represents an XR controller
  128160. */
  128161. export class WebXRInputSource {
  128162. private _scene;
  128163. /** The underlying input source for the controller */
  128164. inputSource: XRInputSource;
  128165. private _options;
  128166. private _tmpVector;
  128167. private _uniqueId;
  128168. private _disposed;
  128169. /**
  128170. * 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
  128171. */
  128172. grip?: AbstractMesh;
  128173. /**
  128174. * If available, this is the gamepad object related to this controller.
  128175. * Using this object it is possible to get click events and trackpad changes of the
  128176. * webxr controller that is currently being used.
  128177. */
  128178. motionController?: WebXRAbstractMotionController;
  128179. /**
  128180. * Event that fires when the controller is removed/disposed.
  128181. * The object provided as event data is this controller, after associated assets were disposed.
  128182. * uniqueId is still available.
  128183. */
  128184. onDisposeObservable: Observable<WebXRInputSource>;
  128185. /**
  128186. * Will be triggered when the mesh associated with the motion controller is done loading.
  128187. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  128188. * A shortened version of controller -> motion controller -> on mesh loaded.
  128189. */
  128190. onMeshLoadedObservable: Observable<AbstractMesh>;
  128191. /**
  128192. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  128193. */
  128194. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  128195. /**
  128196. * Pointer which can be used to select objects or attach a visible laser to
  128197. */
  128198. pointer: AbstractMesh;
  128199. /**
  128200. * Creates the input source object
  128201. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  128202. * @param _scene the scene which the controller should be associated to
  128203. * @param inputSource the underlying input source for the controller
  128204. * @param _options options for this controller creation
  128205. */
  128206. constructor(_scene: Scene,
  128207. /** The underlying input source for the controller */
  128208. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  128209. /**
  128210. * Get this controllers unique id
  128211. */
  128212. get uniqueId(): string;
  128213. /**
  128214. * Disposes of the object
  128215. */
  128216. dispose(): void;
  128217. /**
  128218. * Gets a world space ray coming from the pointer or grip
  128219. * @param result the resulting ray
  128220. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  128221. */
  128222. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  128223. /**
  128224. * Updates the controller pose based on the given XRFrame
  128225. * @param xrFrame xr frame to update the pose with
  128226. * @param referenceSpace reference space to use
  128227. */
  128228. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  128229. }
  128230. }
  128231. declare module BABYLON {
  128232. /**
  128233. * The schema for initialization options of the XR Input class
  128234. */
  128235. export interface IWebXRInputOptions {
  128236. /**
  128237. * If set to true no model will be automatically loaded
  128238. */
  128239. doNotLoadControllerMeshes?: boolean;
  128240. /**
  128241. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  128242. * If not found, the xr input profile data will be used.
  128243. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  128244. */
  128245. forceInputProfile?: string;
  128246. /**
  128247. * Do not send a request to the controller repository to load the profile.
  128248. *
  128249. * Instead, use the controllers available in babylon itself.
  128250. */
  128251. disableOnlineControllerRepository?: boolean;
  128252. /**
  128253. * A custom URL for the controllers repository
  128254. */
  128255. customControllersRepositoryURL?: string;
  128256. /**
  128257. * Should the controller model's components not move according to the user input
  128258. */
  128259. disableControllerAnimation?: boolean;
  128260. /**
  128261. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  128262. */
  128263. controllerOptions?: IWebXRControllerOptions;
  128264. }
  128265. /**
  128266. * XR input used to track XR inputs such as controllers/rays
  128267. */
  128268. export class WebXRInput implements IDisposable {
  128269. /**
  128270. * the xr session manager for this session
  128271. */
  128272. xrSessionManager: WebXRSessionManager;
  128273. /**
  128274. * the WebXR camera for this session. Mainly used for teleportation
  128275. */
  128276. xrCamera: WebXRCamera;
  128277. private readonly options;
  128278. /**
  128279. * XR controllers being tracked
  128280. */
  128281. controllers: Array<WebXRInputSource>;
  128282. private _frameObserver;
  128283. private _sessionEndedObserver;
  128284. private _sessionInitObserver;
  128285. /**
  128286. * Event when a controller has been connected/added
  128287. */
  128288. onControllerAddedObservable: Observable<WebXRInputSource>;
  128289. /**
  128290. * Event when a controller has been removed/disconnected
  128291. */
  128292. onControllerRemovedObservable: Observable<WebXRInputSource>;
  128293. /**
  128294. * Initializes the WebXRInput
  128295. * @param xrSessionManager the xr session manager for this session
  128296. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  128297. * @param options = initialization options for this xr input
  128298. */
  128299. constructor(
  128300. /**
  128301. * the xr session manager for this session
  128302. */
  128303. xrSessionManager: WebXRSessionManager,
  128304. /**
  128305. * the WebXR camera for this session. Mainly used for teleportation
  128306. */
  128307. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  128308. private _onInputSourcesChange;
  128309. private _addAndRemoveControllers;
  128310. /**
  128311. * Disposes of the object
  128312. */
  128313. dispose(): void;
  128314. }
  128315. }
  128316. declare module BABYLON {
  128317. /**
  128318. * This is the base class for all WebXR features.
  128319. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  128320. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  128321. */
  128322. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  128323. protected _xrSessionManager: WebXRSessionManager;
  128324. private _attached;
  128325. private _removeOnDetach;
  128326. /**
  128327. * Should auto-attach be disabled?
  128328. */
  128329. disableAutoAttach: boolean;
  128330. /**
  128331. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  128332. */
  128333. xrNativeFeatureName: string;
  128334. /**
  128335. * Construct a new (abstract) WebXR feature
  128336. * @param _xrSessionManager the xr session manager for this feature
  128337. */
  128338. constructor(_xrSessionManager: WebXRSessionManager);
  128339. /**
  128340. * Is this feature attached
  128341. */
  128342. get attached(): boolean;
  128343. /**
  128344. * attach this feature
  128345. *
  128346. * @param force should attachment be forced (even when already attached)
  128347. * @returns true if successful, false is failed or already attached
  128348. */
  128349. attach(force?: boolean): boolean;
  128350. /**
  128351. * detach this feature.
  128352. *
  128353. * @returns true if successful, false if failed or already detached
  128354. */
  128355. detach(): boolean;
  128356. /**
  128357. * Dispose this feature and all of the resources attached
  128358. */
  128359. dispose(): void;
  128360. /**
  128361. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  128362. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  128363. *
  128364. * @returns whether or not the feature is compatible in this environment
  128365. */
  128366. isCompatible(): boolean;
  128367. /**
  128368. * This is used to register callbacks that will automatically be removed when detach is called.
  128369. * @param observable the observable to which the observer will be attached
  128370. * @param callback the callback to register
  128371. */
  128372. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  128373. /**
  128374. * Code in this function will be executed on each xrFrame received from the browser.
  128375. * This function will not execute after the feature is detached.
  128376. * @param _xrFrame the current frame
  128377. */
  128378. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  128379. }
  128380. }
  128381. declare module BABYLON {
  128382. /**
  128383. * Renders a layer on top of an existing scene
  128384. */
  128385. export class UtilityLayerRenderer implements IDisposable {
  128386. /** the original scene that will be rendered on top of */
  128387. originalScene: Scene;
  128388. private _pointerCaptures;
  128389. private _lastPointerEvents;
  128390. private static _DefaultUtilityLayer;
  128391. private static _DefaultKeepDepthUtilityLayer;
  128392. private _sharedGizmoLight;
  128393. private _renderCamera;
  128394. /**
  128395. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  128396. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  128397. * @returns the camera that is used when rendering the utility layer
  128398. */
  128399. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  128400. /**
  128401. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  128402. * @param cam the camera that should be used when rendering the utility layer
  128403. */
  128404. setRenderCamera(cam: Nullable<Camera>): void;
  128405. /**
  128406. * @hidden
  128407. * Light which used by gizmos to get light shading
  128408. */
  128409. _getSharedGizmoLight(): HemisphericLight;
  128410. /**
  128411. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  128412. */
  128413. pickUtilitySceneFirst: boolean;
  128414. /**
  128415. * 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)
  128416. */
  128417. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  128418. /**
  128419. * 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)
  128420. */
  128421. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  128422. /**
  128423. * The scene that is rendered on top of the original scene
  128424. */
  128425. utilityLayerScene: Scene;
  128426. /**
  128427. * If the utility layer should automatically be rendered on top of existing scene
  128428. */
  128429. shouldRender: boolean;
  128430. /**
  128431. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  128432. */
  128433. onlyCheckPointerDownEvents: boolean;
  128434. /**
  128435. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  128436. */
  128437. processAllEvents: boolean;
  128438. /**
  128439. * Observable raised when the pointer move from the utility layer scene to the main scene
  128440. */
  128441. onPointerOutObservable: Observable<number>;
  128442. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  128443. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  128444. private _afterRenderObserver;
  128445. private _sceneDisposeObserver;
  128446. private _originalPointerObserver;
  128447. /**
  128448. * Instantiates a UtilityLayerRenderer
  128449. * @param originalScene the original scene that will be rendered on top of
  128450. * @param handleEvents boolean indicating if the utility layer should handle events
  128451. */
  128452. constructor(
  128453. /** the original scene that will be rendered on top of */
  128454. originalScene: Scene, handleEvents?: boolean);
  128455. private _notifyObservers;
  128456. /**
  128457. * Renders the utility layers scene on top of the original scene
  128458. */
  128459. render(): void;
  128460. /**
  128461. * Disposes of the renderer
  128462. */
  128463. dispose(): void;
  128464. private _updateCamera;
  128465. }
  128466. }
  128467. declare module BABYLON {
  128468. /**
  128469. * Options interface for the pointer selection module
  128470. */
  128471. export interface IWebXRControllerPointerSelectionOptions {
  128472. /**
  128473. * if provided, this scene will be used to render meshes.
  128474. */
  128475. customUtilityLayerScene?: Scene;
  128476. /**
  128477. * 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)
  128478. * If not disabled, the last picked point will be used to execute a pointer up event
  128479. * If disabled, pointer up event will be triggered right after the pointer down event.
  128480. * Used in screen and gaze target ray mode only
  128481. */
  128482. disablePointerUpOnTouchOut: boolean;
  128483. /**
  128484. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  128485. */
  128486. forceGazeMode: boolean;
  128487. /**
  128488. * 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
  128489. * to start a new countdown to the pointer down event.
  128490. * Defaults to 1.
  128491. */
  128492. gazeModePointerMovedFactor?: number;
  128493. /**
  128494. * Different button type to use instead of the main component
  128495. */
  128496. overrideButtonId?: string;
  128497. /**
  128498. * use this rendering group id for the meshes (optional)
  128499. */
  128500. renderingGroupId?: number;
  128501. /**
  128502. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  128503. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  128504. * 3000 means 3 seconds between pointing at something and selecting it
  128505. */
  128506. timeToSelect?: number;
  128507. /**
  128508. * Should meshes created here be added to a utility layer or the main scene
  128509. */
  128510. useUtilityLayer?: boolean;
  128511. /**
  128512. * Optional WebXR camera to be used for gaze selection
  128513. */
  128514. gazeCamera?: WebXRCamera;
  128515. /**
  128516. * the xr input to use with this pointer selection
  128517. */
  128518. xrInput: WebXRInput;
  128519. }
  128520. /**
  128521. * A module that will enable pointer selection for motion controllers of XR Input Sources
  128522. */
  128523. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  128524. private readonly _options;
  128525. private static _idCounter;
  128526. private _attachController;
  128527. private _controllers;
  128528. private _scene;
  128529. private _tmpVectorForPickCompare;
  128530. /**
  128531. * The module's name
  128532. */
  128533. static readonly Name: string;
  128534. /**
  128535. * The (Babylon) version of this module.
  128536. * This is an integer representing the implementation version.
  128537. * This number does not correspond to the WebXR specs version
  128538. */
  128539. static readonly Version: number;
  128540. /**
  128541. * Disable lighting on the laser pointer (so it will always be visible)
  128542. */
  128543. disablePointerLighting: boolean;
  128544. /**
  128545. * Disable lighting on the selection mesh (so it will always be visible)
  128546. */
  128547. disableSelectionMeshLighting: boolean;
  128548. /**
  128549. * Should the laser pointer be displayed
  128550. */
  128551. displayLaserPointer: boolean;
  128552. /**
  128553. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  128554. */
  128555. displaySelectionMesh: boolean;
  128556. /**
  128557. * This color will be set to the laser pointer when selection is triggered
  128558. */
  128559. laserPointerPickedColor: Color3;
  128560. /**
  128561. * Default color of the laser pointer
  128562. */
  128563. laserPointerDefaultColor: Color3;
  128564. /**
  128565. * default color of the selection ring
  128566. */
  128567. selectionMeshDefaultColor: Color3;
  128568. /**
  128569. * This color will be applied to the selection ring when selection is triggered
  128570. */
  128571. selectionMeshPickedColor: Color3;
  128572. /**
  128573. * Optional filter to be used for ray selection. This predicate shares behavior with
  128574. * scene.pointerMovePredicate which takes priority if it is also assigned.
  128575. */
  128576. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  128577. /**
  128578. * constructs a new background remover module
  128579. * @param _xrSessionManager the session manager for this module
  128580. * @param _options read-only options to be used in this module
  128581. */
  128582. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  128583. /**
  128584. * attach this feature
  128585. * Will usually be called by the features manager
  128586. *
  128587. * @returns true if successful.
  128588. */
  128589. attach(): boolean;
  128590. /**
  128591. * detach this feature.
  128592. * Will usually be called by the features manager
  128593. *
  128594. * @returns true if successful.
  128595. */
  128596. detach(): boolean;
  128597. /**
  128598. * Will get the mesh under a specific pointer.
  128599. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  128600. * @param controllerId the controllerId to check
  128601. * @returns The mesh under pointer or null if no mesh is under the pointer
  128602. */
  128603. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  128604. /**
  128605. * Get the xr controller that correlates to the pointer id in the pointer event
  128606. *
  128607. * @param id the pointer id to search for
  128608. * @returns the controller that correlates to this id or null if not found
  128609. */
  128610. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  128611. protected _onXRFrame(_xrFrame: XRFrame): void;
  128612. private _attachGazeMode;
  128613. private _attachScreenRayMode;
  128614. private _attachTrackedPointerRayMode;
  128615. private _convertNormalToDirectionOfRay;
  128616. private _detachController;
  128617. private _generateNewMeshPair;
  128618. private _pickingMoved;
  128619. private _updatePointerDistance;
  128620. /** @hidden */
  128621. get lasterPointerDefaultColor(): Color3;
  128622. }
  128623. }
  128624. declare module BABYLON {
  128625. /**
  128626. * Button which can be used to enter a different mode of XR
  128627. */
  128628. export class WebXREnterExitUIButton {
  128629. /** button element */
  128630. element: HTMLElement;
  128631. /** XR initialization options for the button */
  128632. sessionMode: XRSessionMode;
  128633. /** Reference space type */
  128634. referenceSpaceType: XRReferenceSpaceType;
  128635. /**
  128636. * Creates a WebXREnterExitUIButton
  128637. * @param element button element
  128638. * @param sessionMode XR initialization session mode
  128639. * @param referenceSpaceType the type of reference space to be used
  128640. */
  128641. constructor(
  128642. /** button element */
  128643. element: HTMLElement,
  128644. /** XR initialization options for the button */
  128645. sessionMode: XRSessionMode,
  128646. /** Reference space type */
  128647. referenceSpaceType: XRReferenceSpaceType);
  128648. /**
  128649. * Extendable function which can be used to update the button's visuals when the state changes
  128650. * @param activeButton the current active button in the UI
  128651. */
  128652. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  128653. }
  128654. /**
  128655. * Options to create the webXR UI
  128656. */
  128657. export class WebXREnterExitUIOptions {
  128658. /**
  128659. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  128660. */
  128661. customButtons?: Array<WebXREnterExitUIButton>;
  128662. /**
  128663. * A reference space type to use when creating the default button.
  128664. * Default is local-floor
  128665. */
  128666. referenceSpaceType?: XRReferenceSpaceType;
  128667. /**
  128668. * Context to enter xr with
  128669. */
  128670. renderTarget?: Nullable<WebXRRenderTarget>;
  128671. /**
  128672. * A session mode to use when creating the default button.
  128673. * Default is immersive-vr
  128674. */
  128675. sessionMode?: XRSessionMode;
  128676. /**
  128677. * A list of optional features to init the session with
  128678. */
  128679. optionalFeatures?: string[];
  128680. /**
  128681. * A list of optional features to init the session with
  128682. */
  128683. requiredFeatures?: string[];
  128684. }
  128685. /**
  128686. * UI to allow the user to enter/exit XR mode
  128687. */
  128688. export class WebXREnterExitUI implements IDisposable {
  128689. private scene;
  128690. /** version of the options passed to this UI */
  128691. options: WebXREnterExitUIOptions;
  128692. private _activeButton;
  128693. private _buttons;
  128694. /**
  128695. * The HTML Div Element to which buttons are added.
  128696. */
  128697. readonly overlay: HTMLDivElement;
  128698. /**
  128699. * Fired every time the active button is changed.
  128700. *
  128701. * When xr is entered via a button that launches xr that button will be the callback parameter
  128702. *
  128703. * When exiting xr the callback parameter will be null)
  128704. */
  128705. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  128706. /**
  128707. *
  128708. * @param scene babylon scene object to use
  128709. * @param options (read-only) version of the options passed to this UI
  128710. */
  128711. private constructor();
  128712. /**
  128713. * Creates UI to allow the user to enter/exit XR mode
  128714. * @param scene the scene to add the ui to
  128715. * @param helper the xr experience helper to enter/exit xr with
  128716. * @param options options to configure the UI
  128717. * @returns the created ui
  128718. */
  128719. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  128720. /**
  128721. * Disposes of the XR UI component
  128722. */
  128723. dispose(): void;
  128724. private _updateButtons;
  128725. }
  128726. }
  128727. declare module BABYLON {
  128728. /**
  128729. * Class containing static functions to help procedurally build meshes
  128730. */
  128731. export class LinesBuilder {
  128732. /**
  128733. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  128734. * * 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
  128735. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  128736. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  128737. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  128738. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  128739. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128740. * * 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
  128741. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  128742. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128743. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  128744. * @param name defines the name of the new line system
  128745. * @param options defines the options used to create the line system
  128746. * @param scene defines the hosting scene
  128747. * @returns a new line system mesh
  128748. */
  128749. static CreateLineSystem(name: string, options: {
  128750. lines: Vector3[][];
  128751. updatable?: boolean;
  128752. instance?: Nullable<LinesMesh>;
  128753. colors?: Nullable<Color4[][]>;
  128754. useVertexAlpha?: boolean;
  128755. }, scene: Nullable<Scene>): LinesMesh;
  128756. /**
  128757. * Creates a line mesh
  128758. * 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
  128759. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128760. * * The parameter `points` is an array successive Vector3
  128761. * * 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
  128762. * * The optional parameter `colors` is an array of successive Color4, one per line point
  128763. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  128764. * * When updating an instance, remember that only point positions can change, not the number of points
  128765. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128766. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  128767. * @param name defines the name of the new line system
  128768. * @param options defines the options used to create the line system
  128769. * @param scene defines the hosting scene
  128770. * @returns a new line mesh
  128771. */
  128772. static CreateLines(name: string, options: {
  128773. points: Vector3[];
  128774. updatable?: boolean;
  128775. instance?: Nullable<LinesMesh>;
  128776. colors?: Color4[];
  128777. useVertexAlpha?: boolean;
  128778. }, scene?: Nullable<Scene>): LinesMesh;
  128779. /**
  128780. * Creates a dashed line mesh
  128781. * * 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
  128782. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128783. * * The parameter `points` is an array successive Vector3
  128784. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  128785. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  128786. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  128787. * * 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
  128788. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128789. * * When updating an instance, remember that only point positions can change, not the number of points
  128790. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128791. * @param name defines the name of the mesh
  128792. * @param options defines the options used to create the mesh
  128793. * @param scene defines the hosting scene
  128794. * @returns the dashed line mesh
  128795. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  128796. */
  128797. static CreateDashedLines(name: string, options: {
  128798. points: Vector3[];
  128799. dashSize?: number;
  128800. gapSize?: number;
  128801. dashNb?: number;
  128802. updatable?: boolean;
  128803. instance?: LinesMesh;
  128804. useVertexAlpha?: boolean;
  128805. }, scene?: Nullable<Scene>): LinesMesh;
  128806. }
  128807. }
  128808. declare module BABYLON {
  128809. /**
  128810. * Construction options for a timer
  128811. */
  128812. export interface ITimerOptions<T> {
  128813. /**
  128814. * Time-to-end
  128815. */
  128816. timeout: number;
  128817. /**
  128818. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  128819. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  128820. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  128821. */
  128822. contextObservable: Observable<T>;
  128823. /**
  128824. * Optional parameters when adding an observer to the observable
  128825. */
  128826. observableParameters?: {
  128827. mask?: number;
  128828. insertFirst?: boolean;
  128829. scope?: any;
  128830. };
  128831. /**
  128832. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  128833. */
  128834. breakCondition?: (data?: ITimerData<T>) => boolean;
  128835. /**
  128836. * Will be triggered when the time condition has met
  128837. */
  128838. onEnded?: (data: ITimerData<any>) => void;
  128839. /**
  128840. * Will be triggered when the break condition has met (prematurely ended)
  128841. */
  128842. onAborted?: (data: ITimerData<any>) => void;
  128843. /**
  128844. * Optional function to execute on each tick (or count)
  128845. */
  128846. onTick?: (data: ITimerData<any>) => void;
  128847. }
  128848. /**
  128849. * An interface defining the data sent by the timer
  128850. */
  128851. export interface ITimerData<T> {
  128852. /**
  128853. * When did it start
  128854. */
  128855. startTime: number;
  128856. /**
  128857. * Time now
  128858. */
  128859. currentTime: number;
  128860. /**
  128861. * Time passed since started
  128862. */
  128863. deltaTime: number;
  128864. /**
  128865. * How much is completed, in [0.0...1.0].
  128866. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  128867. */
  128868. completeRate: number;
  128869. /**
  128870. * What the registered observable sent in the last count
  128871. */
  128872. payload: T;
  128873. }
  128874. /**
  128875. * The current state of the timer
  128876. */
  128877. export enum TimerState {
  128878. /**
  128879. * Timer initialized, not yet started
  128880. */
  128881. INIT = 0,
  128882. /**
  128883. * Timer started and counting
  128884. */
  128885. STARTED = 1,
  128886. /**
  128887. * Timer ended (whether aborted or time reached)
  128888. */
  128889. ENDED = 2
  128890. }
  128891. /**
  128892. * A simple version of the timer. Will take options and start the timer immediately after calling it
  128893. *
  128894. * @param options options with which to initialize this timer
  128895. */
  128896. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  128897. /**
  128898. * An advanced implementation of a timer class
  128899. */
  128900. export class AdvancedTimer<T = any> implements IDisposable {
  128901. /**
  128902. * Will notify each time the timer calculates the remaining time
  128903. */
  128904. onEachCountObservable: Observable<ITimerData<T>>;
  128905. /**
  128906. * Will trigger when the timer was aborted due to the break condition
  128907. */
  128908. onTimerAbortedObservable: Observable<ITimerData<T>>;
  128909. /**
  128910. * Will trigger when the timer ended successfully
  128911. */
  128912. onTimerEndedObservable: Observable<ITimerData<T>>;
  128913. /**
  128914. * Will trigger when the timer state has changed
  128915. */
  128916. onStateChangedObservable: Observable<TimerState>;
  128917. private _observer;
  128918. private _contextObservable;
  128919. private _observableParameters;
  128920. private _startTime;
  128921. private _timer;
  128922. private _state;
  128923. private _breakCondition;
  128924. private _timeToEnd;
  128925. private _breakOnNextTick;
  128926. /**
  128927. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  128928. * @param options construction options for this advanced timer
  128929. */
  128930. constructor(options: ITimerOptions<T>);
  128931. /**
  128932. * set a breaking condition for this timer. Default is to never break during count
  128933. * @param predicate the new break condition. Returns true to break, false otherwise
  128934. */
  128935. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  128936. /**
  128937. * Reset ALL associated observables in this advanced timer
  128938. */
  128939. clearObservables(): void;
  128940. /**
  128941. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  128942. *
  128943. * @param timeToEnd how much time to measure until timer ended
  128944. */
  128945. start(timeToEnd?: number): void;
  128946. /**
  128947. * Will force a stop on the next tick.
  128948. */
  128949. stop(): void;
  128950. /**
  128951. * Dispose this timer, clearing all resources
  128952. */
  128953. dispose(): void;
  128954. private _setState;
  128955. private _tick;
  128956. private _stop;
  128957. }
  128958. }
  128959. declare module BABYLON {
  128960. /**
  128961. * The options container for the teleportation module
  128962. */
  128963. export interface IWebXRTeleportationOptions {
  128964. /**
  128965. * if provided, this scene will be used to render meshes.
  128966. */
  128967. customUtilityLayerScene?: Scene;
  128968. /**
  128969. * Values to configure the default target mesh
  128970. */
  128971. defaultTargetMeshOptions?: {
  128972. /**
  128973. * Fill color of the teleportation area
  128974. */
  128975. teleportationFillColor?: string;
  128976. /**
  128977. * Border color for the teleportation area
  128978. */
  128979. teleportationBorderColor?: string;
  128980. /**
  128981. * Disable the mesh's animation sequence
  128982. */
  128983. disableAnimation?: boolean;
  128984. /**
  128985. * Disable lighting on the material or the ring and arrow
  128986. */
  128987. disableLighting?: boolean;
  128988. /**
  128989. * Override the default material of the torus and arrow
  128990. */
  128991. torusArrowMaterial?: Material;
  128992. };
  128993. /**
  128994. * A list of meshes to use as floor meshes.
  128995. * Meshes can be added and removed after initializing the feature using the
  128996. * addFloorMesh and removeFloorMesh functions
  128997. * If empty, rotation will still work
  128998. */
  128999. floorMeshes?: AbstractMesh[];
  129000. /**
  129001. * use this rendering group id for the meshes (optional)
  129002. */
  129003. renderingGroupId?: number;
  129004. /**
  129005. * Should teleportation move only to snap points
  129006. */
  129007. snapPointsOnly?: boolean;
  129008. /**
  129009. * An array of points to which the teleportation will snap to.
  129010. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  129011. */
  129012. snapPositions?: Vector3[];
  129013. /**
  129014. * How close should the teleportation ray be in order to snap to position.
  129015. * Default to 0.8 units (meters)
  129016. */
  129017. snapToPositionRadius?: number;
  129018. /**
  129019. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  129020. * If you want to support rotation, make sure your mesh has a direction indicator.
  129021. *
  129022. * When left untouched, the default mesh will be initialized.
  129023. */
  129024. teleportationTargetMesh?: AbstractMesh;
  129025. /**
  129026. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  129027. */
  129028. timeToTeleport?: number;
  129029. /**
  129030. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  129031. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  129032. */
  129033. useMainComponentOnly?: boolean;
  129034. /**
  129035. * Should meshes created here be added to a utility layer or the main scene
  129036. */
  129037. useUtilityLayer?: boolean;
  129038. /**
  129039. * Babylon XR Input class for controller
  129040. */
  129041. xrInput: WebXRInput;
  129042. }
  129043. /**
  129044. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  129045. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  129046. * the input of the attached controllers.
  129047. */
  129048. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  129049. private _options;
  129050. private _controllers;
  129051. private _currentTeleportationControllerId;
  129052. private _floorMeshes;
  129053. private _quadraticBezierCurve;
  129054. private _selectionFeature;
  129055. private _snapToPositions;
  129056. private _snappedToPoint;
  129057. private _teleportationRingMaterial?;
  129058. private _tmpRay;
  129059. private _tmpVector;
  129060. /**
  129061. * The module's name
  129062. */
  129063. static readonly Name: string;
  129064. /**
  129065. * The (Babylon) version of this module.
  129066. * This is an integer representing the implementation version.
  129067. * This number does not correspond to the webxr specs version
  129068. */
  129069. static readonly Version: number;
  129070. /**
  129071. * Is movement backwards enabled
  129072. */
  129073. backwardsMovementEnabled: boolean;
  129074. /**
  129075. * Distance to travel when moving backwards
  129076. */
  129077. backwardsTeleportationDistance: number;
  129078. /**
  129079. * The distance from the user to the inspection point in the direction of the controller
  129080. * A higher number will allow the user to move further
  129081. * defaults to 5 (meters, in xr units)
  129082. */
  129083. parabolicCheckRadius: number;
  129084. /**
  129085. * Should the module support parabolic ray on top of direct ray
  129086. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  129087. * Very helpful when moving between floors / different heights
  129088. */
  129089. parabolicRayEnabled: boolean;
  129090. /**
  129091. * How much rotation should be applied when rotating right and left
  129092. */
  129093. rotationAngle: number;
  129094. /**
  129095. * Is rotation enabled when moving forward?
  129096. * Disabling this feature will prevent the user from deciding the direction when teleporting
  129097. */
  129098. rotationEnabled: boolean;
  129099. /**
  129100. * constructs a new anchor system
  129101. * @param _xrSessionManager an instance of WebXRSessionManager
  129102. * @param _options configuration object for this feature
  129103. */
  129104. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  129105. /**
  129106. * Get the snapPointsOnly flag
  129107. */
  129108. get snapPointsOnly(): boolean;
  129109. /**
  129110. * Sets the snapPointsOnly flag
  129111. * @param snapToPoints should teleportation be exclusively to snap points
  129112. */
  129113. set snapPointsOnly(snapToPoints: boolean);
  129114. /**
  129115. * Add a new mesh to the floor meshes array
  129116. * @param mesh the mesh to use as floor mesh
  129117. */
  129118. addFloorMesh(mesh: AbstractMesh): void;
  129119. /**
  129120. * Add a new snap-to point to fix teleportation to this position
  129121. * @param newSnapPoint The new Snap-To point
  129122. */
  129123. addSnapPoint(newSnapPoint: Vector3): void;
  129124. attach(): boolean;
  129125. detach(): boolean;
  129126. dispose(): void;
  129127. /**
  129128. * Remove a mesh from the floor meshes array
  129129. * @param mesh the mesh to remove
  129130. */
  129131. removeFloorMesh(mesh: AbstractMesh): void;
  129132. /**
  129133. * Remove a mesh from the floor meshes array using its name
  129134. * @param name the mesh name to remove
  129135. */
  129136. removeFloorMeshByName(name: string): void;
  129137. /**
  129138. * 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
  129139. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  129140. * @returns was the point found and removed or not
  129141. */
  129142. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  129143. /**
  129144. * This function sets a selection feature that will be disabled when
  129145. * the forward ray is shown and will be reattached when hidden.
  129146. * This is used to remove the selection rays when moving.
  129147. * @param selectionFeature the feature to disable when forward movement is enabled
  129148. */
  129149. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  129150. protected _onXRFrame(_xrFrame: XRFrame): void;
  129151. private _attachController;
  129152. private _createDefaultTargetMesh;
  129153. private _detachController;
  129154. private _findClosestSnapPointWithRadius;
  129155. private _setTargetMeshPosition;
  129156. private _setTargetMeshVisibility;
  129157. private _showParabolicPath;
  129158. private _teleportForward;
  129159. }
  129160. }
  129161. declare module BABYLON {
  129162. /**
  129163. * Options for the default xr helper
  129164. */
  129165. export class WebXRDefaultExperienceOptions {
  129166. /**
  129167. * Enable or disable default UI to enter XR
  129168. */
  129169. disableDefaultUI?: boolean;
  129170. /**
  129171. * Should teleportation not initialize. defaults to false.
  129172. */
  129173. disableTeleportation?: boolean;
  129174. /**
  129175. * Floor meshes that will be used for teleport
  129176. */
  129177. floorMeshes?: Array<AbstractMesh>;
  129178. /**
  129179. * If set to true, the first frame will not be used to reset position
  129180. * The first frame is mainly used when copying transformation from the old camera
  129181. * Mainly used in AR
  129182. */
  129183. ignoreNativeCameraTransformation?: boolean;
  129184. /**
  129185. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  129186. */
  129187. inputOptions?: IWebXRInputOptions;
  129188. /**
  129189. * optional configuration for the output canvas
  129190. */
  129191. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  129192. /**
  129193. * optional UI options. This can be used among other to change session mode and reference space type
  129194. */
  129195. uiOptions?: WebXREnterExitUIOptions;
  129196. /**
  129197. * When loading teleportation and pointer select, use stable versions instead of latest.
  129198. */
  129199. useStablePlugins?: boolean;
  129200. /**
  129201. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  129202. */
  129203. renderingGroupId?: number;
  129204. /**
  129205. * A list of optional features to init the session with
  129206. * If set to true, all features we support will be added
  129207. */
  129208. optionalFeatures?: boolean | string[];
  129209. }
  129210. /**
  129211. * Default experience which provides a similar setup to the previous webVRExperience
  129212. */
  129213. export class WebXRDefaultExperience {
  129214. /**
  129215. * Base experience
  129216. */
  129217. baseExperience: WebXRExperienceHelper;
  129218. /**
  129219. * Enables ui for entering/exiting xr
  129220. */
  129221. enterExitUI: WebXREnterExitUI;
  129222. /**
  129223. * Input experience extension
  129224. */
  129225. input: WebXRInput;
  129226. /**
  129227. * Enables laser pointer and selection
  129228. */
  129229. pointerSelection: WebXRControllerPointerSelection;
  129230. /**
  129231. * Default target xr should render to
  129232. */
  129233. renderTarget: WebXRRenderTarget;
  129234. /**
  129235. * Enables teleportation
  129236. */
  129237. teleportation: WebXRMotionControllerTeleportation;
  129238. private constructor();
  129239. /**
  129240. * Creates the default xr experience
  129241. * @param scene scene
  129242. * @param options options for basic configuration
  129243. * @returns resulting WebXRDefaultExperience
  129244. */
  129245. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  129246. /**
  129247. * DIsposes of the experience helper
  129248. */
  129249. dispose(): void;
  129250. }
  129251. }
  129252. declare module BABYLON {
  129253. /**
  129254. * Options to modify the vr teleportation behavior.
  129255. */
  129256. export interface VRTeleportationOptions {
  129257. /**
  129258. * The name of the mesh which should be used as the teleportation floor. (default: null)
  129259. */
  129260. floorMeshName?: string;
  129261. /**
  129262. * A list of meshes to be used as the teleportation floor. (default: empty)
  129263. */
  129264. floorMeshes?: Mesh[];
  129265. /**
  129266. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  129267. */
  129268. teleportationMode?: number;
  129269. /**
  129270. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  129271. */
  129272. teleportationTime?: number;
  129273. /**
  129274. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  129275. */
  129276. teleportationSpeed?: number;
  129277. /**
  129278. * The easing function used in the animation or null for Linear. (default CircleEase)
  129279. */
  129280. easingFunction?: EasingFunction;
  129281. }
  129282. /**
  129283. * Options to modify the vr experience helper's behavior.
  129284. */
  129285. export interface VRExperienceHelperOptions extends WebVROptions {
  129286. /**
  129287. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  129288. */
  129289. createDeviceOrientationCamera?: boolean;
  129290. /**
  129291. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  129292. */
  129293. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  129294. /**
  129295. * Uses the main button on the controller to toggle the laser casted. (default: true)
  129296. */
  129297. laserToggle?: boolean;
  129298. /**
  129299. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  129300. */
  129301. floorMeshes?: Mesh[];
  129302. /**
  129303. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  129304. */
  129305. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  129306. /**
  129307. * Defines if WebXR should be used instead of WebVR (if available)
  129308. */
  129309. useXR?: boolean;
  129310. }
  129311. /**
  129312. * Event containing information after VR has been entered
  129313. */
  129314. export class OnAfterEnteringVRObservableEvent {
  129315. /**
  129316. * If entering vr was successful
  129317. */
  129318. success: boolean;
  129319. }
  129320. /**
  129321. * Helps to quickly add VR support to an existing scene.
  129322. * See https://doc.babylonjs.com/how_to/webvr_helper
  129323. */
  129324. export class VRExperienceHelper {
  129325. /** Options to modify the vr experience helper's behavior. */
  129326. webVROptions: VRExperienceHelperOptions;
  129327. private _scene;
  129328. private _position;
  129329. private _btnVR;
  129330. private _btnVRDisplayed;
  129331. private _webVRsupported;
  129332. private _webVRready;
  129333. private _webVRrequesting;
  129334. private _webVRpresenting;
  129335. private _hasEnteredVR;
  129336. private _fullscreenVRpresenting;
  129337. private _inputElement;
  129338. private _webVRCamera;
  129339. private _vrDeviceOrientationCamera;
  129340. private _deviceOrientationCamera;
  129341. private _existingCamera;
  129342. private _onKeyDown;
  129343. private _onVrDisplayPresentChange;
  129344. private _onVRDisplayChanged;
  129345. private _onVRRequestPresentStart;
  129346. private _onVRRequestPresentComplete;
  129347. /**
  129348. * 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)
  129349. */
  129350. enableGazeEvenWhenNoPointerLock: boolean;
  129351. /**
  129352. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  129353. */
  129354. exitVROnDoubleTap: boolean;
  129355. /**
  129356. * Observable raised right before entering VR.
  129357. */
  129358. onEnteringVRObservable: Observable<VRExperienceHelper>;
  129359. /**
  129360. * Observable raised when entering VR has completed.
  129361. */
  129362. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  129363. /**
  129364. * Observable raised when exiting VR.
  129365. */
  129366. onExitingVRObservable: Observable<VRExperienceHelper>;
  129367. /**
  129368. * Observable raised when controller mesh is loaded.
  129369. */
  129370. onControllerMeshLoadedObservable: Observable<WebVRController>;
  129371. /** Return this.onEnteringVRObservable
  129372. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  129373. */
  129374. get onEnteringVR(): Observable<VRExperienceHelper>;
  129375. /** Return this.onExitingVRObservable
  129376. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  129377. */
  129378. get onExitingVR(): Observable<VRExperienceHelper>;
  129379. /** Return this.onControllerMeshLoadedObservable
  129380. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  129381. */
  129382. get onControllerMeshLoaded(): Observable<WebVRController>;
  129383. private _rayLength;
  129384. private _useCustomVRButton;
  129385. private _teleportationRequested;
  129386. private _teleportActive;
  129387. private _floorMeshName;
  129388. private _floorMeshesCollection;
  129389. private _teleportationMode;
  129390. private _teleportationTime;
  129391. private _teleportationSpeed;
  129392. private _teleportationEasing;
  129393. private _rotationAllowed;
  129394. private _teleportBackwardsVector;
  129395. private _teleportationTarget;
  129396. private _isDefaultTeleportationTarget;
  129397. private _postProcessMove;
  129398. private _teleportationFillColor;
  129399. private _teleportationBorderColor;
  129400. private _rotationAngle;
  129401. private _haloCenter;
  129402. private _cameraGazer;
  129403. private _padSensibilityUp;
  129404. private _padSensibilityDown;
  129405. private _leftController;
  129406. private _rightController;
  129407. private _gazeColor;
  129408. private _laserColor;
  129409. private _pickedLaserColor;
  129410. private _pickedGazeColor;
  129411. /**
  129412. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  129413. */
  129414. onNewMeshSelected: Observable<AbstractMesh>;
  129415. /**
  129416. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  129417. * This observable will provide the mesh and the controller used to select the mesh
  129418. */
  129419. onMeshSelectedWithController: Observable<{
  129420. mesh: AbstractMesh;
  129421. controller: WebVRController;
  129422. }>;
  129423. /**
  129424. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  129425. */
  129426. onNewMeshPicked: Observable<PickingInfo>;
  129427. private _circleEase;
  129428. /**
  129429. * Observable raised before camera teleportation
  129430. */
  129431. onBeforeCameraTeleport: Observable<Vector3>;
  129432. /**
  129433. * Observable raised after camera teleportation
  129434. */
  129435. onAfterCameraTeleport: Observable<Vector3>;
  129436. /**
  129437. * Observable raised when current selected mesh gets unselected
  129438. */
  129439. onSelectedMeshUnselected: Observable<AbstractMesh>;
  129440. private _raySelectionPredicate;
  129441. /**
  129442. * To be optionaly changed by user to define custom ray selection
  129443. */
  129444. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  129445. /**
  129446. * To be optionaly changed by user to define custom selection logic (after ray selection)
  129447. */
  129448. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  129449. /**
  129450. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  129451. */
  129452. teleportationEnabled: boolean;
  129453. private _defaultHeight;
  129454. private _teleportationInitialized;
  129455. private _interactionsEnabled;
  129456. private _interactionsRequested;
  129457. private _displayGaze;
  129458. private _displayLaserPointer;
  129459. /**
  129460. * The mesh used to display where the user is going to teleport.
  129461. */
  129462. get teleportationTarget(): Mesh;
  129463. /**
  129464. * Sets the mesh to be used to display where the user is going to teleport.
  129465. */
  129466. set teleportationTarget(value: Mesh);
  129467. /**
  129468. * 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
  129469. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  129470. * See https://doc.babylonjs.com/resources/baking_transformations
  129471. */
  129472. get gazeTrackerMesh(): Mesh;
  129473. set gazeTrackerMesh(value: Mesh);
  129474. /**
  129475. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  129476. */
  129477. updateGazeTrackerScale: boolean;
  129478. /**
  129479. * If the gaze trackers color should be updated when selecting meshes
  129480. */
  129481. updateGazeTrackerColor: boolean;
  129482. /**
  129483. * If the controller laser color should be updated when selecting meshes
  129484. */
  129485. updateControllerLaserColor: boolean;
  129486. /**
  129487. * The gaze tracking mesh corresponding to the left controller
  129488. */
  129489. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  129490. /**
  129491. * The gaze tracking mesh corresponding to the right controller
  129492. */
  129493. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  129494. /**
  129495. * If the ray of the gaze should be displayed.
  129496. */
  129497. get displayGaze(): boolean;
  129498. /**
  129499. * Sets if the ray of the gaze should be displayed.
  129500. */
  129501. set displayGaze(value: boolean);
  129502. /**
  129503. * If the ray of the LaserPointer should be displayed.
  129504. */
  129505. get displayLaserPointer(): boolean;
  129506. /**
  129507. * Sets if the ray of the LaserPointer should be displayed.
  129508. */
  129509. set displayLaserPointer(value: boolean);
  129510. /**
  129511. * The deviceOrientationCamera used as the camera when not in VR.
  129512. */
  129513. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  129514. /**
  129515. * Based on the current WebVR support, returns the current VR camera used.
  129516. */
  129517. get currentVRCamera(): Nullable<Camera>;
  129518. /**
  129519. * The webVRCamera which is used when in VR.
  129520. */
  129521. get webVRCamera(): WebVRFreeCamera;
  129522. /**
  129523. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  129524. */
  129525. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  129526. /**
  129527. * The html button that is used to trigger entering into VR.
  129528. */
  129529. get vrButton(): Nullable<HTMLButtonElement>;
  129530. private get _teleportationRequestInitiated();
  129531. /**
  129532. * Defines whether or not Pointer lock should be requested when switching to
  129533. * full screen.
  129534. */
  129535. requestPointerLockOnFullScreen: boolean;
  129536. /**
  129537. * If asking to force XR, this will be populated with the default xr experience
  129538. */
  129539. xr: WebXRDefaultExperience;
  129540. /**
  129541. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  129542. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  129543. */
  129544. xrTestDone: boolean;
  129545. /**
  129546. * Instantiates a VRExperienceHelper.
  129547. * Helps to quickly add VR support to an existing scene.
  129548. * @param scene The scene the VRExperienceHelper belongs to.
  129549. * @param webVROptions Options to modify the vr experience helper's behavior.
  129550. */
  129551. constructor(scene: Scene,
  129552. /** Options to modify the vr experience helper's behavior. */
  129553. webVROptions?: VRExperienceHelperOptions);
  129554. private completeVRInit;
  129555. private _onDefaultMeshLoaded;
  129556. private _onResize;
  129557. private _onFullscreenChange;
  129558. /**
  129559. * Gets a value indicating if we are currently in VR mode.
  129560. */
  129561. get isInVRMode(): boolean;
  129562. private onVrDisplayPresentChange;
  129563. private onVRDisplayChanged;
  129564. private moveButtonToBottomRight;
  129565. private displayVRButton;
  129566. private updateButtonVisibility;
  129567. private _cachedAngularSensibility;
  129568. /**
  129569. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  129570. * Otherwise, will use the fullscreen API.
  129571. */
  129572. enterVR(): void;
  129573. /**
  129574. * Attempt to exit VR, or fullscreen.
  129575. */
  129576. exitVR(): void;
  129577. /**
  129578. * The position of the vr experience helper.
  129579. */
  129580. get position(): Vector3;
  129581. /**
  129582. * Sets the position of the vr experience helper.
  129583. */
  129584. set position(value: Vector3);
  129585. /**
  129586. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  129587. */
  129588. enableInteractions(): void;
  129589. private get _noControllerIsActive();
  129590. private beforeRender;
  129591. private _isTeleportationFloor;
  129592. /**
  129593. * Adds a floor mesh to be used for teleportation.
  129594. * @param floorMesh the mesh to be used for teleportation.
  129595. */
  129596. addFloorMesh(floorMesh: Mesh): void;
  129597. /**
  129598. * Removes a floor mesh from being used for teleportation.
  129599. * @param floorMesh the mesh to be removed.
  129600. */
  129601. removeFloorMesh(floorMesh: Mesh): void;
  129602. /**
  129603. * Enables interactions and teleportation using the VR controllers and gaze.
  129604. * @param vrTeleportationOptions options to modify teleportation behavior.
  129605. */
  129606. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  129607. private _onNewGamepadConnected;
  129608. private _tryEnableInteractionOnController;
  129609. private _onNewGamepadDisconnected;
  129610. private _enableInteractionOnController;
  129611. private _checkTeleportWithRay;
  129612. private _checkRotate;
  129613. private _checkTeleportBackwards;
  129614. private _enableTeleportationOnController;
  129615. private _createTeleportationCircles;
  129616. private _displayTeleportationTarget;
  129617. private _hideTeleportationTarget;
  129618. private _rotateCamera;
  129619. private _moveTeleportationSelectorTo;
  129620. private _workingVector;
  129621. private _workingQuaternion;
  129622. private _workingMatrix;
  129623. /**
  129624. * Time Constant Teleportation Mode
  129625. */
  129626. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  129627. /**
  129628. * Speed Constant Teleportation Mode
  129629. */
  129630. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  129631. /**
  129632. * Teleports the users feet to the desired location
  129633. * @param location The location where the user's feet should be placed
  129634. */
  129635. teleportCamera(location: Vector3): void;
  129636. private _convertNormalToDirectionOfRay;
  129637. private _castRayAndSelectObject;
  129638. private _notifySelectedMeshUnselected;
  129639. /**
  129640. * Permanently set new colors for the laser pointer
  129641. * @param color the new laser color
  129642. * @param pickedColor the new laser color when picked mesh detected
  129643. */
  129644. setLaserColor(color: Color3, pickedColor?: Color3): void;
  129645. /**
  129646. * Set lighting enabled / disabled on the laser pointer of both controllers
  129647. * @param enabled should the lighting be enabled on the laser pointer
  129648. */
  129649. setLaserLightingState(enabled?: boolean): void;
  129650. /**
  129651. * Permanently set new colors for the gaze pointer
  129652. * @param color the new gaze color
  129653. * @param pickedColor the new gaze color when picked mesh detected
  129654. */
  129655. setGazeColor(color: Color3, pickedColor?: Color3): void;
  129656. /**
  129657. * Sets the color of the laser ray from the vr controllers.
  129658. * @param color new color for the ray.
  129659. */
  129660. changeLaserColor(color: Color3): void;
  129661. /**
  129662. * Sets the color of the ray from the vr headsets gaze.
  129663. * @param color new color for the ray.
  129664. */
  129665. changeGazeColor(color: Color3): void;
  129666. /**
  129667. * Exits VR and disposes of the vr experience helper
  129668. */
  129669. dispose(): void;
  129670. /**
  129671. * Gets the name of the VRExperienceHelper class
  129672. * @returns "VRExperienceHelper"
  129673. */
  129674. getClassName(): string;
  129675. }
  129676. }
  129677. declare module BABYLON {
  129678. /**
  129679. * Contains an array of blocks representing the octree
  129680. */
  129681. export interface IOctreeContainer<T> {
  129682. /**
  129683. * Blocks within the octree
  129684. */
  129685. blocks: Array<OctreeBlock<T>>;
  129686. }
  129687. /**
  129688. * Class used to store a cell in an octree
  129689. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129690. */
  129691. export class OctreeBlock<T> {
  129692. /**
  129693. * Gets the content of the current block
  129694. */
  129695. entries: T[];
  129696. /**
  129697. * Gets the list of block children
  129698. */
  129699. blocks: Array<OctreeBlock<T>>;
  129700. private _depth;
  129701. private _maxDepth;
  129702. private _capacity;
  129703. private _minPoint;
  129704. private _maxPoint;
  129705. private _boundingVectors;
  129706. private _creationFunc;
  129707. /**
  129708. * Creates a new block
  129709. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  129710. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  129711. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129712. * @param depth defines the current depth of this block in the octree
  129713. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  129714. * @param creationFunc defines a callback to call when an element is added to the block
  129715. */
  129716. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  129717. /**
  129718. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129719. */
  129720. get capacity(): number;
  129721. /**
  129722. * Gets the minimum vector (in world space) of the block's bounding box
  129723. */
  129724. get minPoint(): Vector3;
  129725. /**
  129726. * Gets the maximum vector (in world space) of the block's bounding box
  129727. */
  129728. get maxPoint(): Vector3;
  129729. /**
  129730. * Add a new element to this block
  129731. * @param entry defines the element to add
  129732. */
  129733. addEntry(entry: T): void;
  129734. /**
  129735. * Remove an element from this block
  129736. * @param entry defines the element to remove
  129737. */
  129738. removeEntry(entry: T): void;
  129739. /**
  129740. * Add an array of elements to this block
  129741. * @param entries defines the array of elements to add
  129742. */
  129743. addEntries(entries: T[]): void;
  129744. /**
  129745. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  129746. * @param frustumPlanes defines the frustum planes to test
  129747. * @param selection defines the array to store current content if selection is positive
  129748. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129749. */
  129750. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129751. /**
  129752. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  129753. * @param sphereCenter defines the bounding sphere center
  129754. * @param sphereRadius defines the bounding sphere radius
  129755. * @param selection defines the array to store current content if selection is positive
  129756. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129757. */
  129758. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129759. /**
  129760. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  129761. * @param ray defines the ray to test with
  129762. * @param selection defines the array to store current content if selection is positive
  129763. */
  129764. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  129765. /**
  129766. * Subdivide the content into child blocks (this block will then be empty)
  129767. */
  129768. createInnerBlocks(): void;
  129769. /**
  129770. * @hidden
  129771. */
  129772. 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;
  129773. }
  129774. }
  129775. declare module BABYLON {
  129776. /**
  129777. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  129778. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129779. */
  129780. export class Octree<T> {
  129781. /** 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.) */
  129782. maxDepth: number;
  129783. /**
  129784. * Blocks within the octree containing objects
  129785. */
  129786. blocks: Array<OctreeBlock<T>>;
  129787. /**
  129788. * Content stored in the octree
  129789. */
  129790. dynamicContent: T[];
  129791. private _maxBlockCapacity;
  129792. private _selectionContent;
  129793. private _creationFunc;
  129794. /**
  129795. * Creates a octree
  129796. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129797. * @param creationFunc function to be used to instatiate the octree
  129798. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  129799. * @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.)
  129800. */
  129801. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  129802. /** 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.) */
  129803. maxDepth?: number);
  129804. /**
  129805. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  129806. * @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);
  129807. * @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);
  129808. * @param entries meshes to be added to the octree blocks
  129809. */
  129810. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  129811. /**
  129812. * Adds a mesh to the octree
  129813. * @param entry Mesh to add to the octree
  129814. */
  129815. addMesh(entry: T): void;
  129816. /**
  129817. * Remove an element from the octree
  129818. * @param entry defines the element to remove
  129819. */
  129820. removeMesh(entry: T): void;
  129821. /**
  129822. * Selects an array of meshes within the frustum
  129823. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  129824. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  129825. * @returns array of meshes within the frustum
  129826. */
  129827. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  129828. /**
  129829. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  129830. * @param sphereCenter defines the bounding sphere center
  129831. * @param sphereRadius defines the bounding sphere radius
  129832. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129833. * @returns an array of objects that intersect the sphere
  129834. */
  129835. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  129836. /**
  129837. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  129838. * @param ray defines the ray to test with
  129839. * @returns array of intersected objects
  129840. */
  129841. intersectsRay(ray: Ray): SmartArray<T>;
  129842. /**
  129843. * Adds a mesh into the octree block if it intersects the block
  129844. */
  129845. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  129846. /**
  129847. * Adds a submesh into the octree block if it intersects the block
  129848. */
  129849. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  129850. }
  129851. }
  129852. declare module BABYLON {
  129853. interface Scene {
  129854. /**
  129855. * @hidden
  129856. * Backing Filed
  129857. */
  129858. _selectionOctree: Octree<AbstractMesh>;
  129859. /**
  129860. * Gets the octree used to boost mesh selection (picking)
  129861. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129862. */
  129863. selectionOctree: Octree<AbstractMesh>;
  129864. /**
  129865. * Creates or updates the octree used to boost selection (picking)
  129866. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129867. * @param maxCapacity defines the maximum capacity per leaf
  129868. * @param maxDepth defines the maximum depth of the octree
  129869. * @returns an octree of AbstractMesh
  129870. */
  129871. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  129872. }
  129873. interface AbstractMesh {
  129874. /**
  129875. * @hidden
  129876. * Backing Field
  129877. */
  129878. _submeshesOctree: Octree<SubMesh>;
  129879. /**
  129880. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  129881. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  129882. * @param maxCapacity defines the maximum size of each block (64 by default)
  129883. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  129884. * @returns the new octree
  129885. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  129886. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129887. */
  129888. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  129889. }
  129890. /**
  129891. * Defines the octree scene component responsible to manage any octrees
  129892. * in a given scene.
  129893. */
  129894. export class OctreeSceneComponent {
  129895. /**
  129896. * The component name help to identify the component in the list of scene components.
  129897. */
  129898. readonly name: string;
  129899. /**
  129900. * The scene the component belongs to.
  129901. */
  129902. scene: Scene;
  129903. /**
  129904. * Indicates if the meshes have been checked to make sure they are isEnabled()
  129905. */
  129906. readonly checksIsEnabled: boolean;
  129907. /**
  129908. * Creates a new instance of the component for the given scene
  129909. * @param scene Defines the scene to register the component in
  129910. */
  129911. constructor(scene: Scene);
  129912. /**
  129913. * Registers the component in a given scene
  129914. */
  129915. register(): void;
  129916. /**
  129917. * Return the list of active meshes
  129918. * @returns the list of active meshes
  129919. */
  129920. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  129921. /**
  129922. * Return the list of active sub meshes
  129923. * @param mesh The mesh to get the candidates sub meshes from
  129924. * @returns the list of active sub meshes
  129925. */
  129926. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  129927. private _tempRay;
  129928. /**
  129929. * Return the list of sub meshes intersecting with a given local ray
  129930. * @param mesh defines the mesh to find the submesh for
  129931. * @param localRay defines the ray in local space
  129932. * @returns the list of intersecting sub meshes
  129933. */
  129934. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  129935. /**
  129936. * Return the list of sub meshes colliding with a collider
  129937. * @param mesh defines the mesh to find the submesh for
  129938. * @param collider defines the collider to evaluate the collision against
  129939. * @returns the list of colliding sub meshes
  129940. */
  129941. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  129942. /**
  129943. * Rebuilds the elements related to this component in case of
  129944. * context lost for instance.
  129945. */
  129946. rebuild(): void;
  129947. /**
  129948. * Disposes the component and the associated ressources.
  129949. */
  129950. dispose(): void;
  129951. }
  129952. }
  129953. declare module BABYLON {
  129954. /**
  129955. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  129956. */
  129957. export class Gizmo implements IDisposable {
  129958. /** The utility layer the gizmo will be added to */
  129959. gizmoLayer: UtilityLayerRenderer;
  129960. /**
  129961. * The root mesh of the gizmo
  129962. */
  129963. _rootMesh: Mesh;
  129964. private _attachedMesh;
  129965. private _attachedNode;
  129966. /**
  129967. * Ratio for the scale of the gizmo (Default: 1)
  129968. */
  129969. protected _scaleRatio: number;
  129970. /**
  129971. * Ratio for the scale of the gizmo (Default: 1)
  129972. */
  129973. set scaleRatio(value: number);
  129974. get scaleRatio(): number;
  129975. /**
  129976. * If a custom mesh has been set (Default: false)
  129977. */
  129978. protected _customMeshSet: boolean;
  129979. /**
  129980. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  129981. * * When set, interactions will be enabled
  129982. */
  129983. get attachedMesh(): Nullable<AbstractMesh>;
  129984. set attachedMesh(value: Nullable<AbstractMesh>);
  129985. /**
  129986. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  129987. * * When set, interactions will be enabled
  129988. */
  129989. get attachedNode(): Nullable<Node>;
  129990. set attachedNode(value: Nullable<Node>);
  129991. /**
  129992. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  129993. * @param mesh The mesh to replace the default mesh of the gizmo
  129994. */
  129995. setCustomMesh(mesh: Mesh): void;
  129996. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  129997. /**
  129998. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  129999. */
  130000. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130001. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130002. /**
  130003. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  130004. */
  130005. updateGizmoPositionToMatchAttachedMesh: boolean;
  130006. /**
  130007. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  130008. */
  130009. updateScale: boolean;
  130010. protected _interactionsEnabled: boolean;
  130011. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130012. private _beforeRenderObserver;
  130013. private _tempQuaternion;
  130014. private _tempVector;
  130015. private _tempVector2;
  130016. /**
  130017. * Creates a gizmo
  130018. * @param gizmoLayer The utility layer the gizmo will be added to
  130019. */
  130020. constructor(
  130021. /** The utility layer the gizmo will be added to */
  130022. gizmoLayer?: UtilityLayerRenderer);
  130023. /**
  130024. * Updates the gizmo to match the attached mesh's position/rotation
  130025. */
  130026. protected _update(): void;
  130027. /**
  130028. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  130029. * @param value Node, TransformNode or mesh
  130030. */
  130031. protected _matrixChanged(): void;
  130032. /**
  130033. * Disposes of the gizmo
  130034. */
  130035. dispose(): void;
  130036. }
  130037. }
  130038. declare module BABYLON {
  130039. /**
  130040. * Single plane drag gizmo
  130041. */
  130042. export class PlaneDragGizmo extends Gizmo {
  130043. /**
  130044. * Drag behavior responsible for the gizmos dragging interactions
  130045. */
  130046. dragBehavior: PointerDragBehavior;
  130047. private _pointerObserver;
  130048. /**
  130049. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130050. */
  130051. snapDistance: number;
  130052. /**
  130053. * Event that fires each time the gizmo snaps to a new location.
  130054. * * snapDistance is the the change in distance
  130055. */
  130056. onSnapObservable: Observable<{
  130057. snapDistance: number;
  130058. }>;
  130059. private _plane;
  130060. private _coloredMaterial;
  130061. private _hoverMaterial;
  130062. private _isEnabled;
  130063. private _parent;
  130064. /** @hidden */
  130065. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  130066. /** @hidden */
  130067. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130068. /**
  130069. * Creates a PlaneDragGizmo
  130070. * @param gizmoLayer The utility layer the gizmo will be added to
  130071. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  130072. * @param color The color of the gizmo
  130073. */
  130074. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  130075. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130076. /**
  130077. * If the gizmo is enabled
  130078. */
  130079. set isEnabled(value: boolean);
  130080. get isEnabled(): boolean;
  130081. /**
  130082. * Disposes of the gizmo
  130083. */
  130084. dispose(): void;
  130085. }
  130086. }
  130087. declare module BABYLON {
  130088. /**
  130089. * Gizmo that enables dragging a mesh along 3 axis
  130090. */
  130091. export class PositionGizmo extends Gizmo {
  130092. /**
  130093. * Internal gizmo used for interactions on the x axis
  130094. */
  130095. xGizmo: AxisDragGizmo;
  130096. /**
  130097. * Internal gizmo used for interactions on the y axis
  130098. */
  130099. yGizmo: AxisDragGizmo;
  130100. /**
  130101. * Internal gizmo used for interactions on the z axis
  130102. */
  130103. zGizmo: AxisDragGizmo;
  130104. /**
  130105. * Internal gizmo used for interactions on the yz plane
  130106. */
  130107. xPlaneGizmo: PlaneDragGizmo;
  130108. /**
  130109. * Internal gizmo used for interactions on the xz plane
  130110. */
  130111. yPlaneGizmo: PlaneDragGizmo;
  130112. /**
  130113. * Internal gizmo used for interactions on the xy plane
  130114. */
  130115. zPlaneGizmo: PlaneDragGizmo;
  130116. /**
  130117. * private variables
  130118. */
  130119. private _meshAttached;
  130120. private _nodeAttached;
  130121. private _snapDistance;
  130122. /** Fires an event when any of it's sub gizmos are dragged */
  130123. onDragStartObservable: Observable<unknown>;
  130124. /** Fires an event when any of it's sub gizmos are released from dragging */
  130125. onDragEndObservable: Observable<unknown>;
  130126. /**
  130127. * If set to true, planar drag is enabled
  130128. */
  130129. private _planarGizmoEnabled;
  130130. get attachedMesh(): Nullable<AbstractMesh>;
  130131. set attachedMesh(mesh: Nullable<AbstractMesh>);
  130132. get attachedNode(): Nullable<Node>;
  130133. set attachedNode(node: Nullable<Node>);
  130134. /**
  130135. * Creates a PositionGizmo
  130136. * @param gizmoLayer The utility layer the gizmo will be added to
  130137. @param thickness display gizmo axis thickness
  130138. */
  130139. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  130140. /**
  130141. * If the planar drag gizmo is enabled
  130142. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  130143. */
  130144. set planarGizmoEnabled(value: boolean);
  130145. get planarGizmoEnabled(): boolean;
  130146. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130147. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130148. /**
  130149. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130150. */
  130151. set snapDistance(value: number);
  130152. get snapDistance(): number;
  130153. /**
  130154. * Ratio for the scale of the gizmo (Default: 1)
  130155. */
  130156. set scaleRatio(value: number);
  130157. get scaleRatio(): number;
  130158. /**
  130159. * Disposes of the gizmo
  130160. */
  130161. dispose(): void;
  130162. /**
  130163. * CustomMeshes are not supported by this gizmo
  130164. * @param mesh The mesh to replace the default mesh of the gizmo
  130165. */
  130166. setCustomMesh(mesh: Mesh): void;
  130167. }
  130168. }
  130169. declare module BABYLON {
  130170. /**
  130171. * Single axis drag gizmo
  130172. */
  130173. export class AxisDragGizmo extends Gizmo {
  130174. /**
  130175. * Drag behavior responsible for the gizmos dragging interactions
  130176. */
  130177. dragBehavior: PointerDragBehavior;
  130178. private _pointerObserver;
  130179. /**
  130180. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130181. */
  130182. snapDistance: number;
  130183. /**
  130184. * Event that fires each time the gizmo snaps to a new location.
  130185. * * snapDistance is the the change in distance
  130186. */
  130187. onSnapObservable: Observable<{
  130188. snapDistance: number;
  130189. }>;
  130190. private _isEnabled;
  130191. private _parent;
  130192. private _arrow;
  130193. private _coloredMaterial;
  130194. private _hoverMaterial;
  130195. /** @hidden */
  130196. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  130197. /** @hidden */
  130198. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130199. /**
  130200. * Creates an AxisDragGizmo
  130201. * @param gizmoLayer The utility layer the gizmo will be added to
  130202. * @param dragAxis The axis which the gizmo will be able to drag on
  130203. * @param color The color of the gizmo
  130204. * @param thickness display gizmo axis thickness
  130205. */
  130206. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  130207. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130208. /**
  130209. * If the gizmo is enabled
  130210. */
  130211. set isEnabled(value: boolean);
  130212. get isEnabled(): boolean;
  130213. /**
  130214. * Disposes of the gizmo
  130215. */
  130216. dispose(): void;
  130217. }
  130218. }
  130219. declare module BABYLON.Debug {
  130220. /**
  130221. * The Axes viewer will show 3 axes in a specific point in space
  130222. */
  130223. export class AxesViewer {
  130224. private _xAxis;
  130225. private _yAxis;
  130226. private _zAxis;
  130227. private _scaleLinesFactor;
  130228. private _instanced;
  130229. /**
  130230. * Gets the hosting scene
  130231. */
  130232. scene: Nullable<Scene>;
  130233. /**
  130234. * Gets or sets a number used to scale line length
  130235. */
  130236. scaleLines: number;
  130237. /** Gets the node hierarchy used to render x-axis */
  130238. get xAxis(): TransformNode;
  130239. /** Gets the node hierarchy used to render y-axis */
  130240. get yAxis(): TransformNode;
  130241. /** Gets the node hierarchy used to render z-axis */
  130242. get zAxis(): TransformNode;
  130243. /**
  130244. * Creates a new AxesViewer
  130245. * @param scene defines the hosting scene
  130246. * @param scaleLines defines a number used to scale line length (1 by default)
  130247. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  130248. * @param xAxis defines the node hierarchy used to render the x-axis
  130249. * @param yAxis defines the node hierarchy used to render the y-axis
  130250. * @param zAxis defines the node hierarchy used to render the z-axis
  130251. */
  130252. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  130253. /**
  130254. * Force the viewer to update
  130255. * @param position defines the position of the viewer
  130256. * @param xaxis defines the x axis of the viewer
  130257. * @param yaxis defines the y axis of the viewer
  130258. * @param zaxis defines the z axis of the viewer
  130259. */
  130260. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  130261. /**
  130262. * Creates an instance of this axes viewer.
  130263. * @returns a new axes viewer with instanced meshes
  130264. */
  130265. createInstance(): AxesViewer;
  130266. /** Releases resources */
  130267. dispose(): void;
  130268. private static _SetRenderingGroupId;
  130269. }
  130270. }
  130271. declare module BABYLON.Debug {
  130272. /**
  130273. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  130274. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  130275. */
  130276. export class BoneAxesViewer extends AxesViewer {
  130277. /**
  130278. * Gets or sets the target mesh where to display the axes viewer
  130279. */
  130280. mesh: Nullable<Mesh>;
  130281. /**
  130282. * Gets or sets the target bone where to display the axes viewer
  130283. */
  130284. bone: Nullable<Bone>;
  130285. /** Gets current position */
  130286. pos: Vector3;
  130287. /** Gets direction of X axis */
  130288. xaxis: Vector3;
  130289. /** Gets direction of Y axis */
  130290. yaxis: Vector3;
  130291. /** Gets direction of Z axis */
  130292. zaxis: Vector3;
  130293. /**
  130294. * Creates a new BoneAxesViewer
  130295. * @param scene defines the hosting scene
  130296. * @param bone defines the target bone
  130297. * @param mesh defines the target mesh
  130298. * @param scaleLines defines a scaling factor for line length (1 by default)
  130299. */
  130300. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  130301. /**
  130302. * Force the viewer to update
  130303. */
  130304. update(): void;
  130305. /** Releases resources */
  130306. dispose(): void;
  130307. }
  130308. }
  130309. declare module BABYLON {
  130310. /**
  130311. * Interface used to define scene explorer extensibility option
  130312. */
  130313. export interface IExplorerExtensibilityOption {
  130314. /**
  130315. * Define the option label
  130316. */
  130317. label: string;
  130318. /**
  130319. * Defines the action to execute on click
  130320. */
  130321. action: (entity: any) => void;
  130322. }
  130323. /**
  130324. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  130325. */
  130326. export interface IExplorerExtensibilityGroup {
  130327. /**
  130328. * Defines a predicate to test if a given type mut be extended
  130329. */
  130330. predicate: (entity: any) => boolean;
  130331. /**
  130332. * Gets the list of options added to a type
  130333. */
  130334. entries: IExplorerExtensibilityOption[];
  130335. }
  130336. /**
  130337. * Interface used to define the options to use to create the Inspector
  130338. */
  130339. export interface IInspectorOptions {
  130340. /**
  130341. * Display in overlay mode (default: false)
  130342. */
  130343. overlay?: boolean;
  130344. /**
  130345. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  130346. */
  130347. globalRoot?: HTMLElement;
  130348. /**
  130349. * Display the Scene explorer
  130350. */
  130351. showExplorer?: boolean;
  130352. /**
  130353. * Display the property inspector
  130354. */
  130355. showInspector?: boolean;
  130356. /**
  130357. * Display in embed mode (both panes on the right)
  130358. */
  130359. embedMode?: boolean;
  130360. /**
  130361. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  130362. */
  130363. handleResize?: boolean;
  130364. /**
  130365. * Allow the panes to popup (default: true)
  130366. */
  130367. enablePopup?: boolean;
  130368. /**
  130369. * Allow the panes to be closed by users (default: true)
  130370. */
  130371. enableClose?: boolean;
  130372. /**
  130373. * Optional list of extensibility entries
  130374. */
  130375. explorerExtensibility?: IExplorerExtensibilityGroup[];
  130376. /**
  130377. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  130378. */
  130379. inspectorURL?: string;
  130380. /**
  130381. * Optional initial tab (default to DebugLayerTab.Properties)
  130382. */
  130383. initialTab?: DebugLayerTab;
  130384. }
  130385. interface Scene {
  130386. /**
  130387. * @hidden
  130388. * Backing field
  130389. */
  130390. _debugLayer: DebugLayer;
  130391. /**
  130392. * Gets the debug layer (aka Inspector) associated with the scene
  130393. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130394. */
  130395. debugLayer: DebugLayer;
  130396. }
  130397. /**
  130398. * Enum of inspector action tab
  130399. */
  130400. export enum DebugLayerTab {
  130401. /**
  130402. * Properties tag (default)
  130403. */
  130404. Properties = 0,
  130405. /**
  130406. * Debug tab
  130407. */
  130408. Debug = 1,
  130409. /**
  130410. * Statistics tab
  130411. */
  130412. Statistics = 2,
  130413. /**
  130414. * Tools tab
  130415. */
  130416. Tools = 3,
  130417. /**
  130418. * Settings tab
  130419. */
  130420. Settings = 4
  130421. }
  130422. /**
  130423. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130424. * what is happening in your scene
  130425. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130426. */
  130427. export class DebugLayer {
  130428. /**
  130429. * Define the url to get the inspector script from.
  130430. * By default it uses the babylonjs CDN.
  130431. * @ignoreNaming
  130432. */
  130433. static InspectorURL: string;
  130434. private _scene;
  130435. private BJSINSPECTOR;
  130436. private _onPropertyChangedObservable?;
  130437. /**
  130438. * Observable triggered when a property is changed through the inspector.
  130439. */
  130440. get onPropertyChangedObservable(): any;
  130441. /**
  130442. * Instantiates a new debug layer.
  130443. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130444. * what is happening in your scene
  130445. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130446. * @param scene Defines the scene to inspect
  130447. */
  130448. constructor(scene: Scene);
  130449. /** Creates the inspector window. */
  130450. private _createInspector;
  130451. /**
  130452. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  130453. * @param entity defines the entity to select
  130454. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  130455. */
  130456. select(entity: any, lineContainerTitles?: string | string[]): void;
  130457. /** Get the inspector from bundle or global */
  130458. private _getGlobalInspector;
  130459. /**
  130460. * Get if the inspector is visible or not.
  130461. * @returns true if visible otherwise, false
  130462. */
  130463. isVisible(): boolean;
  130464. /**
  130465. * Hide the inspector and close its window.
  130466. */
  130467. hide(): void;
  130468. /**
  130469. * Update the scene in the inspector
  130470. */
  130471. setAsActiveScene(): void;
  130472. /**
  130473. * Launch the debugLayer.
  130474. * @param config Define the configuration of the inspector
  130475. * @return a promise fulfilled when the debug layer is visible
  130476. */
  130477. show(config?: IInspectorOptions): Promise<DebugLayer>;
  130478. }
  130479. }
  130480. declare module BABYLON {
  130481. /**
  130482. * Class containing static functions to help procedurally build meshes
  130483. */
  130484. export class BoxBuilder {
  130485. /**
  130486. * Creates a box mesh
  130487. * * The parameter `size` sets the size (float) of each box side (default 1)
  130488. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  130489. * * 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)
  130490. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  130491. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130492. * * 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
  130493. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130494. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  130495. * @param name defines the name of the mesh
  130496. * @param options defines the options used to create the mesh
  130497. * @param scene defines the hosting scene
  130498. * @returns the box mesh
  130499. */
  130500. static CreateBox(name: string, options: {
  130501. size?: number;
  130502. width?: number;
  130503. height?: number;
  130504. depth?: number;
  130505. faceUV?: Vector4[];
  130506. faceColors?: Color4[];
  130507. sideOrientation?: number;
  130508. frontUVs?: Vector4;
  130509. backUVs?: Vector4;
  130510. wrap?: boolean;
  130511. topBaseAt?: number;
  130512. bottomBaseAt?: number;
  130513. updatable?: boolean;
  130514. }, scene?: Nullable<Scene>): Mesh;
  130515. }
  130516. }
  130517. declare module BABYLON.Debug {
  130518. /**
  130519. * Used to show the physics impostor around the specific mesh
  130520. */
  130521. export class PhysicsViewer {
  130522. /** @hidden */
  130523. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  130524. /** @hidden */
  130525. protected _meshes: Array<Nullable<AbstractMesh>>;
  130526. /** @hidden */
  130527. protected _scene: Nullable<Scene>;
  130528. /** @hidden */
  130529. protected _numMeshes: number;
  130530. /** @hidden */
  130531. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  130532. private _renderFunction;
  130533. private _utilityLayer;
  130534. private _debugBoxMesh;
  130535. private _debugSphereMesh;
  130536. private _debugCylinderMesh;
  130537. private _debugMaterial;
  130538. private _debugMeshMeshes;
  130539. /**
  130540. * Creates a new PhysicsViewer
  130541. * @param scene defines the hosting scene
  130542. */
  130543. constructor(scene: Scene);
  130544. /** @hidden */
  130545. protected _updateDebugMeshes(): void;
  130546. /**
  130547. * Renders a specified physic impostor
  130548. * @param impostor defines the impostor to render
  130549. * @param targetMesh defines the mesh represented by the impostor
  130550. * @returns the new debug mesh used to render the impostor
  130551. */
  130552. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  130553. /**
  130554. * Hides a specified physic impostor
  130555. * @param impostor defines the impostor to hide
  130556. */
  130557. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  130558. private _getDebugMaterial;
  130559. private _getDebugBoxMesh;
  130560. private _getDebugSphereMesh;
  130561. private _getDebugCylinderMesh;
  130562. private _getDebugMeshMesh;
  130563. private _getDebugMesh;
  130564. /** Releases all resources */
  130565. dispose(): void;
  130566. }
  130567. }
  130568. declare module BABYLON {
  130569. /**
  130570. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130571. * in order to better appreciate the issue one might have.
  130572. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130573. */
  130574. export class RayHelper {
  130575. /**
  130576. * Defines the ray we are currently tryin to visualize.
  130577. */
  130578. ray: Nullable<Ray>;
  130579. private _renderPoints;
  130580. private _renderLine;
  130581. private _renderFunction;
  130582. private _scene;
  130583. private _onAfterRenderObserver;
  130584. private _onAfterStepObserver;
  130585. private _attachedToMesh;
  130586. private _meshSpaceDirection;
  130587. private _meshSpaceOrigin;
  130588. /**
  130589. * Helper function to create a colored helper in a scene in one line.
  130590. * @param ray Defines the ray we are currently tryin to visualize
  130591. * @param scene Defines the scene the ray is used in
  130592. * @param color Defines the color we want to see the ray in
  130593. * @returns The newly created ray helper.
  130594. */
  130595. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  130596. /**
  130597. * Instantiate a new ray helper.
  130598. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130599. * in order to better appreciate the issue one might have.
  130600. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130601. * @param ray Defines the ray we are currently tryin to visualize
  130602. */
  130603. constructor(ray: Ray);
  130604. /**
  130605. * Shows the ray we are willing to debug.
  130606. * @param scene Defines the scene the ray needs to be rendered in
  130607. * @param color Defines the color the ray needs to be rendered in
  130608. */
  130609. show(scene: Scene, color?: Color3): void;
  130610. /**
  130611. * Hides the ray we are debugging.
  130612. */
  130613. hide(): void;
  130614. private _render;
  130615. /**
  130616. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  130617. * @param mesh Defines the mesh we want the helper attached to
  130618. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  130619. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  130620. * @param length Defines the length of the ray
  130621. */
  130622. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  130623. /**
  130624. * Detach the ray helper from the mesh it has previously been attached to.
  130625. */
  130626. detachFromMesh(): void;
  130627. private _updateToMesh;
  130628. /**
  130629. * Dispose the helper and release its associated resources.
  130630. */
  130631. dispose(): void;
  130632. }
  130633. }
  130634. declare module BABYLON {
  130635. /**
  130636. * Defines the options associated with the creation of a SkeletonViewer.
  130637. */
  130638. export interface ISkeletonViewerOptions {
  130639. /** Should the system pause animations before building the Viewer? */
  130640. pauseAnimations: boolean;
  130641. /** Should the system return the skeleton to rest before building? */
  130642. returnToRest: boolean;
  130643. /** public Display Mode of the Viewer */
  130644. displayMode: number;
  130645. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130646. displayOptions: ISkeletonViewerDisplayOptions;
  130647. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130648. computeBonesUsingShaders: boolean;
  130649. }
  130650. /**
  130651. * Defines how to display the various bone meshes for the viewer.
  130652. */
  130653. export interface ISkeletonViewerDisplayOptions {
  130654. /** How far down to start tapering the bone spurs */
  130655. midStep?: number;
  130656. /** How big is the midStep? */
  130657. midStepFactor?: number;
  130658. /** Base for the Sphere Size */
  130659. sphereBaseSize?: number;
  130660. /** The ratio of the sphere to the longest bone in units */
  130661. sphereScaleUnit?: number;
  130662. /** Ratio for the Sphere Size */
  130663. sphereFactor?: number;
  130664. }
  130665. }
  130666. declare module BABYLON {
  130667. /**
  130668. * Class containing static functions to help procedurally build meshes
  130669. */
  130670. export class RibbonBuilder {
  130671. /**
  130672. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  130673. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  130674. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  130675. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  130676. * * 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
  130677. * * 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
  130678. * * 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
  130679. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130680. * * 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
  130681. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130682. * * 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
  130683. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  130684. * * 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
  130685. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  130686. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130687. * @param name defines the name of the mesh
  130688. * @param options defines the options used to create the mesh
  130689. * @param scene defines the hosting scene
  130690. * @returns the ribbon mesh
  130691. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  130692. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130693. */
  130694. static CreateRibbon(name: string, options: {
  130695. pathArray: Vector3[][];
  130696. closeArray?: boolean;
  130697. closePath?: boolean;
  130698. offset?: number;
  130699. updatable?: boolean;
  130700. sideOrientation?: number;
  130701. frontUVs?: Vector4;
  130702. backUVs?: Vector4;
  130703. instance?: Mesh;
  130704. invertUV?: boolean;
  130705. uvs?: Vector2[];
  130706. colors?: Color4[];
  130707. }, scene?: Nullable<Scene>): Mesh;
  130708. }
  130709. }
  130710. declare module BABYLON {
  130711. /**
  130712. * Class containing static functions to help procedurally build meshes
  130713. */
  130714. export class ShapeBuilder {
  130715. /**
  130716. * 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.
  130717. * * 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.
  130718. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130719. * * 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.
  130720. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  130721. * * 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
  130722. * * 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
  130723. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  130724. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130725. * * 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
  130726. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  130727. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130728. * @param name defines the name of the mesh
  130729. * @param options defines the options used to create the mesh
  130730. * @param scene defines the hosting scene
  130731. * @returns the extruded shape mesh
  130732. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130733. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130734. */
  130735. static ExtrudeShape(name: string, options: {
  130736. shape: Vector3[];
  130737. path: Vector3[];
  130738. scale?: number;
  130739. rotation?: number;
  130740. cap?: number;
  130741. updatable?: boolean;
  130742. sideOrientation?: number;
  130743. frontUVs?: Vector4;
  130744. backUVs?: Vector4;
  130745. instance?: Mesh;
  130746. invertUV?: boolean;
  130747. }, scene?: Nullable<Scene>): Mesh;
  130748. /**
  130749. * Creates an custom extruded shape mesh.
  130750. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  130751. * * 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.
  130752. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130753. * * 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
  130754. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  130755. * * 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
  130756. * * It must returns a float value that will be the scale value applied to the shape on each path point
  130757. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  130758. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  130759. * * 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
  130760. * * 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
  130761. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  130762. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130763. * * 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
  130764. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130765. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130766. * @param name defines the name of the mesh
  130767. * @param options defines the options used to create the mesh
  130768. * @param scene defines the hosting scene
  130769. * @returns the custom extruded shape mesh
  130770. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  130771. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130772. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130773. */
  130774. static ExtrudeShapeCustom(name: string, options: {
  130775. shape: Vector3[];
  130776. path: Vector3[];
  130777. scaleFunction?: any;
  130778. rotationFunction?: any;
  130779. ribbonCloseArray?: boolean;
  130780. ribbonClosePath?: boolean;
  130781. cap?: number;
  130782. updatable?: boolean;
  130783. sideOrientation?: number;
  130784. frontUVs?: Vector4;
  130785. backUVs?: Vector4;
  130786. instance?: Mesh;
  130787. invertUV?: boolean;
  130788. }, scene?: Nullable<Scene>): Mesh;
  130789. private static _ExtrudeShapeGeneric;
  130790. }
  130791. }
  130792. declare module BABYLON.Debug {
  130793. /**
  130794. * Class used to render a debug view of a given skeleton
  130795. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  130796. */
  130797. export class SkeletonViewer {
  130798. /** defines the skeleton to render */
  130799. skeleton: Skeleton;
  130800. /** defines the mesh attached to the skeleton */
  130801. mesh: AbstractMesh;
  130802. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130803. autoUpdateBonesMatrices: boolean;
  130804. /** defines the rendering group id to use with the viewer */
  130805. renderingGroupId: number;
  130806. /** is the options for the viewer */
  130807. options: Partial<ISkeletonViewerOptions>;
  130808. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  130809. static readonly DISPLAY_LINES: number;
  130810. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  130811. static readonly DISPLAY_SPHERES: number;
  130812. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  130813. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  130814. /** If SkeletonViewer scene scope. */
  130815. private _scene;
  130816. /** Gets or sets the color used to render the skeleton */
  130817. color: Color3;
  130818. /** Array of the points of the skeleton fo the line view. */
  130819. private _debugLines;
  130820. /** The SkeletonViewers Mesh. */
  130821. private _debugMesh;
  130822. /** If SkeletonViewer is enabled. */
  130823. private _isEnabled;
  130824. /** If SkeletonViewer is ready. */
  130825. private _ready;
  130826. /** SkeletonViewer render observable. */
  130827. private _obs;
  130828. /** The Utility Layer to render the gizmos in. */
  130829. private _utilityLayer;
  130830. private _boneIndices;
  130831. /** Gets the Scene. */
  130832. get scene(): Scene;
  130833. /** Gets the utilityLayer. */
  130834. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  130835. /** Checks Ready Status. */
  130836. get isReady(): Boolean;
  130837. /** Sets Ready Status. */
  130838. set ready(value: boolean);
  130839. /** Gets the debugMesh */
  130840. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  130841. /** Sets the debugMesh */
  130842. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  130843. /** Gets the material */
  130844. get material(): StandardMaterial;
  130845. /** Sets the material */
  130846. set material(value: StandardMaterial);
  130847. /** Gets the material */
  130848. get displayMode(): number;
  130849. /** Sets the material */
  130850. set displayMode(value: number);
  130851. /**
  130852. * Creates a new SkeletonViewer
  130853. * @param skeleton defines the skeleton to render
  130854. * @param mesh defines the mesh attached to the skeleton
  130855. * @param scene defines the hosting scene
  130856. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  130857. * @param renderingGroupId defines the rendering group id to use with the viewer
  130858. * @param options All of the extra constructor options for the SkeletonViewer
  130859. */
  130860. constructor(
  130861. /** defines the skeleton to render */
  130862. skeleton: Skeleton,
  130863. /** defines the mesh attached to the skeleton */
  130864. mesh: AbstractMesh,
  130865. /** The Scene scope*/
  130866. scene: Scene,
  130867. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130868. autoUpdateBonesMatrices?: boolean,
  130869. /** defines the rendering group id to use with the viewer */
  130870. renderingGroupId?: number,
  130871. /** is the options for the viewer */
  130872. options?: Partial<ISkeletonViewerOptions>);
  130873. /** The Dynamic bindings for the update functions */
  130874. private _bindObs;
  130875. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  130876. update(): void;
  130877. /** Gets or sets a boolean indicating if the viewer is enabled */
  130878. set isEnabled(value: boolean);
  130879. get isEnabled(): boolean;
  130880. private _getBonePosition;
  130881. private _getLinesForBonesWithLength;
  130882. private _getLinesForBonesNoLength;
  130883. /** function to revert the mesh and scene back to the initial state. */
  130884. private _revert;
  130885. /** function to build and bind sphere joint points and spur bone representations. */
  130886. private _buildSpheresAndSpurs;
  130887. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  130888. private _displayLinesUpdate;
  130889. /** Changes the displayMode of the skeleton viewer
  130890. * @param mode The displayMode numerical value
  130891. */
  130892. changeDisplayMode(mode: number): void;
  130893. /** Changes the displayMode of the skeleton viewer
  130894. * @param option String of the option name
  130895. * @param value The numerical option value
  130896. */
  130897. changeDisplayOptions(option: string, value: number): void;
  130898. /** Release associated resources */
  130899. dispose(): void;
  130900. }
  130901. }
  130902. declare module BABYLON {
  130903. /**
  130904. * Enum for Device Types
  130905. */
  130906. export enum DeviceType {
  130907. /** Generic */
  130908. Generic = 0,
  130909. /** Keyboard */
  130910. Keyboard = 1,
  130911. /** Mouse */
  130912. Mouse = 2,
  130913. /** Touch Pointers */
  130914. Touch = 3,
  130915. /** PS4 Dual Shock */
  130916. DualShock = 4,
  130917. /** Xbox */
  130918. Xbox = 5,
  130919. /** Switch Controller */
  130920. Switch = 6
  130921. }
  130922. /**
  130923. * Enum for All Pointers (Touch/Mouse)
  130924. */
  130925. export enum PointerInput {
  130926. /** Horizontal Axis */
  130927. Horizontal = 0,
  130928. /** Vertical Axis */
  130929. Vertical = 1,
  130930. /** Left Click or Touch */
  130931. LeftClick = 2,
  130932. /** Middle Click */
  130933. MiddleClick = 3,
  130934. /** Right Click */
  130935. RightClick = 4,
  130936. /** Browser Back */
  130937. BrowserBack = 5,
  130938. /** Browser Forward */
  130939. BrowserForward = 6
  130940. }
  130941. /**
  130942. * Enum for Dual Shock Gamepad
  130943. */
  130944. export enum DualShockInput {
  130945. /** Cross */
  130946. Cross = 0,
  130947. /** Circle */
  130948. Circle = 1,
  130949. /** Square */
  130950. Square = 2,
  130951. /** Triangle */
  130952. Triangle = 3,
  130953. /** L1 */
  130954. L1 = 4,
  130955. /** R1 */
  130956. R1 = 5,
  130957. /** L2 */
  130958. L2 = 6,
  130959. /** R2 */
  130960. R2 = 7,
  130961. /** Share */
  130962. Share = 8,
  130963. /** Options */
  130964. Options = 9,
  130965. /** L3 */
  130966. L3 = 10,
  130967. /** R3 */
  130968. R3 = 11,
  130969. /** DPadUp */
  130970. DPadUp = 12,
  130971. /** DPadDown */
  130972. DPadDown = 13,
  130973. /** DPadLeft */
  130974. DPadLeft = 14,
  130975. /** DRight */
  130976. DPadRight = 15,
  130977. /** Home */
  130978. Home = 16,
  130979. /** TouchPad */
  130980. TouchPad = 17,
  130981. /** LStickXAxis */
  130982. LStickXAxis = 18,
  130983. /** LStickYAxis */
  130984. LStickYAxis = 19,
  130985. /** RStickXAxis */
  130986. RStickXAxis = 20,
  130987. /** RStickYAxis */
  130988. RStickYAxis = 21
  130989. }
  130990. /**
  130991. * Enum for Xbox Gamepad
  130992. */
  130993. export enum XboxInput {
  130994. /** A */
  130995. A = 0,
  130996. /** B */
  130997. B = 1,
  130998. /** X */
  130999. X = 2,
  131000. /** Y */
  131001. Y = 3,
  131002. /** LB */
  131003. LB = 4,
  131004. /** RB */
  131005. RB = 5,
  131006. /** LT */
  131007. LT = 6,
  131008. /** RT */
  131009. RT = 7,
  131010. /** Back */
  131011. Back = 8,
  131012. /** Start */
  131013. Start = 9,
  131014. /** LS */
  131015. LS = 10,
  131016. /** RS */
  131017. RS = 11,
  131018. /** DPadUp */
  131019. DPadUp = 12,
  131020. /** DPadDown */
  131021. DPadDown = 13,
  131022. /** DPadLeft */
  131023. DPadLeft = 14,
  131024. /** DRight */
  131025. DPadRight = 15,
  131026. /** Home */
  131027. Home = 16,
  131028. /** LStickXAxis */
  131029. LStickXAxis = 17,
  131030. /** LStickYAxis */
  131031. LStickYAxis = 18,
  131032. /** RStickXAxis */
  131033. RStickXAxis = 19,
  131034. /** RStickYAxis */
  131035. RStickYAxis = 20
  131036. }
  131037. /**
  131038. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  131039. */
  131040. export enum SwitchInput {
  131041. /** B */
  131042. B = 0,
  131043. /** A */
  131044. A = 1,
  131045. /** Y */
  131046. Y = 2,
  131047. /** X */
  131048. X = 3,
  131049. /** L */
  131050. L = 4,
  131051. /** R */
  131052. R = 5,
  131053. /** ZL */
  131054. ZL = 6,
  131055. /** ZR */
  131056. ZR = 7,
  131057. /** Minus */
  131058. Minus = 8,
  131059. /** Plus */
  131060. Plus = 9,
  131061. /** LS */
  131062. LS = 10,
  131063. /** RS */
  131064. RS = 11,
  131065. /** DPadUp */
  131066. DPadUp = 12,
  131067. /** DPadDown */
  131068. DPadDown = 13,
  131069. /** DPadLeft */
  131070. DPadLeft = 14,
  131071. /** DRight */
  131072. DPadRight = 15,
  131073. /** Home */
  131074. Home = 16,
  131075. /** Capture */
  131076. Capture = 17,
  131077. /** LStickXAxis */
  131078. LStickXAxis = 18,
  131079. /** LStickYAxis */
  131080. LStickYAxis = 19,
  131081. /** RStickXAxis */
  131082. RStickXAxis = 20,
  131083. /** RStickYAxis */
  131084. RStickYAxis = 21
  131085. }
  131086. }
  131087. declare module BABYLON {
  131088. /**
  131089. * This class will take all inputs from Keyboard, Pointer, and
  131090. * any Gamepads and provide a polling system that all devices
  131091. * will use. This class assumes that there will only be one
  131092. * pointer device and one keyboard.
  131093. */
  131094. export class DeviceInputSystem implements IDisposable {
  131095. /**
  131096. * Callback to be triggered when a device is connected
  131097. */
  131098. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131099. /**
  131100. * Callback to be triggered when a device is disconnected
  131101. */
  131102. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131103. /**
  131104. * Callback to be triggered when event driven input is updated
  131105. */
  131106. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  131107. private _inputs;
  131108. private _gamepads;
  131109. private _keyboardActive;
  131110. private _pointerActive;
  131111. private _elementToAttachTo;
  131112. private _keyboardDownEvent;
  131113. private _keyboardUpEvent;
  131114. private _pointerMoveEvent;
  131115. private _pointerDownEvent;
  131116. private _pointerUpEvent;
  131117. private _gamepadConnectedEvent;
  131118. private _gamepadDisconnectedEvent;
  131119. private static _MAX_KEYCODES;
  131120. private static _MAX_POINTER_INPUTS;
  131121. private constructor();
  131122. /**
  131123. * Creates a new DeviceInputSystem instance
  131124. * @param engine Engine to pull input element from
  131125. * @returns The new instance
  131126. */
  131127. static Create(engine: Engine): DeviceInputSystem;
  131128. /**
  131129. * Checks for current device input value, given an id and input index
  131130. * @param deviceName Id of connected device
  131131. * @param inputIndex Index of device input
  131132. * @returns Current value of input
  131133. */
  131134. /**
  131135. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  131136. * @param deviceType Enum specifiying device type
  131137. * @param deviceSlot "Slot" or index that device is referenced in
  131138. * @param inputIndex Id of input to be checked
  131139. * @returns Current value of input
  131140. */
  131141. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  131142. /**
  131143. * Dispose of all the eventlisteners
  131144. */
  131145. dispose(): void;
  131146. /**
  131147. * Add device and inputs to device array
  131148. * @param deviceType Enum specifiying device type
  131149. * @param deviceSlot "Slot" or index that device is referenced in
  131150. * @param numberOfInputs Number of input entries to create for given device
  131151. */
  131152. private _registerDevice;
  131153. /**
  131154. * Given a specific device name, remove that device from the device map
  131155. * @param deviceType Enum specifiying device type
  131156. * @param deviceSlot "Slot" or index that device is referenced in
  131157. */
  131158. private _unregisterDevice;
  131159. /**
  131160. * Handle all actions that come from keyboard interaction
  131161. */
  131162. private _handleKeyActions;
  131163. /**
  131164. * Handle all actions that come from pointer interaction
  131165. */
  131166. private _handlePointerActions;
  131167. /**
  131168. * Handle all actions that come from gamepad interaction
  131169. */
  131170. private _handleGamepadActions;
  131171. /**
  131172. * Update all non-event based devices with each frame
  131173. * @param deviceType Enum specifiying device type
  131174. * @param deviceSlot "Slot" or index that device is referenced in
  131175. * @param inputIndex Id of input to be checked
  131176. */
  131177. private _updateDevice;
  131178. /**
  131179. * Gets DeviceType from the device name
  131180. * @param deviceName Name of Device from DeviceInputSystem
  131181. * @returns DeviceType enum value
  131182. */
  131183. private _getGamepadDeviceType;
  131184. }
  131185. }
  131186. declare module BABYLON {
  131187. /**
  131188. * Type to handle enforcement of inputs
  131189. */
  131190. 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;
  131191. }
  131192. declare module BABYLON {
  131193. /**
  131194. * Class that handles all input for a specific device
  131195. */
  131196. export class DeviceSource<T extends DeviceType> {
  131197. /** Type of device */
  131198. readonly deviceType: DeviceType;
  131199. /** "Slot" or index that device is referenced in */
  131200. readonly deviceSlot: number;
  131201. /**
  131202. * Observable to handle device input changes per device
  131203. */
  131204. readonly onInputChangedObservable: Observable<{
  131205. inputIndex: DeviceInput<T>;
  131206. previousState: Nullable<number>;
  131207. currentState: Nullable<number>;
  131208. }>;
  131209. private readonly _deviceInputSystem;
  131210. /**
  131211. * Default Constructor
  131212. * @param deviceInputSystem Reference to DeviceInputSystem
  131213. * @param deviceType Type of device
  131214. * @param deviceSlot "Slot" or index that device is referenced in
  131215. */
  131216. constructor(deviceInputSystem: DeviceInputSystem,
  131217. /** Type of device */
  131218. deviceType: DeviceType,
  131219. /** "Slot" or index that device is referenced in */
  131220. deviceSlot?: number);
  131221. /**
  131222. * Get input for specific input
  131223. * @param inputIndex index of specific input on device
  131224. * @returns Input value from DeviceInputSystem
  131225. */
  131226. getInput(inputIndex: DeviceInput<T>): number;
  131227. }
  131228. /**
  131229. * Class to keep track of devices
  131230. */
  131231. export class DeviceSourceManager implements IDisposable {
  131232. /**
  131233. * Observable to be triggered when before a device is connected
  131234. */
  131235. readonly onBeforeDeviceConnectedObservable: Observable<{
  131236. deviceType: DeviceType;
  131237. deviceSlot: number;
  131238. }>;
  131239. /**
  131240. * Observable to be triggered when before a device is disconnected
  131241. */
  131242. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  131243. deviceType: DeviceType;
  131244. deviceSlot: number;
  131245. }>;
  131246. /**
  131247. * Observable to be triggered when after a device is connected
  131248. */
  131249. readonly onAfterDeviceConnectedObservable: Observable<{
  131250. deviceType: DeviceType;
  131251. deviceSlot: number;
  131252. }>;
  131253. /**
  131254. * Observable to be triggered when after a device is disconnected
  131255. */
  131256. readonly onAfterDeviceDisconnectedObservable: Observable<{
  131257. deviceType: DeviceType;
  131258. deviceSlot: number;
  131259. }>;
  131260. private readonly _devices;
  131261. private readonly _firstDevice;
  131262. private readonly _deviceInputSystem;
  131263. /**
  131264. * Default Constructor
  131265. * @param engine engine to pull input element from
  131266. */
  131267. constructor(engine: Engine);
  131268. /**
  131269. * Gets a DeviceSource, given a type and slot
  131270. * @param deviceType Enum specifying device type
  131271. * @param deviceSlot "Slot" or index that device is referenced in
  131272. * @returns DeviceSource object
  131273. */
  131274. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  131275. /**
  131276. * Gets an array of DeviceSource objects for a given device type
  131277. * @param deviceType Enum specifying device type
  131278. * @returns Array of DeviceSource objects
  131279. */
  131280. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  131281. /**
  131282. * Dispose of DeviceInputSystem and other parts
  131283. */
  131284. dispose(): void;
  131285. /**
  131286. * Function to add device name to device list
  131287. * @param deviceType Enum specifying device type
  131288. * @param deviceSlot "Slot" or index that device is referenced in
  131289. */
  131290. private _addDevice;
  131291. /**
  131292. * Function to remove device name to device list
  131293. * @param deviceType Enum specifying device type
  131294. * @param deviceSlot "Slot" or index that device is referenced in
  131295. */
  131296. private _removeDevice;
  131297. /**
  131298. * Updates array storing first connected device of each type
  131299. * @param type Type of Device
  131300. */
  131301. private _updateFirstDevices;
  131302. }
  131303. }
  131304. declare module BABYLON {
  131305. /**
  131306. * Options to create the null engine
  131307. */
  131308. export class NullEngineOptions {
  131309. /**
  131310. * Render width (Default: 512)
  131311. */
  131312. renderWidth: number;
  131313. /**
  131314. * Render height (Default: 256)
  131315. */
  131316. renderHeight: number;
  131317. /**
  131318. * Texture size (Default: 512)
  131319. */
  131320. textureSize: number;
  131321. /**
  131322. * If delta time between frames should be constant
  131323. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131324. */
  131325. deterministicLockstep: boolean;
  131326. /**
  131327. * Maximum about of steps between frames (Default: 4)
  131328. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131329. */
  131330. lockstepMaxSteps: number;
  131331. /**
  131332. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  131333. */
  131334. useHighPrecisionMatrix?: boolean;
  131335. }
  131336. /**
  131337. * The null engine class provides support for headless version of babylon.js.
  131338. * This can be used in server side scenario or for testing purposes
  131339. */
  131340. export class NullEngine extends Engine {
  131341. private _options;
  131342. /**
  131343. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  131344. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131345. * @returns true if engine is in deterministic lock step mode
  131346. */
  131347. isDeterministicLockStep(): boolean;
  131348. /**
  131349. * Gets the max steps when engine is running in deterministic lock step
  131350. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131351. * @returns the max steps
  131352. */
  131353. getLockstepMaxSteps(): number;
  131354. /**
  131355. * Gets the current hardware scaling level.
  131356. * By default the hardware scaling level is computed from the window device ratio.
  131357. * 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.
  131358. * @returns a number indicating the current hardware scaling level
  131359. */
  131360. getHardwareScalingLevel(): number;
  131361. constructor(options?: NullEngineOptions);
  131362. /**
  131363. * Creates a vertex buffer
  131364. * @param vertices the data for the vertex buffer
  131365. * @returns the new WebGL static buffer
  131366. */
  131367. createVertexBuffer(vertices: FloatArray): DataBuffer;
  131368. /**
  131369. * Creates a new index buffer
  131370. * @param indices defines the content of the index buffer
  131371. * @param updatable defines if the index buffer must be updatable
  131372. * @returns a new webGL buffer
  131373. */
  131374. createIndexBuffer(indices: IndicesArray): DataBuffer;
  131375. /**
  131376. * Clear the current render buffer or the current render target (if any is set up)
  131377. * @param color defines the color to use
  131378. * @param backBuffer defines if the back buffer must be cleared
  131379. * @param depth defines if the depth buffer must be cleared
  131380. * @param stencil defines if the stencil buffer must be cleared
  131381. */
  131382. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  131383. /**
  131384. * Gets the current render width
  131385. * @param useScreen defines if screen size must be used (or the current render target if any)
  131386. * @returns a number defining the current render width
  131387. */
  131388. getRenderWidth(useScreen?: boolean): number;
  131389. /**
  131390. * Gets the current render height
  131391. * @param useScreen defines if screen size must be used (or the current render target if any)
  131392. * @returns a number defining the current render height
  131393. */
  131394. getRenderHeight(useScreen?: boolean): number;
  131395. /**
  131396. * Set the WebGL's viewport
  131397. * @param viewport defines the viewport element to be used
  131398. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  131399. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  131400. */
  131401. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  131402. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  131403. /**
  131404. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  131405. * @param pipelineContext defines the pipeline context to use
  131406. * @param uniformsNames defines the list of uniform names
  131407. * @returns an array of webGL uniform locations
  131408. */
  131409. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  131410. /**
  131411. * Gets the lsit of active attributes for a given webGL program
  131412. * @param pipelineContext defines the pipeline context to use
  131413. * @param attributesNames defines the list of attribute names to get
  131414. * @returns an array of indices indicating the offset of each attribute
  131415. */
  131416. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  131417. /**
  131418. * Binds an effect to the webGL context
  131419. * @param effect defines the effect to bind
  131420. */
  131421. bindSamplers(effect: Effect): void;
  131422. /**
  131423. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  131424. * @param effect defines the effect to activate
  131425. */
  131426. enableEffect(effect: Effect): void;
  131427. /**
  131428. * Set various states to the webGL context
  131429. * @param culling defines backface culling state
  131430. * @param zOffset defines the value to apply to zOffset (0 by default)
  131431. * @param force defines if states must be applied even if cache is up to date
  131432. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  131433. */
  131434. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  131435. /**
  131436. * Set the value of an uniform to an array of int32
  131437. * @param uniform defines the webGL uniform location where to store the value
  131438. * @param array defines the array of int32 to store
  131439. */
  131440. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  131441. /**
  131442. * Set the value of an uniform to an array of int32 (stored as vec2)
  131443. * @param uniform defines the webGL uniform location where to store the value
  131444. * @param array defines the array of int32 to store
  131445. */
  131446. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  131447. /**
  131448. * Set the value of an uniform to an array of int32 (stored as vec3)
  131449. * @param uniform defines the webGL uniform location where to store the value
  131450. * @param array defines the array of int32 to store
  131451. */
  131452. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  131453. /**
  131454. * Set the value of an uniform to an array of int32 (stored as vec4)
  131455. * @param uniform defines the webGL uniform location where to store the value
  131456. * @param array defines the array of int32 to store
  131457. */
  131458. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  131459. /**
  131460. * Set the value of an uniform to an array of float32
  131461. * @param uniform defines the webGL uniform location where to store the value
  131462. * @param array defines the array of float32 to store
  131463. */
  131464. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  131465. /**
  131466. * Set the value of an uniform to an array of float32 (stored as vec2)
  131467. * @param uniform defines the webGL uniform location where to store the value
  131468. * @param array defines the array of float32 to store
  131469. */
  131470. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  131471. /**
  131472. * Set the value of an uniform to an array of float32 (stored as vec3)
  131473. * @param uniform defines the webGL uniform location where to store the value
  131474. * @param array defines the array of float32 to store
  131475. */
  131476. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  131477. /**
  131478. * Set the value of an uniform to an array of float32 (stored as vec4)
  131479. * @param uniform defines the webGL uniform location where to store the value
  131480. * @param array defines the array of float32 to store
  131481. */
  131482. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  131483. /**
  131484. * Set the value of an uniform to an array of number
  131485. * @param uniform defines the webGL uniform location where to store the value
  131486. * @param array defines the array of number to store
  131487. */
  131488. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  131489. /**
  131490. * Set the value of an uniform to an array of number (stored as vec2)
  131491. * @param uniform defines the webGL uniform location where to store the value
  131492. * @param array defines the array of number to store
  131493. */
  131494. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  131495. /**
  131496. * Set the value of an uniform to an array of number (stored as vec3)
  131497. * @param uniform defines the webGL uniform location where to store the value
  131498. * @param array defines the array of number to store
  131499. */
  131500. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  131501. /**
  131502. * Set the value of an uniform to an array of number (stored as vec4)
  131503. * @param uniform defines the webGL uniform location where to store the value
  131504. * @param array defines the array of number to store
  131505. */
  131506. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  131507. /**
  131508. * Set the value of an uniform to an array of float32 (stored as matrices)
  131509. * @param uniform defines the webGL uniform location where to store the value
  131510. * @param matrices defines the array of float32 to store
  131511. */
  131512. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  131513. /**
  131514. * Set the value of an uniform to a matrix (3x3)
  131515. * @param uniform defines the webGL uniform location where to store the value
  131516. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  131517. */
  131518. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131519. /**
  131520. * Set the value of an uniform to a matrix (2x2)
  131521. * @param uniform defines the webGL uniform location where to store the value
  131522. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  131523. */
  131524. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131525. /**
  131526. * Set the value of an uniform to a number (float)
  131527. * @param uniform defines the webGL uniform location where to store the value
  131528. * @param value defines the float number to store
  131529. */
  131530. setFloat(uniform: WebGLUniformLocation, value: number): void;
  131531. /**
  131532. * Set the value of an uniform to a vec2
  131533. * @param uniform defines the webGL uniform location where to store the value
  131534. * @param x defines the 1st component of the value
  131535. * @param y defines the 2nd component of the value
  131536. */
  131537. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  131538. /**
  131539. * Set the value of an uniform to a vec3
  131540. * @param uniform defines the webGL uniform location where to store the value
  131541. * @param x defines the 1st component of the value
  131542. * @param y defines the 2nd component of the value
  131543. * @param z defines the 3rd component of the value
  131544. */
  131545. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  131546. /**
  131547. * Set the value of an uniform to a boolean
  131548. * @param uniform defines the webGL uniform location where to store the value
  131549. * @param bool defines the boolean to store
  131550. */
  131551. setBool(uniform: WebGLUniformLocation, bool: number): void;
  131552. /**
  131553. * Set the value of an uniform to a vec4
  131554. * @param uniform defines the webGL uniform location where to store the value
  131555. * @param x defines the 1st component of the value
  131556. * @param y defines the 2nd component of the value
  131557. * @param z defines the 3rd component of the value
  131558. * @param w defines the 4th component of the value
  131559. */
  131560. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  131561. /**
  131562. * Sets the current alpha mode
  131563. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  131564. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  131565. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  131566. */
  131567. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  131568. /**
  131569. * Bind webGl buffers directly to the webGL context
  131570. * @param vertexBuffers defines the vertex buffer to bind
  131571. * @param indexBuffer defines the index buffer to bind
  131572. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  131573. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  131574. * @param effect defines the effect associated with the vertex buffer
  131575. */
  131576. bindBuffers(vertexBuffers: {
  131577. [key: string]: VertexBuffer;
  131578. }, indexBuffer: DataBuffer, effect: Effect): void;
  131579. /**
  131580. * Force the entire cache to be cleared
  131581. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  131582. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  131583. */
  131584. wipeCaches(bruteForce?: boolean): void;
  131585. /**
  131586. * Send a draw order
  131587. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  131588. * @param indexStart defines the starting index
  131589. * @param indexCount defines the number of index to draw
  131590. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131591. */
  131592. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  131593. /**
  131594. * Draw a list of indexed primitives
  131595. * @param fillMode defines the primitive to use
  131596. * @param indexStart defines the starting index
  131597. * @param indexCount defines the number of index to draw
  131598. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131599. */
  131600. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  131601. /**
  131602. * Draw a list of unindexed primitives
  131603. * @param fillMode defines the primitive to use
  131604. * @param verticesStart defines the index of first vertex to draw
  131605. * @param verticesCount defines the count of vertices to draw
  131606. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131607. */
  131608. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  131609. /** @hidden */
  131610. _createTexture(): WebGLTexture;
  131611. /** @hidden */
  131612. _releaseTexture(texture: InternalTexture): void;
  131613. /**
  131614. * Usually called from Texture.ts.
  131615. * Passed information to create a WebGLTexture
  131616. * @param urlArg defines a value which contains one of the following:
  131617. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  131618. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  131619. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  131620. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  131621. * @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)
  131622. * @param scene needed for loading to the correct scene
  131623. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  131624. * @param onLoad optional callback to be called upon successful completion
  131625. * @param onError optional callback to be called upon failure
  131626. * @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
  131627. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  131628. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  131629. * @param forcedExtension defines the extension to use to pick the right loader
  131630. * @param mimeType defines an optional mime type
  131631. * @returns a InternalTexture for assignment back into BABYLON.Texture
  131632. */
  131633. 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;
  131634. /**
  131635. * Creates a new render target texture
  131636. * @param size defines the size of the texture
  131637. * @param options defines the options used to create the texture
  131638. * @returns a new render target texture stored in an InternalTexture
  131639. */
  131640. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  131641. /**
  131642. * Update the sampling mode of a given texture
  131643. * @param samplingMode defines the required sampling mode
  131644. * @param texture defines the texture to update
  131645. */
  131646. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  131647. /**
  131648. * Binds the frame buffer to the specified texture.
  131649. * @param texture The texture to render to or null for the default canvas
  131650. * @param faceIndex The face of the texture to render to in case of cube texture
  131651. * @param requiredWidth The width of the target to render to
  131652. * @param requiredHeight The height of the target to render to
  131653. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  131654. * @param lodLevel defines le lod level to bind to the frame buffer
  131655. */
  131656. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  131657. /**
  131658. * Unbind the current render target texture from the webGL context
  131659. * @param texture defines the render target texture to unbind
  131660. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  131661. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  131662. */
  131663. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  131664. /**
  131665. * Creates a dynamic vertex buffer
  131666. * @param vertices the data for the dynamic vertex buffer
  131667. * @returns the new WebGL dynamic buffer
  131668. */
  131669. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  131670. /**
  131671. * Update the content of a dynamic texture
  131672. * @param texture defines the texture to update
  131673. * @param canvas defines the canvas containing the source
  131674. * @param invertY defines if data must be stored with Y axis inverted
  131675. * @param premulAlpha defines if alpha is stored as premultiplied
  131676. * @param format defines the format of the data
  131677. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  131678. */
  131679. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  131680. /**
  131681. * Gets a boolean indicating if all created effects are ready
  131682. * @returns true if all effects are ready
  131683. */
  131684. areAllEffectsReady(): boolean;
  131685. /**
  131686. * @hidden
  131687. * Get the current error code of the webGL context
  131688. * @returns the error code
  131689. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  131690. */
  131691. getError(): number;
  131692. /** @hidden */
  131693. _getUnpackAlignement(): number;
  131694. /** @hidden */
  131695. _unpackFlipY(value: boolean): void;
  131696. /**
  131697. * Update a dynamic index buffer
  131698. * @param indexBuffer defines the target index buffer
  131699. * @param indices defines the data to update
  131700. * @param offset defines the offset in the target index buffer where update should start
  131701. */
  131702. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  131703. /**
  131704. * Updates a dynamic vertex buffer.
  131705. * @param vertexBuffer the vertex buffer to update
  131706. * @param vertices the data used to update the vertex buffer
  131707. * @param byteOffset the byte offset of the data (optional)
  131708. * @param byteLength the byte length of the data (optional)
  131709. */
  131710. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  131711. /** @hidden */
  131712. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  131713. /** @hidden */
  131714. _bindTexture(channel: number, texture: InternalTexture): void;
  131715. protected _deleteBuffer(buffer: WebGLBuffer): void;
  131716. /**
  131717. * 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
  131718. */
  131719. releaseEffects(): void;
  131720. displayLoadingUI(): void;
  131721. hideLoadingUI(): void;
  131722. /** @hidden */
  131723. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131724. /** @hidden */
  131725. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131726. /** @hidden */
  131727. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131728. /** @hidden */
  131729. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  131730. }
  131731. }
  131732. declare module BABYLON {
  131733. /**
  131734. * @hidden
  131735. **/
  131736. export class _TimeToken {
  131737. _startTimeQuery: Nullable<WebGLQuery>;
  131738. _endTimeQuery: Nullable<WebGLQuery>;
  131739. _timeElapsedQuery: Nullable<WebGLQuery>;
  131740. _timeElapsedQueryEnded: boolean;
  131741. }
  131742. }
  131743. declare module BABYLON {
  131744. /** @hidden */
  131745. export class _OcclusionDataStorage {
  131746. /** @hidden */
  131747. occlusionInternalRetryCounter: number;
  131748. /** @hidden */
  131749. isOcclusionQueryInProgress: boolean;
  131750. /** @hidden */
  131751. isOccluded: boolean;
  131752. /** @hidden */
  131753. occlusionRetryCount: number;
  131754. /** @hidden */
  131755. occlusionType: number;
  131756. /** @hidden */
  131757. occlusionQueryAlgorithmType: number;
  131758. }
  131759. interface Engine {
  131760. /**
  131761. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  131762. * @return the new query
  131763. */
  131764. createQuery(): WebGLQuery;
  131765. /**
  131766. * Delete and release a webGL query
  131767. * @param query defines the query to delete
  131768. * @return the current engine
  131769. */
  131770. deleteQuery(query: WebGLQuery): Engine;
  131771. /**
  131772. * Check if a given query has resolved and got its value
  131773. * @param query defines the query to check
  131774. * @returns true if the query got its value
  131775. */
  131776. isQueryResultAvailable(query: WebGLQuery): boolean;
  131777. /**
  131778. * Gets the value of a given query
  131779. * @param query defines the query to check
  131780. * @returns the value of the query
  131781. */
  131782. getQueryResult(query: WebGLQuery): number;
  131783. /**
  131784. * Initiates an occlusion query
  131785. * @param algorithmType defines the algorithm to use
  131786. * @param query defines the query to use
  131787. * @returns the current engine
  131788. * @see https://doc.babylonjs.com/features/occlusionquery
  131789. */
  131790. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  131791. /**
  131792. * Ends an occlusion query
  131793. * @see https://doc.babylonjs.com/features/occlusionquery
  131794. * @param algorithmType defines the algorithm to use
  131795. * @returns the current engine
  131796. */
  131797. endOcclusionQuery(algorithmType: number): Engine;
  131798. /**
  131799. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  131800. * Please note that only one query can be issued at a time
  131801. * @returns a time token used to track the time span
  131802. */
  131803. startTimeQuery(): Nullable<_TimeToken>;
  131804. /**
  131805. * Ends a time query
  131806. * @param token defines the token used to measure the time span
  131807. * @returns the time spent (in ns)
  131808. */
  131809. endTimeQuery(token: _TimeToken): int;
  131810. /** @hidden */
  131811. _currentNonTimestampToken: Nullable<_TimeToken>;
  131812. /** @hidden */
  131813. _createTimeQuery(): WebGLQuery;
  131814. /** @hidden */
  131815. _deleteTimeQuery(query: WebGLQuery): void;
  131816. /** @hidden */
  131817. _getGlAlgorithmType(algorithmType: number): number;
  131818. /** @hidden */
  131819. _getTimeQueryResult(query: WebGLQuery): any;
  131820. /** @hidden */
  131821. _getTimeQueryAvailability(query: WebGLQuery): any;
  131822. }
  131823. interface AbstractMesh {
  131824. /**
  131825. * Backing filed
  131826. * @hidden
  131827. */
  131828. __occlusionDataStorage: _OcclusionDataStorage;
  131829. /**
  131830. * Access property
  131831. * @hidden
  131832. */
  131833. _occlusionDataStorage: _OcclusionDataStorage;
  131834. /**
  131835. * 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.
  131836. * The default value is -1 which means don't break the query and wait till the result
  131837. * @see https://doc.babylonjs.com/features/occlusionquery
  131838. */
  131839. occlusionRetryCount: number;
  131840. /**
  131841. * 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:
  131842. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  131843. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  131844. * * 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.
  131845. * @see https://doc.babylonjs.com/features/occlusionquery
  131846. */
  131847. occlusionType: number;
  131848. /**
  131849. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  131850. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  131851. * * 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.
  131852. * @see https://doc.babylonjs.com/features/occlusionquery
  131853. */
  131854. occlusionQueryAlgorithmType: number;
  131855. /**
  131856. * 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
  131857. * @see https://doc.babylonjs.com/features/occlusionquery
  131858. */
  131859. isOccluded: boolean;
  131860. /**
  131861. * Flag to check the progress status of the query
  131862. * @see https://doc.babylonjs.com/features/occlusionquery
  131863. */
  131864. isOcclusionQueryInProgress: boolean;
  131865. }
  131866. }
  131867. declare module BABYLON {
  131868. /** @hidden */
  131869. export var _forceTransformFeedbackToBundle: boolean;
  131870. interface Engine {
  131871. /**
  131872. * Creates a webGL transform feedback object
  131873. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  131874. * @returns the webGL transform feedback object
  131875. */
  131876. createTransformFeedback(): WebGLTransformFeedback;
  131877. /**
  131878. * Delete a webGL transform feedback object
  131879. * @param value defines the webGL transform feedback object to delete
  131880. */
  131881. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  131882. /**
  131883. * Bind a webGL transform feedback object to the webgl context
  131884. * @param value defines the webGL transform feedback object to bind
  131885. */
  131886. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  131887. /**
  131888. * Begins a transform feedback operation
  131889. * @param usePoints defines if points or triangles must be used
  131890. */
  131891. beginTransformFeedback(usePoints: boolean): void;
  131892. /**
  131893. * Ends a transform feedback operation
  131894. */
  131895. endTransformFeedback(): void;
  131896. /**
  131897. * Specify the varyings to use with transform feedback
  131898. * @param program defines the associated webGL program
  131899. * @param value defines the list of strings representing the varying names
  131900. */
  131901. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  131902. /**
  131903. * Bind a webGL buffer for a transform feedback operation
  131904. * @param value defines the webGL buffer to bind
  131905. */
  131906. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  131907. }
  131908. }
  131909. declare module BABYLON {
  131910. /**
  131911. * Class used to define an additional view for the engine
  131912. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131913. */
  131914. export class EngineView {
  131915. /** Defines the canvas where to render the view */
  131916. target: HTMLCanvasElement;
  131917. /** Defines an optional camera used to render the view (will use active camera else) */
  131918. camera?: Camera;
  131919. }
  131920. interface Engine {
  131921. /**
  131922. * Gets or sets the HTML element to use for attaching events
  131923. */
  131924. inputElement: Nullable<HTMLElement>;
  131925. /**
  131926. * Gets the current engine view
  131927. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131928. */
  131929. activeView: Nullable<EngineView>;
  131930. /** Gets or sets the list of views */
  131931. views: EngineView[];
  131932. /**
  131933. * Register a new child canvas
  131934. * @param canvas defines the canvas to register
  131935. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  131936. * @returns the associated view
  131937. */
  131938. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  131939. /**
  131940. * Remove a registered child canvas
  131941. * @param canvas defines the canvas to remove
  131942. * @returns the current engine
  131943. */
  131944. unRegisterView(canvas: HTMLCanvasElement): Engine;
  131945. }
  131946. }
  131947. declare module BABYLON {
  131948. interface Engine {
  131949. /** @hidden */
  131950. _excludedCompressedTextures: string[];
  131951. /** @hidden */
  131952. _textureFormatInUse: string;
  131953. /**
  131954. * Gets the list of texture formats supported
  131955. */
  131956. readonly texturesSupported: Array<string>;
  131957. /**
  131958. * Gets the texture format in use
  131959. */
  131960. readonly textureFormatInUse: Nullable<string>;
  131961. /**
  131962. * Set the compressed texture extensions or file names to skip.
  131963. *
  131964. * @param skippedFiles defines the list of those texture files you want to skip
  131965. * Example: [".dds", ".env", "myfile.png"]
  131966. */
  131967. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  131968. /**
  131969. * Set the compressed texture format to use, based on the formats you have, and the formats
  131970. * supported by the hardware / browser.
  131971. *
  131972. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  131973. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  131974. * to API arguments needed to compressed textures. This puts the burden on the container
  131975. * generator to house the arcane code for determining these for current & future formats.
  131976. *
  131977. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  131978. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  131979. *
  131980. * Note: The result of this call is not taken into account when a texture is base64.
  131981. *
  131982. * @param formatsAvailable defines the list of those format families you have created
  131983. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  131984. *
  131985. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  131986. * @returns The extension selected.
  131987. */
  131988. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  131989. }
  131990. }
  131991. declare module BABYLON {
  131992. /**
  131993. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  131994. */
  131995. export interface CubeMapInfo {
  131996. /**
  131997. * The pixel array for the front face.
  131998. * This is stored in format, left to right, up to down format.
  131999. */
  132000. front: Nullable<ArrayBufferView>;
  132001. /**
  132002. * The pixel array for the back face.
  132003. * This is stored in format, left to right, up to down format.
  132004. */
  132005. back: Nullable<ArrayBufferView>;
  132006. /**
  132007. * The pixel array for the left face.
  132008. * This is stored in format, left to right, up to down format.
  132009. */
  132010. left: Nullable<ArrayBufferView>;
  132011. /**
  132012. * The pixel array for the right face.
  132013. * This is stored in format, left to right, up to down format.
  132014. */
  132015. right: Nullable<ArrayBufferView>;
  132016. /**
  132017. * The pixel array for the up face.
  132018. * This is stored in format, left to right, up to down format.
  132019. */
  132020. up: Nullable<ArrayBufferView>;
  132021. /**
  132022. * The pixel array for the down face.
  132023. * This is stored in format, left to right, up to down format.
  132024. */
  132025. down: Nullable<ArrayBufferView>;
  132026. /**
  132027. * The size of the cubemap stored.
  132028. *
  132029. * Each faces will be size * size pixels.
  132030. */
  132031. size: number;
  132032. /**
  132033. * The format of the texture.
  132034. *
  132035. * RGBA, RGB.
  132036. */
  132037. format: number;
  132038. /**
  132039. * The type of the texture data.
  132040. *
  132041. * UNSIGNED_INT, FLOAT.
  132042. */
  132043. type: number;
  132044. /**
  132045. * Specifies whether the texture is in gamma space.
  132046. */
  132047. gammaSpace: boolean;
  132048. }
  132049. /**
  132050. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  132051. */
  132052. export class PanoramaToCubeMapTools {
  132053. private static FACE_LEFT;
  132054. private static FACE_RIGHT;
  132055. private static FACE_FRONT;
  132056. private static FACE_BACK;
  132057. private static FACE_DOWN;
  132058. private static FACE_UP;
  132059. /**
  132060. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  132061. *
  132062. * @param float32Array The source data.
  132063. * @param inputWidth The width of the input panorama.
  132064. * @param inputHeight The height of the input panorama.
  132065. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  132066. * @return The cubemap data
  132067. */
  132068. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  132069. private static CreateCubemapTexture;
  132070. private static CalcProjectionSpherical;
  132071. }
  132072. }
  132073. declare module BABYLON {
  132074. /**
  132075. * Helper class dealing with the extraction of spherical polynomial dataArray
  132076. * from a cube map.
  132077. */
  132078. export class CubeMapToSphericalPolynomialTools {
  132079. private static FileFaces;
  132080. /**
  132081. * Converts a texture to the according Spherical Polynomial data.
  132082. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132083. *
  132084. * @param texture The texture to extract the information from.
  132085. * @return The Spherical Polynomial data.
  132086. */
  132087. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  132088. /**
  132089. * Converts a cubemap to the according Spherical Polynomial data.
  132090. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132091. *
  132092. * @param cubeInfo The Cube map to extract the information from.
  132093. * @return The Spherical Polynomial data.
  132094. */
  132095. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  132096. }
  132097. }
  132098. declare module BABYLON {
  132099. interface BaseTexture {
  132100. /**
  132101. * Get the polynomial representation of the texture data.
  132102. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  132103. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  132104. */
  132105. sphericalPolynomial: Nullable<SphericalPolynomial>;
  132106. }
  132107. }
  132108. declare module BABYLON {
  132109. /** @hidden */
  132110. export var rgbdEncodePixelShader: {
  132111. name: string;
  132112. shader: string;
  132113. };
  132114. }
  132115. declare module BABYLON {
  132116. /** @hidden */
  132117. export var rgbdDecodePixelShader: {
  132118. name: string;
  132119. shader: string;
  132120. };
  132121. }
  132122. declare module BABYLON {
  132123. /**
  132124. * Raw texture data and descriptor sufficient for WebGL texture upload
  132125. */
  132126. export interface EnvironmentTextureInfo {
  132127. /**
  132128. * Version of the environment map
  132129. */
  132130. version: number;
  132131. /**
  132132. * Width of image
  132133. */
  132134. width: number;
  132135. /**
  132136. * Irradiance information stored in the file.
  132137. */
  132138. irradiance: any;
  132139. /**
  132140. * Specular information stored in the file.
  132141. */
  132142. specular: any;
  132143. }
  132144. /**
  132145. * Defines One Image in the file. It requires only the position in the file
  132146. * as well as the length.
  132147. */
  132148. interface BufferImageData {
  132149. /**
  132150. * Length of the image data.
  132151. */
  132152. length: number;
  132153. /**
  132154. * Position of the data from the null terminator delimiting the end of the JSON.
  132155. */
  132156. position: number;
  132157. }
  132158. /**
  132159. * Defines the specular data enclosed in the file.
  132160. * This corresponds to the version 1 of the data.
  132161. */
  132162. export interface EnvironmentTextureSpecularInfoV1 {
  132163. /**
  132164. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  132165. */
  132166. specularDataPosition?: number;
  132167. /**
  132168. * This contains all the images data needed to reconstruct the cubemap.
  132169. */
  132170. mipmaps: Array<BufferImageData>;
  132171. /**
  132172. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  132173. */
  132174. lodGenerationScale: number;
  132175. }
  132176. /**
  132177. * Sets of helpers addressing the serialization and deserialization of environment texture
  132178. * stored in a BabylonJS env file.
  132179. * Those files are usually stored as .env files.
  132180. */
  132181. export class EnvironmentTextureTools {
  132182. /**
  132183. * Magic number identifying the env file.
  132184. */
  132185. private static _MagicBytes;
  132186. /**
  132187. * Gets the environment info from an env file.
  132188. * @param data The array buffer containing the .env bytes.
  132189. * @returns the environment file info (the json header) if successfully parsed.
  132190. */
  132191. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  132192. /**
  132193. * Creates an environment texture from a loaded cube texture.
  132194. * @param texture defines the cube texture to convert in env file
  132195. * @return a promise containing the environment data if succesfull.
  132196. */
  132197. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  132198. /**
  132199. * Creates a JSON representation of the spherical data.
  132200. * @param texture defines the texture containing the polynomials
  132201. * @return the JSON representation of the spherical info
  132202. */
  132203. private static _CreateEnvTextureIrradiance;
  132204. /**
  132205. * Creates the ArrayBufferViews used for initializing environment texture image data.
  132206. * @param data the image data
  132207. * @param info parameters that determine what views will be created for accessing the underlying buffer
  132208. * @return the views described by info providing access to the underlying buffer
  132209. */
  132210. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  132211. /**
  132212. * Uploads the texture info contained in the env file to the GPU.
  132213. * @param texture defines the internal texture to upload to
  132214. * @param data defines the data to load
  132215. * @param info defines the texture info retrieved through the GetEnvInfo method
  132216. * @returns a promise
  132217. */
  132218. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  132219. private static _OnImageReadyAsync;
  132220. /**
  132221. * Uploads the levels of image data to the GPU.
  132222. * @param texture defines the internal texture to upload to
  132223. * @param imageData defines the array buffer views of image data [mipmap][face]
  132224. * @returns a promise
  132225. */
  132226. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  132227. /**
  132228. * Uploads spherical polynomials information to the texture.
  132229. * @param texture defines the texture we are trying to upload the information to
  132230. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  132231. */
  132232. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  132233. /** @hidden */
  132234. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  132235. }
  132236. }
  132237. declare module BABYLON {
  132238. /**
  132239. * Class used to inline functions in shader code
  132240. */
  132241. export class ShaderCodeInliner {
  132242. private static readonly _RegexpFindFunctionNameAndType;
  132243. private _sourceCode;
  132244. private _functionDescr;
  132245. private _numMaxIterations;
  132246. /** Gets or sets the token used to mark the functions to inline */
  132247. inlineToken: string;
  132248. /** Gets or sets the debug mode */
  132249. debug: boolean;
  132250. /** Gets the code after the inlining process */
  132251. get code(): string;
  132252. /**
  132253. * Initializes the inliner
  132254. * @param sourceCode shader code source to inline
  132255. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  132256. */
  132257. constructor(sourceCode: string, numMaxIterations?: number);
  132258. /**
  132259. * Start the processing of the shader code
  132260. */
  132261. processCode(): void;
  132262. private _collectFunctions;
  132263. private _processInlining;
  132264. private _extractBetweenMarkers;
  132265. private _skipWhitespaces;
  132266. private _removeComments;
  132267. private _replaceFunctionCallsByCode;
  132268. private _findBackward;
  132269. private _escapeRegExp;
  132270. private _replaceNames;
  132271. }
  132272. }
  132273. declare module BABYLON {
  132274. /**
  132275. * Container for accessors for natively-stored mesh data buffers.
  132276. */
  132277. class NativeDataBuffer extends DataBuffer {
  132278. /**
  132279. * Accessor value used to identify/retrieve a natively-stored index buffer.
  132280. */
  132281. nativeIndexBuffer?: any;
  132282. /**
  132283. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  132284. */
  132285. nativeVertexBuffer?: any;
  132286. }
  132287. /** @hidden */
  132288. class NativeTexture extends InternalTexture {
  132289. getInternalTexture(): InternalTexture;
  132290. getViewCount(): number;
  132291. }
  132292. /** @hidden */
  132293. export class NativeEngine extends Engine {
  132294. private readonly _native;
  132295. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  132296. private readonly INVALID_HANDLE;
  132297. private _boundBuffersVertexArray;
  132298. getHardwareScalingLevel(): number;
  132299. constructor();
  132300. dispose(): void;
  132301. /**
  132302. * Can be used to override the current requestAnimationFrame requester.
  132303. * @hidden
  132304. */
  132305. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  132306. /**
  132307. * Override default engine behavior.
  132308. * @param color
  132309. * @param backBuffer
  132310. * @param depth
  132311. * @param stencil
  132312. */
  132313. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  132314. /**
  132315. * Gets host document
  132316. * @returns the host document object
  132317. */
  132318. getHostDocument(): Nullable<Document>;
  132319. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  132320. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  132321. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  132322. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  132323. [key: string]: VertexBuffer;
  132324. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132325. bindBuffers(vertexBuffers: {
  132326. [key: string]: VertexBuffer;
  132327. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132328. recordVertexArrayObject(vertexBuffers: {
  132329. [key: string]: VertexBuffer;
  132330. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  132331. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132332. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132333. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  132334. /**
  132335. * Draw a list of indexed primitives
  132336. * @param fillMode defines the primitive to use
  132337. * @param indexStart defines the starting index
  132338. * @param indexCount defines the number of index to draw
  132339. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132340. */
  132341. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  132342. /**
  132343. * Draw a list of unindexed primitives
  132344. * @param fillMode defines the primitive to use
  132345. * @param verticesStart defines the index of first vertex to draw
  132346. * @param verticesCount defines the count of vertices to draw
  132347. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132348. */
  132349. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  132350. createPipelineContext(): IPipelineContext;
  132351. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  132352. /** @hidden */
  132353. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  132354. /** @hidden */
  132355. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  132356. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132357. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132358. protected _setProgram(program: WebGLProgram): void;
  132359. _releaseEffect(effect: Effect): void;
  132360. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  132361. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  132362. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  132363. bindSamplers(effect: Effect): void;
  132364. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  132365. getRenderWidth(useScreen?: boolean): number;
  132366. getRenderHeight(useScreen?: boolean): number;
  132367. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  132368. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  132369. /**
  132370. * Set the z offset to apply to current rendering
  132371. * @param value defines the offset to apply
  132372. */
  132373. setZOffset(value: number): void;
  132374. /**
  132375. * Gets the current value of the zOffset
  132376. * @returns the current zOffset state
  132377. */
  132378. getZOffset(): number;
  132379. /**
  132380. * Enable or disable depth buffering
  132381. * @param enable defines the state to set
  132382. */
  132383. setDepthBuffer(enable: boolean): void;
  132384. /**
  132385. * Gets a boolean indicating if depth writing is enabled
  132386. * @returns the current depth writing state
  132387. */
  132388. getDepthWrite(): boolean;
  132389. /**
  132390. * Enable or disable depth writing
  132391. * @param enable defines the state to set
  132392. */
  132393. setDepthWrite(enable: boolean): void;
  132394. /**
  132395. * Enable or disable color writing
  132396. * @param enable defines the state to set
  132397. */
  132398. setColorWrite(enable: boolean): void;
  132399. /**
  132400. * Gets a boolean indicating if color writing is enabled
  132401. * @returns the current color writing state
  132402. */
  132403. getColorWrite(): boolean;
  132404. /**
  132405. * Sets alpha constants used by some alpha blending modes
  132406. * @param r defines the red component
  132407. * @param g defines the green component
  132408. * @param b defines the blue component
  132409. * @param a defines the alpha component
  132410. */
  132411. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  132412. /**
  132413. * Sets the current alpha mode
  132414. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  132415. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  132416. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132417. */
  132418. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  132419. /**
  132420. * Gets the current alpha mode
  132421. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132422. * @returns the current alpha mode
  132423. */
  132424. getAlphaMode(): number;
  132425. setInt(uniform: WebGLUniformLocation, int: number): void;
  132426. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  132427. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  132428. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  132429. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  132430. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  132431. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  132432. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  132433. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  132434. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  132435. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  132436. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  132437. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  132438. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  132439. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132440. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132441. setFloat(uniform: WebGLUniformLocation, value: number): void;
  132442. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  132443. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  132444. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  132445. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  132446. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  132447. wipeCaches(bruteForce?: boolean): void;
  132448. _createTexture(): WebGLTexture;
  132449. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  132450. /**
  132451. * Usually called from Texture.ts.
  132452. * Passed information to create a WebGLTexture
  132453. * @param url defines a value which contains one of the following:
  132454. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  132455. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  132456. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  132457. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  132458. * @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)
  132459. * @param scene needed for loading to the correct scene
  132460. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  132461. * @param onLoad optional callback to be called upon successful completion
  132462. * @param onError optional callback to be called upon failure
  132463. * @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
  132464. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  132465. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  132466. * @param forcedExtension defines the extension to use to pick the right loader
  132467. * @param mimeType defines an optional mime type
  132468. * @returns a InternalTexture for assignment back into BABYLON.Texture
  132469. */
  132470. 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;
  132471. /**
  132472. * Creates a cube texture
  132473. * @param rootUrl defines the url where the files to load is located
  132474. * @param scene defines the current scene
  132475. * @param files defines the list of files to load (1 per face)
  132476. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  132477. * @param onLoad defines an optional callback raised when the texture is loaded
  132478. * @param onError defines an optional callback raised if there is an issue to load the texture
  132479. * @param format defines the format of the data
  132480. * @param forcedExtension defines the extension to use to pick the right loader
  132481. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  132482. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  132483. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  132484. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  132485. * @returns the cube texture as an InternalTexture
  132486. */
  132487. 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;
  132488. private _getSamplingFilter;
  132489. private static _GetNativeTextureFormat;
  132490. createRenderTargetTexture(size: number | {
  132491. width: number;
  132492. height: number;
  132493. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  132494. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  132495. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  132496. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  132497. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  132498. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  132499. /**
  132500. * Updates a dynamic vertex buffer.
  132501. * @param vertexBuffer the vertex buffer to update
  132502. * @param data the data used to update the vertex buffer
  132503. * @param byteOffset the byte offset of the data (optional)
  132504. * @param byteLength the byte length of the data (optional)
  132505. */
  132506. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  132507. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  132508. private _updateAnisotropicLevel;
  132509. private _getAddressMode;
  132510. /** @hidden */
  132511. _bindTexture(channel: number, texture: InternalTexture): void;
  132512. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  132513. releaseEffects(): void;
  132514. /** @hidden */
  132515. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132516. /** @hidden */
  132517. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132518. /** @hidden */
  132519. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132520. /** @hidden */
  132521. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  132522. }
  132523. }
  132524. declare module BABYLON {
  132525. /**
  132526. * Gather the list of clipboard event types as constants.
  132527. */
  132528. export class ClipboardEventTypes {
  132529. /**
  132530. * The clipboard event is fired when a copy command is active (pressed).
  132531. */
  132532. static readonly COPY: number;
  132533. /**
  132534. * The clipboard event is fired when a cut command is active (pressed).
  132535. */
  132536. static readonly CUT: number;
  132537. /**
  132538. * The clipboard event is fired when a paste command is active (pressed).
  132539. */
  132540. static readonly PASTE: number;
  132541. }
  132542. /**
  132543. * This class is used to store clipboard related info for the onClipboardObservable event.
  132544. */
  132545. export class ClipboardInfo {
  132546. /**
  132547. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132548. */
  132549. type: number;
  132550. /**
  132551. * Defines the related dom event
  132552. */
  132553. event: ClipboardEvent;
  132554. /**
  132555. *Creates an instance of ClipboardInfo.
  132556. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  132557. * @param event Defines the related dom event
  132558. */
  132559. constructor(
  132560. /**
  132561. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132562. */
  132563. type: number,
  132564. /**
  132565. * Defines the related dom event
  132566. */
  132567. event: ClipboardEvent);
  132568. /**
  132569. * Get the clipboard event's type from the keycode.
  132570. * @param keyCode Defines the keyCode for the current keyboard event.
  132571. * @return {number}
  132572. */
  132573. static GetTypeFromCharacter(keyCode: number): number;
  132574. }
  132575. }
  132576. declare module BABYLON {
  132577. /**
  132578. * Google Daydream controller
  132579. */
  132580. export class DaydreamController extends WebVRController {
  132581. /**
  132582. * Base Url for the controller model.
  132583. */
  132584. static MODEL_BASE_URL: string;
  132585. /**
  132586. * File name for the controller model.
  132587. */
  132588. static MODEL_FILENAME: string;
  132589. /**
  132590. * Gamepad Id prefix used to identify Daydream Controller.
  132591. */
  132592. static readonly GAMEPAD_ID_PREFIX: string;
  132593. /**
  132594. * Creates a new DaydreamController from a gamepad
  132595. * @param vrGamepad the gamepad that the controller should be created from
  132596. */
  132597. constructor(vrGamepad: any);
  132598. /**
  132599. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132600. * @param scene scene in which to add meshes
  132601. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132602. */
  132603. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132604. /**
  132605. * Called once for each button that changed state since the last frame
  132606. * @param buttonIdx Which button index changed
  132607. * @param state New state of the button
  132608. * @param changes Which properties on the state changed since last frame
  132609. */
  132610. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132611. }
  132612. }
  132613. declare module BABYLON {
  132614. /**
  132615. * Gear VR Controller
  132616. */
  132617. export class GearVRController extends WebVRController {
  132618. /**
  132619. * Base Url for the controller model.
  132620. */
  132621. static MODEL_BASE_URL: string;
  132622. /**
  132623. * File name for the controller model.
  132624. */
  132625. static MODEL_FILENAME: string;
  132626. /**
  132627. * Gamepad Id prefix used to identify this controller.
  132628. */
  132629. static readonly GAMEPAD_ID_PREFIX: string;
  132630. private readonly _buttonIndexToObservableNameMap;
  132631. /**
  132632. * Creates a new GearVRController from a gamepad
  132633. * @param vrGamepad the gamepad that the controller should be created from
  132634. */
  132635. constructor(vrGamepad: any);
  132636. /**
  132637. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132638. * @param scene scene in which to add meshes
  132639. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132640. */
  132641. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132642. /**
  132643. * Called once for each button that changed state since the last frame
  132644. * @param buttonIdx Which button index changed
  132645. * @param state New state of the button
  132646. * @param changes Which properties on the state changed since last frame
  132647. */
  132648. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132649. }
  132650. }
  132651. declare module BABYLON {
  132652. /**
  132653. * Generic Controller
  132654. */
  132655. export class GenericController extends WebVRController {
  132656. /**
  132657. * Base Url for the controller model.
  132658. */
  132659. static readonly MODEL_BASE_URL: string;
  132660. /**
  132661. * File name for the controller model.
  132662. */
  132663. static readonly MODEL_FILENAME: string;
  132664. /**
  132665. * Creates a new GenericController from a gamepad
  132666. * @param vrGamepad the gamepad that the controller should be created from
  132667. */
  132668. constructor(vrGamepad: any);
  132669. /**
  132670. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132671. * @param scene scene in which to add meshes
  132672. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132673. */
  132674. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132675. /**
  132676. * Called once for each button that changed state since the last frame
  132677. * @param buttonIdx Which button index changed
  132678. * @param state New state of the button
  132679. * @param changes Which properties on the state changed since last frame
  132680. */
  132681. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132682. }
  132683. }
  132684. declare module BABYLON {
  132685. /**
  132686. * Oculus Touch Controller
  132687. */
  132688. export class OculusTouchController extends WebVRController {
  132689. /**
  132690. * Base Url for the controller model.
  132691. */
  132692. static MODEL_BASE_URL: string;
  132693. /**
  132694. * File name for the left controller model.
  132695. */
  132696. static MODEL_LEFT_FILENAME: string;
  132697. /**
  132698. * File name for the right controller model.
  132699. */
  132700. static MODEL_RIGHT_FILENAME: string;
  132701. /**
  132702. * Base Url for the Quest controller model.
  132703. */
  132704. static QUEST_MODEL_BASE_URL: string;
  132705. /**
  132706. * @hidden
  132707. * If the controllers are running on a device that needs the updated Quest controller models
  132708. */
  132709. static _IsQuest: boolean;
  132710. /**
  132711. * Fired when the secondary trigger on this controller is modified
  132712. */
  132713. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  132714. /**
  132715. * Fired when the thumb rest on this controller is modified
  132716. */
  132717. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  132718. /**
  132719. * Creates a new OculusTouchController from a gamepad
  132720. * @param vrGamepad the gamepad that the controller should be created from
  132721. */
  132722. constructor(vrGamepad: any);
  132723. /**
  132724. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132725. * @param scene scene in which to add meshes
  132726. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132727. */
  132728. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132729. /**
  132730. * Fired when the A button on this controller is modified
  132731. */
  132732. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132733. /**
  132734. * Fired when the B button on this controller is modified
  132735. */
  132736. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132737. /**
  132738. * Fired when the X button on this controller is modified
  132739. */
  132740. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132741. /**
  132742. * Fired when the Y button on this controller is modified
  132743. */
  132744. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132745. /**
  132746. * Called once for each button that changed state since the last frame
  132747. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  132748. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  132749. * 2) secondary trigger (same)
  132750. * 3) A (right) X (left), touch, pressed = value
  132751. * 4) B / Y
  132752. * 5) thumb rest
  132753. * @param buttonIdx Which button index changed
  132754. * @param state New state of the button
  132755. * @param changes Which properties on the state changed since last frame
  132756. */
  132757. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132758. }
  132759. }
  132760. declare module BABYLON {
  132761. /**
  132762. * Vive Controller
  132763. */
  132764. export class ViveController extends WebVRController {
  132765. /**
  132766. * Base Url for the controller model.
  132767. */
  132768. static MODEL_BASE_URL: string;
  132769. /**
  132770. * File name for the controller model.
  132771. */
  132772. static MODEL_FILENAME: string;
  132773. /**
  132774. * Creates a new ViveController from a gamepad
  132775. * @param vrGamepad the gamepad that the controller should be created from
  132776. */
  132777. constructor(vrGamepad: any);
  132778. /**
  132779. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132780. * @param scene scene in which to add meshes
  132781. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132782. */
  132783. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132784. /**
  132785. * Fired when the left button on this controller is modified
  132786. */
  132787. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132788. /**
  132789. * Fired when the right button on this controller is modified
  132790. */
  132791. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132792. /**
  132793. * Fired when the menu button on this controller is modified
  132794. */
  132795. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132796. /**
  132797. * Called once for each button that changed state since the last frame
  132798. * Vive mapping:
  132799. * 0: touchpad
  132800. * 1: trigger
  132801. * 2: left AND right buttons
  132802. * 3: menu button
  132803. * @param buttonIdx Which button index changed
  132804. * @param state New state of the button
  132805. * @param changes Which properties on the state changed since last frame
  132806. */
  132807. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132808. }
  132809. }
  132810. declare module BABYLON {
  132811. /**
  132812. * Defines the WindowsMotionController object that the state of the windows motion controller
  132813. */
  132814. export class WindowsMotionController extends WebVRController {
  132815. /**
  132816. * The base url used to load the left and right controller models
  132817. */
  132818. static MODEL_BASE_URL: string;
  132819. /**
  132820. * The name of the left controller model file
  132821. */
  132822. static MODEL_LEFT_FILENAME: string;
  132823. /**
  132824. * The name of the right controller model file
  132825. */
  132826. static MODEL_RIGHT_FILENAME: string;
  132827. /**
  132828. * The controller name prefix for this controller type
  132829. */
  132830. static readonly GAMEPAD_ID_PREFIX: string;
  132831. /**
  132832. * The controller id pattern for this controller type
  132833. */
  132834. private static readonly GAMEPAD_ID_PATTERN;
  132835. private _loadedMeshInfo;
  132836. protected readonly _mapping: {
  132837. buttons: string[];
  132838. buttonMeshNames: {
  132839. trigger: string;
  132840. menu: string;
  132841. grip: string;
  132842. thumbstick: string;
  132843. trackpad: string;
  132844. };
  132845. buttonObservableNames: {
  132846. trigger: string;
  132847. menu: string;
  132848. grip: string;
  132849. thumbstick: string;
  132850. trackpad: string;
  132851. };
  132852. axisMeshNames: string[];
  132853. pointingPoseMeshName: string;
  132854. };
  132855. /**
  132856. * Fired when the trackpad on this controller is clicked
  132857. */
  132858. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132859. /**
  132860. * Fired when the trackpad on this controller is modified
  132861. */
  132862. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132863. /**
  132864. * The current x and y values of this controller's trackpad
  132865. */
  132866. trackpad: StickValues;
  132867. /**
  132868. * Creates a new WindowsMotionController from a gamepad
  132869. * @param vrGamepad the gamepad that the controller should be created from
  132870. */
  132871. constructor(vrGamepad: any);
  132872. /**
  132873. * Fired when the trigger on this controller is modified
  132874. */
  132875. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132876. /**
  132877. * Fired when the menu button on this controller is modified
  132878. */
  132879. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132880. /**
  132881. * Fired when the grip button on this controller is modified
  132882. */
  132883. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132884. /**
  132885. * Fired when the thumbstick button on this controller is modified
  132886. */
  132887. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132888. /**
  132889. * Fired when the touchpad button on this controller is modified
  132890. */
  132891. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132892. /**
  132893. * Fired when the touchpad values on this controller are modified
  132894. */
  132895. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  132896. protected _updateTrackpad(): void;
  132897. /**
  132898. * Called once per frame by the engine.
  132899. */
  132900. update(): void;
  132901. /**
  132902. * Called once for each button that changed state since the last frame
  132903. * @param buttonIdx Which button index changed
  132904. * @param state New state of the button
  132905. * @param changes Which properties on the state changed since last frame
  132906. */
  132907. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132908. /**
  132909. * Moves the buttons on the controller mesh based on their current state
  132910. * @param buttonName the name of the button to move
  132911. * @param buttonValue the value of the button which determines the buttons new position
  132912. */
  132913. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  132914. /**
  132915. * Moves the axis on the controller mesh based on its current state
  132916. * @param axis the index of the axis
  132917. * @param axisValue the value of the axis which determines the meshes new position
  132918. * @hidden
  132919. */
  132920. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  132921. /**
  132922. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132923. * @param scene scene in which to add meshes
  132924. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132925. */
  132926. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  132927. /**
  132928. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  132929. * can be transformed by button presses and axes values, based on this._mapping.
  132930. *
  132931. * @param scene scene in which the meshes exist
  132932. * @param meshes list of meshes that make up the controller model to process
  132933. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  132934. */
  132935. private processModel;
  132936. private createMeshInfo;
  132937. /**
  132938. * Gets the ray of the controller in the direction the controller is pointing
  132939. * @param length the length the resulting ray should be
  132940. * @returns a ray in the direction the controller is pointing
  132941. */
  132942. getForwardRay(length?: number): Ray;
  132943. /**
  132944. * Disposes of the controller
  132945. */
  132946. dispose(): void;
  132947. }
  132948. /**
  132949. * This class represents a new windows motion controller in XR.
  132950. */
  132951. export class XRWindowsMotionController extends WindowsMotionController {
  132952. /**
  132953. * Changing the original WIndowsMotionController mapping to fir the new mapping
  132954. */
  132955. protected readonly _mapping: {
  132956. buttons: string[];
  132957. buttonMeshNames: {
  132958. trigger: string;
  132959. menu: string;
  132960. grip: string;
  132961. thumbstick: string;
  132962. trackpad: string;
  132963. };
  132964. buttonObservableNames: {
  132965. trigger: string;
  132966. menu: string;
  132967. grip: string;
  132968. thumbstick: string;
  132969. trackpad: string;
  132970. };
  132971. axisMeshNames: string[];
  132972. pointingPoseMeshName: string;
  132973. };
  132974. /**
  132975. * Construct a new XR-Based windows motion controller
  132976. *
  132977. * @param gamepadInfo the gamepad object from the browser
  132978. */
  132979. constructor(gamepadInfo: any);
  132980. /**
  132981. * holds the thumbstick values (X,Y)
  132982. */
  132983. thumbstickValues: StickValues;
  132984. /**
  132985. * Fired when the thumbstick on this controller is clicked
  132986. */
  132987. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  132988. /**
  132989. * Fired when the thumbstick on this controller is modified
  132990. */
  132991. onThumbstickValuesChangedObservable: Observable<StickValues>;
  132992. /**
  132993. * Fired when the touchpad button on this controller is modified
  132994. */
  132995. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132996. /**
  132997. * Fired when the touchpad values on this controller are modified
  132998. */
  132999. onTrackpadValuesChangedObservable: Observable<StickValues>;
  133000. /**
  133001. * Fired when the thumbstick button on this controller is modified
  133002. * here to prevent breaking changes
  133003. */
  133004. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133005. /**
  133006. * updating the thumbstick(!) and not the trackpad.
  133007. * This is named this way due to the difference between WebVR and XR and to avoid
  133008. * changing the parent class.
  133009. */
  133010. protected _updateTrackpad(): void;
  133011. /**
  133012. * Disposes the class with joy
  133013. */
  133014. dispose(): void;
  133015. }
  133016. }
  133017. declare module BABYLON {
  133018. /**
  133019. * Class containing static functions to help procedurally build meshes
  133020. */
  133021. export class PolyhedronBuilder {
  133022. /**
  133023. * Creates a polyhedron mesh
  133024. * * 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
  133025. * * The parameter `size` (positive float, default 1) sets the polygon size
  133026. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  133027. * * 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`
  133028. * * 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
  133029. * * 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)`)
  133030. * * 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
  133031. * * 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
  133032. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  133033. * * 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
  133034. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  133035. * @param name defines the name of the mesh
  133036. * @param options defines the options used to create the mesh
  133037. * @param scene defines the hosting scene
  133038. * @returns the polyhedron mesh
  133039. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  133040. */
  133041. static CreatePolyhedron(name: string, options: {
  133042. type?: number;
  133043. size?: number;
  133044. sizeX?: number;
  133045. sizeY?: number;
  133046. sizeZ?: number;
  133047. custom?: any;
  133048. faceUV?: Vector4[];
  133049. faceColors?: Color4[];
  133050. flat?: boolean;
  133051. updatable?: boolean;
  133052. sideOrientation?: number;
  133053. frontUVs?: Vector4;
  133054. backUVs?: Vector4;
  133055. }, scene?: Nullable<Scene>): Mesh;
  133056. }
  133057. }
  133058. declare module BABYLON {
  133059. /**
  133060. * Gizmo that enables scaling a mesh along 3 axis
  133061. */
  133062. export class ScaleGizmo extends Gizmo {
  133063. /**
  133064. * Internal gizmo used for interactions on the x axis
  133065. */
  133066. xGizmo: AxisScaleGizmo;
  133067. /**
  133068. * Internal gizmo used for interactions on the y axis
  133069. */
  133070. yGizmo: AxisScaleGizmo;
  133071. /**
  133072. * Internal gizmo used for interactions on the z axis
  133073. */
  133074. zGizmo: AxisScaleGizmo;
  133075. /**
  133076. * Internal gizmo used to scale all axis equally
  133077. */
  133078. uniformScaleGizmo: AxisScaleGizmo;
  133079. private _meshAttached;
  133080. private _nodeAttached;
  133081. private _snapDistance;
  133082. private _uniformScalingMesh;
  133083. private _octahedron;
  133084. private _sensitivity;
  133085. /** Fires an event when any of it's sub gizmos are dragged */
  133086. onDragStartObservable: Observable<unknown>;
  133087. /** Fires an event when any of it's sub gizmos are released from dragging */
  133088. onDragEndObservable: Observable<unknown>;
  133089. get attachedMesh(): Nullable<AbstractMesh>;
  133090. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133091. get attachedNode(): Nullable<Node>;
  133092. set attachedNode(node: Nullable<Node>);
  133093. /**
  133094. * Creates a ScaleGizmo
  133095. * @param gizmoLayer The utility layer the gizmo will be added to
  133096. * @param thickness display gizmo axis thickness
  133097. */
  133098. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  133099. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133100. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133101. /**
  133102. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133103. */
  133104. set snapDistance(value: number);
  133105. get snapDistance(): number;
  133106. /**
  133107. * Ratio for the scale of the gizmo (Default: 1)
  133108. */
  133109. set scaleRatio(value: number);
  133110. get scaleRatio(): number;
  133111. /**
  133112. * Sensitivity factor for dragging (Default: 1)
  133113. */
  133114. set sensitivity(value: number);
  133115. get sensitivity(): number;
  133116. /**
  133117. * Disposes of the gizmo
  133118. */
  133119. dispose(): void;
  133120. }
  133121. }
  133122. declare module BABYLON {
  133123. /**
  133124. * Single axis scale gizmo
  133125. */
  133126. export class AxisScaleGizmo extends Gizmo {
  133127. /**
  133128. * Drag behavior responsible for the gizmos dragging interactions
  133129. */
  133130. dragBehavior: PointerDragBehavior;
  133131. private _pointerObserver;
  133132. /**
  133133. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133134. */
  133135. snapDistance: number;
  133136. /**
  133137. * Event that fires each time the gizmo snaps to a new location.
  133138. * * snapDistance is the the change in distance
  133139. */
  133140. onSnapObservable: Observable<{
  133141. snapDistance: number;
  133142. }>;
  133143. /**
  133144. * If the scaling operation should be done on all axis (default: false)
  133145. */
  133146. uniformScaling: boolean;
  133147. /**
  133148. * Custom sensitivity value for the drag strength
  133149. */
  133150. sensitivity: number;
  133151. private _isEnabled;
  133152. private _parent;
  133153. private _arrow;
  133154. private _coloredMaterial;
  133155. private _hoverMaterial;
  133156. /**
  133157. * Creates an AxisScaleGizmo
  133158. * @param gizmoLayer The utility layer the gizmo will be added to
  133159. * @param dragAxis The axis which the gizmo will be able to scale on
  133160. * @param color The color of the gizmo
  133161. * @param thickness display gizmo axis thickness
  133162. */
  133163. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  133164. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133165. /**
  133166. * If the gizmo is enabled
  133167. */
  133168. set isEnabled(value: boolean);
  133169. get isEnabled(): boolean;
  133170. /**
  133171. * Disposes of the gizmo
  133172. */
  133173. dispose(): void;
  133174. /**
  133175. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  133176. * @param mesh The mesh to replace the default mesh of the gizmo
  133177. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  133178. */
  133179. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  133180. }
  133181. }
  133182. declare module BABYLON {
  133183. /**
  133184. * Bounding box gizmo
  133185. */
  133186. export class BoundingBoxGizmo extends Gizmo {
  133187. private _lineBoundingBox;
  133188. private _rotateSpheresParent;
  133189. private _scaleBoxesParent;
  133190. private _boundingDimensions;
  133191. private _renderObserver;
  133192. private _pointerObserver;
  133193. private _scaleDragSpeed;
  133194. private _tmpQuaternion;
  133195. private _tmpVector;
  133196. private _tmpRotationMatrix;
  133197. /**
  133198. * 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)
  133199. */
  133200. ignoreChildren: boolean;
  133201. /**
  133202. * 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)
  133203. */
  133204. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  133205. /**
  133206. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  133207. */
  133208. rotationSphereSize: number;
  133209. /**
  133210. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  133211. */
  133212. scaleBoxSize: number;
  133213. /**
  133214. * 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)
  133215. */
  133216. fixedDragMeshScreenSize: boolean;
  133217. /**
  133218. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  133219. */
  133220. fixedDragMeshScreenSizeDistanceFactor: number;
  133221. /**
  133222. * Fired when a rotation sphere or scale box is dragged
  133223. */
  133224. onDragStartObservable: Observable<{}>;
  133225. /**
  133226. * Fired when a scale box is dragged
  133227. */
  133228. onScaleBoxDragObservable: Observable<{}>;
  133229. /**
  133230. * Fired when a scale box drag is ended
  133231. */
  133232. onScaleBoxDragEndObservable: Observable<{}>;
  133233. /**
  133234. * Fired when a rotation sphere is dragged
  133235. */
  133236. onRotationSphereDragObservable: Observable<{}>;
  133237. /**
  133238. * Fired when a rotation sphere drag is ended
  133239. */
  133240. onRotationSphereDragEndObservable: Observable<{}>;
  133241. /**
  133242. * 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)
  133243. */
  133244. scalePivot: Nullable<Vector3>;
  133245. /**
  133246. * Mesh used as a pivot to rotate the attached node
  133247. */
  133248. private _anchorMesh;
  133249. private _existingMeshScale;
  133250. private _dragMesh;
  133251. private pointerDragBehavior;
  133252. private coloredMaterial;
  133253. private hoverColoredMaterial;
  133254. /**
  133255. * Sets the color of the bounding box gizmo
  133256. * @param color the color to set
  133257. */
  133258. setColor(color: Color3): void;
  133259. /**
  133260. * Creates an BoundingBoxGizmo
  133261. * @param gizmoLayer The utility layer the gizmo will be added to
  133262. * @param color The color of the gizmo
  133263. */
  133264. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  133265. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  133266. private _selectNode;
  133267. /**
  133268. * Updates the bounding box information for the Gizmo
  133269. */
  133270. updateBoundingBox(): void;
  133271. private _updateRotationSpheres;
  133272. private _updateScaleBoxes;
  133273. /**
  133274. * Enables rotation on the specified axis and disables rotation on the others
  133275. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  133276. */
  133277. setEnabledRotationAxis(axis: string): void;
  133278. /**
  133279. * Enables/disables scaling
  133280. * @param enable if scaling should be enabled
  133281. * @param homogeneousScaling defines if scaling should only be homogeneous
  133282. */
  133283. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  133284. private _updateDummy;
  133285. /**
  133286. * Enables a pointer drag behavior on the bounding box of the gizmo
  133287. */
  133288. enableDragBehavior(): void;
  133289. /**
  133290. * Disposes of the gizmo
  133291. */
  133292. dispose(): void;
  133293. /**
  133294. * 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)
  133295. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  133296. * @returns the bounding box mesh with the passed in mesh as a child
  133297. */
  133298. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  133299. /**
  133300. * CustomMeshes are not supported by this gizmo
  133301. * @param mesh The mesh to replace the default mesh of the gizmo
  133302. */
  133303. setCustomMesh(mesh: Mesh): void;
  133304. }
  133305. }
  133306. declare module BABYLON {
  133307. /**
  133308. * Single plane rotation gizmo
  133309. */
  133310. export class PlaneRotationGizmo extends Gizmo {
  133311. /**
  133312. * Drag behavior responsible for the gizmos dragging interactions
  133313. */
  133314. dragBehavior: PointerDragBehavior;
  133315. private _pointerObserver;
  133316. /**
  133317. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  133318. */
  133319. snapDistance: number;
  133320. /**
  133321. * Event that fires each time the gizmo snaps to a new location.
  133322. * * snapDistance is the the change in distance
  133323. */
  133324. onSnapObservable: Observable<{
  133325. snapDistance: number;
  133326. }>;
  133327. private _isEnabled;
  133328. private _parent;
  133329. /**
  133330. * Creates a PlaneRotationGizmo
  133331. * @param gizmoLayer The utility layer the gizmo will be added to
  133332. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  133333. * @param color The color of the gizmo
  133334. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133335. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133336. * @param thickness display gizmo axis thickness
  133337. */
  133338. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  133339. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133340. /**
  133341. * If the gizmo is enabled
  133342. */
  133343. set isEnabled(value: boolean);
  133344. get isEnabled(): boolean;
  133345. /**
  133346. * Disposes of the gizmo
  133347. */
  133348. dispose(): void;
  133349. }
  133350. }
  133351. declare module BABYLON {
  133352. /**
  133353. * Gizmo that enables rotating a mesh along 3 axis
  133354. */
  133355. export class RotationGizmo extends Gizmo {
  133356. /**
  133357. * Internal gizmo used for interactions on the x axis
  133358. */
  133359. xGizmo: PlaneRotationGizmo;
  133360. /**
  133361. * Internal gizmo used for interactions on the y axis
  133362. */
  133363. yGizmo: PlaneRotationGizmo;
  133364. /**
  133365. * Internal gizmo used for interactions on the z axis
  133366. */
  133367. zGizmo: PlaneRotationGizmo;
  133368. /** Fires an event when any of it's sub gizmos are dragged */
  133369. onDragStartObservable: Observable<unknown>;
  133370. /** Fires an event when any of it's sub gizmos are released from dragging */
  133371. onDragEndObservable: Observable<unknown>;
  133372. private _meshAttached;
  133373. private _nodeAttached;
  133374. get attachedMesh(): Nullable<AbstractMesh>;
  133375. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133376. get attachedNode(): Nullable<Node>;
  133377. set attachedNode(node: Nullable<Node>);
  133378. /**
  133379. * Creates a RotationGizmo
  133380. * @param gizmoLayer The utility layer the gizmo will be added to
  133381. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133382. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133383. * @param thickness display gizmo axis thickness
  133384. */
  133385. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  133386. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133387. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133388. /**
  133389. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133390. */
  133391. set snapDistance(value: number);
  133392. get snapDistance(): number;
  133393. /**
  133394. * Ratio for the scale of the gizmo (Default: 1)
  133395. */
  133396. set scaleRatio(value: number);
  133397. get scaleRatio(): number;
  133398. /**
  133399. * Disposes of the gizmo
  133400. */
  133401. dispose(): void;
  133402. /**
  133403. * CustomMeshes are not supported by this gizmo
  133404. * @param mesh The mesh to replace the default mesh of the gizmo
  133405. */
  133406. setCustomMesh(mesh: Mesh): void;
  133407. }
  133408. }
  133409. declare module BABYLON {
  133410. /**
  133411. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  133412. */
  133413. export class GizmoManager implements IDisposable {
  133414. private scene;
  133415. /**
  133416. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  133417. */
  133418. gizmos: {
  133419. positionGizmo: Nullable<PositionGizmo>;
  133420. rotationGizmo: Nullable<RotationGizmo>;
  133421. scaleGizmo: Nullable<ScaleGizmo>;
  133422. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  133423. };
  133424. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  133425. clearGizmoOnEmptyPointerEvent: boolean;
  133426. /** Fires an event when the manager is attached to a mesh */
  133427. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  133428. /** Fires an event when the manager is attached to a node */
  133429. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  133430. private _gizmosEnabled;
  133431. private _pointerObserver;
  133432. private _attachedMesh;
  133433. private _attachedNode;
  133434. private _boundingBoxColor;
  133435. private _defaultUtilityLayer;
  133436. private _defaultKeepDepthUtilityLayer;
  133437. private _thickness;
  133438. /**
  133439. * When bounding box gizmo is enabled, this can be used to track drag/end events
  133440. */
  133441. boundingBoxDragBehavior: SixDofDragBehavior;
  133442. /**
  133443. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  133444. */
  133445. attachableMeshes: Nullable<Array<AbstractMesh>>;
  133446. /**
  133447. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  133448. */
  133449. attachableNodes: Nullable<Array<Node>>;
  133450. /**
  133451. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  133452. */
  133453. usePointerToAttachGizmos: boolean;
  133454. /**
  133455. * Utility layer that the bounding box gizmo belongs to
  133456. */
  133457. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  133458. /**
  133459. * Utility layer that all gizmos besides bounding box belong to
  133460. */
  133461. get utilityLayer(): UtilityLayerRenderer;
  133462. /**
  133463. * Instatiates a gizmo manager
  133464. * @param scene the scene to overlay the gizmos on top of
  133465. * @param thickness display gizmo axis thickness
  133466. */
  133467. constructor(scene: Scene, thickness?: number);
  133468. /**
  133469. * Attaches a set of gizmos to the specified mesh
  133470. * @param mesh The mesh the gizmo's should be attached to
  133471. */
  133472. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  133473. /**
  133474. * Attaches a set of gizmos to the specified node
  133475. * @param node The node the gizmo's should be attached to
  133476. */
  133477. attachToNode(node: Nullable<Node>): void;
  133478. /**
  133479. * If the position gizmo is enabled
  133480. */
  133481. set positionGizmoEnabled(value: boolean);
  133482. get positionGizmoEnabled(): boolean;
  133483. /**
  133484. * If the rotation gizmo is enabled
  133485. */
  133486. set rotationGizmoEnabled(value: boolean);
  133487. get rotationGizmoEnabled(): boolean;
  133488. /**
  133489. * If the scale gizmo is enabled
  133490. */
  133491. set scaleGizmoEnabled(value: boolean);
  133492. get scaleGizmoEnabled(): boolean;
  133493. /**
  133494. * If the boundingBox gizmo is enabled
  133495. */
  133496. set boundingBoxGizmoEnabled(value: boolean);
  133497. get boundingBoxGizmoEnabled(): boolean;
  133498. /**
  133499. * Disposes of the gizmo manager
  133500. */
  133501. dispose(): void;
  133502. }
  133503. }
  133504. declare module BABYLON {
  133505. /**
  133506. * A directional light is defined by a direction (what a surprise!).
  133507. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  133508. * 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.
  133509. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133510. */
  133511. export class DirectionalLight extends ShadowLight {
  133512. private _shadowFrustumSize;
  133513. /**
  133514. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  133515. */
  133516. get shadowFrustumSize(): number;
  133517. /**
  133518. * Specifies a fix frustum size for the shadow generation.
  133519. */
  133520. set shadowFrustumSize(value: number);
  133521. private _shadowOrthoScale;
  133522. /**
  133523. * Gets the shadow projection scale against the optimal computed one.
  133524. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133525. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133526. */
  133527. get shadowOrthoScale(): number;
  133528. /**
  133529. * Sets the shadow projection scale against the optimal computed one.
  133530. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133531. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133532. */
  133533. set shadowOrthoScale(value: number);
  133534. /**
  133535. * Automatically compute the projection matrix to best fit (including all the casters)
  133536. * on each frame.
  133537. */
  133538. autoUpdateExtends: boolean;
  133539. /**
  133540. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  133541. * on each frame. autoUpdateExtends must be set to true for this to work
  133542. */
  133543. autoCalcShadowZBounds: boolean;
  133544. private _orthoLeft;
  133545. private _orthoRight;
  133546. private _orthoTop;
  133547. private _orthoBottom;
  133548. /**
  133549. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  133550. * The directional light is emitted from everywhere in the given direction.
  133551. * It can cast shadows.
  133552. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133553. * @param name The friendly name of the light
  133554. * @param direction The direction of the light
  133555. * @param scene The scene the light belongs to
  133556. */
  133557. constructor(name: string, direction: Vector3, scene: Scene);
  133558. /**
  133559. * Returns the string "DirectionalLight".
  133560. * @return The class name
  133561. */
  133562. getClassName(): string;
  133563. /**
  133564. * Returns the integer 1.
  133565. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133566. */
  133567. getTypeID(): number;
  133568. /**
  133569. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  133570. * Returns the DirectionalLight Shadow projection matrix.
  133571. */
  133572. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133573. /**
  133574. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  133575. * Returns the DirectionalLight Shadow projection matrix.
  133576. */
  133577. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  133578. /**
  133579. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  133580. * Returns the DirectionalLight Shadow projection matrix.
  133581. */
  133582. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133583. protected _buildUniformLayout(): void;
  133584. /**
  133585. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  133586. * @param effect The effect to update
  133587. * @param lightIndex The index of the light in the effect to update
  133588. * @returns The directional light
  133589. */
  133590. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  133591. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  133592. /**
  133593. * Gets the minZ used for shadow according to both the scene and the light.
  133594. *
  133595. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133596. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133597. * @param activeCamera The camera we are returning the min for
  133598. * @returns the depth min z
  133599. */
  133600. getDepthMinZ(activeCamera: Camera): number;
  133601. /**
  133602. * Gets the maxZ used for shadow according to both the scene and the light.
  133603. *
  133604. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133605. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133606. * @param activeCamera The camera we are returning the max for
  133607. * @returns the depth max z
  133608. */
  133609. getDepthMaxZ(activeCamera: Camera): number;
  133610. /**
  133611. * Prepares the list of defines specific to the light type.
  133612. * @param defines the list of defines
  133613. * @param lightIndex defines the index of the light for the effect
  133614. */
  133615. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133616. }
  133617. }
  133618. declare module BABYLON {
  133619. /**
  133620. * Class containing static functions to help procedurally build meshes
  133621. */
  133622. export class HemisphereBuilder {
  133623. /**
  133624. * Creates a hemisphere mesh
  133625. * @param name defines the name of the mesh
  133626. * @param options defines the options used to create the mesh
  133627. * @param scene defines the hosting scene
  133628. * @returns the hemisphere mesh
  133629. */
  133630. static CreateHemisphere(name: string, options: {
  133631. segments?: number;
  133632. diameter?: number;
  133633. sideOrientation?: number;
  133634. }, scene: any): Mesh;
  133635. }
  133636. }
  133637. declare module BABYLON {
  133638. /**
  133639. * A spot light is defined by a position, a direction, an angle, and an exponent.
  133640. * These values define a cone of light starting from the position, emitting toward the direction.
  133641. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  133642. * and the exponent defines the speed of the decay of the light with distance (reach).
  133643. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133644. */
  133645. export class SpotLight extends ShadowLight {
  133646. private _angle;
  133647. private _innerAngle;
  133648. private _cosHalfAngle;
  133649. private _lightAngleScale;
  133650. private _lightAngleOffset;
  133651. /**
  133652. * Gets the cone angle of the spot light in Radians.
  133653. */
  133654. get angle(): number;
  133655. /**
  133656. * Sets the cone angle of the spot light in Radians.
  133657. */
  133658. set angle(value: number);
  133659. /**
  133660. * Only used in gltf falloff mode, this defines the angle where
  133661. * the directional falloff will start before cutting at angle which could be seen
  133662. * as outer angle.
  133663. */
  133664. get innerAngle(): number;
  133665. /**
  133666. * Only used in gltf falloff mode, this defines the angle where
  133667. * the directional falloff will start before cutting at angle which could be seen
  133668. * as outer angle.
  133669. */
  133670. set innerAngle(value: number);
  133671. private _shadowAngleScale;
  133672. /**
  133673. * Allows scaling the angle of the light for shadow generation only.
  133674. */
  133675. get shadowAngleScale(): number;
  133676. /**
  133677. * Allows scaling the angle of the light for shadow generation only.
  133678. */
  133679. set shadowAngleScale(value: number);
  133680. /**
  133681. * The light decay speed with the distance from the emission spot.
  133682. */
  133683. exponent: number;
  133684. private _projectionTextureMatrix;
  133685. /**
  133686. * Allows reading the projecton texture
  133687. */
  133688. get projectionTextureMatrix(): Matrix;
  133689. protected _projectionTextureLightNear: number;
  133690. /**
  133691. * Gets the near clip of the Spotlight for texture projection.
  133692. */
  133693. get projectionTextureLightNear(): number;
  133694. /**
  133695. * Sets the near clip of the Spotlight for texture projection.
  133696. */
  133697. set projectionTextureLightNear(value: number);
  133698. protected _projectionTextureLightFar: number;
  133699. /**
  133700. * Gets the far clip of the Spotlight for texture projection.
  133701. */
  133702. get projectionTextureLightFar(): number;
  133703. /**
  133704. * Sets the far clip of the Spotlight for texture projection.
  133705. */
  133706. set projectionTextureLightFar(value: number);
  133707. protected _projectionTextureUpDirection: Vector3;
  133708. /**
  133709. * Gets the Up vector of the Spotlight for texture projection.
  133710. */
  133711. get projectionTextureUpDirection(): Vector3;
  133712. /**
  133713. * Sets the Up vector of the Spotlight for texture projection.
  133714. */
  133715. set projectionTextureUpDirection(value: Vector3);
  133716. private _projectionTexture;
  133717. /**
  133718. * Gets the projection texture of the light.
  133719. */
  133720. get projectionTexture(): Nullable<BaseTexture>;
  133721. /**
  133722. * Sets the projection texture of the light.
  133723. */
  133724. set projectionTexture(value: Nullable<BaseTexture>);
  133725. private _projectionTextureViewLightDirty;
  133726. private _projectionTextureProjectionLightDirty;
  133727. private _projectionTextureDirty;
  133728. private _projectionTextureViewTargetVector;
  133729. private _projectionTextureViewLightMatrix;
  133730. private _projectionTextureProjectionLightMatrix;
  133731. private _projectionTextureScalingMatrix;
  133732. /**
  133733. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  133734. * It can cast shadows.
  133735. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133736. * @param name The light friendly name
  133737. * @param position The position of the spot light in the scene
  133738. * @param direction The direction of the light in the scene
  133739. * @param angle The cone angle of the light in Radians
  133740. * @param exponent The light decay speed with the distance from the emission spot
  133741. * @param scene The scene the lights belongs to
  133742. */
  133743. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  133744. /**
  133745. * Returns the string "SpotLight".
  133746. * @returns the class name
  133747. */
  133748. getClassName(): string;
  133749. /**
  133750. * Returns the integer 2.
  133751. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133752. */
  133753. getTypeID(): number;
  133754. /**
  133755. * Overrides the direction setter to recompute the projection texture view light Matrix.
  133756. */
  133757. protected _setDirection(value: Vector3): void;
  133758. /**
  133759. * Overrides the position setter to recompute the projection texture view light Matrix.
  133760. */
  133761. protected _setPosition(value: Vector3): void;
  133762. /**
  133763. * 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.
  133764. * Returns the SpotLight.
  133765. */
  133766. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133767. protected _computeProjectionTextureViewLightMatrix(): void;
  133768. protected _computeProjectionTextureProjectionLightMatrix(): void;
  133769. /**
  133770. * Main function for light texture projection matrix computing.
  133771. */
  133772. protected _computeProjectionTextureMatrix(): void;
  133773. protected _buildUniformLayout(): void;
  133774. private _computeAngleValues;
  133775. /**
  133776. * Sets the passed Effect "effect" with the Light textures.
  133777. * @param effect The effect to update
  133778. * @param lightIndex The index of the light in the effect to update
  133779. * @returns The light
  133780. */
  133781. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  133782. /**
  133783. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  133784. * @param effect The effect to update
  133785. * @param lightIndex The index of the light in the effect to update
  133786. * @returns The spot light
  133787. */
  133788. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  133789. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  133790. /**
  133791. * Disposes the light and the associated resources.
  133792. */
  133793. dispose(): void;
  133794. /**
  133795. * Prepares the list of defines specific to the light type.
  133796. * @param defines the list of defines
  133797. * @param lightIndex defines the index of the light for the effect
  133798. */
  133799. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133800. }
  133801. }
  133802. declare module BABYLON {
  133803. /**
  133804. * Gizmo that enables viewing a light
  133805. */
  133806. export class LightGizmo extends Gizmo {
  133807. private _lightMesh;
  133808. private _material;
  133809. private _cachedPosition;
  133810. private _cachedForward;
  133811. private _attachedMeshParent;
  133812. /**
  133813. * Creates a LightGizmo
  133814. * @param gizmoLayer The utility layer the gizmo will be added to
  133815. */
  133816. constructor(gizmoLayer?: UtilityLayerRenderer);
  133817. private _light;
  133818. /**
  133819. * The light that the gizmo is attached to
  133820. */
  133821. set light(light: Nullable<Light>);
  133822. get light(): Nullable<Light>;
  133823. /**
  133824. * Gets the material used to render the light gizmo
  133825. */
  133826. get material(): StandardMaterial;
  133827. /**
  133828. * @hidden
  133829. * Updates the gizmo to match the attached mesh's position/rotation
  133830. */
  133831. protected _update(): void;
  133832. private static _Scale;
  133833. /**
  133834. * Creates the lines for a light mesh
  133835. */
  133836. private static _CreateLightLines;
  133837. /**
  133838. * Disposes of the light gizmo
  133839. */
  133840. dispose(): void;
  133841. private static _CreateHemisphericLightMesh;
  133842. private static _CreatePointLightMesh;
  133843. private static _CreateSpotLightMesh;
  133844. private static _CreateDirectionalLightMesh;
  133845. }
  133846. }
  133847. declare module BABYLON {
  133848. /**
  133849. * Gizmo that enables viewing a camera
  133850. */
  133851. export class CameraGizmo extends Gizmo {
  133852. private _cameraMesh;
  133853. private _cameraLinesMesh;
  133854. private _material;
  133855. /**
  133856. * Creates a CameraGizmo
  133857. * @param gizmoLayer The utility layer the gizmo will be added to
  133858. */
  133859. constructor(gizmoLayer?: UtilityLayerRenderer);
  133860. private _camera;
  133861. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  133862. get displayFrustum(): boolean;
  133863. set displayFrustum(value: boolean);
  133864. /**
  133865. * The camera that the gizmo is attached to
  133866. */
  133867. set camera(camera: Nullable<Camera>);
  133868. get camera(): Nullable<Camera>;
  133869. /**
  133870. * Gets the material used to render the camera gizmo
  133871. */
  133872. get material(): StandardMaterial;
  133873. /**
  133874. * @hidden
  133875. * Updates the gizmo to match the attached mesh's position/rotation
  133876. */
  133877. protected _update(): void;
  133878. private static _Scale;
  133879. private _invProjection;
  133880. /**
  133881. * Disposes of the camera gizmo
  133882. */
  133883. dispose(): void;
  133884. private static _CreateCameraMesh;
  133885. private static _CreateCameraFrustum;
  133886. }
  133887. }
  133888. declare module BABYLON {
  133889. /** @hidden */
  133890. export var backgroundFragmentDeclaration: {
  133891. name: string;
  133892. shader: string;
  133893. };
  133894. }
  133895. declare module BABYLON {
  133896. /** @hidden */
  133897. export var backgroundUboDeclaration: {
  133898. name: string;
  133899. shader: string;
  133900. };
  133901. }
  133902. declare module BABYLON {
  133903. /** @hidden */
  133904. export var backgroundPixelShader: {
  133905. name: string;
  133906. shader: string;
  133907. };
  133908. }
  133909. declare module BABYLON {
  133910. /** @hidden */
  133911. export var backgroundVertexDeclaration: {
  133912. name: string;
  133913. shader: string;
  133914. };
  133915. }
  133916. declare module BABYLON {
  133917. /** @hidden */
  133918. export var backgroundVertexShader: {
  133919. name: string;
  133920. shader: string;
  133921. };
  133922. }
  133923. declare module BABYLON {
  133924. /**
  133925. * Background material used to create an efficient environement around your scene.
  133926. */
  133927. export class BackgroundMaterial extends PushMaterial {
  133928. /**
  133929. * Standard reflectance value at parallel view angle.
  133930. */
  133931. static StandardReflectance0: number;
  133932. /**
  133933. * Standard reflectance value at grazing angle.
  133934. */
  133935. static StandardReflectance90: number;
  133936. protected _primaryColor: Color3;
  133937. /**
  133938. * Key light Color (multiply against the environement texture)
  133939. */
  133940. primaryColor: Color3;
  133941. protected __perceptualColor: Nullable<Color3>;
  133942. /**
  133943. * Experimental Internal Use Only.
  133944. *
  133945. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  133946. * This acts as a helper to set the primary color to a more "human friendly" value.
  133947. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  133948. * output color as close as possible from the chosen value.
  133949. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  133950. * part of lighting setup.)
  133951. */
  133952. get _perceptualColor(): Nullable<Color3>;
  133953. set _perceptualColor(value: Nullable<Color3>);
  133954. protected _primaryColorShadowLevel: float;
  133955. /**
  133956. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  133957. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  133958. */
  133959. get primaryColorShadowLevel(): float;
  133960. set primaryColorShadowLevel(value: float);
  133961. protected _primaryColorHighlightLevel: float;
  133962. /**
  133963. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  133964. * The primary color is used at the level chosen to define what the white area would look.
  133965. */
  133966. get primaryColorHighlightLevel(): float;
  133967. set primaryColorHighlightLevel(value: float);
  133968. protected _reflectionTexture: Nullable<BaseTexture>;
  133969. /**
  133970. * Reflection Texture used in the material.
  133971. * Should be author in a specific way for the best result (refer to the documentation).
  133972. */
  133973. reflectionTexture: Nullable<BaseTexture>;
  133974. protected _reflectionBlur: float;
  133975. /**
  133976. * Reflection Texture level of blur.
  133977. *
  133978. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  133979. * texture twice.
  133980. */
  133981. reflectionBlur: float;
  133982. protected _diffuseTexture: Nullable<BaseTexture>;
  133983. /**
  133984. * Diffuse Texture used in the material.
  133985. * Should be author in a specific way for the best result (refer to the documentation).
  133986. */
  133987. diffuseTexture: Nullable<BaseTexture>;
  133988. protected _shadowLights: Nullable<IShadowLight[]>;
  133989. /**
  133990. * Specify the list of lights casting shadow on the material.
  133991. * All scene shadow lights will be included if null.
  133992. */
  133993. shadowLights: Nullable<IShadowLight[]>;
  133994. protected _shadowLevel: float;
  133995. /**
  133996. * Helps adjusting the shadow to a softer level if required.
  133997. * 0 means black shadows and 1 means no shadows.
  133998. */
  133999. shadowLevel: float;
  134000. protected _sceneCenter: Vector3;
  134001. /**
  134002. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  134003. * It is usually zero but might be interesting to modify according to your setup.
  134004. */
  134005. sceneCenter: Vector3;
  134006. protected _opacityFresnel: boolean;
  134007. /**
  134008. * This helps specifying that the material is falling off to the sky box at grazing angle.
  134009. * This helps ensuring a nice transition when the camera goes under the ground.
  134010. */
  134011. opacityFresnel: boolean;
  134012. protected _reflectionFresnel: boolean;
  134013. /**
  134014. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  134015. * This helps adding a mirror texture on the ground.
  134016. */
  134017. reflectionFresnel: boolean;
  134018. protected _reflectionFalloffDistance: number;
  134019. /**
  134020. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  134021. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  134022. */
  134023. reflectionFalloffDistance: number;
  134024. protected _reflectionAmount: number;
  134025. /**
  134026. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  134027. */
  134028. reflectionAmount: number;
  134029. protected _reflectionReflectance0: number;
  134030. /**
  134031. * This specifies the weight of the reflection at grazing angle.
  134032. */
  134033. reflectionReflectance0: number;
  134034. protected _reflectionReflectance90: number;
  134035. /**
  134036. * This specifies the weight of the reflection at a perpendicular point of view.
  134037. */
  134038. reflectionReflectance90: number;
  134039. /**
  134040. * Sets the reflection reflectance fresnel values according to the default standard
  134041. * empirically know to work well :-)
  134042. */
  134043. set reflectionStandardFresnelWeight(value: number);
  134044. protected _useRGBColor: boolean;
  134045. /**
  134046. * Helps to directly use the maps channels instead of their level.
  134047. */
  134048. useRGBColor: boolean;
  134049. protected _enableNoise: boolean;
  134050. /**
  134051. * This helps reducing the banding effect that could occur on the background.
  134052. */
  134053. enableNoise: boolean;
  134054. /**
  134055. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134056. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  134057. * Recommended to be keep at 1.0 except for special cases.
  134058. */
  134059. get fovMultiplier(): number;
  134060. set fovMultiplier(value: number);
  134061. private _fovMultiplier;
  134062. /**
  134063. * Enable the FOV adjustment feature controlled by fovMultiplier.
  134064. */
  134065. useEquirectangularFOV: boolean;
  134066. private _maxSimultaneousLights;
  134067. /**
  134068. * Number of Simultaneous lights allowed on the material.
  134069. */
  134070. maxSimultaneousLights: int;
  134071. private _shadowOnly;
  134072. /**
  134073. * Make the material only render shadows
  134074. */
  134075. shadowOnly: boolean;
  134076. /**
  134077. * Default configuration related to image processing available in the Background Material.
  134078. */
  134079. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  134080. /**
  134081. * Keep track of the image processing observer to allow dispose and replace.
  134082. */
  134083. private _imageProcessingObserver;
  134084. /**
  134085. * Attaches a new image processing configuration to the PBR Material.
  134086. * @param configuration (if null the scene configuration will be use)
  134087. */
  134088. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  134089. /**
  134090. * Gets the image processing configuration used either in this material.
  134091. */
  134092. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  134093. /**
  134094. * Sets the Default image processing configuration used either in the this material.
  134095. *
  134096. * If sets to null, the scene one is in use.
  134097. */
  134098. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  134099. /**
  134100. * Gets wether the color curves effect is enabled.
  134101. */
  134102. get cameraColorCurvesEnabled(): boolean;
  134103. /**
  134104. * Sets wether the color curves effect is enabled.
  134105. */
  134106. set cameraColorCurvesEnabled(value: boolean);
  134107. /**
  134108. * Gets wether the color grading effect is enabled.
  134109. */
  134110. get cameraColorGradingEnabled(): boolean;
  134111. /**
  134112. * Gets wether the color grading effect is enabled.
  134113. */
  134114. set cameraColorGradingEnabled(value: boolean);
  134115. /**
  134116. * Gets wether tonemapping is enabled or not.
  134117. */
  134118. get cameraToneMappingEnabled(): boolean;
  134119. /**
  134120. * Sets wether tonemapping is enabled or not
  134121. */
  134122. set cameraToneMappingEnabled(value: boolean);
  134123. /**
  134124. * The camera exposure used on this material.
  134125. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134126. * This corresponds to a photographic exposure.
  134127. */
  134128. get cameraExposure(): float;
  134129. /**
  134130. * The camera exposure used on this material.
  134131. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134132. * This corresponds to a photographic exposure.
  134133. */
  134134. set cameraExposure(value: float);
  134135. /**
  134136. * Gets The camera contrast used on this material.
  134137. */
  134138. get cameraContrast(): float;
  134139. /**
  134140. * Sets The camera contrast used on this material.
  134141. */
  134142. set cameraContrast(value: float);
  134143. /**
  134144. * Gets the Color Grading 2D Lookup Texture.
  134145. */
  134146. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  134147. /**
  134148. * Sets the Color Grading 2D Lookup Texture.
  134149. */
  134150. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  134151. /**
  134152. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134153. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134154. * 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;
  134155. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134156. */
  134157. get cameraColorCurves(): Nullable<ColorCurves>;
  134158. /**
  134159. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134160. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134161. * 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;
  134162. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134163. */
  134164. set cameraColorCurves(value: Nullable<ColorCurves>);
  134165. /**
  134166. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  134167. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  134168. */
  134169. switchToBGR: boolean;
  134170. private _renderTargets;
  134171. private _reflectionControls;
  134172. private _white;
  134173. private _primaryShadowColor;
  134174. private _primaryHighlightColor;
  134175. /**
  134176. * Instantiates a Background Material in the given scene
  134177. * @param name The friendly name of the material
  134178. * @param scene The scene to add the material to
  134179. */
  134180. constructor(name: string, scene: Scene);
  134181. /**
  134182. * Gets a boolean indicating that current material needs to register RTT
  134183. */
  134184. get hasRenderTargetTextures(): boolean;
  134185. /**
  134186. * The entire material has been created in order to prevent overdraw.
  134187. * @returns false
  134188. */
  134189. needAlphaTesting(): boolean;
  134190. /**
  134191. * The entire material has been created in order to prevent overdraw.
  134192. * @returns true if blending is enable
  134193. */
  134194. needAlphaBlending(): boolean;
  134195. /**
  134196. * Checks wether the material is ready to be rendered for a given mesh.
  134197. * @param mesh The mesh to render
  134198. * @param subMesh The submesh to check against
  134199. * @param useInstances Specify wether or not the material is used with instances
  134200. * @returns true if all the dependencies are ready (Textures, Effects...)
  134201. */
  134202. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  134203. /**
  134204. * Compute the primary color according to the chosen perceptual color.
  134205. */
  134206. private _computePrimaryColorFromPerceptualColor;
  134207. /**
  134208. * Compute the highlights and shadow colors according to their chosen levels.
  134209. */
  134210. private _computePrimaryColors;
  134211. /**
  134212. * Build the uniform buffer used in the material.
  134213. */
  134214. buildUniformLayout(): void;
  134215. /**
  134216. * Unbind the material.
  134217. */
  134218. unbind(): void;
  134219. /**
  134220. * Bind only the world matrix to the material.
  134221. * @param world The world matrix to bind.
  134222. */
  134223. bindOnlyWorldMatrix(world: Matrix): void;
  134224. /**
  134225. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  134226. * @param world The world matrix to bind.
  134227. * @param subMesh The submesh to bind for.
  134228. */
  134229. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  134230. /**
  134231. * Checks to see if a texture is used in the material.
  134232. * @param texture - Base texture to use.
  134233. * @returns - Boolean specifying if a texture is used in the material.
  134234. */
  134235. hasTexture(texture: BaseTexture): boolean;
  134236. /**
  134237. * Dispose the material.
  134238. * @param forceDisposeEffect Force disposal of the associated effect.
  134239. * @param forceDisposeTextures Force disposal of the associated textures.
  134240. */
  134241. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  134242. /**
  134243. * Clones the material.
  134244. * @param name The cloned name.
  134245. * @returns The cloned material.
  134246. */
  134247. clone(name: string): BackgroundMaterial;
  134248. /**
  134249. * Serializes the current material to its JSON representation.
  134250. * @returns The JSON representation.
  134251. */
  134252. serialize(): any;
  134253. /**
  134254. * Gets the class name of the material
  134255. * @returns "BackgroundMaterial"
  134256. */
  134257. getClassName(): string;
  134258. /**
  134259. * Parse a JSON input to create back a background material.
  134260. * @param source The JSON data to parse
  134261. * @param scene The scene to create the parsed material in
  134262. * @param rootUrl The root url of the assets the material depends upon
  134263. * @returns the instantiated BackgroundMaterial.
  134264. */
  134265. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  134266. }
  134267. }
  134268. declare module BABYLON {
  134269. /**
  134270. * Represents the different options available during the creation of
  134271. * a Environment helper.
  134272. *
  134273. * This can control the default ground, skybox and image processing setup of your scene.
  134274. */
  134275. export interface IEnvironmentHelperOptions {
  134276. /**
  134277. * Specifies whether or not to create a ground.
  134278. * True by default.
  134279. */
  134280. createGround: boolean;
  134281. /**
  134282. * Specifies the ground size.
  134283. * 15 by default.
  134284. */
  134285. groundSize: number;
  134286. /**
  134287. * The texture used on the ground for the main color.
  134288. * Comes from the BabylonJS CDN by default.
  134289. *
  134290. * Remarks: Can be either a texture or a url.
  134291. */
  134292. groundTexture: string | BaseTexture;
  134293. /**
  134294. * The color mixed in the ground texture by default.
  134295. * BabylonJS clearColor by default.
  134296. */
  134297. groundColor: Color3;
  134298. /**
  134299. * Specifies the ground opacity.
  134300. * 1 by default.
  134301. */
  134302. groundOpacity: number;
  134303. /**
  134304. * Enables the ground to receive shadows.
  134305. * True by default.
  134306. */
  134307. enableGroundShadow: boolean;
  134308. /**
  134309. * Helps preventing the shadow to be fully black on the ground.
  134310. * 0.5 by default.
  134311. */
  134312. groundShadowLevel: number;
  134313. /**
  134314. * Creates a mirror texture attach to the ground.
  134315. * false by default.
  134316. */
  134317. enableGroundMirror: boolean;
  134318. /**
  134319. * Specifies the ground mirror size ratio.
  134320. * 0.3 by default as the default kernel is 64.
  134321. */
  134322. groundMirrorSizeRatio: number;
  134323. /**
  134324. * Specifies the ground mirror blur kernel size.
  134325. * 64 by default.
  134326. */
  134327. groundMirrorBlurKernel: number;
  134328. /**
  134329. * Specifies the ground mirror visibility amount.
  134330. * 1 by default
  134331. */
  134332. groundMirrorAmount: number;
  134333. /**
  134334. * Specifies the ground mirror reflectance weight.
  134335. * This uses the standard weight of the background material to setup the fresnel effect
  134336. * of the mirror.
  134337. * 1 by default.
  134338. */
  134339. groundMirrorFresnelWeight: number;
  134340. /**
  134341. * Specifies the ground mirror Falloff distance.
  134342. * This can helps reducing the size of the reflection.
  134343. * 0 by Default.
  134344. */
  134345. groundMirrorFallOffDistance: number;
  134346. /**
  134347. * Specifies the ground mirror texture type.
  134348. * Unsigned Int by Default.
  134349. */
  134350. groundMirrorTextureType: number;
  134351. /**
  134352. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  134353. * the shown objects.
  134354. */
  134355. groundYBias: number;
  134356. /**
  134357. * Specifies whether or not to create a skybox.
  134358. * True by default.
  134359. */
  134360. createSkybox: boolean;
  134361. /**
  134362. * Specifies the skybox size.
  134363. * 20 by default.
  134364. */
  134365. skyboxSize: number;
  134366. /**
  134367. * The texture used on the skybox for the main color.
  134368. * Comes from the BabylonJS CDN by default.
  134369. *
  134370. * Remarks: Can be either a texture or a url.
  134371. */
  134372. skyboxTexture: string | BaseTexture;
  134373. /**
  134374. * The color mixed in the skybox texture by default.
  134375. * BabylonJS clearColor by default.
  134376. */
  134377. skyboxColor: Color3;
  134378. /**
  134379. * The background rotation around the Y axis of the scene.
  134380. * This helps aligning the key lights of your scene with the background.
  134381. * 0 by default.
  134382. */
  134383. backgroundYRotation: number;
  134384. /**
  134385. * Compute automatically the size of the elements to best fit with the scene.
  134386. */
  134387. sizeAuto: boolean;
  134388. /**
  134389. * Default position of the rootMesh if autoSize is not true.
  134390. */
  134391. rootPosition: Vector3;
  134392. /**
  134393. * Sets up the image processing in the scene.
  134394. * true by default.
  134395. */
  134396. setupImageProcessing: boolean;
  134397. /**
  134398. * The texture used as your environment texture in the scene.
  134399. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  134400. *
  134401. * Remarks: Can be either a texture or a url.
  134402. */
  134403. environmentTexture: string | BaseTexture;
  134404. /**
  134405. * The value of the exposure to apply to the scene.
  134406. * 0.6 by default if setupImageProcessing is true.
  134407. */
  134408. cameraExposure: number;
  134409. /**
  134410. * The value of the contrast to apply to the scene.
  134411. * 1.6 by default if setupImageProcessing is true.
  134412. */
  134413. cameraContrast: number;
  134414. /**
  134415. * Specifies whether or not tonemapping should be enabled in the scene.
  134416. * true by default if setupImageProcessing is true.
  134417. */
  134418. toneMappingEnabled: boolean;
  134419. }
  134420. /**
  134421. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  134422. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  134423. * It also helps with the default setup of your imageProcessing configuration.
  134424. */
  134425. export class EnvironmentHelper {
  134426. /**
  134427. * Default ground texture URL.
  134428. */
  134429. private static _groundTextureCDNUrl;
  134430. /**
  134431. * Default skybox texture URL.
  134432. */
  134433. private static _skyboxTextureCDNUrl;
  134434. /**
  134435. * Default environment texture URL.
  134436. */
  134437. private static _environmentTextureCDNUrl;
  134438. /**
  134439. * Creates the default options for the helper.
  134440. */
  134441. private static _getDefaultOptions;
  134442. private _rootMesh;
  134443. /**
  134444. * Gets the root mesh created by the helper.
  134445. */
  134446. get rootMesh(): Mesh;
  134447. private _skybox;
  134448. /**
  134449. * Gets the skybox created by the helper.
  134450. */
  134451. get skybox(): Nullable<Mesh>;
  134452. private _skyboxTexture;
  134453. /**
  134454. * Gets the skybox texture created by the helper.
  134455. */
  134456. get skyboxTexture(): Nullable<BaseTexture>;
  134457. private _skyboxMaterial;
  134458. /**
  134459. * Gets the skybox material created by the helper.
  134460. */
  134461. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  134462. private _ground;
  134463. /**
  134464. * Gets the ground mesh created by the helper.
  134465. */
  134466. get ground(): Nullable<Mesh>;
  134467. private _groundTexture;
  134468. /**
  134469. * Gets the ground texture created by the helper.
  134470. */
  134471. get groundTexture(): Nullable<BaseTexture>;
  134472. private _groundMirror;
  134473. /**
  134474. * Gets the ground mirror created by the helper.
  134475. */
  134476. get groundMirror(): Nullable<MirrorTexture>;
  134477. /**
  134478. * Gets the ground mirror render list to helps pushing the meshes
  134479. * you wish in the ground reflection.
  134480. */
  134481. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  134482. private _groundMaterial;
  134483. /**
  134484. * Gets the ground material created by the helper.
  134485. */
  134486. get groundMaterial(): Nullable<BackgroundMaterial>;
  134487. /**
  134488. * Stores the creation options.
  134489. */
  134490. private readonly _scene;
  134491. private _options;
  134492. /**
  134493. * This observable will be notified with any error during the creation of the environment,
  134494. * mainly texture creation errors.
  134495. */
  134496. onErrorObservable: Observable<{
  134497. message?: string;
  134498. exception?: any;
  134499. }>;
  134500. /**
  134501. * constructor
  134502. * @param options Defines the options we want to customize the helper
  134503. * @param scene The scene to add the material to
  134504. */
  134505. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  134506. /**
  134507. * Updates the background according to the new options
  134508. * @param options
  134509. */
  134510. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  134511. /**
  134512. * Sets the primary color of all the available elements.
  134513. * @param color the main color to affect to the ground and the background
  134514. */
  134515. setMainColor(color: Color3): void;
  134516. /**
  134517. * Setup the image processing according to the specified options.
  134518. */
  134519. private _setupImageProcessing;
  134520. /**
  134521. * Setup the environment texture according to the specified options.
  134522. */
  134523. private _setupEnvironmentTexture;
  134524. /**
  134525. * Setup the background according to the specified options.
  134526. */
  134527. private _setupBackground;
  134528. /**
  134529. * Get the scene sizes according to the setup.
  134530. */
  134531. private _getSceneSize;
  134532. /**
  134533. * Setup the ground according to the specified options.
  134534. */
  134535. private _setupGround;
  134536. /**
  134537. * Setup the ground material according to the specified options.
  134538. */
  134539. private _setupGroundMaterial;
  134540. /**
  134541. * Setup the ground diffuse texture according to the specified options.
  134542. */
  134543. private _setupGroundDiffuseTexture;
  134544. /**
  134545. * Setup the ground mirror texture according to the specified options.
  134546. */
  134547. private _setupGroundMirrorTexture;
  134548. /**
  134549. * Setup the ground to receive the mirror texture.
  134550. */
  134551. private _setupMirrorInGroundMaterial;
  134552. /**
  134553. * Setup the skybox according to the specified options.
  134554. */
  134555. private _setupSkybox;
  134556. /**
  134557. * Setup the skybox material according to the specified options.
  134558. */
  134559. private _setupSkyboxMaterial;
  134560. /**
  134561. * Setup the skybox reflection texture according to the specified options.
  134562. */
  134563. private _setupSkyboxReflectionTexture;
  134564. private _errorHandler;
  134565. /**
  134566. * Dispose all the elements created by the Helper.
  134567. */
  134568. dispose(): void;
  134569. }
  134570. }
  134571. declare module BABYLON {
  134572. /**
  134573. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  134574. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  134575. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134576. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134577. */
  134578. export abstract class TextureDome<T extends Texture> extends TransformNode {
  134579. protected onError: Nullable<(message?: string, exception?: any) => void>;
  134580. /**
  134581. * Define the source as a Monoscopic panoramic 360/180.
  134582. */
  134583. static readonly MODE_MONOSCOPIC: number;
  134584. /**
  134585. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  134586. */
  134587. static readonly MODE_TOPBOTTOM: number;
  134588. /**
  134589. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  134590. */
  134591. static readonly MODE_SIDEBYSIDE: number;
  134592. private _halfDome;
  134593. protected _useDirectMapping: boolean;
  134594. /**
  134595. * The texture being displayed on the sphere
  134596. */
  134597. protected _texture: T;
  134598. /**
  134599. * Gets the texture being displayed on the sphere
  134600. */
  134601. get texture(): T;
  134602. /**
  134603. * Sets the texture being displayed on the sphere
  134604. */
  134605. set texture(newTexture: T);
  134606. /**
  134607. * The skybox material
  134608. */
  134609. protected _material: BackgroundMaterial;
  134610. /**
  134611. * The surface used for the dome
  134612. */
  134613. protected _mesh: Mesh;
  134614. /**
  134615. * Gets the mesh used for the dome.
  134616. */
  134617. get mesh(): Mesh;
  134618. /**
  134619. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  134620. */
  134621. private _halfDomeMask;
  134622. /**
  134623. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134624. * Also see the options.resolution property.
  134625. */
  134626. get fovMultiplier(): number;
  134627. set fovMultiplier(value: number);
  134628. protected _textureMode: number;
  134629. /**
  134630. * Gets or set the current texture mode for the texture. It can be:
  134631. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134632. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134633. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134634. */
  134635. get textureMode(): number;
  134636. /**
  134637. * Sets the current texture mode for the texture. It can be:
  134638. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134639. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134640. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134641. */
  134642. set textureMode(value: number);
  134643. /**
  134644. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  134645. */
  134646. get halfDome(): boolean;
  134647. /**
  134648. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  134649. */
  134650. set halfDome(enabled: boolean);
  134651. /**
  134652. * Oberserver used in Stereoscopic VR Mode.
  134653. */
  134654. private _onBeforeCameraRenderObserver;
  134655. /**
  134656. * Observable raised when an error occured while loading the 360 image
  134657. */
  134658. onLoadErrorObservable: Observable<string>;
  134659. /**
  134660. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  134661. * @param name Element's name, child elements will append suffixes for their own names.
  134662. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  134663. * @param options An object containing optional or exposed sub element properties
  134664. */
  134665. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  134666. resolution?: number;
  134667. clickToPlay?: boolean;
  134668. autoPlay?: boolean;
  134669. loop?: boolean;
  134670. size?: number;
  134671. poster?: string;
  134672. faceForward?: boolean;
  134673. useDirectMapping?: boolean;
  134674. halfDomeMode?: boolean;
  134675. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  134676. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  134677. protected _changeTextureMode(value: number): void;
  134678. /**
  134679. * Releases resources associated with this node.
  134680. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  134681. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  134682. */
  134683. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  134684. }
  134685. }
  134686. declare module BABYLON {
  134687. /**
  134688. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  134689. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  134690. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134691. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134692. */
  134693. export class PhotoDome extends TextureDome<Texture> {
  134694. /**
  134695. * Define the image as a Monoscopic panoramic 360 image.
  134696. */
  134697. static readonly MODE_MONOSCOPIC: number;
  134698. /**
  134699. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  134700. */
  134701. static readonly MODE_TOPBOTTOM: number;
  134702. /**
  134703. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  134704. */
  134705. static readonly MODE_SIDEBYSIDE: number;
  134706. /**
  134707. * Gets or sets the texture being displayed on the sphere
  134708. */
  134709. get photoTexture(): Texture;
  134710. /**
  134711. * sets the texture being displayed on the sphere
  134712. */
  134713. set photoTexture(value: Texture);
  134714. /**
  134715. * Gets the current video mode for the video. It can be:
  134716. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134717. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134718. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134719. */
  134720. get imageMode(): number;
  134721. /**
  134722. * Sets the current video mode for the video. It can be:
  134723. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134724. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134725. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134726. */
  134727. set imageMode(value: number);
  134728. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  134729. }
  134730. }
  134731. declare module BABYLON {
  134732. /**
  134733. * Class used to host RGBD texture specific utilities
  134734. */
  134735. export class RGBDTextureTools {
  134736. /**
  134737. * Expand the RGBD Texture from RGBD to Half Float if possible.
  134738. * @param texture the texture to expand.
  134739. */
  134740. static ExpandRGBDTexture(texture: Texture): void;
  134741. }
  134742. }
  134743. declare module BABYLON {
  134744. /**
  134745. * Class used to host texture specific utilities
  134746. */
  134747. export class BRDFTextureTools {
  134748. /**
  134749. * Prevents texture cache collision
  134750. */
  134751. private static _instanceNumber;
  134752. /**
  134753. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  134754. * @param scene defines the hosting scene
  134755. * @returns the environment BRDF texture
  134756. */
  134757. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  134758. private static _environmentBRDFBase64Texture;
  134759. }
  134760. }
  134761. declare module BABYLON {
  134762. /**
  134763. * @hidden
  134764. */
  134765. export interface IMaterialClearCoatDefines {
  134766. CLEARCOAT: boolean;
  134767. CLEARCOAT_DEFAULTIOR: boolean;
  134768. CLEARCOAT_TEXTURE: boolean;
  134769. CLEARCOAT_TEXTUREDIRECTUV: number;
  134770. CLEARCOAT_BUMP: boolean;
  134771. CLEARCOAT_BUMPDIRECTUV: number;
  134772. CLEARCOAT_TINT: boolean;
  134773. CLEARCOAT_TINT_TEXTURE: boolean;
  134774. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  134775. /** @hidden */
  134776. _areTexturesDirty: boolean;
  134777. }
  134778. /**
  134779. * Define the code related to the clear coat parameters of the pbr material.
  134780. */
  134781. export class PBRClearCoatConfiguration {
  134782. /**
  134783. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134784. * The default fits with a polyurethane material.
  134785. */
  134786. private static readonly _DefaultIndexOfRefraction;
  134787. private _isEnabled;
  134788. /**
  134789. * Defines if the clear coat is enabled in the material.
  134790. */
  134791. isEnabled: boolean;
  134792. /**
  134793. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  134794. */
  134795. intensity: number;
  134796. /**
  134797. * Defines the clear coat layer roughness.
  134798. */
  134799. roughness: number;
  134800. private _indexOfRefraction;
  134801. /**
  134802. * Defines the index of refraction of the clear coat.
  134803. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134804. * The default fits with a polyurethane material.
  134805. * Changing the default value is more performance intensive.
  134806. */
  134807. indexOfRefraction: number;
  134808. private _texture;
  134809. /**
  134810. * Stores the clear coat values in a texture.
  134811. */
  134812. texture: Nullable<BaseTexture>;
  134813. private _bumpTexture;
  134814. /**
  134815. * Define the clear coat specific bump texture.
  134816. */
  134817. bumpTexture: Nullable<BaseTexture>;
  134818. private _isTintEnabled;
  134819. /**
  134820. * Defines if the clear coat tint is enabled in the material.
  134821. */
  134822. isTintEnabled: boolean;
  134823. /**
  134824. * Defines the clear coat tint of the material.
  134825. * This is only use if tint is enabled
  134826. */
  134827. tintColor: Color3;
  134828. /**
  134829. * Defines the distance at which the tint color should be found in the
  134830. * clear coat media.
  134831. * This is only use if tint is enabled
  134832. */
  134833. tintColorAtDistance: number;
  134834. /**
  134835. * Defines the clear coat layer thickness.
  134836. * This is only use if tint is enabled
  134837. */
  134838. tintThickness: number;
  134839. private _tintTexture;
  134840. /**
  134841. * Stores the clear tint values in a texture.
  134842. * rgb is tint
  134843. * a is a thickness factor
  134844. */
  134845. tintTexture: Nullable<BaseTexture>;
  134846. /** @hidden */
  134847. private _internalMarkAllSubMeshesAsTexturesDirty;
  134848. /** @hidden */
  134849. _markAllSubMeshesAsTexturesDirty(): void;
  134850. /**
  134851. * Instantiate a new istance of clear coat configuration.
  134852. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134853. */
  134854. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134855. /**
  134856. * Gets wehter the submesh is ready to be used or not.
  134857. * @param defines the list of "defines" to update.
  134858. * @param scene defines the scene the material belongs to.
  134859. * @param engine defines the engine the material belongs to.
  134860. * @param disableBumpMap defines wether the material disables bump or not.
  134861. * @returns - boolean indicating that the submesh is ready or not.
  134862. */
  134863. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  134864. /**
  134865. * Checks to see if a texture is used in the material.
  134866. * @param defines the list of "defines" to update.
  134867. * @param scene defines the scene to the material belongs to.
  134868. */
  134869. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  134870. /**
  134871. * Binds the material data.
  134872. * @param uniformBuffer defines the Uniform buffer to fill in.
  134873. * @param scene defines the scene the material belongs to.
  134874. * @param engine defines the engine the material belongs to.
  134875. * @param disableBumpMap defines wether the material disables bump or not.
  134876. * @param isFrozen defines wether the material is frozen or not.
  134877. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  134878. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  134879. */
  134880. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  134881. /**
  134882. * Checks to see if a texture is used in the material.
  134883. * @param texture - Base texture to use.
  134884. * @returns - Boolean specifying if a texture is used in the material.
  134885. */
  134886. hasTexture(texture: BaseTexture): boolean;
  134887. /**
  134888. * Returns an array of the actively used textures.
  134889. * @param activeTextures Array of BaseTextures
  134890. */
  134891. getActiveTextures(activeTextures: BaseTexture[]): void;
  134892. /**
  134893. * Returns the animatable textures.
  134894. * @param animatables Array of animatable textures.
  134895. */
  134896. getAnimatables(animatables: IAnimatable[]): void;
  134897. /**
  134898. * Disposes the resources of the material.
  134899. * @param forceDisposeTextures - Forces the disposal of all textures.
  134900. */
  134901. dispose(forceDisposeTextures?: boolean): void;
  134902. /**
  134903. * Get the current class name of the texture useful for serialization or dynamic coding.
  134904. * @returns "PBRClearCoatConfiguration"
  134905. */
  134906. getClassName(): string;
  134907. /**
  134908. * Add fallbacks to the effect fallbacks list.
  134909. * @param defines defines the Base texture to use.
  134910. * @param fallbacks defines the current fallback list.
  134911. * @param currentRank defines the current fallback rank.
  134912. * @returns the new fallback rank.
  134913. */
  134914. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134915. /**
  134916. * Add the required uniforms to the current list.
  134917. * @param uniforms defines the current uniform list.
  134918. */
  134919. static AddUniforms(uniforms: string[]): void;
  134920. /**
  134921. * Add the required samplers to the current list.
  134922. * @param samplers defines the current sampler list.
  134923. */
  134924. static AddSamplers(samplers: string[]): void;
  134925. /**
  134926. * Add the required uniforms to the current buffer.
  134927. * @param uniformBuffer defines the current uniform buffer.
  134928. */
  134929. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134930. /**
  134931. * Makes a duplicate of the current configuration into another one.
  134932. * @param clearCoatConfiguration define the config where to copy the info
  134933. */
  134934. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  134935. /**
  134936. * Serializes this clear coat configuration.
  134937. * @returns - An object with the serialized config.
  134938. */
  134939. serialize(): any;
  134940. /**
  134941. * Parses a anisotropy Configuration from a serialized object.
  134942. * @param source - Serialized object.
  134943. * @param scene Defines the scene we are parsing for
  134944. * @param rootUrl Defines the rootUrl to load from
  134945. */
  134946. parse(source: any, scene: Scene, rootUrl: string): void;
  134947. }
  134948. }
  134949. declare module BABYLON {
  134950. /**
  134951. * @hidden
  134952. */
  134953. export interface IMaterialAnisotropicDefines {
  134954. ANISOTROPIC: boolean;
  134955. ANISOTROPIC_TEXTURE: boolean;
  134956. ANISOTROPIC_TEXTUREDIRECTUV: number;
  134957. MAINUV1: boolean;
  134958. _areTexturesDirty: boolean;
  134959. _needUVs: boolean;
  134960. }
  134961. /**
  134962. * Define the code related to the anisotropic parameters of the pbr material.
  134963. */
  134964. export class PBRAnisotropicConfiguration {
  134965. private _isEnabled;
  134966. /**
  134967. * Defines if the anisotropy is enabled in the material.
  134968. */
  134969. isEnabled: boolean;
  134970. /**
  134971. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  134972. */
  134973. intensity: number;
  134974. /**
  134975. * Defines if the effect is along the tangents, bitangents or in between.
  134976. * By default, the effect is "strectching" the highlights along the tangents.
  134977. */
  134978. direction: Vector2;
  134979. private _texture;
  134980. /**
  134981. * Stores the anisotropy values in a texture.
  134982. * rg is direction (like normal from -1 to 1)
  134983. * b is a intensity
  134984. */
  134985. texture: Nullable<BaseTexture>;
  134986. /** @hidden */
  134987. private _internalMarkAllSubMeshesAsTexturesDirty;
  134988. /** @hidden */
  134989. _markAllSubMeshesAsTexturesDirty(): void;
  134990. /**
  134991. * Instantiate a new istance of anisotropy configuration.
  134992. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134993. */
  134994. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134995. /**
  134996. * Specifies that the submesh is ready to be used.
  134997. * @param defines the list of "defines" to update.
  134998. * @param scene defines the scene the material belongs to.
  134999. * @returns - boolean indicating that the submesh is ready or not.
  135000. */
  135001. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  135002. /**
  135003. * Checks to see if a texture is used in the material.
  135004. * @param defines the list of "defines" to update.
  135005. * @param mesh the mesh we are preparing the defines for.
  135006. * @param scene defines the scene the material belongs to.
  135007. */
  135008. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  135009. /**
  135010. * Binds the material data.
  135011. * @param uniformBuffer defines the Uniform buffer to fill in.
  135012. * @param scene defines the scene the material belongs to.
  135013. * @param isFrozen defines wether the material is frozen or not.
  135014. */
  135015. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135016. /**
  135017. * Checks to see if a texture is used in the material.
  135018. * @param texture - Base texture to use.
  135019. * @returns - Boolean specifying if a texture is used in the material.
  135020. */
  135021. hasTexture(texture: BaseTexture): boolean;
  135022. /**
  135023. * Returns an array of the actively used textures.
  135024. * @param activeTextures Array of BaseTextures
  135025. */
  135026. getActiveTextures(activeTextures: BaseTexture[]): void;
  135027. /**
  135028. * Returns the animatable textures.
  135029. * @param animatables Array of animatable textures.
  135030. */
  135031. getAnimatables(animatables: IAnimatable[]): void;
  135032. /**
  135033. * Disposes the resources of the material.
  135034. * @param forceDisposeTextures - Forces the disposal of all textures.
  135035. */
  135036. dispose(forceDisposeTextures?: boolean): void;
  135037. /**
  135038. * Get the current class name of the texture useful for serialization or dynamic coding.
  135039. * @returns "PBRAnisotropicConfiguration"
  135040. */
  135041. getClassName(): string;
  135042. /**
  135043. * Add fallbacks to the effect fallbacks list.
  135044. * @param defines defines the Base texture to use.
  135045. * @param fallbacks defines the current fallback list.
  135046. * @param currentRank defines the current fallback rank.
  135047. * @returns the new fallback rank.
  135048. */
  135049. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135050. /**
  135051. * Add the required uniforms to the current list.
  135052. * @param uniforms defines the current uniform list.
  135053. */
  135054. static AddUniforms(uniforms: string[]): void;
  135055. /**
  135056. * Add the required uniforms to the current buffer.
  135057. * @param uniformBuffer defines the current uniform buffer.
  135058. */
  135059. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135060. /**
  135061. * Add the required samplers to the current list.
  135062. * @param samplers defines the current sampler list.
  135063. */
  135064. static AddSamplers(samplers: string[]): void;
  135065. /**
  135066. * Makes a duplicate of the current configuration into another one.
  135067. * @param anisotropicConfiguration define the config where to copy the info
  135068. */
  135069. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  135070. /**
  135071. * Serializes this anisotropy configuration.
  135072. * @returns - An object with the serialized config.
  135073. */
  135074. serialize(): any;
  135075. /**
  135076. * Parses a anisotropy Configuration from a serialized object.
  135077. * @param source - Serialized object.
  135078. * @param scene Defines the scene we are parsing for
  135079. * @param rootUrl Defines the rootUrl to load from
  135080. */
  135081. parse(source: any, scene: Scene, rootUrl: string): void;
  135082. }
  135083. }
  135084. declare module BABYLON {
  135085. /**
  135086. * @hidden
  135087. */
  135088. export interface IMaterialBRDFDefines {
  135089. BRDF_V_HEIGHT_CORRELATED: boolean;
  135090. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135091. SPHERICAL_HARMONICS: boolean;
  135092. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135093. /** @hidden */
  135094. _areMiscDirty: boolean;
  135095. }
  135096. /**
  135097. * Define the code related to the BRDF parameters of the pbr material.
  135098. */
  135099. export class PBRBRDFConfiguration {
  135100. /**
  135101. * Default value used for the energy conservation.
  135102. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135103. */
  135104. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  135105. /**
  135106. * Default value used for the Smith Visibility Height Correlated mode.
  135107. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135108. */
  135109. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  135110. /**
  135111. * Default value used for the IBL diffuse part.
  135112. * This can help switching back to the polynomials mode globally which is a tiny bit
  135113. * less GPU intensive at the drawback of a lower quality.
  135114. */
  135115. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  135116. /**
  135117. * Default value used for activating energy conservation for the specular workflow.
  135118. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135119. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135120. */
  135121. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  135122. private _useEnergyConservation;
  135123. /**
  135124. * Defines if the material uses energy conservation.
  135125. */
  135126. useEnergyConservation: boolean;
  135127. private _useSmithVisibilityHeightCorrelated;
  135128. /**
  135129. * LEGACY Mode set to false
  135130. * Defines if the material uses height smith correlated visibility term.
  135131. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  135132. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  135133. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  135134. * Not relying on height correlated will also disable energy conservation.
  135135. */
  135136. useSmithVisibilityHeightCorrelated: boolean;
  135137. private _useSphericalHarmonics;
  135138. /**
  135139. * LEGACY Mode set to false
  135140. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  135141. * diffuse part of the IBL.
  135142. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  135143. * to the ground truth.
  135144. */
  135145. useSphericalHarmonics: boolean;
  135146. private _useSpecularGlossinessInputEnergyConservation;
  135147. /**
  135148. * Defines if the material uses energy conservation, when the specular workflow is active.
  135149. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135150. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135151. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  135152. */
  135153. useSpecularGlossinessInputEnergyConservation: boolean;
  135154. /** @hidden */
  135155. private _internalMarkAllSubMeshesAsMiscDirty;
  135156. /** @hidden */
  135157. _markAllSubMeshesAsMiscDirty(): void;
  135158. /**
  135159. * Instantiate a new istance of clear coat configuration.
  135160. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  135161. */
  135162. constructor(markAllSubMeshesAsMiscDirty: () => void);
  135163. /**
  135164. * Checks to see if a texture is used in the material.
  135165. * @param defines the list of "defines" to update.
  135166. */
  135167. prepareDefines(defines: IMaterialBRDFDefines): void;
  135168. /**
  135169. * Get the current class name of the texture useful for serialization or dynamic coding.
  135170. * @returns "PBRClearCoatConfiguration"
  135171. */
  135172. getClassName(): string;
  135173. /**
  135174. * Makes a duplicate of the current configuration into another one.
  135175. * @param brdfConfiguration define the config where to copy the info
  135176. */
  135177. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  135178. /**
  135179. * Serializes this BRDF configuration.
  135180. * @returns - An object with the serialized config.
  135181. */
  135182. serialize(): any;
  135183. /**
  135184. * Parses a anisotropy Configuration from a serialized object.
  135185. * @param source - Serialized object.
  135186. * @param scene Defines the scene we are parsing for
  135187. * @param rootUrl Defines the rootUrl to load from
  135188. */
  135189. parse(source: any, scene: Scene, rootUrl: string): void;
  135190. }
  135191. }
  135192. declare module BABYLON {
  135193. /**
  135194. * @hidden
  135195. */
  135196. export interface IMaterialSheenDefines {
  135197. SHEEN: boolean;
  135198. SHEEN_TEXTURE: boolean;
  135199. SHEEN_TEXTUREDIRECTUV: number;
  135200. SHEEN_LINKWITHALBEDO: boolean;
  135201. SHEEN_ROUGHNESS: boolean;
  135202. SHEEN_ALBEDOSCALING: boolean;
  135203. /** @hidden */
  135204. _areTexturesDirty: boolean;
  135205. }
  135206. /**
  135207. * Define the code related to the Sheen parameters of the pbr material.
  135208. */
  135209. export class PBRSheenConfiguration {
  135210. private _isEnabled;
  135211. /**
  135212. * Defines if the material uses sheen.
  135213. */
  135214. isEnabled: boolean;
  135215. private _linkSheenWithAlbedo;
  135216. /**
  135217. * Defines if the sheen is linked to the sheen color.
  135218. */
  135219. linkSheenWithAlbedo: boolean;
  135220. /**
  135221. * Defines the sheen intensity.
  135222. */
  135223. intensity: number;
  135224. /**
  135225. * Defines the sheen color.
  135226. */
  135227. color: Color3;
  135228. private _texture;
  135229. /**
  135230. * Stores the sheen tint values in a texture.
  135231. * rgb is tint
  135232. * a is a intensity or roughness if roughness has been defined
  135233. */
  135234. texture: Nullable<BaseTexture>;
  135235. private _roughness;
  135236. /**
  135237. * Defines the sheen roughness.
  135238. * It is not taken into account if linkSheenWithAlbedo is true.
  135239. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  135240. */
  135241. roughness: Nullable<number>;
  135242. private _albedoScaling;
  135243. /**
  135244. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  135245. * It allows the strength of the sheen effect to not depend on the base color of the material,
  135246. * making it easier to setup and tweak the effect
  135247. */
  135248. albedoScaling: boolean;
  135249. /** @hidden */
  135250. private _internalMarkAllSubMeshesAsTexturesDirty;
  135251. /** @hidden */
  135252. _markAllSubMeshesAsTexturesDirty(): void;
  135253. /**
  135254. * Instantiate a new istance of clear coat configuration.
  135255. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135256. */
  135257. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135258. /**
  135259. * Specifies that the submesh is ready to be used.
  135260. * @param defines the list of "defines" to update.
  135261. * @param scene defines the scene the material belongs to.
  135262. * @returns - boolean indicating that the submesh is ready or not.
  135263. */
  135264. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  135265. /**
  135266. * Checks to see if a texture is used in the material.
  135267. * @param defines the list of "defines" to update.
  135268. * @param scene defines the scene the material belongs to.
  135269. */
  135270. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  135271. /**
  135272. * Binds the material data.
  135273. * @param uniformBuffer defines the Uniform buffer to fill in.
  135274. * @param scene defines the scene the material belongs to.
  135275. * @param isFrozen defines wether the material is frozen or not.
  135276. */
  135277. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135278. /**
  135279. * Checks to see if a texture is used in the material.
  135280. * @param texture - Base texture to use.
  135281. * @returns - Boolean specifying if a texture is used in the material.
  135282. */
  135283. hasTexture(texture: BaseTexture): boolean;
  135284. /**
  135285. * Returns an array of the actively used textures.
  135286. * @param activeTextures Array of BaseTextures
  135287. */
  135288. getActiveTextures(activeTextures: BaseTexture[]): void;
  135289. /**
  135290. * Returns the animatable textures.
  135291. * @param animatables Array of animatable textures.
  135292. */
  135293. getAnimatables(animatables: IAnimatable[]): void;
  135294. /**
  135295. * Disposes the resources of the material.
  135296. * @param forceDisposeTextures - Forces the disposal of all textures.
  135297. */
  135298. dispose(forceDisposeTextures?: boolean): void;
  135299. /**
  135300. * Get the current class name of the texture useful for serialization or dynamic coding.
  135301. * @returns "PBRSheenConfiguration"
  135302. */
  135303. getClassName(): string;
  135304. /**
  135305. * Add fallbacks to the effect fallbacks list.
  135306. * @param defines defines the Base texture to use.
  135307. * @param fallbacks defines the current fallback list.
  135308. * @param currentRank defines the current fallback rank.
  135309. * @returns the new fallback rank.
  135310. */
  135311. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135312. /**
  135313. * Add the required uniforms to the current list.
  135314. * @param uniforms defines the current uniform list.
  135315. */
  135316. static AddUniforms(uniforms: string[]): void;
  135317. /**
  135318. * Add the required uniforms to the current buffer.
  135319. * @param uniformBuffer defines the current uniform buffer.
  135320. */
  135321. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135322. /**
  135323. * Add the required samplers to the current list.
  135324. * @param samplers defines the current sampler list.
  135325. */
  135326. static AddSamplers(samplers: string[]): void;
  135327. /**
  135328. * Makes a duplicate of the current configuration into another one.
  135329. * @param sheenConfiguration define the config where to copy the info
  135330. */
  135331. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  135332. /**
  135333. * Serializes this BRDF configuration.
  135334. * @returns - An object with the serialized config.
  135335. */
  135336. serialize(): any;
  135337. /**
  135338. * Parses a anisotropy Configuration from a serialized object.
  135339. * @param source - Serialized object.
  135340. * @param scene Defines the scene we are parsing for
  135341. * @param rootUrl Defines the rootUrl to load from
  135342. */
  135343. parse(source: any, scene: Scene, rootUrl: string): void;
  135344. }
  135345. }
  135346. declare module BABYLON {
  135347. /**
  135348. * @hidden
  135349. */
  135350. export interface IMaterialSubSurfaceDefines {
  135351. SUBSURFACE: boolean;
  135352. SS_REFRACTION: boolean;
  135353. SS_TRANSLUCENCY: boolean;
  135354. SS_SCATTERING: boolean;
  135355. SS_THICKNESSANDMASK_TEXTURE: boolean;
  135356. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  135357. SS_REFRACTIONMAP_3D: boolean;
  135358. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  135359. SS_LODINREFRACTIONALPHA: boolean;
  135360. SS_GAMMAREFRACTION: boolean;
  135361. SS_RGBDREFRACTION: boolean;
  135362. SS_LINEARSPECULARREFRACTION: boolean;
  135363. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  135364. SS_ALBEDOFORREFRACTIONTINT: boolean;
  135365. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  135366. /** @hidden */
  135367. _areTexturesDirty: boolean;
  135368. }
  135369. /**
  135370. * Define the code related to the sub surface parameters of the pbr material.
  135371. */
  135372. export class PBRSubSurfaceConfiguration {
  135373. private _isRefractionEnabled;
  135374. /**
  135375. * Defines if the refraction is enabled in the material.
  135376. */
  135377. isRefractionEnabled: boolean;
  135378. private _isTranslucencyEnabled;
  135379. /**
  135380. * Defines if the translucency is enabled in the material.
  135381. */
  135382. isTranslucencyEnabled: boolean;
  135383. private _isScatteringEnabled;
  135384. /**
  135385. * Defines if the sub surface scattering is enabled in the material.
  135386. */
  135387. isScatteringEnabled: boolean;
  135388. private _scatteringDiffusionProfileIndex;
  135389. /**
  135390. * Diffusion profile for subsurface scattering.
  135391. * Useful for better scattering in the skins or foliages.
  135392. */
  135393. get scatteringDiffusionProfile(): Nullable<Color3>;
  135394. set scatteringDiffusionProfile(c: Nullable<Color3>);
  135395. /**
  135396. * Defines the refraction intensity of the material.
  135397. * The refraction when enabled replaces the Diffuse part of the material.
  135398. * The intensity helps transitionning between diffuse and refraction.
  135399. */
  135400. refractionIntensity: number;
  135401. /**
  135402. * Defines the translucency intensity of the material.
  135403. * When translucency has been enabled, this defines how much of the "translucency"
  135404. * is addded to the diffuse part of the material.
  135405. */
  135406. translucencyIntensity: number;
  135407. /**
  135408. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  135409. */
  135410. useAlbedoToTintRefraction: boolean;
  135411. private _thicknessTexture;
  135412. /**
  135413. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  135414. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  135415. * 0 would mean minimumThickness
  135416. * 1 would mean maximumThickness
  135417. * The other channels might be use as a mask to vary the different effects intensity.
  135418. */
  135419. thicknessTexture: Nullable<BaseTexture>;
  135420. private _refractionTexture;
  135421. /**
  135422. * Defines the texture to use for refraction.
  135423. */
  135424. refractionTexture: Nullable<BaseTexture>;
  135425. private _indexOfRefraction;
  135426. /**
  135427. * Index of refraction of the material base layer.
  135428. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135429. *
  135430. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  135431. *
  135432. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  135433. */
  135434. indexOfRefraction: number;
  135435. private _volumeIndexOfRefraction;
  135436. /**
  135437. * Index of refraction of the material's volume.
  135438. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135439. *
  135440. * This ONLY impacts refraction. If not provided or given a non-valid value,
  135441. * the volume will use the same IOR as the surface.
  135442. */
  135443. get volumeIndexOfRefraction(): number;
  135444. set volumeIndexOfRefraction(value: number);
  135445. private _invertRefractionY;
  135446. /**
  135447. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  135448. */
  135449. invertRefractionY: boolean;
  135450. private _linkRefractionWithTransparency;
  135451. /**
  135452. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  135453. * Materials half opaque for instance using refraction could benefit from this control.
  135454. */
  135455. linkRefractionWithTransparency: boolean;
  135456. /**
  135457. * Defines the minimum thickness stored in the thickness map.
  135458. * If no thickness map is defined, this value will be used to simulate thickness.
  135459. */
  135460. minimumThickness: number;
  135461. /**
  135462. * Defines the maximum thickness stored in the thickness map.
  135463. */
  135464. maximumThickness: number;
  135465. /**
  135466. * Defines the volume tint of the material.
  135467. * This is used for both translucency and scattering.
  135468. */
  135469. tintColor: Color3;
  135470. /**
  135471. * Defines the distance at which the tint color should be found in the media.
  135472. * This is used for refraction only.
  135473. */
  135474. tintColorAtDistance: number;
  135475. /**
  135476. * Defines how far each channel transmit through the media.
  135477. * It is defined as a color to simplify it selection.
  135478. */
  135479. diffusionDistance: Color3;
  135480. private _useMaskFromThicknessTexture;
  135481. /**
  135482. * Stores the intensity of the different subsurface effects in the thickness texture.
  135483. * * the green channel is the translucency intensity.
  135484. * * the blue channel is the scattering intensity.
  135485. * * the alpha channel is the refraction intensity.
  135486. */
  135487. useMaskFromThicknessTexture: boolean;
  135488. private _scene;
  135489. /** @hidden */
  135490. private _internalMarkAllSubMeshesAsTexturesDirty;
  135491. private _internalMarkScenePrePassDirty;
  135492. /** @hidden */
  135493. _markAllSubMeshesAsTexturesDirty(): void;
  135494. /** @hidden */
  135495. _markScenePrePassDirty(): void;
  135496. /**
  135497. * Instantiate a new istance of sub surface configuration.
  135498. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135499. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  135500. * @param scene The scene
  135501. */
  135502. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  135503. /**
  135504. * Gets wehter the submesh is ready to be used or not.
  135505. * @param defines the list of "defines" to update.
  135506. * @param scene defines the scene the material belongs to.
  135507. * @returns - boolean indicating that the submesh is ready or not.
  135508. */
  135509. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  135510. /**
  135511. * Checks to see if a texture is used in the material.
  135512. * @param defines the list of "defines" to update.
  135513. * @param scene defines the scene to the material belongs to.
  135514. */
  135515. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  135516. /**
  135517. * Binds the material data.
  135518. * @param uniformBuffer defines the Uniform buffer to fill in.
  135519. * @param scene defines the scene the material belongs to.
  135520. * @param engine defines the engine the material belongs to.
  135521. * @param isFrozen defines whether the material is frozen or not.
  135522. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  135523. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  135524. */
  135525. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  135526. /**
  135527. * Unbinds the material from the mesh.
  135528. * @param activeEffect defines the effect that should be unbound from.
  135529. * @returns true if unbound, otherwise false
  135530. */
  135531. unbind(activeEffect: Effect): boolean;
  135532. /**
  135533. * Returns the texture used for refraction or null if none is used.
  135534. * @param scene defines the scene the material belongs to.
  135535. * @returns - Refraction texture if present. If no refraction texture and refraction
  135536. * is linked with transparency, returns environment texture. Otherwise, returns null.
  135537. */
  135538. private _getRefractionTexture;
  135539. /**
  135540. * Returns true if alpha blending should be disabled.
  135541. */
  135542. get disableAlphaBlending(): boolean;
  135543. /**
  135544. * Fills the list of render target textures.
  135545. * @param renderTargets the list of render targets to update
  135546. */
  135547. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  135548. /**
  135549. * Checks to see if a texture is used in the material.
  135550. * @param texture - Base texture to use.
  135551. * @returns - Boolean specifying if a texture is used in the material.
  135552. */
  135553. hasTexture(texture: BaseTexture): boolean;
  135554. /**
  135555. * Gets a boolean indicating that current material needs to register RTT
  135556. * @returns true if this uses a render target otherwise false.
  135557. */
  135558. hasRenderTargetTextures(): boolean;
  135559. /**
  135560. * Returns an array of the actively used textures.
  135561. * @param activeTextures Array of BaseTextures
  135562. */
  135563. getActiveTextures(activeTextures: BaseTexture[]): void;
  135564. /**
  135565. * Returns the animatable textures.
  135566. * @param animatables Array of animatable textures.
  135567. */
  135568. getAnimatables(animatables: IAnimatable[]): void;
  135569. /**
  135570. * Disposes the resources of the material.
  135571. * @param forceDisposeTextures - Forces the disposal of all textures.
  135572. */
  135573. dispose(forceDisposeTextures?: boolean): void;
  135574. /**
  135575. * Get the current class name of the texture useful for serialization or dynamic coding.
  135576. * @returns "PBRSubSurfaceConfiguration"
  135577. */
  135578. getClassName(): string;
  135579. /**
  135580. * Add fallbacks to the effect fallbacks list.
  135581. * @param defines defines the Base texture to use.
  135582. * @param fallbacks defines the current fallback list.
  135583. * @param currentRank defines the current fallback rank.
  135584. * @returns the new fallback rank.
  135585. */
  135586. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135587. /**
  135588. * Add the required uniforms to the current list.
  135589. * @param uniforms defines the current uniform list.
  135590. */
  135591. static AddUniforms(uniforms: string[]): void;
  135592. /**
  135593. * Add the required samplers to the current list.
  135594. * @param samplers defines the current sampler list.
  135595. */
  135596. static AddSamplers(samplers: string[]): void;
  135597. /**
  135598. * Add the required uniforms to the current buffer.
  135599. * @param uniformBuffer defines the current uniform buffer.
  135600. */
  135601. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135602. /**
  135603. * Makes a duplicate of the current configuration into another one.
  135604. * @param configuration define the config where to copy the info
  135605. */
  135606. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  135607. /**
  135608. * Serializes this Sub Surface configuration.
  135609. * @returns - An object with the serialized config.
  135610. */
  135611. serialize(): any;
  135612. /**
  135613. * Parses a anisotropy Configuration from a serialized object.
  135614. * @param source - Serialized object.
  135615. * @param scene Defines the scene we are parsing for
  135616. * @param rootUrl Defines the rootUrl to load from
  135617. */
  135618. parse(source: any, scene: Scene, rootUrl: string): void;
  135619. }
  135620. }
  135621. declare module BABYLON {
  135622. /** @hidden */
  135623. export var pbrFragmentDeclaration: {
  135624. name: string;
  135625. shader: string;
  135626. };
  135627. }
  135628. declare module BABYLON {
  135629. /** @hidden */
  135630. export var pbrUboDeclaration: {
  135631. name: string;
  135632. shader: string;
  135633. };
  135634. }
  135635. declare module BABYLON {
  135636. /** @hidden */
  135637. export var pbrFragmentExtraDeclaration: {
  135638. name: string;
  135639. shader: string;
  135640. };
  135641. }
  135642. declare module BABYLON {
  135643. /** @hidden */
  135644. export var pbrFragmentSamplersDeclaration: {
  135645. name: string;
  135646. shader: string;
  135647. };
  135648. }
  135649. declare module BABYLON {
  135650. /** @hidden */
  135651. export var importanceSampling: {
  135652. name: string;
  135653. shader: string;
  135654. };
  135655. }
  135656. declare module BABYLON {
  135657. /** @hidden */
  135658. export var pbrHelperFunctions: {
  135659. name: string;
  135660. shader: string;
  135661. };
  135662. }
  135663. declare module BABYLON {
  135664. /** @hidden */
  135665. export var harmonicsFunctions: {
  135666. name: string;
  135667. shader: string;
  135668. };
  135669. }
  135670. declare module BABYLON {
  135671. /** @hidden */
  135672. export var pbrDirectLightingSetupFunctions: {
  135673. name: string;
  135674. shader: string;
  135675. };
  135676. }
  135677. declare module BABYLON {
  135678. /** @hidden */
  135679. export var pbrDirectLightingFalloffFunctions: {
  135680. name: string;
  135681. shader: string;
  135682. };
  135683. }
  135684. declare module BABYLON {
  135685. /** @hidden */
  135686. export var pbrBRDFFunctions: {
  135687. name: string;
  135688. shader: string;
  135689. };
  135690. }
  135691. declare module BABYLON {
  135692. /** @hidden */
  135693. export var hdrFilteringFunctions: {
  135694. name: string;
  135695. shader: string;
  135696. };
  135697. }
  135698. declare module BABYLON {
  135699. /** @hidden */
  135700. export var pbrDirectLightingFunctions: {
  135701. name: string;
  135702. shader: string;
  135703. };
  135704. }
  135705. declare module BABYLON {
  135706. /** @hidden */
  135707. export var pbrIBLFunctions: {
  135708. name: string;
  135709. shader: string;
  135710. };
  135711. }
  135712. declare module BABYLON {
  135713. /** @hidden */
  135714. export var pbrBlockAlbedoOpacity: {
  135715. name: string;
  135716. shader: string;
  135717. };
  135718. }
  135719. declare module BABYLON {
  135720. /** @hidden */
  135721. export var pbrBlockReflectivity: {
  135722. name: string;
  135723. shader: string;
  135724. };
  135725. }
  135726. declare module BABYLON {
  135727. /** @hidden */
  135728. export var pbrBlockAmbientOcclusion: {
  135729. name: string;
  135730. shader: string;
  135731. };
  135732. }
  135733. declare module BABYLON {
  135734. /** @hidden */
  135735. export var pbrBlockAlphaFresnel: {
  135736. name: string;
  135737. shader: string;
  135738. };
  135739. }
  135740. declare module BABYLON {
  135741. /** @hidden */
  135742. export var pbrBlockAnisotropic: {
  135743. name: string;
  135744. shader: string;
  135745. };
  135746. }
  135747. declare module BABYLON {
  135748. /** @hidden */
  135749. export var pbrBlockReflection: {
  135750. name: string;
  135751. shader: string;
  135752. };
  135753. }
  135754. declare module BABYLON {
  135755. /** @hidden */
  135756. export var pbrBlockSheen: {
  135757. name: string;
  135758. shader: string;
  135759. };
  135760. }
  135761. declare module BABYLON {
  135762. /** @hidden */
  135763. export var pbrBlockClearcoat: {
  135764. name: string;
  135765. shader: string;
  135766. };
  135767. }
  135768. declare module BABYLON {
  135769. /** @hidden */
  135770. export var pbrBlockSubSurface: {
  135771. name: string;
  135772. shader: string;
  135773. };
  135774. }
  135775. declare module BABYLON {
  135776. /** @hidden */
  135777. export var pbrBlockNormalGeometric: {
  135778. name: string;
  135779. shader: string;
  135780. };
  135781. }
  135782. declare module BABYLON {
  135783. /** @hidden */
  135784. export var pbrBlockNormalFinal: {
  135785. name: string;
  135786. shader: string;
  135787. };
  135788. }
  135789. declare module BABYLON {
  135790. /** @hidden */
  135791. export var pbrBlockLightmapInit: {
  135792. name: string;
  135793. shader: string;
  135794. };
  135795. }
  135796. declare module BABYLON {
  135797. /** @hidden */
  135798. export var pbrBlockGeometryInfo: {
  135799. name: string;
  135800. shader: string;
  135801. };
  135802. }
  135803. declare module BABYLON {
  135804. /** @hidden */
  135805. export var pbrBlockReflectance0: {
  135806. name: string;
  135807. shader: string;
  135808. };
  135809. }
  135810. declare module BABYLON {
  135811. /** @hidden */
  135812. export var pbrBlockReflectance: {
  135813. name: string;
  135814. shader: string;
  135815. };
  135816. }
  135817. declare module BABYLON {
  135818. /** @hidden */
  135819. export var pbrBlockDirectLighting: {
  135820. name: string;
  135821. shader: string;
  135822. };
  135823. }
  135824. declare module BABYLON {
  135825. /** @hidden */
  135826. export var pbrBlockFinalLitComponents: {
  135827. name: string;
  135828. shader: string;
  135829. };
  135830. }
  135831. declare module BABYLON {
  135832. /** @hidden */
  135833. export var pbrBlockFinalUnlitComponents: {
  135834. name: string;
  135835. shader: string;
  135836. };
  135837. }
  135838. declare module BABYLON {
  135839. /** @hidden */
  135840. export var pbrBlockFinalColorComposition: {
  135841. name: string;
  135842. shader: string;
  135843. };
  135844. }
  135845. declare module BABYLON {
  135846. /** @hidden */
  135847. export var pbrBlockImageProcessing: {
  135848. name: string;
  135849. shader: string;
  135850. };
  135851. }
  135852. declare module BABYLON {
  135853. /** @hidden */
  135854. export var pbrDebug: {
  135855. name: string;
  135856. shader: string;
  135857. };
  135858. }
  135859. declare module BABYLON {
  135860. /** @hidden */
  135861. export var pbrPixelShader: {
  135862. name: string;
  135863. shader: string;
  135864. };
  135865. }
  135866. declare module BABYLON {
  135867. /** @hidden */
  135868. export var pbrVertexDeclaration: {
  135869. name: string;
  135870. shader: string;
  135871. };
  135872. }
  135873. declare module BABYLON {
  135874. /** @hidden */
  135875. export var pbrVertexShader: {
  135876. name: string;
  135877. shader: string;
  135878. };
  135879. }
  135880. declare module BABYLON {
  135881. /**
  135882. * Manages the defines for the PBR Material.
  135883. * @hidden
  135884. */
  135885. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  135886. PBR: boolean;
  135887. NUM_SAMPLES: string;
  135888. REALTIME_FILTERING: boolean;
  135889. MAINUV1: boolean;
  135890. MAINUV2: boolean;
  135891. UV1: boolean;
  135892. UV2: boolean;
  135893. ALBEDO: boolean;
  135894. GAMMAALBEDO: boolean;
  135895. ALBEDODIRECTUV: number;
  135896. VERTEXCOLOR: boolean;
  135897. DETAIL: boolean;
  135898. DETAILDIRECTUV: number;
  135899. DETAIL_NORMALBLENDMETHOD: number;
  135900. AMBIENT: boolean;
  135901. AMBIENTDIRECTUV: number;
  135902. AMBIENTINGRAYSCALE: boolean;
  135903. OPACITY: boolean;
  135904. VERTEXALPHA: boolean;
  135905. OPACITYDIRECTUV: number;
  135906. OPACITYRGB: boolean;
  135907. ALPHATEST: boolean;
  135908. DEPTHPREPASS: boolean;
  135909. ALPHABLEND: boolean;
  135910. ALPHAFROMALBEDO: boolean;
  135911. ALPHATESTVALUE: string;
  135912. SPECULAROVERALPHA: boolean;
  135913. RADIANCEOVERALPHA: boolean;
  135914. ALPHAFRESNEL: boolean;
  135915. LINEARALPHAFRESNEL: boolean;
  135916. PREMULTIPLYALPHA: boolean;
  135917. EMISSIVE: boolean;
  135918. EMISSIVEDIRECTUV: number;
  135919. REFLECTIVITY: boolean;
  135920. REFLECTIVITYDIRECTUV: number;
  135921. SPECULARTERM: boolean;
  135922. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  135923. MICROSURFACEAUTOMATIC: boolean;
  135924. LODBASEDMICROSFURACE: boolean;
  135925. MICROSURFACEMAP: boolean;
  135926. MICROSURFACEMAPDIRECTUV: number;
  135927. METALLICWORKFLOW: boolean;
  135928. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  135929. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  135930. METALLNESSSTOREINMETALMAPBLUE: boolean;
  135931. AOSTOREINMETALMAPRED: boolean;
  135932. METALLIC_REFLECTANCE: boolean;
  135933. METALLIC_REFLECTANCEDIRECTUV: number;
  135934. ENVIRONMENTBRDF: boolean;
  135935. ENVIRONMENTBRDF_RGBD: boolean;
  135936. NORMAL: boolean;
  135937. TANGENT: boolean;
  135938. BUMP: boolean;
  135939. BUMPDIRECTUV: number;
  135940. OBJECTSPACE_NORMALMAP: boolean;
  135941. PARALLAX: boolean;
  135942. PARALLAXOCCLUSION: boolean;
  135943. NORMALXYSCALE: boolean;
  135944. LIGHTMAP: boolean;
  135945. LIGHTMAPDIRECTUV: number;
  135946. USELIGHTMAPASSHADOWMAP: boolean;
  135947. GAMMALIGHTMAP: boolean;
  135948. RGBDLIGHTMAP: boolean;
  135949. REFLECTION: boolean;
  135950. REFLECTIONMAP_3D: boolean;
  135951. REFLECTIONMAP_SPHERICAL: boolean;
  135952. REFLECTIONMAP_PLANAR: boolean;
  135953. REFLECTIONMAP_CUBIC: boolean;
  135954. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  135955. REFLECTIONMAP_PROJECTION: boolean;
  135956. REFLECTIONMAP_SKYBOX: boolean;
  135957. REFLECTIONMAP_EXPLICIT: boolean;
  135958. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  135959. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  135960. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  135961. INVERTCUBICMAP: boolean;
  135962. USESPHERICALFROMREFLECTIONMAP: boolean;
  135963. USEIRRADIANCEMAP: boolean;
  135964. SPHERICAL_HARMONICS: boolean;
  135965. USESPHERICALINVERTEX: boolean;
  135966. REFLECTIONMAP_OPPOSITEZ: boolean;
  135967. LODINREFLECTIONALPHA: boolean;
  135968. GAMMAREFLECTION: boolean;
  135969. RGBDREFLECTION: boolean;
  135970. LINEARSPECULARREFLECTION: boolean;
  135971. RADIANCEOCCLUSION: boolean;
  135972. HORIZONOCCLUSION: boolean;
  135973. INSTANCES: boolean;
  135974. THIN_INSTANCES: boolean;
  135975. PREPASS: boolean;
  135976. SCENE_MRT_COUNT: number;
  135977. NUM_BONE_INFLUENCERS: number;
  135978. BonesPerMesh: number;
  135979. BONETEXTURE: boolean;
  135980. NONUNIFORMSCALING: boolean;
  135981. MORPHTARGETS: boolean;
  135982. MORPHTARGETS_NORMAL: boolean;
  135983. MORPHTARGETS_TANGENT: boolean;
  135984. MORPHTARGETS_UV: boolean;
  135985. NUM_MORPH_INFLUENCERS: number;
  135986. IMAGEPROCESSING: boolean;
  135987. VIGNETTE: boolean;
  135988. VIGNETTEBLENDMODEMULTIPLY: boolean;
  135989. VIGNETTEBLENDMODEOPAQUE: boolean;
  135990. TONEMAPPING: boolean;
  135991. TONEMAPPING_ACES: boolean;
  135992. CONTRAST: boolean;
  135993. COLORCURVES: boolean;
  135994. COLORGRADING: boolean;
  135995. COLORGRADING3D: boolean;
  135996. SAMPLER3DGREENDEPTH: boolean;
  135997. SAMPLER3DBGRMAP: boolean;
  135998. IMAGEPROCESSINGPOSTPROCESS: boolean;
  135999. EXPOSURE: boolean;
  136000. MULTIVIEW: boolean;
  136001. USEPHYSICALLIGHTFALLOFF: boolean;
  136002. USEGLTFLIGHTFALLOFF: boolean;
  136003. TWOSIDEDLIGHTING: boolean;
  136004. SHADOWFLOAT: boolean;
  136005. CLIPPLANE: boolean;
  136006. CLIPPLANE2: boolean;
  136007. CLIPPLANE3: boolean;
  136008. CLIPPLANE4: boolean;
  136009. CLIPPLANE5: boolean;
  136010. CLIPPLANE6: boolean;
  136011. POINTSIZE: boolean;
  136012. FOG: boolean;
  136013. LOGARITHMICDEPTH: boolean;
  136014. FORCENORMALFORWARD: boolean;
  136015. SPECULARAA: boolean;
  136016. CLEARCOAT: boolean;
  136017. CLEARCOAT_DEFAULTIOR: boolean;
  136018. CLEARCOAT_TEXTURE: boolean;
  136019. CLEARCOAT_TEXTUREDIRECTUV: number;
  136020. CLEARCOAT_BUMP: boolean;
  136021. CLEARCOAT_BUMPDIRECTUV: number;
  136022. CLEARCOAT_TINT: boolean;
  136023. CLEARCOAT_TINT_TEXTURE: boolean;
  136024. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  136025. ANISOTROPIC: boolean;
  136026. ANISOTROPIC_TEXTURE: boolean;
  136027. ANISOTROPIC_TEXTUREDIRECTUV: number;
  136028. BRDF_V_HEIGHT_CORRELATED: boolean;
  136029. MS_BRDF_ENERGY_CONSERVATION: boolean;
  136030. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  136031. SHEEN: boolean;
  136032. SHEEN_TEXTURE: boolean;
  136033. SHEEN_TEXTUREDIRECTUV: number;
  136034. SHEEN_LINKWITHALBEDO: boolean;
  136035. SHEEN_ROUGHNESS: boolean;
  136036. SHEEN_ALBEDOSCALING: boolean;
  136037. SUBSURFACE: boolean;
  136038. SS_REFRACTION: boolean;
  136039. SS_TRANSLUCENCY: boolean;
  136040. SS_SCATTERING: boolean;
  136041. SS_THICKNESSANDMASK_TEXTURE: boolean;
  136042. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  136043. SS_REFRACTIONMAP_3D: boolean;
  136044. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  136045. SS_LODINREFRACTIONALPHA: boolean;
  136046. SS_GAMMAREFRACTION: boolean;
  136047. SS_RGBDREFRACTION: boolean;
  136048. SS_LINEARSPECULARREFRACTION: boolean;
  136049. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  136050. SS_ALBEDOFORREFRACTIONTINT: boolean;
  136051. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  136052. UNLIT: boolean;
  136053. DEBUGMODE: number;
  136054. /**
  136055. * Initializes the PBR Material defines.
  136056. */
  136057. constructor();
  136058. /**
  136059. * Resets the PBR Material defines.
  136060. */
  136061. reset(): void;
  136062. }
  136063. /**
  136064. * The Physically based material base class of BJS.
  136065. *
  136066. * This offers the main features of a standard PBR material.
  136067. * For more information, please refer to the documentation :
  136068. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136069. */
  136070. export abstract class PBRBaseMaterial extends PushMaterial {
  136071. /**
  136072. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136073. */
  136074. static readonly PBRMATERIAL_OPAQUE: number;
  136075. /**
  136076. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136077. */
  136078. static readonly PBRMATERIAL_ALPHATEST: number;
  136079. /**
  136080. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136081. */
  136082. static readonly PBRMATERIAL_ALPHABLEND: number;
  136083. /**
  136084. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136085. * They are also discarded below the alpha cutoff threshold to improve performances.
  136086. */
  136087. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136088. /**
  136089. * Defines the default value of how much AO map is occluding the analytical lights
  136090. * (point spot...).
  136091. */
  136092. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136093. /**
  136094. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  136095. */
  136096. static readonly LIGHTFALLOFF_PHYSICAL: number;
  136097. /**
  136098. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  136099. * to enhance interoperability with other engines.
  136100. */
  136101. static readonly LIGHTFALLOFF_GLTF: number;
  136102. /**
  136103. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  136104. * to enhance interoperability with other materials.
  136105. */
  136106. static readonly LIGHTFALLOFF_STANDARD: number;
  136107. /**
  136108. * Intensity of the direct lights e.g. the four lights available in your scene.
  136109. * This impacts both the direct diffuse and specular highlights.
  136110. */
  136111. protected _directIntensity: number;
  136112. /**
  136113. * Intensity of the emissive part of the material.
  136114. * This helps controlling the emissive effect without modifying the emissive color.
  136115. */
  136116. protected _emissiveIntensity: number;
  136117. /**
  136118. * Intensity of the environment e.g. how much the environment will light the object
  136119. * either through harmonics for rough material or through the refelction for shiny ones.
  136120. */
  136121. protected _environmentIntensity: number;
  136122. /**
  136123. * This is a special control allowing the reduction of the specular highlights coming from the
  136124. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136125. */
  136126. protected _specularIntensity: number;
  136127. /**
  136128. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  136129. */
  136130. private _lightingInfos;
  136131. /**
  136132. * Debug Control allowing disabling the bump map on this material.
  136133. */
  136134. protected _disableBumpMap: boolean;
  136135. /**
  136136. * AKA Diffuse Texture in standard nomenclature.
  136137. */
  136138. protected _albedoTexture: Nullable<BaseTexture>;
  136139. /**
  136140. * AKA Occlusion Texture in other nomenclature.
  136141. */
  136142. protected _ambientTexture: Nullable<BaseTexture>;
  136143. /**
  136144. * AKA Occlusion Texture Intensity in other nomenclature.
  136145. */
  136146. protected _ambientTextureStrength: number;
  136147. /**
  136148. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136149. * 1 means it completely occludes it
  136150. * 0 mean it has no impact
  136151. */
  136152. protected _ambientTextureImpactOnAnalyticalLights: number;
  136153. /**
  136154. * Stores the alpha values in a texture.
  136155. */
  136156. protected _opacityTexture: Nullable<BaseTexture>;
  136157. /**
  136158. * Stores the reflection values in a texture.
  136159. */
  136160. protected _reflectionTexture: Nullable<BaseTexture>;
  136161. /**
  136162. * Stores the emissive values in a texture.
  136163. */
  136164. protected _emissiveTexture: Nullable<BaseTexture>;
  136165. /**
  136166. * AKA Specular texture in other nomenclature.
  136167. */
  136168. protected _reflectivityTexture: Nullable<BaseTexture>;
  136169. /**
  136170. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136171. */
  136172. protected _metallicTexture: Nullable<BaseTexture>;
  136173. /**
  136174. * Specifies the metallic scalar of the metallic/roughness workflow.
  136175. * Can also be used to scale the metalness values of the metallic texture.
  136176. */
  136177. protected _metallic: Nullable<number>;
  136178. /**
  136179. * Specifies the roughness scalar of the metallic/roughness workflow.
  136180. * Can also be used to scale the roughness values of the metallic texture.
  136181. */
  136182. protected _roughness: Nullable<number>;
  136183. /**
  136184. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136185. * By default the indexOfrefraction is used to compute F0;
  136186. *
  136187. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136188. *
  136189. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136190. * F90 = metallicReflectanceColor;
  136191. */
  136192. protected _metallicF0Factor: number;
  136193. /**
  136194. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136195. * By default the F90 is always 1;
  136196. *
  136197. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136198. *
  136199. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136200. * F90 = metallicReflectanceColor;
  136201. */
  136202. protected _metallicReflectanceColor: Color3;
  136203. /**
  136204. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136205. * This is multiply against the scalar values defined in the material.
  136206. */
  136207. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  136208. /**
  136209. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136210. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136211. */
  136212. protected _microSurfaceTexture: Nullable<BaseTexture>;
  136213. /**
  136214. * Stores surface normal data used to displace a mesh in a texture.
  136215. */
  136216. protected _bumpTexture: Nullable<BaseTexture>;
  136217. /**
  136218. * Stores the pre-calculated light information of a mesh in a texture.
  136219. */
  136220. protected _lightmapTexture: Nullable<BaseTexture>;
  136221. /**
  136222. * The color of a material in ambient lighting.
  136223. */
  136224. protected _ambientColor: Color3;
  136225. /**
  136226. * AKA Diffuse Color in other nomenclature.
  136227. */
  136228. protected _albedoColor: Color3;
  136229. /**
  136230. * AKA Specular Color in other nomenclature.
  136231. */
  136232. protected _reflectivityColor: Color3;
  136233. /**
  136234. * The color applied when light is reflected from a material.
  136235. */
  136236. protected _reflectionColor: Color3;
  136237. /**
  136238. * The color applied when light is emitted from a material.
  136239. */
  136240. protected _emissiveColor: Color3;
  136241. /**
  136242. * AKA Glossiness in other nomenclature.
  136243. */
  136244. protected _microSurface: number;
  136245. /**
  136246. * Specifies that the material will use the light map as a show map.
  136247. */
  136248. protected _useLightmapAsShadowmap: boolean;
  136249. /**
  136250. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136251. * makes the reflect vector face the model (under horizon).
  136252. */
  136253. protected _useHorizonOcclusion: boolean;
  136254. /**
  136255. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136256. * too much the area relying on ambient texture to define their ambient occlusion.
  136257. */
  136258. protected _useRadianceOcclusion: boolean;
  136259. /**
  136260. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136261. */
  136262. protected _useAlphaFromAlbedoTexture: boolean;
  136263. /**
  136264. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  136265. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136266. */
  136267. protected _useSpecularOverAlpha: boolean;
  136268. /**
  136269. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136270. */
  136271. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136272. /**
  136273. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136274. */
  136275. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  136276. /**
  136277. * Specifies if the metallic texture contains the roughness information in its green channel.
  136278. */
  136279. protected _useRoughnessFromMetallicTextureGreen: boolean;
  136280. /**
  136281. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136282. */
  136283. protected _useMetallnessFromMetallicTextureBlue: boolean;
  136284. /**
  136285. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136286. */
  136287. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  136288. /**
  136289. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136290. */
  136291. protected _useAmbientInGrayScale: boolean;
  136292. /**
  136293. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136294. * The material will try to infer what glossiness each pixel should be.
  136295. */
  136296. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  136297. /**
  136298. * Defines the falloff type used in this material.
  136299. * It by default is Physical.
  136300. */
  136301. protected _lightFalloff: number;
  136302. /**
  136303. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136304. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136305. */
  136306. protected _useRadianceOverAlpha: boolean;
  136307. /**
  136308. * Allows using an object space normal map (instead of tangent space).
  136309. */
  136310. protected _useObjectSpaceNormalMap: boolean;
  136311. /**
  136312. * Allows using the bump map in parallax mode.
  136313. */
  136314. protected _useParallax: boolean;
  136315. /**
  136316. * Allows using the bump map in parallax occlusion mode.
  136317. */
  136318. protected _useParallaxOcclusion: boolean;
  136319. /**
  136320. * Controls the scale bias of the parallax mode.
  136321. */
  136322. protected _parallaxScaleBias: number;
  136323. /**
  136324. * If sets to true, disables all the lights affecting the material.
  136325. */
  136326. protected _disableLighting: boolean;
  136327. /**
  136328. * Number of Simultaneous lights allowed on the material.
  136329. */
  136330. protected _maxSimultaneousLights: number;
  136331. /**
  136332. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  136333. */
  136334. protected _invertNormalMapX: boolean;
  136335. /**
  136336. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  136337. */
  136338. protected _invertNormalMapY: boolean;
  136339. /**
  136340. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136341. */
  136342. protected _twoSidedLighting: boolean;
  136343. /**
  136344. * Defines the alpha limits in alpha test mode.
  136345. */
  136346. protected _alphaCutOff: number;
  136347. /**
  136348. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136349. */
  136350. protected _forceAlphaTest: boolean;
  136351. /**
  136352. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136353. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136354. */
  136355. protected _useAlphaFresnel: boolean;
  136356. /**
  136357. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136358. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136359. */
  136360. protected _useLinearAlphaFresnel: boolean;
  136361. /**
  136362. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  136363. * from cos thetav and roughness:
  136364. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  136365. */
  136366. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  136367. /**
  136368. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136369. */
  136370. protected _forceIrradianceInFragment: boolean;
  136371. private _realTimeFiltering;
  136372. /**
  136373. * Enables realtime filtering on the texture.
  136374. */
  136375. get realTimeFiltering(): boolean;
  136376. set realTimeFiltering(b: boolean);
  136377. private _realTimeFilteringQuality;
  136378. /**
  136379. * Quality switch for realtime filtering
  136380. */
  136381. get realTimeFilteringQuality(): number;
  136382. set realTimeFilteringQuality(n: number);
  136383. /**
  136384. * Can this material render to several textures at once
  136385. */
  136386. get canRenderToMRT(): boolean;
  136387. /**
  136388. * Force normal to face away from face.
  136389. */
  136390. protected _forceNormalForward: boolean;
  136391. /**
  136392. * Enables specular anti aliasing in the PBR shader.
  136393. * It will both interacts on the Geometry for analytical and IBL lighting.
  136394. * It also prefilter the roughness map based on the bump values.
  136395. */
  136396. protected _enableSpecularAntiAliasing: boolean;
  136397. /**
  136398. * Default configuration related to image processing available in the PBR Material.
  136399. */
  136400. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  136401. /**
  136402. * Keep track of the image processing observer to allow dispose and replace.
  136403. */
  136404. private _imageProcessingObserver;
  136405. /**
  136406. * Attaches a new image processing configuration to the PBR Material.
  136407. * @param configuration
  136408. */
  136409. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  136410. /**
  136411. * Stores the available render targets.
  136412. */
  136413. private _renderTargets;
  136414. /**
  136415. * Sets the global ambient color for the material used in lighting calculations.
  136416. */
  136417. private _globalAmbientColor;
  136418. /**
  136419. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  136420. */
  136421. private _useLogarithmicDepth;
  136422. /**
  136423. * If set to true, no lighting calculations will be applied.
  136424. */
  136425. private _unlit;
  136426. private _debugMode;
  136427. /**
  136428. * @hidden
  136429. * This is reserved for the inspector.
  136430. * Defines the material debug mode.
  136431. * It helps seeing only some components of the material while troubleshooting.
  136432. */
  136433. debugMode: number;
  136434. /**
  136435. * @hidden
  136436. * This is reserved for the inspector.
  136437. * Specify from where on screen the debug mode should start.
  136438. * The value goes from -1 (full screen) to 1 (not visible)
  136439. * It helps with side by side comparison against the final render
  136440. * This defaults to -1
  136441. */
  136442. private debugLimit;
  136443. /**
  136444. * @hidden
  136445. * This is reserved for the inspector.
  136446. * As the default viewing range might not be enough (if the ambient is really small for instance)
  136447. * You can use the factor to better multiply the final value.
  136448. */
  136449. private debugFactor;
  136450. /**
  136451. * Defines the clear coat layer parameters for the material.
  136452. */
  136453. readonly clearCoat: PBRClearCoatConfiguration;
  136454. /**
  136455. * Defines the anisotropic parameters for the material.
  136456. */
  136457. readonly anisotropy: PBRAnisotropicConfiguration;
  136458. /**
  136459. * Defines the BRDF parameters for the material.
  136460. */
  136461. readonly brdf: PBRBRDFConfiguration;
  136462. /**
  136463. * Defines the Sheen parameters for the material.
  136464. */
  136465. readonly sheen: PBRSheenConfiguration;
  136466. /**
  136467. * Defines the SubSurface parameters for the material.
  136468. */
  136469. readonly subSurface: PBRSubSurfaceConfiguration;
  136470. /**
  136471. * Defines the detail map parameters for the material.
  136472. */
  136473. readonly detailMap: DetailMapConfiguration;
  136474. protected _rebuildInParallel: boolean;
  136475. /**
  136476. * Instantiates a new PBRMaterial instance.
  136477. *
  136478. * @param name The material name
  136479. * @param scene The scene the material will be use in.
  136480. */
  136481. constructor(name: string, scene: Scene);
  136482. /**
  136483. * Gets a boolean indicating that current material needs to register RTT
  136484. */
  136485. get hasRenderTargetTextures(): boolean;
  136486. /**
  136487. * Gets the name of the material class.
  136488. */
  136489. getClassName(): string;
  136490. /**
  136491. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136492. */
  136493. get useLogarithmicDepth(): boolean;
  136494. /**
  136495. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136496. */
  136497. set useLogarithmicDepth(value: boolean);
  136498. /**
  136499. * Returns true if alpha blending should be disabled.
  136500. */
  136501. protected get _disableAlphaBlending(): boolean;
  136502. /**
  136503. * Specifies whether or not this material should be rendered in alpha blend mode.
  136504. */
  136505. needAlphaBlending(): boolean;
  136506. /**
  136507. * Specifies whether or not this material should be rendered in alpha test mode.
  136508. */
  136509. needAlphaTesting(): boolean;
  136510. /**
  136511. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  136512. */
  136513. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  136514. /**
  136515. * Gets the texture used for the alpha test.
  136516. */
  136517. getAlphaTestTexture(): Nullable<BaseTexture>;
  136518. /**
  136519. * Specifies that the submesh is ready to be used.
  136520. * @param mesh - BJS mesh.
  136521. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  136522. * @param useInstances - Specifies that instances should be used.
  136523. * @returns - boolean indicating that the submesh is ready or not.
  136524. */
  136525. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  136526. /**
  136527. * Specifies if the material uses metallic roughness workflow.
  136528. * @returns boolean specifiying if the material uses metallic roughness workflow.
  136529. */
  136530. isMetallicWorkflow(): boolean;
  136531. private _prepareEffect;
  136532. private _prepareDefines;
  136533. /**
  136534. * Force shader compilation
  136535. */
  136536. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  136537. /**
  136538. * Initializes the uniform buffer layout for the shader.
  136539. */
  136540. buildUniformLayout(): void;
  136541. /**
  136542. * Unbinds the material from the mesh
  136543. */
  136544. unbind(): void;
  136545. /**
  136546. * Binds the submesh data.
  136547. * @param world - The world matrix.
  136548. * @param mesh - The BJS mesh.
  136549. * @param subMesh - A submesh of the BJS mesh.
  136550. */
  136551. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  136552. /**
  136553. * Returns the animatable textures.
  136554. * @returns - Array of animatable textures.
  136555. */
  136556. getAnimatables(): IAnimatable[];
  136557. /**
  136558. * Returns the texture used for reflections.
  136559. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  136560. */
  136561. private _getReflectionTexture;
  136562. /**
  136563. * Returns an array of the actively used textures.
  136564. * @returns - Array of BaseTextures
  136565. */
  136566. getActiveTextures(): BaseTexture[];
  136567. /**
  136568. * Checks to see if a texture is used in the material.
  136569. * @param texture - Base texture to use.
  136570. * @returns - Boolean specifying if a texture is used in the material.
  136571. */
  136572. hasTexture(texture: BaseTexture): boolean;
  136573. /**
  136574. * Sets the required values to the prepass renderer.
  136575. * @param prePassRenderer defines the prepass renderer to setup
  136576. */
  136577. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  136578. /**
  136579. * Disposes the resources of the material.
  136580. * @param forceDisposeEffect - Forces the disposal of effects.
  136581. * @param forceDisposeTextures - Forces the disposal of all textures.
  136582. */
  136583. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  136584. }
  136585. }
  136586. declare module BABYLON {
  136587. /**
  136588. * The Physically based material of BJS.
  136589. *
  136590. * This offers the main features of a standard PBR material.
  136591. * For more information, please refer to the documentation :
  136592. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136593. */
  136594. export class PBRMaterial extends PBRBaseMaterial {
  136595. /**
  136596. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136597. */
  136598. static readonly PBRMATERIAL_OPAQUE: number;
  136599. /**
  136600. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136601. */
  136602. static readonly PBRMATERIAL_ALPHATEST: number;
  136603. /**
  136604. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136605. */
  136606. static readonly PBRMATERIAL_ALPHABLEND: number;
  136607. /**
  136608. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136609. * They are also discarded below the alpha cutoff threshold to improve performances.
  136610. */
  136611. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136612. /**
  136613. * Defines the default value of how much AO map is occluding the analytical lights
  136614. * (point spot...).
  136615. */
  136616. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136617. /**
  136618. * Intensity of the direct lights e.g. the four lights available in your scene.
  136619. * This impacts both the direct diffuse and specular highlights.
  136620. */
  136621. directIntensity: number;
  136622. /**
  136623. * Intensity of the emissive part of the material.
  136624. * This helps controlling the emissive effect without modifying the emissive color.
  136625. */
  136626. emissiveIntensity: number;
  136627. /**
  136628. * Intensity of the environment e.g. how much the environment will light the object
  136629. * either through harmonics for rough material or through the refelction for shiny ones.
  136630. */
  136631. environmentIntensity: number;
  136632. /**
  136633. * This is a special control allowing the reduction of the specular highlights coming from the
  136634. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136635. */
  136636. specularIntensity: number;
  136637. /**
  136638. * Debug Control allowing disabling the bump map on this material.
  136639. */
  136640. disableBumpMap: boolean;
  136641. /**
  136642. * AKA Diffuse Texture in standard nomenclature.
  136643. */
  136644. albedoTexture: BaseTexture;
  136645. /**
  136646. * AKA Occlusion Texture in other nomenclature.
  136647. */
  136648. ambientTexture: BaseTexture;
  136649. /**
  136650. * AKA Occlusion Texture Intensity in other nomenclature.
  136651. */
  136652. ambientTextureStrength: number;
  136653. /**
  136654. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136655. * 1 means it completely occludes it
  136656. * 0 mean it has no impact
  136657. */
  136658. ambientTextureImpactOnAnalyticalLights: number;
  136659. /**
  136660. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  136661. */
  136662. opacityTexture: BaseTexture;
  136663. /**
  136664. * Stores the reflection values in a texture.
  136665. */
  136666. reflectionTexture: Nullable<BaseTexture>;
  136667. /**
  136668. * Stores the emissive values in a texture.
  136669. */
  136670. emissiveTexture: BaseTexture;
  136671. /**
  136672. * AKA Specular texture in other nomenclature.
  136673. */
  136674. reflectivityTexture: BaseTexture;
  136675. /**
  136676. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136677. */
  136678. metallicTexture: BaseTexture;
  136679. /**
  136680. * Specifies the metallic scalar of the metallic/roughness workflow.
  136681. * Can also be used to scale the metalness values of the metallic texture.
  136682. */
  136683. metallic: Nullable<number>;
  136684. /**
  136685. * Specifies the roughness scalar of the metallic/roughness workflow.
  136686. * Can also be used to scale the roughness values of the metallic texture.
  136687. */
  136688. roughness: Nullable<number>;
  136689. /**
  136690. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136691. * By default the indexOfrefraction is used to compute F0;
  136692. *
  136693. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136694. *
  136695. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136696. * F90 = metallicReflectanceColor;
  136697. */
  136698. metallicF0Factor: number;
  136699. /**
  136700. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136701. * By default the F90 is always 1;
  136702. *
  136703. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136704. *
  136705. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136706. * F90 = metallicReflectanceColor;
  136707. */
  136708. metallicReflectanceColor: Color3;
  136709. /**
  136710. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136711. * This is multiply against the scalar values defined in the material.
  136712. */
  136713. metallicReflectanceTexture: Nullable<BaseTexture>;
  136714. /**
  136715. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136716. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136717. */
  136718. microSurfaceTexture: BaseTexture;
  136719. /**
  136720. * Stores surface normal data used to displace a mesh in a texture.
  136721. */
  136722. bumpTexture: BaseTexture;
  136723. /**
  136724. * Stores the pre-calculated light information of a mesh in a texture.
  136725. */
  136726. lightmapTexture: BaseTexture;
  136727. /**
  136728. * Stores the refracted light information in a texture.
  136729. */
  136730. get refractionTexture(): Nullable<BaseTexture>;
  136731. set refractionTexture(value: Nullable<BaseTexture>);
  136732. /**
  136733. * The color of a material in ambient lighting.
  136734. */
  136735. ambientColor: Color3;
  136736. /**
  136737. * AKA Diffuse Color in other nomenclature.
  136738. */
  136739. albedoColor: Color3;
  136740. /**
  136741. * AKA Specular Color in other nomenclature.
  136742. */
  136743. reflectivityColor: Color3;
  136744. /**
  136745. * The color reflected from the material.
  136746. */
  136747. reflectionColor: Color3;
  136748. /**
  136749. * The color emitted from the material.
  136750. */
  136751. emissiveColor: Color3;
  136752. /**
  136753. * AKA Glossiness in other nomenclature.
  136754. */
  136755. microSurface: number;
  136756. /**
  136757. * Index of refraction of the material base layer.
  136758. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136759. *
  136760. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  136761. *
  136762. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  136763. */
  136764. get indexOfRefraction(): number;
  136765. set indexOfRefraction(value: number);
  136766. /**
  136767. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  136768. */
  136769. get invertRefractionY(): boolean;
  136770. set invertRefractionY(value: boolean);
  136771. /**
  136772. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  136773. * Materials half opaque for instance using refraction could benefit from this control.
  136774. */
  136775. get linkRefractionWithTransparency(): boolean;
  136776. set linkRefractionWithTransparency(value: boolean);
  136777. /**
  136778. * If true, the light map contains occlusion information instead of lighting info.
  136779. */
  136780. useLightmapAsShadowmap: boolean;
  136781. /**
  136782. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136783. */
  136784. useAlphaFromAlbedoTexture: boolean;
  136785. /**
  136786. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136787. */
  136788. forceAlphaTest: boolean;
  136789. /**
  136790. * Defines the alpha limits in alpha test mode.
  136791. */
  136792. alphaCutOff: number;
  136793. /**
  136794. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  136795. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136796. */
  136797. useSpecularOverAlpha: boolean;
  136798. /**
  136799. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136800. */
  136801. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136802. /**
  136803. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136804. */
  136805. useRoughnessFromMetallicTextureAlpha: boolean;
  136806. /**
  136807. * Specifies if the metallic texture contains the roughness information in its green channel.
  136808. */
  136809. useRoughnessFromMetallicTextureGreen: boolean;
  136810. /**
  136811. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136812. */
  136813. useMetallnessFromMetallicTextureBlue: boolean;
  136814. /**
  136815. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136816. */
  136817. useAmbientOcclusionFromMetallicTextureRed: boolean;
  136818. /**
  136819. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136820. */
  136821. useAmbientInGrayScale: boolean;
  136822. /**
  136823. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136824. * The material will try to infer what glossiness each pixel should be.
  136825. */
  136826. useAutoMicroSurfaceFromReflectivityMap: boolean;
  136827. /**
  136828. * BJS is using an harcoded light falloff based on a manually sets up range.
  136829. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136830. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136831. */
  136832. get usePhysicalLightFalloff(): boolean;
  136833. /**
  136834. * BJS is using an harcoded light falloff based on a manually sets up range.
  136835. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136836. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136837. */
  136838. set usePhysicalLightFalloff(value: boolean);
  136839. /**
  136840. * In order to support the falloff compatibility with gltf, a special mode has been added
  136841. * to reproduce the gltf light falloff.
  136842. */
  136843. get useGLTFLightFalloff(): boolean;
  136844. /**
  136845. * In order to support the falloff compatibility with gltf, a special mode has been added
  136846. * to reproduce the gltf light falloff.
  136847. */
  136848. set useGLTFLightFalloff(value: boolean);
  136849. /**
  136850. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136851. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136852. */
  136853. useRadianceOverAlpha: boolean;
  136854. /**
  136855. * Allows using an object space normal map (instead of tangent space).
  136856. */
  136857. useObjectSpaceNormalMap: boolean;
  136858. /**
  136859. * Allows using the bump map in parallax mode.
  136860. */
  136861. useParallax: boolean;
  136862. /**
  136863. * Allows using the bump map in parallax occlusion mode.
  136864. */
  136865. useParallaxOcclusion: boolean;
  136866. /**
  136867. * Controls the scale bias of the parallax mode.
  136868. */
  136869. parallaxScaleBias: number;
  136870. /**
  136871. * If sets to true, disables all the lights affecting the material.
  136872. */
  136873. disableLighting: boolean;
  136874. /**
  136875. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136876. */
  136877. forceIrradianceInFragment: boolean;
  136878. /**
  136879. * Number of Simultaneous lights allowed on the material.
  136880. */
  136881. maxSimultaneousLights: number;
  136882. /**
  136883. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  136884. */
  136885. invertNormalMapX: boolean;
  136886. /**
  136887. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  136888. */
  136889. invertNormalMapY: boolean;
  136890. /**
  136891. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136892. */
  136893. twoSidedLighting: boolean;
  136894. /**
  136895. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136896. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136897. */
  136898. useAlphaFresnel: boolean;
  136899. /**
  136900. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136901. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136902. */
  136903. useLinearAlphaFresnel: boolean;
  136904. /**
  136905. * Let user defines the brdf lookup texture used for IBL.
  136906. * A default 8bit version is embedded but you could point at :
  136907. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  136908. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  136909. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  136910. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  136911. */
  136912. environmentBRDFTexture: Nullable<BaseTexture>;
  136913. /**
  136914. * Force normal to face away from face.
  136915. */
  136916. forceNormalForward: boolean;
  136917. /**
  136918. * Enables specular anti aliasing in the PBR shader.
  136919. * It will both interacts on the Geometry for analytical and IBL lighting.
  136920. * It also prefilter the roughness map based on the bump values.
  136921. */
  136922. enableSpecularAntiAliasing: boolean;
  136923. /**
  136924. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136925. * makes the reflect vector face the model (under horizon).
  136926. */
  136927. useHorizonOcclusion: boolean;
  136928. /**
  136929. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136930. * too much the area relying on ambient texture to define their ambient occlusion.
  136931. */
  136932. useRadianceOcclusion: boolean;
  136933. /**
  136934. * If set to true, no lighting calculations will be applied.
  136935. */
  136936. unlit: boolean;
  136937. /**
  136938. * Gets the image processing configuration used either in this material.
  136939. */
  136940. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  136941. /**
  136942. * Sets the Default image processing configuration used either in the this material.
  136943. *
  136944. * If sets to null, the scene one is in use.
  136945. */
  136946. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  136947. /**
  136948. * Gets wether the color curves effect is enabled.
  136949. */
  136950. get cameraColorCurvesEnabled(): boolean;
  136951. /**
  136952. * Sets wether the color curves effect is enabled.
  136953. */
  136954. set cameraColorCurvesEnabled(value: boolean);
  136955. /**
  136956. * Gets wether the color grading effect is enabled.
  136957. */
  136958. get cameraColorGradingEnabled(): boolean;
  136959. /**
  136960. * Gets wether the color grading effect is enabled.
  136961. */
  136962. set cameraColorGradingEnabled(value: boolean);
  136963. /**
  136964. * Gets wether tonemapping is enabled or not.
  136965. */
  136966. get cameraToneMappingEnabled(): boolean;
  136967. /**
  136968. * Sets wether tonemapping is enabled or not
  136969. */
  136970. set cameraToneMappingEnabled(value: boolean);
  136971. /**
  136972. * The camera exposure used on this material.
  136973. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136974. * This corresponds to a photographic exposure.
  136975. */
  136976. get cameraExposure(): number;
  136977. /**
  136978. * The camera exposure used on this material.
  136979. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136980. * This corresponds to a photographic exposure.
  136981. */
  136982. set cameraExposure(value: number);
  136983. /**
  136984. * Gets The camera contrast used on this material.
  136985. */
  136986. get cameraContrast(): number;
  136987. /**
  136988. * Sets The camera contrast used on this material.
  136989. */
  136990. set cameraContrast(value: number);
  136991. /**
  136992. * Gets the Color Grading 2D Lookup Texture.
  136993. */
  136994. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  136995. /**
  136996. * Sets the Color Grading 2D Lookup Texture.
  136997. */
  136998. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  136999. /**
  137000. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  137001. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137002. * 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;
  137003. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137004. */
  137005. get cameraColorCurves(): Nullable<ColorCurves>;
  137006. /**
  137007. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  137008. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137009. * 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;
  137010. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137011. */
  137012. set cameraColorCurves(value: Nullable<ColorCurves>);
  137013. /**
  137014. * Instantiates a new PBRMaterial instance.
  137015. *
  137016. * @param name The material name
  137017. * @param scene The scene the material will be use in.
  137018. */
  137019. constructor(name: string, scene: Scene);
  137020. /**
  137021. * Returns the name of this material class.
  137022. */
  137023. getClassName(): string;
  137024. /**
  137025. * Makes a duplicate of the current material.
  137026. * @param name - name to use for the new material.
  137027. */
  137028. clone(name: string): PBRMaterial;
  137029. /**
  137030. * Serializes this PBR Material.
  137031. * @returns - An object with the serialized material.
  137032. */
  137033. serialize(): any;
  137034. /**
  137035. * Parses a PBR Material from a serialized object.
  137036. * @param source - Serialized object.
  137037. * @param scene - BJS scene instance.
  137038. * @param rootUrl - url for the scene object
  137039. * @returns - PBRMaterial
  137040. */
  137041. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  137042. }
  137043. }
  137044. declare module BABYLON {
  137045. /**
  137046. * Direct draw surface info
  137047. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  137048. */
  137049. export interface DDSInfo {
  137050. /**
  137051. * Width of the texture
  137052. */
  137053. width: number;
  137054. /**
  137055. * Width of the texture
  137056. */
  137057. height: number;
  137058. /**
  137059. * Number of Mipmaps for the texture
  137060. * @see https://en.wikipedia.org/wiki/Mipmap
  137061. */
  137062. mipmapCount: number;
  137063. /**
  137064. * If the textures format is a known fourCC format
  137065. * @see https://www.fourcc.org/
  137066. */
  137067. isFourCC: boolean;
  137068. /**
  137069. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  137070. */
  137071. isRGB: boolean;
  137072. /**
  137073. * If the texture is a lumincance format
  137074. */
  137075. isLuminance: boolean;
  137076. /**
  137077. * If this is a cube texture
  137078. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  137079. */
  137080. isCube: boolean;
  137081. /**
  137082. * If the texture is a compressed format eg. FOURCC_DXT1
  137083. */
  137084. isCompressed: boolean;
  137085. /**
  137086. * The dxgiFormat of the texture
  137087. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  137088. */
  137089. dxgiFormat: number;
  137090. /**
  137091. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  137092. */
  137093. textureType: number;
  137094. /**
  137095. * Sphericle polynomial created for the dds texture
  137096. */
  137097. sphericalPolynomial?: SphericalPolynomial;
  137098. }
  137099. /**
  137100. * Class used to provide DDS decompression tools
  137101. */
  137102. export class DDSTools {
  137103. /**
  137104. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  137105. */
  137106. static StoreLODInAlphaChannel: boolean;
  137107. /**
  137108. * Gets DDS information from an array buffer
  137109. * @param data defines the array buffer view to read data from
  137110. * @returns the DDS information
  137111. */
  137112. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  137113. private static _FloatView;
  137114. private static _Int32View;
  137115. private static _ToHalfFloat;
  137116. private static _FromHalfFloat;
  137117. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  137118. private static _GetHalfFloatRGBAArrayBuffer;
  137119. private static _GetFloatRGBAArrayBuffer;
  137120. private static _GetFloatAsUIntRGBAArrayBuffer;
  137121. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  137122. private static _GetRGBAArrayBuffer;
  137123. private static _ExtractLongWordOrder;
  137124. private static _GetRGBArrayBuffer;
  137125. private static _GetLuminanceArrayBuffer;
  137126. /**
  137127. * Uploads DDS Levels to a Babylon Texture
  137128. * @hidden
  137129. */
  137130. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  137131. }
  137132. interface ThinEngine {
  137133. /**
  137134. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  137135. * @param rootUrl defines the url where the file to load is located
  137136. * @param scene defines the current scene
  137137. * @param lodScale defines scale to apply to the mip map selection
  137138. * @param lodOffset defines offset to apply to the mip map selection
  137139. * @param onLoad defines an optional callback raised when the texture is loaded
  137140. * @param onError defines an optional callback raised if there is an issue to load the texture
  137141. * @param format defines the format of the data
  137142. * @param forcedExtension defines the extension to use to pick the right loader
  137143. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  137144. * @returns the cube texture as an InternalTexture
  137145. */
  137146. 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;
  137147. }
  137148. }
  137149. declare module BABYLON {
  137150. /**
  137151. * Implementation of the DDS Texture Loader.
  137152. * @hidden
  137153. */
  137154. export class _DDSTextureLoader implements IInternalTextureLoader {
  137155. /**
  137156. * Defines wether the loader supports cascade loading the different faces.
  137157. */
  137158. readonly supportCascades: boolean;
  137159. /**
  137160. * This returns if the loader support the current file information.
  137161. * @param extension defines the file extension of the file being loaded
  137162. * @returns true if the loader can load the specified file
  137163. */
  137164. canLoad(extension: string): boolean;
  137165. /**
  137166. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137167. * @param data contains the texture data
  137168. * @param texture defines the BabylonJS internal texture
  137169. * @param createPolynomials will be true if polynomials have been requested
  137170. * @param onLoad defines the callback to trigger once the texture is ready
  137171. * @param onError defines the callback to trigger in case of error
  137172. */
  137173. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137174. /**
  137175. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137176. * @param data contains the texture data
  137177. * @param texture defines the BabylonJS internal texture
  137178. * @param callback defines the method to call once ready to upload
  137179. */
  137180. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137181. }
  137182. }
  137183. declare module BABYLON {
  137184. /**
  137185. * Implementation of the ENV Texture Loader.
  137186. * @hidden
  137187. */
  137188. export class _ENVTextureLoader implements IInternalTextureLoader {
  137189. /**
  137190. * Defines wether the loader supports cascade loading the different faces.
  137191. */
  137192. readonly supportCascades: boolean;
  137193. /**
  137194. * This returns if the loader support the current file information.
  137195. * @param extension defines the file extension of the file being loaded
  137196. * @returns true if the loader can load the specified file
  137197. */
  137198. canLoad(extension: string): boolean;
  137199. /**
  137200. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137201. * @param data contains the texture data
  137202. * @param texture defines the BabylonJS internal texture
  137203. * @param createPolynomials will be true if polynomials have been requested
  137204. * @param onLoad defines the callback to trigger once the texture is ready
  137205. * @param onError defines the callback to trigger in case of error
  137206. */
  137207. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137208. /**
  137209. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137210. * @param data contains the texture data
  137211. * @param texture defines the BabylonJS internal texture
  137212. * @param callback defines the method to call once ready to upload
  137213. */
  137214. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137215. }
  137216. }
  137217. declare module BABYLON {
  137218. /**
  137219. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  137220. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  137221. */
  137222. export class KhronosTextureContainer {
  137223. /** contents of the KTX container file */
  137224. data: ArrayBufferView;
  137225. private static HEADER_LEN;
  137226. private static COMPRESSED_2D;
  137227. private static COMPRESSED_3D;
  137228. private static TEX_2D;
  137229. private static TEX_3D;
  137230. /**
  137231. * Gets the openGL type
  137232. */
  137233. glType: number;
  137234. /**
  137235. * Gets the openGL type size
  137236. */
  137237. glTypeSize: number;
  137238. /**
  137239. * Gets the openGL format
  137240. */
  137241. glFormat: number;
  137242. /**
  137243. * Gets the openGL internal format
  137244. */
  137245. glInternalFormat: number;
  137246. /**
  137247. * Gets the base internal format
  137248. */
  137249. glBaseInternalFormat: number;
  137250. /**
  137251. * Gets image width in pixel
  137252. */
  137253. pixelWidth: number;
  137254. /**
  137255. * Gets image height in pixel
  137256. */
  137257. pixelHeight: number;
  137258. /**
  137259. * Gets image depth in pixels
  137260. */
  137261. pixelDepth: number;
  137262. /**
  137263. * Gets the number of array elements
  137264. */
  137265. numberOfArrayElements: number;
  137266. /**
  137267. * Gets the number of faces
  137268. */
  137269. numberOfFaces: number;
  137270. /**
  137271. * Gets the number of mipmap levels
  137272. */
  137273. numberOfMipmapLevels: number;
  137274. /**
  137275. * Gets the bytes of key value data
  137276. */
  137277. bytesOfKeyValueData: number;
  137278. /**
  137279. * Gets the load type
  137280. */
  137281. loadType: number;
  137282. /**
  137283. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  137284. */
  137285. isInvalid: boolean;
  137286. /**
  137287. * Creates a new KhronosTextureContainer
  137288. * @param data contents of the KTX container file
  137289. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  137290. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  137291. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  137292. */
  137293. constructor(
  137294. /** contents of the KTX container file */
  137295. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  137296. /**
  137297. * Uploads KTX content to a Babylon Texture.
  137298. * It is assumed that the texture has already been created & is currently bound
  137299. * @hidden
  137300. */
  137301. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  137302. private _upload2DCompressedLevels;
  137303. /**
  137304. * Checks if the given data starts with a KTX file identifier.
  137305. * @param data the data to check
  137306. * @returns true if the data is a KTX file or false otherwise
  137307. */
  137308. static IsValid(data: ArrayBufferView): boolean;
  137309. }
  137310. }
  137311. declare module BABYLON {
  137312. /**
  137313. * Class for loading KTX2 files
  137314. * !!! Experimental Extension Subject to Changes !!!
  137315. * @hidden
  137316. */
  137317. export class KhronosTextureContainer2 {
  137318. private static _ModulePromise;
  137319. private static _TranscodeFormat;
  137320. constructor(engine: ThinEngine);
  137321. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  137322. private _determineTranscodeFormat;
  137323. /**
  137324. * Checks if the given data starts with a KTX2 file identifier.
  137325. * @param data the data to check
  137326. * @returns true if the data is a KTX2 file or false otherwise
  137327. */
  137328. static IsValid(data: ArrayBufferView): boolean;
  137329. }
  137330. }
  137331. declare module BABYLON {
  137332. /**
  137333. * Implementation of the KTX Texture Loader.
  137334. * @hidden
  137335. */
  137336. export class _KTXTextureLoader implements IInternalTextureLoader {
  137337. /**
  137338. * Defines wether the loader supports cascade loading the different faces.
  137339. */
  137340. readonly supportCascades: boolean;
  137341. /**
  137342. * This returns if the loader support the current file information.
  137343. * @param extension defines the file extension of the file being loaded
  137344. * @param mimeType defines the optional mime type of the file being loaded
  137345. * @returns true if the loader can load the specified file
  137346. */
  137347. canLoad(extension: string, mimeType?: string): boolean;
  137348. /**
  137349. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137350. * @param data contains the texture data
  137351. * @param texture defines the BabylonJS internal texture
  137352. * @param createPolynomials will be true if polynomials have been requested
  137353. * @param onLoad defines the callback to trigger once the texture is ready
  137354. * @param onError defines the callback to trigger in case of error
  137355. */
  137356. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137357. /**
  137358. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137359. * @param data contains the texture data
  137360. * @param texture defines the BabylonJS internal texture
  137361. * @param callback defines the method to call once ready to upload
  137362. */
  137363. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  137364. }
  137365. }
  137366. declare module BABYLON {
  137367. /** @hidden */
  137368. export var _forceSceneHelpersToBundle: boolean;
  137369. interface Scene {
  137370. /**
  137371. * Creates a default light for the scene.
  137372. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  137373. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  137374. */
  137375. createDefaultLight(replace?: boolean): void;
  137376. /**
  137377. * Creates a default camera for the scene.
  137378. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  137379. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137380. * @param replace has default false, when true replaces the active camera in the scene
  137381. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  137382. */
  137383. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137384. /**
  137385. * Creates a default camera and a default light.
  137386. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  137387. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137388. * @param replace has the default false, when true replaces the active camera/light in the scene
  137389. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  137390. */
  137391. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137392. /**
  137393. * Creates a new sky box
  137394. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  137395. * @param environmentTexture defines the texture to use as environment texture
  137396. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  137397. * @param scale defines the overall scale of the skybox
  137398. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  137399. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  137400. * @returns a new mesh holding the sky box
  137401. */
  137402. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  137403. /**
  137404. * Creates a new environment
  137405. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  137406. * @param options defines the options you can use to configure the environment
  137407. * @returns the new EnvironmentHelper
  137408. */
  137409. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  137410. /**
  137411. * Creates a new VREXperienceHelper
  137412. * @see https://doc.babylonjs.com/how_to/webvr_helper
  137413. * @param webVROptions defines the options used to create the new VREXperienceHelper
  137414. * @returns a new VREXperienceHelper
  137415. */
  137416. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  137417. /**
  137418. * Creates a new WebXRDefaultExperience
  137419. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  137420. * @param options experience options
  137421. * @returns a promise for a new WebXRDefaultExperience
  137422. */
  137423. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  137424. }
  137425. }
  137426. declare module BABYLON {
  137427. /**
  137428. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  137429. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  137430. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  137431. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  137432. */
  137433. export class VideoDome extends TextureDome<VideoTexture> {
  137434. /**
  137435. * Define the video source as a Monoscopic panoramic 360 video.
  137436. */
  137437. static readonly MODE_MONOSCOPIC: number;
  137438. /**
  137439. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  137440. */
  137441. static readonly MODE_TOPBOTTOM: number;
  137442. /**
  137443. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  137444. */
  137445. static readonly MODE_SIDEBYSIDE: number;
  137446. /**
  137447. * Get the video texture associated with this video dome
  137448. */
  137449. get videoTexture(): VideoTexture;
  137450. /**
  137451. * Get the video mode of this dome
  137452. */
  137453. get videoMode(): number;
  137454. /**
  137455. * Set the video mode of this dome.
  137456. * @see textureMode
  137457. */
  137458. set videoMode(value: number);
  137459. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  137460. }
  137461. }
  137462. declare module BABYLON {
  137463. /**
  137464. * This class can be used to get instrumentation data from a Babylon engine
  137465. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137466. */
  137467. export class EngineInstrumentation implements IDisposable {
  137468. /**
  137469. * Define the instrumented engine.
  137470. */
  137471. engine: Engine;
  137472. private _captureGPUFrameTime;
  137473. private _gpuFrameTimeToken;
  137474. private _gpuFrameTime;
  137475. private _captureShaderCompilationTime;
  137476. private _shaderCompilationTime;
  137477. private _onBeginFrameObserver;
  137478. private _onEndFrameObserver;
  137479. private _onBeforeShaderCompilationObserver;
  137480. private _onAfterShaderCompilationObserver;
  137481. /**
  137482. * Gets the perf counter used for GPU frame time
  137483. */
  137484. get gpuFrameTimeCounter(): PerfCounter;
  137485. /**
  137486. * Gets the GPU frame time capture status
  137487. */
  137488. get captureGPUFrameTime(): boolean;
  137489. /**
  137490. * Enable or disable the GPU frame time capture
  137491. */
  137492. set captureGPUFrameTime(value: boolean);
  137493. /**
  137494. * Gets the perf counter used for shader compilation time
  137495. */
  137496. get shaderCompilationTimeCounter(): PerfCounter;
  137497. /**
  137498. * Gets the shader compilation time capture status
  137499. */
  137500. get captureShaderCompilationTime(): boolean;
  137501. /**
  137502. * Enable or disable the shader compilation time capture
  137503. */
  137504. set captureShaderCompilationTime(value: boolean);
  137505. /**
  137506. * Instantiates a new engine instrumentation.
  137507. * This class can be used to get instrumentation data from a Babylon engine
  137508. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137509. * @param engine Defines the engine to instrument
  137510. */
  137511. constructor(
  137512. /**
  137513. * Define the instrumented engine.
  137514. */
  137515. engine: Engine);
  137516. /**
  137517. * Dispose and release associated resources.
  137518. */
  137519. dispose(): void;
  137520. }
  137521. }
  137522. declare module BABYLON {
  137523. /**
  137524. * This class can be used to get instrumentation data from a Babylon engine
  137525. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137526. */
  137527. export class SceneInstrumentation implements IDisposable {
  137528. /**
  137529. * Defines the scene to instrument
  137530. */
  137531. scene: Scene;
  137532. private _captureActiveMeshesEvaluationTime;
  137533. private _activeMeshesEvaluationTime;
  137534. private _captureRenderTargetsRenderTime;
  137535. private _renderTargetsRenderTime;
  137536. private _captureFrameTime;
  137537. private _frameTime;
  137538. private _captureRenderTime;
  137539. private _renderTime;
  137540. private _captureInterFrameTime;
  137541. private _interFrameTime;
  137542. private _captureParticlesRenderTime;
  137543. private _particlesRenderTime;
  137544. private _captureSpritesRenderTime;
  137545. private _spritesRenderTime;
  137546. private _capturePhysicsTime;
  137547. private _physicsTime;
  137548. private _captureAnimationsTime;
  137549. private _animationsTime;
  137550. private _captureCameraRenderTime;
  137551. private _cameraRenderTime;
  137552. private _onBeforeActiveMeshesEvaluationObserver;
  137553. private _onAfterActiveMeshesEvaluationObserver;
  137554. private _onBeforeRenderTargetsRenderObserver;
  137555. private _onAfterRenderTargetsRenderObserver;
  137556. private _onAfterRenderObserver;
  137557. private _onBeforeDrawPhaseObserver;
  137558. private _onAfterDrawPhaseObserver;
  137559. private _onBeforeAnimationsObserver;
  137560. private _onBeforeParticlesRenderingObserver;
  137561. private _onAfterParticlesRenderingObserver;
  137562. private _onBeforeSpritesRenderingObserver;
  137563. private _onAfterSpritesRenderingObserver;
  137564. private _onBeforePhysicsObserver;
  137565. private _onAfterPhysicsObserver;
  137566. private _onAfterAnimationsObserver;
  137567. private _onBeforeCameraRenderObserver;
  137568. private _onAfterCameraRenderObserver;
  137569. /**
  137570. * Gets the perf counter used for active meshes evaluation time
  137571. */
  137572. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  137573. /**
  137574. * Gets the active meshes evaluation time capture status
  137575. */
  137576. get captureActiveMeshesEvaluationTime(): boolean;
  137577. /**
  137578. * Enable or disable the active meshes evaluation time capture
  137579. */
  137580. set captureActiveMeshesEvaluationTime(value: boolean);
  137581. /**
  137582. * Gets the perf counter used for render targets render time
  137583. */
  137584. get renderTargetsRenderTimeCounter(): PerfCounter;
  137585. /**
  137586. * Gets the render targets render time capture status
  137587. */
  137588. get captureRenderTargetsRenderTime(): boolean;
  137589. /**
  137590. * Enable or disable the render targets render time capture
  137591. */
  137592. set captureRenderTargetsRenderTime(value: boolean);
  137593. /**
  137594. * Gets the perf counter used for particles render time
  137595. */
  137596. get particlesRenderTimeCounter(): PerfCounter;
  137597. /**
  137598. * Gets the particles render time capture status
  137599. */
  137600. get captureParticlesRenderTime(): boolean;
  137601. /**
  137602. * Enable or disable the particles render time capture
  137603. */
  137604. set captureParticlesRenderTime(value: boolean);
  137605. /**
  137606. * Gets the perf counter used for sprites render time
  137607. */
  137608. get spritesRenderTimeCounter(): PerfCounter;
  137609. /**
  137610. * Gets the sprites render time capture status
  137611. */
  137612. get captureSpritesRenderTime(): boolean;
  137613. /**
  137614. * Enable or disable the sprites render time capture
  137615. */
  137616. set captureSpritesRenderTime(value: boolean);
  137617. /**
  137618. * Gets the perf counter used for physics time
  137619. */
  137620. get physicsTimeCounter(): PerfCounter;
  137621. /**
  137622. * Gets the physics time capture status
  137623. */
  137624. get capturePhysicsTime(): boolean;
  137625. /**
  137626. * Enable or disable the physics time capture
  137627. */
  137628. set capturePhysicsTime(value: boolean);
  137629. /**
  137630. * Gets the perf counter used for animations time
  137631. */
  137632. get animationsTimeCounter(): PerfCounter;
  137633. /**
  137634. * Gets the animations time capture status
  137635. */
  137636. get captureAnimationsTime(): boolean;
  137637. /**
  137638. * Enable or disable the animations time capture
  137639. */
  137640. set captureAnimationsTime(value: boolean);
  137641. /**
  137642. * Gets the perf counter used for frame time capture
  137643. */
  137644. get frameTimeCounter(): PerfCounter;
  137645. /**
  137646. * Gets the frame time capture status
  137647. */
  137648. get captureFrameTime(): boolean;
  137649. /**
  137650. * Enable or disable the frame time capture
  137651. */
  137652. set captureFrameTime(value: boolean);
  137653. /**
  137654. * Gets the perf counter used for inter-frames time capture
  137655. */
  137656. get interFrameTimeCounter(): PerfCounter;
  137657. /**
  137658. * Gets the inter-frames time capture status
  137659. */
  137660. get captureInterFrameTime(): boolean;
  137661. /**
  137662. * Enable or disable the inter-frames time capture
  137663. */
  137664. set captureInterFrameTime(value: boolean);
  137665. /**
  137666. * Gets the perf counter used for render time capture
  137667. */
  137668. get renderTimeCounter(): PerfCounter;
  137669. /**
  137670. * Gets the render time capture status
  137671. */
  137672. get captureRenderTime(): boolean;
  137673. /**
  137674. * Enable or disable the render time capture
  137675. */
  137676. set captureRenderTime(value: boolean);
  137677. /**
  137678. * Gets the perf counter used for camera render time capture
  137679. */
  137680. get cameraRenderTimeCounter(): PerfCounter;
  137681. /**
  137682. * Gets the camera render time capture status
  137683. */
  137684. get captureCameraRenderTime(): boolean;
  137685. /**
  137686. * Enable or disable the camera render time capture
  137687. */
  137688. set captureCameraRenderTime(value: boolean);
  137689. /**
  137690. * Gets the perf counter used for draw calls
  137691. */
  137692. get drawCallsCounter(): PerfCounter;
  137693. /**
  137694. * Instantiates a new scene instrumentation.
  137695. * This class can be used to get instrumentation data from a Babylon engine
  137696. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137697. * @param scene Defines the scene to instrument
  137698. */
  137699. constructor(
  137700. /**
  137701. * Defines the scene to instrument
  137702. */
  137703. scene: Scene);
  137704. /**
  137705. * Dispose and release associated resources.
  137706. */
  137707. dispose(): void;
  137708. }
  137709. }
  137710. declare module BABYLON {
  137711. /** @hidden */
  137712. export var glowMapGenerationPixelShader: {
  137713. name: string;
  137714. shader: string;
  137715. };
  137716. }
  137717. declare module BABYLON {
  137718. /** @hidden */
  137719. export var glowMapGenerationVertexShader: {
  137720. name: string;
  137721. shader: string;
  137722. };
  137723. }
  137724. declare module BABYLON {
  137725. /**
  137726. * Effect layer options. This helps customizing the behaviour
  137727. * of the effect layer.
  137728. */
  137729. export interface IEffectLayerOptions {
  137730. /**
  137731. * Multiplication factor apply to the canvas size to compute the render target size
  137732. * used to generated the objects (the smaller the faster).
  137733. */
  137734. mainTextureRatio: number;
  137735. /**
  137736. * Enforces a fixed size texture to ensure effect stability across devices.
  137737. */
  137738. mainTextureFixedSize?: number;
  137739. /**
  137740. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  137741. */
  137742. alphaBlendingMode: number;
  137743. /**
  137744. * The camera attached to the layer.
  137745. */
  137746. camera: Nullable<Camera>;
  137747. /**
  137748. * The rendering group to draw the layer in.
  137749. */
  137750. renderingGroupId: number;
  137751. }
  137752. /**
  137753. * The effect layer Helps adding post process effect blended with the main pass.
  137754. *
  137755. * This can be for instance use to generate glow or higlight effects on the scene.
  137756. *
  137757. * The effect layer class can not be used directly and is intented to inherited from to be
  137758. * customized per effects.
  137759. */
  137760. export abstract class EffectLayer {
  137761. private _vertexBuffers;
  137762. private _indexBuffer;
  137763. private _cachedDefines;
  137764. private _effectLayerMapGenerationEffect;
  137765. private _effectLayerOptions;
  137766. private _mergeEffect;
  137767. protected _scene: Scene;
  137768. protected _engine: Engine;
  137769. protected _maxSize: number;
  137770. protected _mainTextureDesiredSize: ISize;
  137771. protected _mainTexture: RenderTargetTexture;
  137772. protected _shouldRender: boolean;
  137773. protected _postProcesses: PostProcess[];
  137774. protected _textures: BaseTexture[];
  137775. protected _emissiveTextureAndColor: {
  137776. texture: Nullable<BaseTexture>;
  137777. color: Color4;
  137778. };
  137779. /**
  137780. * The name of the layer
  137781. */
  137782. name: string;
  137783. /**
  137784. * The clear color of the texture used to generate the glow map.
  137785. */
  137786. neutralColor: Color4;
  137787. /**
  137788. * Specifies whether the highlight layer is enabled or not.
  137789. */
  137790. isEnabled: boolean;
  137791. /**
  137792. * Gets the camera attached to the layer.
  137793. */
  137794. get camera(): Nullable<Camera>;
  137795. /**
  137796. * Gets the rendering group id the layer should render in.
  137797. */
  137798. get renderingGroupId(): number;
  137799. set renderingGroupId(renderingGroupId: number);
  137800. /**
  137801. * An event triggered when the effect layer has been disposed.
  137802. */
  137803. onDisposeObservable: Observable<EffectLayer>;
  137804. /**
  137805. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  137806. */
  137807. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  137808. /**
  137809. * An event triggered when the generated texture is being merged in the scene.
  137810. */
  137811. onBeforeComposeObservable: Observable<EffectLayer>;
  137812. /**
  137813. * An event triggered when the mesh is rendered into the effect render target.
  137814. */
  137815. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  137816. /**
  137817. * An event triggered after the mesh has been rendered into the effect render target.
  137818. */
  137819. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  137820. /**
  137821. * An event triggered when the generated texture has been merged in the scene.
  137822. */
  137823. onAfterComposeObservable: Observable<EffectLayer>;
  137824. /**
  137825. * An event triggered when the efffect layer changes its size.
  137826. */
  137827. onSizeChangedObservable: Observable<EffectLayer>;
  137828. /** @hidden */
  137829. static _SceneComponentInitialization: (scene: Scene) => void;
  137830. /**
  137831. * Instantiates a new effect Layer and references it in the scene.
  137832. * @param name The name of the layer
  137833. * @param scene The scene to use the layer in
  137834. */
  137835. constructor(
  137836. /** The Friendly of the effect in the scene */
  137837. name: string, scene: Scene);
  137838. /**
  137839. * Get the effect name of the layer.
  137840. * @return The effect name
  137841. */
  137842. abstract getEffectName(): string;
  137843. /**
  137844. * Checks for the readiness of the element composing the layer.
  137845. * @param subMesh the mesh to check for
  137846. * @param useInstances specify whether or not to use instances to render the mesh
  137847. * @return true if ready otherwise, false
  137848. */
  137849. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  137850. /**
  137851. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  137852. * @returns true if the effect requires stencil during the main canvas render pass.
  137853. */
  137854. abstract needStencil(): boolean;
  137855. /**
  137856. * Create the merge effect. This is the shader use to blit the information back
  137857. * to the main canvas at the end of the scene rendering.
  137858. * @returns The effect containing the shader used to merge the effect on the main canvas
  137859. */
  137860. protected abstract _createMergeEffect(): Effect;
  137861. /**
  137862. * Creates the render target textures and post processes used in the effect layer.
  137863. */
  137864. protected abstract _createTextureAndPostProcesses(): void;
  137865. /**
  137866. * Implementation specific of rendering the generating effect on the main canvas.
  137867. * @param effect The effect used to render through
  137868. */
  137869. protected abstract _internalRender(effect: Effect): void;
  137870. /**
  137871. * Sets the required values for both the emissive texture and and the main color.
  137872. */
  137873. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  137874. /**
  137875. * Free any resources and references associated to a mesh.
  137876. * Internal use
  137877. * @param mesh The mesh to free.
  137878. */
  137879. abstract _disposeMesh(mesh: Mesh): void;
  137880. /**
  137881. * Serializes this layer (Glow or Highlight for example)
  137882. * @returns a serialized layer object
  137883. */
  137884. abstract serialize?(): any;
  137885. /**
  137886. * Initializes the effect layer with the required options.
  137887. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  137888. */
  137889. protected _init(options: Partial<IEffectLayerOptions>): void;
  137890. /**
  137891. * Generates the index buffer of the full screen quad blending to the main canvas.
  137892. */
  137893. private _generateIndexBuffer;
  137894. /**
  137895. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  137896. */
  137897. private _generateVertexBuffer;
  137898. /**
  137899. * Sets the main texture desired size which is the closest power of two
  137900. * of the engine canvas size.
  137901. */
  137902. private _setMainTextureSize;
  137903. /**
  137904. * Creates the main texture for the effect layer.
  137905. */
  137906. protected _createMainTexture(): void;
  137907. /**
  137908. * Adds specific effects defines.
  137909. * @param defines The defines to add specifics to.
  137910. */
  137911. protected _addCustomEffectDefines(defines: string[]): void;
  137912. /**
  137913. * Checks for the readiness of the element composing the layer.
  137914. * @param subMesh the mesh to check for
  137915. * @param useInstances specify whether or not to use instances to render the mesh
  137916. * @param emissiveTexture the associated emissive texture used to generate the glow
  137917. * @return true if ready otherwise, false
  137918. */
  137919. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  137920. /**
  137921. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  137922. */
  137923. render(): void;
  137924. /**
  137925. * Determine if a given mesh will be used in the current effect.
  137926. * @param mesh mesh to test
  137927. * @returns true if the mesh will be used
  137928. */
  137929. hasMesh(mesh: AbstractMesh): boolean;
  137930. /**
  137931. * Returns true if the layer contains information to display, otherwise false.
  137932. * @returns true if the glow layer should be rendered
  137933. */
  137934. shouldRender(): boolean;
  137935. /**
  137936. * Returns true if the mesh should render, otherwise false.
  137937. * @param mesh The mesh to render
  137938. * @returns true if it should render otherwise false
  137939. */
  137940. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  137941. /**
  137942. * Returns true if the mesh can be rendered, otherwise false.
  137943. * @param mesh The mesh to render
  137944. * @param material The material used on the mesh
  137945. * @returns true if it can be rendered otherwise false
  137946. */
  137947. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  137948. /**
  137949. * Returns true if the mesh should render, otherwise false.
  137950. * @param mesh The mesh to render
  137951. * @returns true if it should render otherwise false
  137952. */
  137953. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  137954. /**
  137955. * Renders the submesh passed in parameter to the generation map.
  137956. */
  137957. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  137958. /**
  137959. * Defines whether the current material of the mesh should be use to render the effect.
  137960. * @param mesh defines the current mesh to render
  137961. */
  137962. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  137963. /**
  137964. * Rebuild the required buffers.
  137965. * @hidden Internal use only.
  137966. */
  137967. _rebuild(): void;
  137968. /**
  137969. * Dispose only the render target textures and post process.
  137970. */
  137971. private _disposeTextureAndPostProcesses;
  137972. /**
  137973. * Dispose the highlight layer and free resources.
  137974. */
  137975. dispose(): void;
  137976. /**
  137977. * Gets the class name of the effect layer
  137978. * @returns the string with the class name of the effect layer
  137979. */
  137980. getClassName(): string;
  137981. /**
  137982. * Creates an effect layer from parsed effect layer data
  137983. * @param parsedEffectLayer defines effect layer data
  137984. * @param scene defines the current scene
  137985. * @param rootUrl defines the root URL containing the effect layer information
  137986. * @returns a parsed effect Layer
  137987. */
  137988. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  137989. }
  137990. }
  137991. declare module BABYLON {
  137992. interface AbstractScene {
  137993. /**
  137994. * The list of effect layers (highlights/glow) added to the scene
  137995. * @see https://doc.babylonjs.com/how_to/highlight_layer
  137996. * @see https://doc.babylonjs.com/how_to/glow_layer
  137997. */
  137998. effectLayers: Array<EffectLayer>;
  137999. /**
  138000. * Removes the given effect layer from this scene.
  138001. * @param toRemove defines the effect layer to remove
  138002. * @returns the index of the removed effect layer
  138003. */
  138004. removeEffectLayer(toRemove: EffectLayer): number;
  138005. /**
  138006. * Adds the given effect layer to this scene
  138007. * @param newEffectLayer defines the effect layer to add
  138008. */
  138009. addEffectLayer(newEffectLayer: EffectLayer): void;
  138010. }
  138011. /**
  138012. * Defines the layer scene component responsible to manage any effect layers
  138013. * in a given scene.
  138014. */
  138015. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  138016. /**
  138017. * The component name helpfull to identify the component in the list of scene components.
  138018. */
  138019. readonly name: string;
  138020. /**
  138021. * The scene the component belongs to.
  138022. */
  138023. scene: Scene;
  138024. private _engine;
  138025. private _renderEffects;
  138026. private _needStencil;
  138027. private _previousStencilState;
  138028. /**
  138029. * Creates a new instance of the component for the given scene
  138030. * @param scene Defines the scene to register the component in
  138031. */
  138032. constructor(scene: Scene);
  138033. /**
  138034. * Registers the component in a given scene
  138035. */
  138036. register(): void;
  138037. /**
  138038. * Rebuilds the elements related to this component in case of
  138039. * context lost for instance.
  138040. */
  138041. rebuild(): void;
  138042. /**
  138043. * Serializes the component data to the specified json object
  138044. * @param serializationObject The object to serialize to
  138045. */
  138046. serialize(serializationObject: any): void;
  138047. /**
  138048. * Adds all the elements from the container to the scene
  138049. * @param container the container holding the elements
  138050. */
  138051. addFromContainer(container: AbstractScene): void;
  138052. /**
  138053. * Removes all the elements in the container from the scene
  138054. * @param container contains the elements to remove
  138055. * @param dispose if the removed element should be disposed (default: false)
  138056. */
  138057. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138058. /**
  138059. * Disposes the component and the associated ressources.
  138060. */
  138061. dispose(): void;
  138062. private _isReadyForMesh;
  138063. private _renderMainTexture;
  138064. private _setStencil;
  138065. private _setStencilBack;
  138066. private _draw;
  138067. private _drawCamera;
  138068. private _drawRenderingGroup;
  138069. }
  138070. }
  138071. declare module BABYLON {
  138072. /** @hidden */
  138073. export var glowMapMergePixelShader: {
  138074. name: string;
  138075. shader: string;
  138076. };
  138077. }
  138078. declare module BABYLON {
  138079. /** @hidden */
  138080. export var glowMapMergeVertexShader: {
  138081. name: string;
  138082. shader: string;
  138083. };
  138084. }
  138085. declare module BABYLON {
  138086. interface AbstractScene {
  138087. /**
  138088. * Return a the first highlight layer of the scene with a given name.
  138089. * @param name The name of the highlight layer to look for.
  138090. * @return The highlight layer if found otherwise null.
  138091. */
  138092. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  138093. }
  138094. /**
  138095. * Glow layer options. This helps customizing the behaviour
  138096. * of the glow layer.
  138097. */
  138098. export interface IGlowLayerOptions {
  138099. /**
  138100. * Multiplication factor apply to the canvas size to compute the render target size
  138101. * used to generated the glowing objects (the smaller the faster).
  138102. */
  138103. mainTextureRatio: number;
  138104. /**
  138105. * Enforces a fixed size texture to ensure resize independant blur.
  138106. */
  138107. mainTextureFixedSize?: number;
  138108. /**
  138109. * How big is the kernel of the blur texture.
  138110. */
  138111. blurKernelSize: number;
  138112. /**
  138113. * The camera attached to the layer.
  138114. */
  138115. camera: Nullable<Camera>;
  138116. /**
  138117. * Enable MSAA by chosing the number of samples.
  138118. */
  138119. mainTextureSamples?: number;
  138120. /**
  138121. * The rendering group to draw the layer in.
  138122. */
  138123. renderingGroupId: number;
  138124. }
  138125. /**
  138126. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  138127. *
  138128. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  138129. *
  138130. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  138131. */
  138132. export class GlowLayer extends EffectLayer {
  138133. /**
  138134. * Effect Name of the layer.
  138135. */
  138136. static readonly EffectName: string;
  138137. /**
  138138. * The default blur kernel size used for the glow.
  138139. */
  138140. static DefaultBlurKernelSize: number;
  138141. /**
  138142. * The default texture size ratio used for the glow.
  138143. */
  138144. static DefaultTextureRatio: number;
  138145. /**
  138146. * Sets the kernel size of the blur.
  138147. */
  138148. set blurKernelSize(value: number);
  138149. /**
  138150. * Gets the kernel size of the blur.
  138151. */
  138152. get blurKernelSize(): number;
  138153. /**
  138154. * Sets the glow intensity.
  138155. */
  138156. set intensity(value: number);
  138157. /**
  138158. * Gets the glow intensity.
  138159. */
  138160. get intensity(): number;
  138161. private _options;
  138162. private _intensity;
  138163. private _horizontalBlurPostprocess1;
  138164. private _verticalBlurPostprocess1;
  138165. private _horizontalBlurPostprocess2;
  138166. private _verticalBlurPostprocess2;
  138167. private _blurTexture1;
  138168. private _blurTexture2;
  138169. private _postProcesses1;
  138170. private _postProcesses2;
  138171. private _includedOnlyMeshes;
  138172. private _excludedMeshes;
  138173. private _meshesUsingTheirOwnMaterials;
  138174. /**
  138175. * Callback used to let the user override the color selection on a per mesh basis
  138176. */
  138177. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  138178. /**
  138179. * Callback used to let the user override the texture selection on a per mesh basis
  138180. */
  138181. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  138182. /**
  138183. * Instantiates a new glow Layer and references it to the scene.
  138184. * @param name The name of the layer
  138185. * @param scene The scene to use the layer in
  138186. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  138187. */
  138188. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  138189. /**
  138190. * Get the effect name of the layer.
  138191. * @return The effect name
  138192. */
  138193. getEffectName(): string;
  138194. /**
  138195. * Create the merge effect. This is the shader use to blit the information back
  138196. * to the main canvas at the end of the scene rendering.
  138197. */
  138198. protected _createMergeEffect(): Effect;
  138199. /**
  138200. * Creates the render target textures and post processes used in the glow layer.
  138201. */
  138202. protected _createTextureAndPostProcesses(): void;
  138203. /**
  138204. * Checks for the readiness of the element composing the layer.
  138205. * @param subMesh the mesh to check for
  138206. * @param useInstances specify wether or not to use instances to render the mesh
  138207. * @param emissiveTexture the associated emissive texture used to generate the glow
  138208. * @return true if ready otherwise, false
  138209. */
  138210. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138211. /**
  138212. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  138213. */
  138214. needStencil(): boolean;
  138215. /**
  138216. * Returns true if the mesh can be rendered, otherwise false.
  138217. * @param mesh The mesh to render
  138218. * @param material The material used on the mesh
  138219. * @returns true if it can be rendered otherwise false
  138220. */
  138221. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138222. /**
  138223. * Implementation specific of rendering the generating effect on the main canvas.
  138224. * @param effect The effect used to render through
  138225. */
  138226. protected _internalRender(effect: Effect): void;
  138227. /**
  138228. * Sets the required values for both the emissive texture and and the main color.
  138229. */
  138230. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138231. /**
  138232. * Returns true if the mesh should render, otherwise false.
  138233. * @param mesh The mesh to render
  138234. * @returns true if it should render otherwise false
  138235. */
  138236. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138237. /**
  138238. * Adds specific effects defines.
  138239. * @param defines The defines to add specifics to.
  138240. */
  138241. protected _addCustomEffectDefines(defines: string[]): void;
  138242. /**
  138243. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  138244. * @param mesh The mesh to exclude from the glow layer
  138245. */
  138246. addExcludedMesh(mesh: Mesh): void;
  138247. /**
  138248. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  138249. * @param mesh The mesh to remove
  138250. */
  138251. removeExcludedMesh(mesh: Mesh): void;
  138252. /**
  138253. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  138254. * @param mesh The mesh to include in the glow layer
  138255. */
  138256. addIncludedOnlyMesh(mesh: Mesh): void;
  138257. /**
  138258. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  138259. * @param mesh The mesh to remove
  138260. */
  138261. removeIncludedOnlyMesh(mesh: Mesh): void;
  138262. /**
  138263. * Determine if a given mesh will be used in the glow layer
  138264. * @param mesh The mesh to test
  138265. * @returns true if the mesh will be highlighted by the current glow layer
  138266. */
  138267. hasMesh(mesh: AbstractMesh): boolean;
  138268. /**
  138269. * Defines whether the current material of the mesh should be use to render the effect.
  138270. * @param mesh defines the current mesh to render
  138271. */
  138272. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  138273. /**
  138274. * Add a mesh to be rendered through its own material and not with emissive only.
  138275. * @param mesh The mesh for which we need to use its material
  138276. */
  138277. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  138278. /**
  138279. * Remove a mesh from being rendered through its own material and not with emissive only.
  138280. * @param mesh The mesh for which we need to not use its material
  138281. */
  138282. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  138283. /**
  138284. * Free any resources and references associated to a mesh.
  138285. * Internal use
  138286. * @param mesh The mesh to free.
  138287. * @hidden
  138288. */
  138289. _disposeMesh(mesh: Mesh): void;
  138290. /**
  138291. * Gets the class name of the effect layer
  138292. * @returns the string with the class name of the effect layer
  138293. */
  138294. getClassName(): string;
  138295. /**
  138296. * Serializes this glow layer
  138297. * @returns a serialized glow layer object
  138298. */
  138299. serialize(): any;
  138300. /**
  138301. * Creates a Glow Layer from parsed glow layer data
  138302. * @param parsedGlowLayer defines glow layer data
  138303. * @param scene defines the current scene
  138304. * @param rootUrl defines the root URL containing the glow layer information
  138305. * @returns a parsed Glow Layer
  138306. */
  138307. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  138308. }
  138309. }
  138310. declare module BABYLON {
  138311. /** @hidden */
  138312. export var glowBlurPostProcessPixelShader: {
  138313. name: string;
  138314. shader: string;
  138315. };
  138316. }
  138317. declare module BABYLON {
  138318. interface AbstractScene {
  138319. /**
  138320. * Return a the first highlight layer of the scene with a given name.
  138321. * @param name The name of the highlight layer to look for.
  138322. * @return The highlight layer if found otherwise null.
  138323. */
  138324. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  138325. }
  138326. /**
  138327. * Highlight layer options. This helps customizing the behaviour
  138328. * of the highlight layer.
  138329. */
  138330. export interface IHighlightLayerOptions {
  138331. /**
  138332. * Multiplication factor apply to the canvas size to compute the render target size
  138333. * used to generated the glowing objects (the smaller the faster).
  138334. */
  138335. mainTextureRatio: number;
  138336. /**
  138337. * Enforces a fixed size texture to ensure resize independant blur.
  138338. */
  138339. mainTextureFixedSize?: number;
  138340. /**
  138341. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  138342. * of the picture to blur (the smaller the faster).
  138343. */
  138344. blurTextureSizeRatio: number;
  138345. /**
  138346. * How big in texel of the blur texture is the vertical blur.
  138347. */
  138348. blurVerticalSize: number;
  138349. /**
  138350. * How big in texel of the blur texture is the horizontal blur.
  138351. */
  138352. blurHorizontalSize: number;
  138353. /**
  138354. * Alpha blending mode used to apply the blur. Default is combine.
  138355. */
  138356. alphaBlendingMode: number;
  138357. /**
  138358. * The camera attached to the layer.
  138359. */
  138360. camera: Nullable<Camera>;
  138361. /**
  138362. * Should we display highlight as a solid stroke?
  138363. */
  138364. isStroke?: boolean;
  138365. /**
  138366. * The rendering group to draw the layer in.
  138367. */
  138368. renderingGroupId: number;
  138369. }
  138370. /**
  138371. * The highlight layer Helps adding a glow effect around a mesh.
  138372. *
  138373. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  138374. * glowy meshes to your scene.
  138375. *
  138376. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  138377. */
  138378. export class HighlightLayer extends EffectLayer {
  138379. name: string;
  138380. /**
  138381. * Effect Name of the highlight layer.
  138382. */
  138383. static readonly EffectName: string;
  138384. /**
  138385. * The neutral color used during the preparation of the glow effect.
  138386. * This is black by default as the blend operation is a blend operation.
  138387. */
  138388. static NeutralColor: Color4;
  138389. /**
  138390. * Stencil value used for glowing meshes.
  138391. */
  138392. static GlowingMeshStencilReference: number;
  138393. /**
  138394. * Stencil value used for the other meshes in the scene.
  138395. */
  138396. static NormalMeshStencilReference: number;
  138397. /**
  138398. * Specifies whether or not the inner glow is ACTIVE in the layer.
  138399. */
  138400. innerGlow: boolean;
  138401. /**
  138402. * Specifies whether or not the outer glow is ACTIVE in the layer.
  138403. */
  138404. outerGlow: boolean;
  138405. /**
  138406. * Specifies the horizontal size of the blur.
  138407. */
  138408. set blurHorizontalSize(value: number);
  138409. /**
  138410. * Specifies the vertical size of the blur.
  138411. */
  138412. set blurVerticalSize(value: number);
  138413. /**
  138414. * Gets the horizontal size of the blur.
  138415. */
  138416. get blurHorizontalSize(): number;
  138417. /**
  138418. * Gets the vertical size of the blur.
  138419. */
  138420. get blurVerticalSize(): number;
  138421. /**
  138422. * An event triggered when the highlight layer is being blurred.
  138423. */
  138424. onBeforeBlurObservable: Observable<HighlightLayer>;
  138425. /**
  138426. * An event triggered when the highlight layer has been blurred.
  138427. */
  138428. onAfterBlurObservable: Observable<HighlightLayer>;
  138429. private _instanceGlowingMeshStencilReference;
  138430. private _options;
  138431. private _downSamplePostprocess;
  138432. private _horizontalBlurPostprocess;
  138433. private _verticalBlurPostprocess;
  138434. private _blurTexture;
  138435. private _meshes;
  138436. private _excludedMeshes;
  138437. /**
  138438. * Instantiates a new highlight Layer and references it to the scene..
  138439. * @param name The name of the layer
  138440. * @param scene The scene to use the layer in
  138441. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  138442. */
  138443. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  138444. /**
  138445. * Get the effect name of the layer.
  138446. * @return The effect name
  138447. */
  138448. getEffectName(): string;
  138449. /**
  138450. * Create the merge effect. This is the shader use to blit the information back
  138451. * to the main canvas at the end of the scene rendering.
  138452. */
  138453. protected _createMergeEffect(): Effect;
  138454. /**
  138455. * Creates the render target textures and post processes used in the highlight layer.
  138456. */
  138457. protected _createTextureAndPostProcesses(): void;
  138458. /**
  138459. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  138460. */
  138461. needStencil(): boolean;
  138462. /**
  138463. * Checks for the readiness of the element composing the layer.
  138464. * @param subMesh the mesh to check for
  138465. * @param useInstances specify wether or not to use instances to render the mesh
  138466. * @param emissiveTexture the associated emissive texture used to generate the glow
  138467. * @return true if ready otherwise, false
  138468. */
  138469. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138470. /**
  138471. * Implementation specific of rendering the generating effect on the main canvas.
  138472. * @param effect The effect used to render through
  138473. */
  138474. protected _internalRender(effect: Effect): void;
  138475. /**
  138476. * Returns true if the layer contains information to display, otherwise false.
  138477. */
  138478. shouldRender(): boolean;
  138479. /**
  138480. * Returns true if the mesh should render, otherwise false.
  138481. * @param mesh The mesh to render
  138482. * @returns true if it should render otherwise false
  138483. */
  138484. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138485. /**
  138486. * Returns true if the mesh can be rendered, otherwise false.
  138487. * @param mesh The mesh to render
  138488. * @param material The material used on the mesh
  138489. * @returns true if it can be rendered otherwise false
  138490. */
  138491. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138492. /**
  138493. * Adds specific effects defines.
  138494. * @param defines The defines to add specifics to.
  138495. */
  138496. protected _addCustomEffectDefines(defines: string[]): void;
  138497. /**
  138498. * Sets the required values for both the emissive texture and and the main color.
  138499. */
  138500. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138501. /**
  138502. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  138503. * @param mesh The mesh to exclude from the highlight layer
  138504. */
  138505. addExcludedMesh(mesh: Mesh): void;
  138506. /**
  138507. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  138508. * @param mesh The mesh to highlight
  138509. */
  138510. removeExcludedMesh(mesh: Mesh): void;
  138511. /**
  138512. * Determine if a given mesh will be highlighted by the current HighlightLayer
  138513. * @param mesh mesh to test
  138514. * @returns true if the mesh will be highlighted by the current HighlightLayer
  138515. */
  138516. hasMesh(mesh: AbstractMesh): boolean;
  138517. /**
  138518. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  138519. * @param mesh The mesh to highlight
  138520. * @param color The color of the highlight
  138521. * @param glowEmissiveOnly Extract the glow from the emissive texture
  138522. */
  138523. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  138524. /**
  138525. * Remove a mesh from the highlight layer in order to make it stop glowing.
  138526. * @param mesh The mesh to highlight
  138527. */
  138528. removeMesh(mesh: Mesh): void;
  138529. /**
  138530. * Remove all the meshes currently referenced in the highlight layer
  138531. */
  138532. removeAllMeshes(): void;
  138533. /**
  138534. * Force the stencil to the normal expected value for none glowing parts
  138535. */
  138536. private _defaultStencilReference;
  138537. /**
  138538. * Free any resources and references associated to a mesh.
  138539. * Internal use
  138540. * @param mesh The mesh to free.
  138541. * @hidden
  138542. */
  138543. _disposeMesh(mesh: Mesh): void;
  138544. /**
  138545. * Dispose the highlight layer and free resources.
  138546. */
  138547. dispose(): void;
  138548. /**
  138549. * Gets the class name of the effect layer
  138550. * @returns the string with the class name of the effect layer
  138551. */
  138552. getClassName(): string;
  138553. /**
  138554. * Serializes this Highlight layer
  138555. * @returns a serialized Highlight layer object
  138556. */
  138557. serialize(): any;
  138558. /**
  138559. * Creates a Highlight layer from parsed Highlight layer data
  138560. * @param parsedHightlightLayer defines the Highlight layer data
  138561. * @param scene defines the current scene
  138562. * @param rootUrl defines the root URL containing the Highlight layer information
  138563. * @returns a parsed Highlight layer
  138564. */
  138565. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  138566. }
  138567. }
  138568. declare module BABYLON {
  138569. interface AbstractScene {
  138570. /**
  138571. * The list of layers (background and foreground) of the scene
  138572. */
  138573. layers: Array<Layer>;
  138574. }
  138575. /**
  138576. * Defines the layer scene component responsible to manage any layers
  138577. * in a given scene.
  138578. */
  138579. export class LayerSceneComponent implements ISceneComponent {
  138580. /**
  138581. * The component name helpfull to identify the component in the list of scene components.
  138582. */
  138583. readonly name: string;
  138584. /**
  138585. * The scene the component belongs to.
  138586. */
  138587. scene: Scene;
  138588. private _engine;
  138589. /**
  138590. * Creates a new instance of the component for the given scene
  138591. * @param scene Defines the scene to register the component in
  138592. */
  138593. constructor(scene: Scene);
  138594. /**
  138595. * Registers the component in a given scene
  138596. */
  138597. register(): void;
  138598. /**
  138599. * Rebuilds the elements related to this component in case of
  138600. * context lost for instance.
  138601. */
  138602. rebuild(): void;
  138603. /**
  138604. * Disposes the component and the associated ressources.
  138605. */
  138606. dispose(): void;
  138607. private _draw;
  138608. private _drawCameraPredicate;
  138609. private _drawCameraBackground;
  138610. private _drawCameraForeground;
  138611. private _drawRenderTargetPredicate;
  138612. private _drawRenderTargetBackground;
  138613. private _drawRenderTargetForeground;
  138614. /**
  138615. * Adds all the elements from the container to the scene
  138616. * @param container the container holding the elements
  138617. */
  138618. addFromContainer(container: AbstractScene): void;
  138619. /**
  138620. * Removes all the elements in the container from the scene
  138621. * @param container contains the elements to remove
  138622. * @param dispose if the removed element should be disposed (default: false)
  138623. */
  138624. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138625. }
  138626. }
  138627. declare module BABYLON {
  138628. /** @hidden */
  138629. export var layerPixelShader: {
  138630. name: string;
  138631. shader: string;
  138632. };
  138633. }
  138634. declare module BABYLON {
  138635. /** @hidden */
  138636. export var layerVertexShader: {
  138637. name: string;
  138638. shader: string;
  138639. };
  138640. }
  138641. declare module BABYLON {
  138642. /**
  138643. * This represents a full screen 2d layer.
  138644. * This can be useful to display a picture in the background of your scene for instance.
  138645. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138646. */
  138647. export class Layer {
  138648. /**
  138649. * Define the name of the layer.
  138650. */
  138651. name: string;
  138652. /**
  138653. * Define the texture the layer should display.
  138654. */
  138655. texture: Nullable<Texture>;
  138656. /**
  138657. * Is the layer in background or foreground.
  138658. */
  138659. isBackground: boolean;
  138660. /**
  138661. * Define the color of the layer (instead of texture).
  138662. */
  138663. color: Color4;
  138664. /**
  138665. * Define the scale of the layer in order to zoom in out of the texture.
  138666. */
  138667. scale: Vector2;
  138668. /**
  138669. * Define an offset for the layer in order to shift the texture.
  138670. */
  138671. offset: Vector2;
  138672. /**
  138673. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  138674. */
  138675. alphaBlendingMode: number;
  138676. /**
  138677. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  138678. * Alpha test will not mix with the background color in case of transparency.
  138679. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  138680. */
  138681. alphaTest: boolean;
  138682. /**
  138683. * Define a mask to restrict the layer to only some of the scene cameras.
  138684. */
  138685. layerMask: number;
  138686. /**
  138687. * Define the list of render target the layer is visible into.
  138688. */
  138689. renderTargetTextures: RenderTargetTexture[];
  138690. /**
  138691. * Define if the layer is only used in renderTarget or if it also
  138692. * renders in the main frame buffer of the canvas.
  138693. */
  138694. renderOnlyInRenderTargetTextures: boolean;
  138695. private _scene;
  138696. private _vertexBuffers;
  138697. private _indexBuffer;
  138698. private _effect;
  138699. private _previousDefines;
  138700. /**
  138701. * An event triggered when the layer is disposed.
  138702. */
  138703. onDisposeObservable: Observable<Layer>;
  138704. private _onDisposeObserver;
  138705. /**
  138706. * Back compatibility with callback before the onDisposeObservable existed.
  138707. * The set callback will be triggered when the layer has been disposed.
  138708. */
  138709. set onDispose(callback: () => void);
  138710. /**
  138711. * An event triggered before rendering the scene
  138712. */
  138713. onBeforeRenderObservable: Observable<Layer>;
  138714. private _onBeforeRenderObserver;
  138715. /**
  138716. * Back compatibility with callback before the onBeforeRenderObservable existed.
  138717. * The set callback will be triggered just before rendering the layer.
  138718. */
  138719. set onBeforeRender(callback: () => void);
  138720. /**
  138721. * An event triggered after rendering the scene
  138722. */
  138723. onAfterRenderObservable: Observable<Layer>;
  138724. private _onAfterRenderObserver;
  138725. /**
  138726. * Back compatibility with callback before the onAfterRenderObservable existed.
  138727. * The set callback will be triggered just after rendering the layer.
  138728. */
  138729. set onAfterRender(callback: () => void);
  138730. /**
  138731. * Instantiates a new layer.
  138732. * This represents a full screen 2d layer.
  138733. * This can be useful to display a picture in the background of your scene for instance.
  138734. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138735. * @param name Define the name of the layer in the scene
  138736. * @param imgUrl Define the url of the texture to display in the layer
  138737. * @param scene Define the scene the layer belongs to
  138738. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  138739. * @param color Defines a color for the layer
  138740. */
  138741. constructor(
  138742. /**
  138743. * Define the name of the layer.
  138744. */
  138745. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  138746. private _createIndexBuffer;
  138747. /** @hidden */
  138748. _rebuild(): void;
  138749. /**
  138750. * Renders the layer in the scene.
  138751. */
  138752. render(): void;
  138753. /**
  138754. * Disposes and releases the associated ressources.
  138755. */
  138756. dispose(): void;
  138757. }
  138758. }
  138759. declare module BABYLON {
  138760. /** @hidden */
  138761. export var lensFlarePixelShader: {
  138762. name: string;
  138763. shader: string;
  138764. };
  138765. }
  138766. declare module BABYLON {
  138767. /** @hidden */
  138768. export var lensFlareVertexShader: {
  138769. name: string;
  138770. shader: string;
  138771. };
  138772. }
  138773. declare module BABYLON {
  138774. /**
  138775. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138776. * It is usually composed of several `lensFlare`.
  138777. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138778. */
  138779. export class LensFlareSystem {
  138780. /**
  138781. * Define the name of the lens flare system
  138782. */
  138783. name: string;
  138784. /**
  138785. * List of lens flares used in this system.
  138786. */
  138787. lensFlares: LensFlare[];
  138788. /**
  138789. * Define a limit from the border the lens flare can be visible.
  138790. */
  138791. borderLimit: number;
  138792. /**
  138793. * Define a viewport border we do not want to see the lens flare in.
  138794. */
  138795. viewportBorder: number;
  138796. /**
  138797. * Define a predicate which could limit the list of meshes able to occlude the effect.
  138798. */
  138799. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  138800. /**
  138801. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  138802. */
  138803. layerMask: number;
  138804. /**
  138805. * Define the id of the lens flare system in the scene.
  138806. * (equal to name by default)
  138807. */
  138808. id: string;
  138809. private _scene;
  138810. private _emitter;
  138811. private _vertexBuffers;
  138812. private _indexBuffer;
  138813. private _effect;
  138814. private _positionX;
  138815. private _positionY;
  138816. private _isEnabled;
  138817. /** @hidden */
  138818. static _SceneComponentInitialization: (scene: Scene) => void;
  138819. /**
  138820. * Instantiates a lens flare system.
  138821. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138822. * It is usually composed of several `lensFlare`.
  138823. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138824. * @param name Define the name of the lens flare system in the scene
  138825. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  138826. * @param scene Define the scene the lens flare system belongs to
  138827. */
  138828. constructor(
  138829. /**
  138830. * Define the name of the lens flare system
  138831. */
  138832. name: string, emitter: any, scene: Scene);
  138833. /**
  138834. * Define if the lens flare system is enabled.
  138835. */
  138836. get isEnabled(): boolean;
  138837. set isEnabled(value: boolean);
  138838. /**
  138839. * Get the scene the effects belongs to.
  138840. * @returns the scene holding the lens flare system
  138841. */
  138842. getScene(): Scene;
  138843. /**
  138844. * Get the emitter of the lens flare system.
  138845. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138846. * @returns the emitter of the lens flare system
  138847. */
  138848. getEmitter(): any;
  138849. /**
  138850. * Set the emitter of the lens flare system.
  138851. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138852. * @param newEmitter Define the new emitter of the system
  138853. */
  138854. setEmitter(newEmitter: any): void;
  138855. /**
  138856. * Get the lens flare system emitter position.
  138857. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  138858. * @returns the position
  138859. */
  138860. getEmitterPosition(): Vector3;
  138861. /**
  138862. * @hidden
  138863. */
  138864. computeEffectivePosition(globalViewport: Viewport): boolean;
  138865. /** @hidden */
  138866. _isVisible(): boolean;
  138867. /**
  138868. * @hidden
  138869. */
  138870. render(): boolean;
  138871. /**
  138872. * Dispose and release the lens flare with its associated resources.
  138873. */
  138874. dispose(): void;
  138875. /**
  138876. * Parse a lens flare system from a JSON repressentation
  138877. * @param parsedLensFlareSystem Define the JSON to parse
  138878. * @param scene Define the scene the parsed system should be instantiated in
  138879. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  138880. * @returns the parsed system
  138881. */
  138882. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  138883. /**
  138884. * Serialize the current Lens Flare System into a JSON representation.
  138885. * @returns the serialized JSON
  138886. */
  138887. serialize(): any;
  138888. }
  138889. }
  138890. declare module BABYLON {
  138891. /**
  138892. * This represents one of the lens effect in a `lensFlareSystem`.
  138893. * It controls one of the indiviual texture used in the effect.
  138894. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138895. */
  138896. export class LensFlare {
  138897. /**
  138898. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138899. */
  138900. size: number;
  138901. /**
  138902. * 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.
  138903. */
  138904. position: number;
  138905. /**
  138906. * Define the lens color.
  138907. */
  138908. color: Color3;
  138909. /**
  138910. * Define the lens texture.
  138911. */
  138912. texture: Nullable<Texture>;
  138913. /**
  138914. * Define the alpha mode to render this particular lens.
  138915. */
  138916. alphaMode: number;
  138917. private _system;
  138918. /**
  138919. * Creates a new Lens Flare.
  138920. * This represents one of the lens effect in a `lensFlareSystem`.
  138921. * It controls one of the indiviual texture used in the effect.
  138922. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138923. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  138924. * @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.
  138925. * @param color Define the lens color
  138926. * @param imgUrl Define the lens texture url
  138927. * @param system Define the `lensFlareSystem` this flare is part of
  138928. * @returns The newly created Lens Flare
  138929. */
  138930. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  138931. /**
  138932. * Instantiates a new Lens Flare.
  138933. * This represents one of the lens effect in a `lensFlareSystem`.
  138934. * It controls one of the indiviual texture used in the effect.
  138935. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138936. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  138937. * @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.
  138938. * @param color Define the lens color
  138939. * @param imgUrl Define the lens texture url
  138940. * @param system Define the `lensFlareSystem` this flare is part of
  138941. */
  138942. constructor(
  138943. /**
  138944. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138945. */
  138946. size: number,
  138947. /**
  138948. * 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.
  138949. */
  138950. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  138951. /**
  138952. * Dispose and release the lens flare with its associated resources.
  138953. */
  138954. dispose(): void;
  138955. }
  138956. }
  138957. declare module BABYLON {
  138958. interface AbstractScene {
  138959. /**
  138960. * The list of lens flare system added to the scene
  138961. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138962. */
  138963. lensFlareSystems: Array<LensFlareSystem>;
  138964. /**
  138965. * Removes the given lens flare system from this scene.
  138966. * @param toRemove The lens flare system to remove
  138967. * @returns The index of the removed lens flare system
  138968. */
  138969. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  138970. /**
  138971. * Adds the given lens flare system to this scene
  138972. * @param newLensFlareSystem The lens flare system to add
  138973. */
  138974. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  138975. /**
  138976. * Gets a lens flare system using its name
  138977. * @param name defines the name to look for
  138978. * @returns the lens flare system or null if not found
  138979. */
  138980. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  138981. /**
  138982. * Gets a lens flare system using its id
  138983. * @param id defines the id to look for
  138984. * @returns the lens flare system or null if not found
  138985. */
  138986. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  138987. }
  138988. /**
  138989. * Defines the lens flare scene component responsible to manage any lens flares
  138990. * in a given scene.
  138991. */
  138992. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  138993. /**
  138994. * The component name helpfull to identify the component in the list of scene components.
  138995. */
  138996. readonly name: string;
  138997. /**
  138998. * The scene the component belongs to.
  138999. */
  139000. scene: Scene;
  139001. /**
  139002. * Creates a new instance of the component for the given scene
  139003. * @param scene Defines the scene to register the component in
  139004. */
  139005. constructor(scene: Scene);
  139006. /**
  139007. * Registers the component in a given scene
  139008. */
  139009. register(): void;
  139010. /**
  139011. * Rebuilds the elements related to this component in case of
  139012. * context lost for instance.
  139013. */
  139014. rebuild(): void;
  139015. /**
  139016. * Adds all the elements from the container to the scene
  139017. * @param container the container holding the elements
  139018. */
  139019. addFromContainer(container: AbstractScene): void;
  139020. /**
  139021. * Removes all the elements in the container from the scene
  139022. * @param container contains the elements to remove
  139023. * @param dispose if the removed element should be disposed (default: false)
  139024. */
  139025. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139026. /**
  139027. * Serializes the component data to the specified json object
  139028. * @param serializationObject The object to serialize to
  139029. */
  139030. serialize(serializationObject: any): void;
  139031. /**
  139032. * Disposes the component and the associated ressources.
  139033. */
  139034. dispose(): void;
  139035. private _draw;
  139036. }
  139037. }
  139038. declare module BABYLON {
  139039. /** @hidden */
  139040. export var depthPixelShader: {
  139041. name: string;
  139042. shader: string;
  139043. };
  139044. }
  139045. declare module BABYLON {
  139046. /** @hidden */
  139047. export var depthVertexShader: {
  139048. name: string;
  139049. shader: string;
  139050. };
  139051. }
  139052. declare module BABYLON {
  139053. /**
  139054. * This represents a depth renderer in Babylon.
  139055. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  139056. */
  139057. export class DepthRenderer {
  139058. private _scene;
  139059. private _depthMap;
  139060. private _effect;
  139061. private readonly _storeNonLinearDepth;
  139062. private readonly _clearColor;
  139063. /** Get if the depth renderer is using packed depth or not */
  139064. readonly isPacked: boolean;
  139065. private _cachedDefines;
  139066. private _camera;
  139067. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  139068. enabled: boolean;
  139069. /**
  139070. * Specifiess that the depth renderer will only be used within
  139071. * the camera it is created for.
  139072. * This can help forcing its rendering during the camera processing.
  139073. */
  139074. useOnlyInActiveCamera: boolean;
  139075. /** @hidden */
  139076. static _SceneComponentInitialization: (scene: Scene) => void;
  139077. /**
  139078. * Instantiates a depth renderer
  139079. * @param scene The scene the renderer belongs to
  139080. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  139081. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  139082. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  139083. */
  139084. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  139085. /**
  139086. * Creates the depth rendering effect and checks if the effect is ready.
  139087. * @param subMesh The submesh to be used to render the depth map of
  139088. * @param useInstances If multiple world instances should be used
  139089. * @returns if the depth renderer is ready to render the depth map
  139090. */
  139091. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139092. /**
  139093. * Gets the texture which the depth map will be written to.
  139094. * @returns The depth map texture
  139095. */
  139096. getDepthMap(): RenderTargetTexture;
  139097. /**
  139098. * Disposes of the depth renderer.
  139099. */
  139100. dispose(): void;
  139101. }
  139102. }
  139103. declare module BABYLON {
  139104. /** @hidden */
  139105. export var minmaxReduxPixelShader: {
  139106. name: string;
  139107. shader: string;
  139108. };
  139109. }
  139110. declare module BABYLON {
  139111. /**
  139112. * This class computes a min/max reduction from a texture: it means it computes the minimum
  139113. * and maximum values from all values of the texture.
  139114. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  139115. * The source values are read from the red channel of the texture.
  139116. */
  139117. export class MinMaxReducer {
  139118. /**
  139119. * Observable triggered when the computation has been performed
  139120. */
  139121. onAfterReductionPerformed: Observable<{
  139122. min: number;
  139123. max: number;
  139124. }>;
  139125. protected _camera: Camera;
  139126. protected _sourceTexture: Nullable<RenderTargetTexture>;
  139127. protected _reductionSteps: Nullable<Array<PostProcess>>;
  139128. protected _postProcessManager: PostProcessManager;
  139129. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  139130. protected _forceFullscreenViewport: boolean;
  139131. /**
  139132. * Creates a min/max reducer
  139133. * @param camera The camera to use for the post processes
  139134. */
  139135. constructor(camera: Camera);
  139136. /**
  139137. * Gets the texture used to read the values from.
  139138. */
  139139. get sourceTexture(): Nullable<RenderTargetTexture>;
  139140. /**
  139141. * Sets the source texture to read the values from.
  139142. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  139143. * because in such textures '1' value must not be taken into account to compute the maximum
  139144. * as this value is used to clear the texture.
  139145. * Note that the computation is not activated by calling this function, you must call activate() for that!
  139146. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  139147. * @param depthRedux Indicates if the texture is a depth texture or not
  139148. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  139149. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139150. */
  139151. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139152. /**
  139153. * Defines the refresh rate of the computation.
  139154. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139155. */
  139156. get refreshRate(): number;
  139157. set refreshRate(value: number);
  139158. protected _activated: boolean;
  139159. /**
  139160. * Gets the activation status of the reducer
  139161. */
  139162. get activated(): boolean;
  139163. /**
  139164. * Activates the reduction computation.
  139165. * When activated, the observers registered in onAfterReductionPerformed are
  139166. * called after the compuation is performed
  139167. */
  139168. activate(): void;
  139169. /**
  139170. * Deactivates the reduction computation.
  139171. */
  139172. deactivate(): void;
  139173. /**
  139174. * Disposes the min/max reducer
  139175. * @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.
  139176. */
  139177. dispose(disposeAll?: boolean): void;
  139178. }
  139179. }
  139180. declare module BABYLON {
  139181. /**
  139182. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  139183. */
  139184. export class DepthReducer extends MinMaxReducer {
  139185. private _depthRenderer;
  139186. private _depthRendererId;
  139187. /**
  139188. * Gets the depth renderer used for the computation.
  139189. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  139190. */
  139191. get depthRenderer(): Nullable<DepthRenderer>;
  139192. /**
  139193. * Creates a depth reducer
  139194. * @param camera The camera used to render the depth texture
  139195. */
  139196. constructor(camera: Camera);
  139197. /**
  139198. * Sets the depth renderer to use to generate the depth map
  139199. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  139200. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  139201. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139202. */
  139203. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  139204. /** @hidden */
  139205. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139206. /**
  139207. * Activates the reduction computation.
  139208. * When activated, the observers registered in onAfterReductionPerformed are
  139209. * called after the compuation is performed
  139210. */
  139211. activate(): void;
  139212. /**
  139213. * Deactivates the reduction computation.
  139214. */
  139215. deactivate(): void;
  139216. /**
  139217. * Disposes the depth reducer
  139218. * @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.
  139219. */
  139220. dispose(disposeAll?: boolean): void;
  139221. }
  139222. }
  139223. declare module BABYLON {
  139224. /**
  139225. * A CSM implementation allowing casting shadows on large scenes.
  139226. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139227. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  139228. */
  139229. export class CascadedShadowGenerator extends ShadowGenerator {
  139230. private static readonly frustumCornersNDCSpace;
  139231. /**
  139232. * Name of the CSM class
  139233. */
  139234. static CLASSNAME: string;
  139235. /**
  139236. * Defines the default number of cascades used by the CSM.
  139237. */
  139238. static readonly DEFAULT_CASCADES_COUNT: number;
  139239. /**
  139240. * Defines the minimum number of cascades used by the CSM.
  139241. */
  139242. static readonly MIN_CASCADES_COUNT: number;
  139243. /**
  139244. * Defines the maximum number of cascades used by the CSM.
  139245. */
  139246. static readonly MAX_CASCADES_COUNT: number;
  139247. protected _validateFilter(filter: number): number;
  139248. /**
  139249. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  139250. */
  139251. penumbraDarkness: number;
  139252. private _numCascades;
  139253. /**
  139254. * Gets or set the number of cascades used by the CSM.
  139255. */
  139256. get numCascades(): number;
  139257. set numCascades(value: number);
  139258. /**
  139259. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  139260. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  139261. */
  139262. stabilizeCascades: boolean;
  139263. private _freezeShadowCastersBoundingInfo;
  139264. private _freezeShadowCastersBoundingInfoObservable;
  139265. /**
  139266. * Enables or disables the shadow casters bounding info computation.
  139267. * If your shadow casters don't move, you can disable this feature.
  139268. * If it is enabled, the bounding box computation is done every frame.
  139269. */
  139270. get freezeShadowCastersBoundingInfo(): boolean;
  139271. set freezeShadowCastersBoundingInfo(freeze: boolean);
  139272. private _scbiMin;
  139273. private _scbiMax;
  139274. protected _computeShadowCastersBoundingInfo(): void;
  139275. protected _shadowCastersBoundingInfo: BoundingInfo;
  139276. /**
  139277. * Gets or sets the shadow casters bounding info.
  139278. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  139279. * so that the system won't overwrite the bounds you provide
  139280. */
  139281. get shadowCastersBoundingInfo(): BoundingInfo;
  139282. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  139283. protected _breaksAreDirty: boolean;
  139284. protected _minDistance: number;
  139285. protected _maxDistance: number;
  139286. /**
  139287. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  139288. *
  139289. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  139290. * If you don't know these values, simply leave them to their defaults and don't call this function.
  139291. * @param min minimal distance for the breaks (default to 0.)
  139292. * @param max maximal distance for the breaks (default to 1.)
  139293. */
  139294. setMinMaxDistance(min: number, max: number): void;
  139295. /** Gets the minimal distance used in the cascade break computation */
  139296. get minDistance(): number;
  139297. /** Gets the maximal distance used in the cascade break computation */
  139298. get maxDistance(): number;
  139299. /**
  139300. * Gets the class name of that object
  139301. * @returns "CascadedShadowGenerator"
  139302. */
  139303. getClassName(): string;
  139304. private _cascadeMinExtents;
  139305. private _cascadeMaxExtents;
  139306. /**
  139307. * Gets a cascade minimum extents
  139308. * @param cascadeIndex index of the cascade
  139309. * @returns the minimum cascade extents
  139310. */
  139311. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  139312. /**
  139313. * Gets a cascade maximum extents
  139314. * @param cascadeIndex index of the cascade
  139315. * @returns the maximum cascade extents
  139316. */
  139317. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  139318. private _cascades;
  139319. private _currentLayer;
  139320. private _viewSpaceFrustumsZ;
  139321. private _viewMatrices;
  139322. private _projectionMatrices;
  139323. private _transformMatrices;
  139324. private _transformMatricesAsArray;
  139325. private _frustumLengths;
  139326. private _lightSizeUVCorrection;
  139327. private _depthCorrection;
  139328. private _frustumCornersWorldSpace;
  139329. private _frustumCenter;
  139330. private _shadowCameraPos;
  139331. private _shadowMaxZ;
  139332. /**
  139333. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  139334. * It defaults to camera.maxZ
  139335. */
  139336. get shadowMaxZ(): number;
  139337. /**
  139338. * Sets the shadow max z distance.
  139339. */
  139340. set shadowMaxZ(value: number);
  139341. protected _debug: boolean;
  139342. /**
  139343. * Gets or sets the debug flag.
  139344. * When enabled, the cascades are materialized by different colors on the screen.
  139345. */
  139346. get debug(): boolean;
  139347. set debug(dbg: boolean);
  139348. private _depthClamp;
  139349. /**
  139350. * Gets or sets the depth clamping value.
  139351. *
  139352. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  139353. * to account for the shadow casters far away.
  139354. *
  139355. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  139356. */
  139357. get depthClamp(): boolean;
  139358. set depthClamp(value: boolean);
  139359. private _cascadeBlendPercentage;
  139360. /**
  139361. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  139362. * It defaults to 0.1 (10% blending).
  139363. */
  139364. get cascadeBlendPercentage(): number;
  139365. set cascadeBlendPercentage(value: number);
  139366. private _lambda;
  139367. /**
  139368. * Gets or set the lambda parameter.
  139369. * This parameter is used to split the camera frustum and create the cascades.
  139370. * 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.
  139371. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  139372. */
  139373. get lambda(): number;
  139374. set lambda(value: number);
  139375. /**
  139376. * Gets the view matrix corresponding to a given cascade
  139377. * @param cascadeNum cascade to retrieve the view matrix from
  139378. * @returns the cascade view matrix
  139379. */
  139380. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  139381. /**
  139382. * Gets the projection matrix corresponding to a given cascade
  139383. * @param cascadeNum cascade to retrieve the projection matrix from
  139384. * @returns the cascade projection matrix
  139385. */
  139386. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  139387. /**
  139388. * Gets the transformation matrix corresponding to a given cascade
  139389. * @param cascadeNum cascade to retrieve the transformation matrix from
  139390. * @returns the cascade transformation matrix
  139391. */
  139392. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  139393. private _depthRenderer;
  139394. /**
  139395. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  139396. *
  139397. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  139398. *
  139399. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  139400. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  139401. * @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
  139402. */
  139403. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  139404. private _depthReducer;
  139405. private _autoCalcDepthBounds;
  139406. /**
  139407. * Gets or sets the autoCalcDepthBounds property.
  139408. *
  139409. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  139410. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  139411. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  139412. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  139413. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  139414. */
  139415. get autoCalcDepthBounds(): boolean;
  139416. set autoCalcDepthBounds(value: boolean);
  139417. /**
  139418. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  139419. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139420. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  139421. * for setting the refresh rate on the renderer yourself!
  139422. */
  139423. get autoCalcDepthBoundsRefreshRate(): number;
  139424. set autoCalcDepthBoundsRefreshRate(value: number);
  139425. /**
  139426. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  139427. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  139428. * you change the camera near/far planes!
  139429. */
  139430. splitFrustum(): void;
  139431. private _splitFrustum;
  139432. private _computeMatrices;
  139433. private _computeFrustumInWorldSpace;
  139434. private _computeCascadeFrustum;
  139435. /**
  139436. * Support test.
  139437. */
  139438. static get IsSupported(): boolean;
  139439. /** @hidden */
  139440. static _SceneComponentInitialization: (scene: Scene) => void;
  139441. /**
  139442. * Creates a Cascaded Shadow Generator object.
  139443. * A ShadowGenerator is the required tool to use the shadows.
  139444. * Each directional light casting shadows needs to use its own ShadowGenerator.
  139445. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139446. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  139447. * @param light The directional light object generating the shadows.
  139448. * @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.
  139449. */
  139450. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  139451. protected _initializeGenerator(): void;
  139452. protected _createTargetRenderTexture(): void;
  139453. protected _initializeShadowMap(): void;
  139454. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  139455. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  139456. /**
  139457. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  139458. * @param defines Defines of the material we want to update
  139459. * @param lightIndex Index of the light in the enabled light list of the material
  139460. */
  139461. prepareDefines(defines: any, lightIndex: number): void;
  139462. /**
  139463. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  139464. * defined in the generator but impacting the effect).
  139465. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  139466. * @param effect The effect we are binfing the information for
  139467. */
  139468. bindShadowLight(lightIndex: string, effect: Effect): void;
  139469. /**
  139470. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  139471. * (eq to view projection * shadow projection matrices)
  139472. * @returns The transform matrix used to create the shadow map
  139473. */
  139474. getTransformMatrix(): Matrix;
  139475. /**
  139476. * Disposes the ShadowGenerator.
  139477. * Returns nothing.
  139478. */
  139479. dispose(): void;
  139480. /**
  139481. * Serializes the shadow generator setup to a json object.
  139482. * @returns The serialized JSON object
  139483. */
  139484. serialize(): any;
  139485. /**
  139486. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  139487. * @param parsedShadowGenerator The JSON object to parse
  139488. * @param scene The scene to create the shadow map for
  139489. * @returns The parsed shadow generator
  139490. */
  139491. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  139492. }
  139493. }
  139494. declare module BABYLON {
  139495. /**
  139496. * Defines the shadow generator component responsible to manage any shadow generators
  139497. * in a given scene.
  139498. */
  139499. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  139500. /**
  139501. * The component name helpfull to identify the component in the list of scene components.
  139502. */
  139503. readonly name: string;
  139504. /**
  139505. * The scene the component belongs to.
  139506. */
  139507. scene: Scene;
  139508. /**
  139509. * Creates a new instance of the component for the given scene
  139510. * @param scene Defines the scene to register the component in
  139511. */
  139512. constructor(scene: Scene);
  139513. /**
  139514. * Registers the component in a given scene
  139515. */
  139516. register(): void;
  139517. /**
  139518. * Rebuilds the elements related to this component in case of
  139519. * context lost for instance.
  139520. */
  139521. rebuild(): void;
  139522. /**
  139523. * Serializes the component data to the specified json object
  139524. * @param serializationObject The object to serialize to
  139525. */
  139526. serialize(serializationObject: any): void;
  139527. /**
  139528. * Adds all the elements from the container to the scene
  139529. * @param container the container holding the elements
  139530. */
  139531. addFromContainer(container: AbstractScene): void;
  139532. /**
  139533. * Removes all the elements in the container from the scene
  139534. * @param container contains the elements to remove
  139535. * @param dispose if the removed element should be disposed (default: false)
  139536. */
  139537. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139538. /**
  139539. * Rebuilds the elements related to this component in case of
  139540. * context lost for instance.
  139541. */
  139542. dispose(): void;
  139543. private _gatherRenderTargets;
  139544. }
  139545. }
  139546. declare module BABYLON {
  139547. /**
  139548. * A point light is a light defined by an unique point in world space.
  139549. * The light is emitted in every direction from this point.
  139550. * A good example of a point light is a standard light bulb.
  139551. * Documentation: https://doc.babylonjs.com/babylon101/lights
  139552. */
  139553. export class PointLight extends ShadowLight {
  139554. private _shadowAngle;
  139555. /**
  139556. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139557. * This specifies what angle the shadow will use to be created.
  139558. *
  139559. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139560. */
  139561. get shadowAngle(): number;
  139562. /**
  139563. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139564. * This specifies what angle the shadow will use to be created.
  139565. *
  139566. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139567. */
  139568. set shadowAngle(value: number);
  139569. /**
  139570. * Gets the direction if it has been set.
  139571. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139572. */
  139573. get direction(): Vector3;
  139574. /**
  139575. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139576. */
  139577. set direction(value: Vector3);
  139578. /**
  139579. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  139580. * A PointLight emits the light in every direction.
  139581. * It can cast shadows.
  139582. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  139583. * ```javascript
  139584. * var pointLight = new PointLight("pl", camera.position, scene);
  139585. * ```
  139586. * Documentation : https://doc.babylonjs.com/babylon101/lights
  139587. * @param name The light friendly name
  139588. * @param position The position of the point light in the scene
  139589. * @param scene The scene the lights belongs to
  139590. */
  139591. constructor(name: string, position: Vector3, scene: Scene);
  139592. /**
  139593. * Returns the string "PointLight"
  139594. * @returns the class name
  139595. */
  139596. getClassName(): string;
  139597. /**
  139598. * Returns the integer 0.
  139599. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  139600. */
  139601. getTypeID(): number;
  139602. /**
  139603. * Specifies wether or not the shadowmap should be a cube texture.
  139604. * @returns true if the shadowmap needs to be a cube texture.
  139605. */
  139606. needCube(): boolean;
  139607. /**
  139608. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  139609. * @param faceIndex The index of the face we are computed the direction to generate shadow
  139610. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  139611. */
  139612. getShadowDirection(faceIndex?: number): Vector3;
  139613. /**
  139614. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  139615. * - fov = PI / 2
  139616. * - aspect ratio : 1.0
  139617. * - z-near and far equal to the active camera minZ and maxZ.
  139618. * Returns the PointLight.
  139619. */
  139620. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  139621. protected _buildUniformLayout(): void;
  139622. /**
  139623. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  139624. * @param effect The effect to update
  139625. * @param lightIndex The index of the light in the effect to update
  139626. * @returns The point light
  139627. */
  139628. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  139629. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  139630. /**
  139631. * Prepares the list of defines specific to the light type.
  139632. * @param defines the list of defines
  139633. * @param lightIndex defines the index of the light for the effect
  139634. */
  139635. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  139636. }
  139637. }
  139638. declare module BABYLON {
  139639. /**
  139640. * Header information of HDR texture files.
  139641. */
  139642. export interface HDRInfo {
  139643. /**
  139644. * The height of the texture in pixels.
  139645. */
  139646. height: number;
  139647. /**
  139648. * The width of the texture in pixels.
  139649. */
  139650. width: number;
  139651. /**
  139652. * The index of the beginning of the data in the binary file.
  139653. */
  139654. dataPosition: number;
  139655. }
  139656. /**
  139657. * This groups tools to convert HDR texture to native colors array.
  139658. */
  139659. export class HDRTools {
  139660. private static Ldexp;
  139661. private static Rgbe2float;
  139662. private static readStringLine;
  139663. /**
  139664. * Reads header information from an RGBE texture stored in a native array.
  139665. * More information on this format are available here:
  139666. * https://en.wikipedia.org/wiki/RGBE_image_format
  139667. *
  139668. * @param uint8array The binary file stored in native array.
  139669. * @return The header information.
  139670. */
  139671. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  139672. /**
  139673. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  139674. * This RGBE texture needs to store the information as a panorama.
  139675. *
  139676. * More information on this format are available here:
  139677. * https://en.wikipedia.org/wiki/RGBE_image_format
  139678. *
  139679. * @param buffer The binary file stored in an array buffer.
  139680. * @param size The expected size of the extracted cubemap.
  139681. * @return The Cube Map information.
  139682. */
  139683. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  139684. /**
  139685. * Returns the pixels data extracted from an RGBE texture.
  139686. * This pixels will be stored left to right up to down in the R G B order in one array.
  139687. *
  139688. * More information on this format are available here:
  139689. * https://en.wikipedia.org/wiki/RGBE_image_format
  139690. *
  139691. * @param uint8array The binary file stored in an array buffer.
  139692. * @param hdrInfo The header information of the file.
  139693. * @return The pixels data in RGB right to left up to down order.
  139694. */
  139695. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  139696. private static RGBE_ReadPixels_RLE;
  139697. private static RGBE_ReadPixels_NOT_RLE;
  139698. }
  139699. }
  139700. declare module BABYLON {
  139701. /**
  139702. * Effect Render Options
  139703. */
  139704. export interface IEffectRendererOptions {
  139705. /**
  139706. * Defines the vertices positions.
  139707. */
  139708. positions?: number[];
  139709. /**
  139710. * Defines the indices.
  139711. */
  139712. indices?: number[];
  139713. }
  139714. /**
  139715. * Helper class to render one or more effects.
  139716. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  139717. */
  139718. export class EffectRenderer {
  139719. private engine;
  139720. private static _DefaultOptions;
  139721. private _vertexBuffers;
  139722. private _indexBuffer;
  139723. private _fullscreenViewport;
  139724. /**
  139725. * Creates an effect renderer
  139726. * @param engine the engine to use for rendering
  139727. * @param options defines the options of the effect renderer
  139728. */
  139729. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  139730. /**
  139731. * Sets the current viewport in normalized coordinates 0-1
  139732. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  139733. */
  139734. setViewport(viewport?: Viewport): void;
  139735. /**
  139736. * Binds the embedded attributes buffer to the effect.
  139737. * @param effect Defines the effect to bind the attributes for
  139738. */
  139739. bindBuffers(effect: Effect): void;
  139740. /**
  139741. * Sets the current effect wrapper to use during draw.
  139742. * The effect needs to be ready before calling this api.
  139743. * This also sets the default full screen position attribute.
  139744. * @param effectWrapper Defines the effect to draw with
  139745. */
  139746. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  139747. /**
  139748. * Restores engine states
  139749. */
  139750. restoreStates(): void;
  139751. /**
  139752. * Draws a full screen quad.
  139753. */
  139754. draw(): void;
  139755. private isRenderTargetTexture;
  139756. /**
  139757. * renders one or more effects to a specified texture
  139758. * @param effectWrapper the effect to renderer
  139759. * @param outputTexture texture to draw to, if null it will render to the screen.
  139760. */
  139761. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  139762. /**
  139763. * Disposes of the effect renderer
  139764. */
  139765. dispose(): void;
  139766. }
  139767. /**
  139768. * Options to create an EffectWrapper
  139769. */
  139770. interface EffectWrapperCreationOptions {
  139771. /**
  139772. * Engine to use to create the effect
  139773. */
  139774. engine: ThinEngine;
  139775. /**
  139776. * Fragment shader for the effect
  139777. */
  139778. fragmentShader: string;
  139779. /**
  139780. * Use the shader store instead of direct source code
  139781. */
  139782. useShaderStore?: boolean;
  139783. /**
  139784. * Vertex shader for the effect
  139785. */
  139786. vertexShader?: string;
  139787. /**
  139788. * Attributes to use in the shader
  139789. */
  139790. attributeNames?: Array<string>;
  139791. /**
  139792. * Uniforms to use in the shader
  139793. */
  139794. uniformNames?: Array<string>;
  139795. /**
  139796. * Texture sampler names to use in the shader
  139797. */
  139798. samplerNames?: Array<string>;
  139799. /**
  139800. * Defines to use in the shader
  139801. */
  139802. defines?: Array<string>;
  139803. /**
  139804. * Callback when effect is compiled
  139805. */
  139806. onCompiled?: Nullable<(effect: Effect) => void>;
  139807. /**
  139808. * The friendly name of the effect displayed in Spector.
  139809. */
  139810. name?: string;
  139811. }
  139812. /**
  139813. * Wraps an effect to be used for rendering
  139814. */
  139815. export class EffectWrapper {
  139816. /**
  139817. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  139818. */
  139819. onApplyObservable: Observable<{}>;
  139820. /**
  139821. * The underlying effect
  139822. */
  139823. effect: Effect;
  139824. /**
  139825. * Creates an effect to be renderer
  139826. * @param creationOptions options to create the effect
  139827. */
  139828. constructor(creationOptions: EffectWrapperCreationOptions);
  139829. /**
  139830. * Disposes of the effect wrapper
  139831. */
  139832. dispose(): void;
  139833. }
  139834. }
  139835. declare module BABYLON {
  139836. /** @hidden */
  139837. export var hdrFilteringVertexShader: {
  139838. name: string;
  139839. shader: string;
  139840. };
  139841. }
  139842. declare module BABYLON {
  139843. /** @hidden */
  139844. export var hdrFilteringPixelShader: {
  139845. name: string;
  139846. shader: string;
  139847. };
  139848. }
  139849. declare module BABYLON {
  139850. /**
  139851. * Options for texture filtering
  139852. */
  139853. interface IHDRFilteringOptions {
  139854. /**
  139855. * Scales pixel intensity for the input HDR map.
  139856. */
  139857. hdrScale?: number;
  139858. /**
  139859. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  139860. */
  139861. quality?: number;
  139862. }
  139863. /**
  139864. * Filters HDR maps to get correct renderings of PBR reflections
  139865. */
  139866. export class HDRFiltering {
  139867. private _engine;
  139868. private _effectRenderer;
  139869. private _effectWrapper;
  139870. private _lodGenerationOffset;
  139871. private _lodGenerationScale;
  139872. /**
  139873. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  139874. * you care about baking speed.
  139875. */
  139876. quality: number;
  139877. /**
  139878. * Scales pixel intensity for the input HDR map.
  139879. */
  139880. hdrScale: number;
  139881. /**
  139882. * Instantiates HDR filter for reflection maps
  139883. *
  139884. * @param engine Thin engine
  139885. * @param options Options
  139886. */
  139887. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  139888. private _createRenderTarget;
  139889. private _prefilterInternal;
  139890. private _createEffect;
  139891. /**
  139892. * Get a value indicating if the filter is ready to be used
  139893. * @param texture Texture to filter
  139894. * @returns true if the filter is ready
  139895. */
  139896. isReady(texture: BaseTexture): boolean;
  139897. /**
  139898. * Prefilters a cube texture to have mipmap levels representing roughness values.
  139899. * Prefiltering will be invoked at the end of next rendering pass.
  139900. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  139901. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  139902. * @param texture Texture to filter
  139903. * @param onFinished Callback when filtering is done
  139904. * @return Promise called when prefiltering is done
  139905. */
  139906. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  139907. }
  139908. }
  139909. declare module BABYLON {
  139910. /**
  139911. * This represents a texture coming from an HDR input.
  139912. *
  139913. * The only supported format is currently panorama picture stored in RGBE format.
  139914. * Example of such files can be found on HDRLib: http://hdrlib.com/
  139915. */
  139916. export class HDRCubeTexture extends BaseTexture {
  139917. private static _facesMapping;
  139918. private _generateHarmonics;
  139919. private _noMipmap;
  139920. private _prefilterOnLoad;
  139921. private _textureMatrix;
  139922. private _size;
  139923. private _onLoad;
  139924. private _onError;
  139925. /**
  139926. * The texture URL.
  139927. */
  139928. url: string;
  139929. protected _isBlocking: boolean;
  139930. /**
  139931. * Sets wether or not the texture is blocking during loading.
  139932. */
  139933. set isBlocking(value: boolean);
  139934. /**
  139935. * Gets wether or not the texture is blocking during loading.
  139936. */
  139937. get isBlocking(): boolean;
  139938. protected _rotationY: number;
  139939. /**
  139940. * Sets texture matrix rotation angle around Y axis in radians.
  139941. */
  139942. set rotationY(value: number);
  139943. /**
  139944. * Gets texture matrix rotation angle around Y axis radians.
  139945. */
  139946. get rotationY(): number;
  139947. /**
  139948. * Gets or sets the center of the bounding box associated with the cube texture
  139949. * It must define where the camera used to render the texture was set
  139950. */
  139951. boundingBoxPosition: Vector3;
  139952. private _boundingBoxSize;
  139953. /**
  139954. * Gets or sets the size of the bounding box associated with the cube texture
  139955. * When defined, the cubemap will switch to local mode
  139956. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  139957. * @example https://www.babylonjs-playground.com/#RNASML
  139958. */
  139959. set boundingBoxSize(value: Vector3);
  139960. get boundingBoxSize(): Vector3;
  139961. /**
  139962. * Instantiates an HDRTexture from the following parameters.
  139963. *
  139964. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  139965. * @param sceneOrEngine The scene or engine the texture will be used in
  139966. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  139967. * @param noMipmap Forces to not generate the mipmap if true
  139968. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  139969. * @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)
  139970. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  139971. */
  139972. 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>);
  139973. /**
  139974. * Get the current class name of the texture useful for serialization or dynamic coding.
  139975. * @returns "HDRCubeTexture"
  139976. */
  139977. getClassName(): string;
  139978. /**
  139979. * Occurs when the file is raw .hdr file.
  139980. */
  139981. private loadTexture;
  139982. clone(): HDRCubeTexture;
  139983. delayLoad(): void;
  139984. /**
  139985. * Get the texture reflection matrix used to rotate/transform the reflection.
  139986. * @returns the reflection matrix
  139987. */
  139988. getReflectionTextureMatrix(): Matrix;
  139989. /**
  139990. * Set the texture reflection matrix used to rotate/transform the reflection.
  139991. * @param value Define the reflection matrix to set
  139992. */
  139993. setReflectionTextureMatrix(value: Matrix): void;
  139994. /**
  139995. * Parses a JSON representation of an HDR Texture in order to create the texture
  139996. * @param parsedTexture Define the JSON representation
  139997. * @param scene Define the scene the texture should be created in
  139998. * @param rootUrl Define the root url in case we need to load relative dependencies
  139999. * @returns the newly created texture after parsing
  140000. */
  140001. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  140002. serialize(): any;
  140003. }
  140004. }
  140005. declare module BABYLON {
  140006. /**
  140007. * Class used to control physics engine
  140008. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140009. */
  140010. export class PhysicsEngine implements IPhysicsEngine {
  140011. private _physicsPlugin;
  140012. /**
  140013. * Global value used to control the smallest number supported by the simulation
  140014. */
  140015. static Epsilon: number;
  140016. private _impostors;
  140017. private _joints;
  140018. private _subTimeStep;
  140019. /**
  140020. * Gets the gravity vector used by the simulation
  140021. */
  140022. gravity: Vector3;
  140023. /**
  140024. * Factory used to create the default physics plugin.
  140025. * @returns The default physics plugin
  140026. */
  140027. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  140028. /**
  140029. * Creates a new Physics Engine
  140030. * @param gravity defines the gravity vector used by the simulation
  140031. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  140032. */
  140033. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  140034. /**
  140035. * Sets the gravity vector used by the simulation
  140036. * @param gravity defines the gravity vector to use
  140037. */
  140038. setGravity(gravity: Vector3): void;
  140039. /**
  140040. * Set the time step of the physics engine.
  140041. * Default is 1/60.
  140042. * To slow it down, enter 1/600 for example.
  140043. * To speed it up, 1/30
  140044. * @param newTimeStep defines the new timestep to apply to this world.
  140045. */
  140046. setTimeStep(newTimeStep?: number): void;
  140047. /**
  140048. * Get the time step of the physics engine.
  140049. * @returns the current time step
  140050. */
  140051. getTimeStep(): number;
  140052. /**
  140053. * Set the sub time step of the physics engine.
  140054. * Default is 0 meaning there is no sub steps
  140055. * To increase physics resolution precision, set a small value (like 1 ms)
  140056. * @param subTimeStep defines the new sub timestep used for physics resolution.
  140057. */
  140058. setSubTimeStep(subTimeStep?: number): void;
  140059. /**
  140060. * Get the sub time step of the physics engine.
  140061. * @returns the current sub time step
  140062. */
  140063. getSubTimeStep(): number;
  140064. /**
  140065. * Release all resources
  140066. */
  140067. dispose(): void;
  140068. /**
  140069. * Gets the name of the current physics plugin
  140070. * @returns the name of the plugin
  140071. */
  140072. getPhysicsPluginName(): string;
  140073. /**
  140074. * Adding a new impostor for the impostor tracking.
  140075. * This will be done by the impostor itself.
  140076. * @param impostor the impostor to add
  140077. */
  140078. addImpostor(impostor: PhysicsImpostor): void;
  140079. /**
  140080. * Remove an impostor from the engine.
  140081. * This impostor and its mesh will not longer be updated by the physics engine.
  140082. * @param impostor the impostor to remove
  140083. */
  140084. removeImpostor(impostor: PhysicsImpostor): void;
  140085. /**
  140086. * Add a joint to the physics engine
  140087. * @param mainImpostor defines the main impostor to which the joint is added.
  140088. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  140089. * @param joint defines the joint that will connect both impostors.
  140090. */
  140091. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140092. /**
  140093. * Removes a joint from the simulation
  140094. * @param mainImpostor defines the impostor used with the joint
  140095. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  140096. * @param joint defines the joint to remove
  140097. */
  140098. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140099. /**
  140100. * Called by the scene. No need to call it.
  140101. * @param delta defines the timespam between frames
  140102. */
  140103. _step(delta: number): void;
  140104. /**
  140105. * Gets the current plugin used to run the simulation
  140106. * @returns current plugin
  140107. */
  140108. getPhysicsPlugin(): IPhysicsEnginePlugin;
  140109. /**
  140110. * Gets the list of physic impostors
  140111. * @returns an array of PhysicsImpostor
  140112. */
  140113. getImpostors(): Array<PhysicsImpostor>;
  140114. /**
  140115. * Gets the impostor for a physics enabled object
  140116. * @param object defines the object impersonated by the impostor
  140117. * @returns the PhysicsImpostor or null if not found
  140118. */
  140119. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  140120. /**
  140121. * Gets the impostor for a physics body object
  140122. * @param body defines physics body used by the impostor
  140123. * @returns the PhysicsImpostor or null if not found
  140124. */
  140125. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  140126. /**
  140127. * Does a raycast in the physics world
  140128. * @param from when should the ray start?
  140129. * @param to when should the ray end?
  140130. * @returns PhysicsRaycastResult
  140131. */
  140132. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140133. }
  140134. }
  140135. declare module BABYLON {
  140136. /** @hidden */
  140137. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  140138. private _useDeltaForWorldStep;
  140139. world: any;
  140140. name: string;
  140141. private _physicsMaterials;
  140142. private _fixedTimeStep;
  140143. private _cannonRaycastResult;
  140144. private _raycastResult;
  140145. private _physicsBodysToRemoveAfterStep;
  140146. private _firstFrame;
  140147. BJSCANNON: any;
  140148. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  140149. setGravity(gravity: Vector3): void;
  140150. setTimeStep(timeStep: number): void;
  140151. getTimeStep(): number;
  140152. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140153. private _removeMarkedPhysicsBodiesFromWorld;
  140154. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140155. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140156. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140157. private _processChildMeshes;
  140158. removePhysicsBody(impostor: PhysicsImpostor): void;
  140159. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140160. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140161. private _addMaterial;
  140162. private _checkWithEpsilon;
  140163. private _createShape;
  140164. private _createHeightmap;
  140165. private _minus90X;
  140166. private _plus90X;
  140167. private _tmpPosition;
  140168. private _tmpDeltaPosition;
  140169. private _tmpUnityRotation;
  140170. private _updatePhysicsBodyTransformation;
  140171. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140172. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140173. isSupported(): boolean;
  140174. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140175. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140176. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140177. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140178. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140179. getBodyMass(impostor: PhysicsImpostor): number;
  140180. getBodyFriction(impostor: PhysicsImpostor): number;
  140181. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140182. getBodyRestitution(impostor: PhysicsImpostor): number;
  140183. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140184. sleepBody(impostor: PhysicsImpostor): void;
  140185. wakeUpBody(impostor: PhysicsImpostor): void;
  140186. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  140187. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140188. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140189. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140190. getRadius(impostor: PhysicsImpostor): number;
  140191. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140192. dispose(): void;
  140193. private _extendNamespace;
  140194. /**
  140195. * Does a raycast in the physics world
  140196. * @param from when should the ray start?
  140197. * @param to when should the ray end?
  140198. * @returns PhysicsRaycastResult
  140199. */
  140200. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140201. }
  140202. }
  140203. declare module BABYLON {
  140204. /** @hidden */
  140205. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  140206. private _useDeltaForWorldStep;
  140207. world: any;
  140208. name: string;
  140209. BJSOIMO: any;
  140210. private _raycastResult;
  140211. private _fixedTimeStep;
  140212. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  140213. setGravity(gravity: Vector3): void;
  140214. setTimeStep(timeStep: number): void;
  140215. getTimeStep(): number;
  140216. private _tmpImpostorsArray;
  140217. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140218. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140219. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140220. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140221. private _tmpPositionVector;
  140222. removePhysicsBody(impostor: PhysicsImpostor): void;
  140223. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140224. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140225. isSupported(): boolean;
  140226. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140227. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140228. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140229. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140230. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140231. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140232. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140233. getBodyMass(impostor: PhysicsImpostor): number;
  140234. getBodyFriction(impostor: PhysicsImpostor): number;
  140235. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140236. getBodyRestitution(impostor: PhysicsImpostor): number;
  140237. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140238. sleepBody(impostor: PhysicsImpostor): void;
  140239. wakeUpBody(impostor: PhysicsImpostor): void;
  140240. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140241. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  140242. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  140243. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140244. getRadius(impostor: PhysicsImpostor): number;
  140245. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140246. dispose(): void;
  140247. /**
  140248. * Does a raycast in the physics world
  140249. * @param from when should the ray start?
  140250. * @param to when should the ray end?
  140251. * @returns PhysicsRaycastResult
  140252. */
  140253. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140254. }
  140255. }
  140256. declare module BABYLON {
  140257. /**
  140258. * AmmoJS Physics plugin
  140259. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140260. * @see https://github.com/kripken/ammo.js/
  140261. */
  140262. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  140263. private _useDeltaForWorldStep;
  140264. /**
  140265. * Reference to the Ammo library
  140266. */
  140267. bjsAMMO: any;
  140268. /**
  140269. * Created ammoJS world which physics bodies are added to
  140270. */
  140271. world: any;
  140272. /**
  140273. * Name of the plugin
  140274. */
  140275. name: string;
  140276. private _timeStep;
  140277. private _fixedTimeStep;
  140278. private _maxSteps;
  140279. private _tmpQuaternion;
  140280. private _tmpAmmoTransform;
  140281. private _tmpAmmoQuaternion;
  140282. private _tmpAmmoConcreteContactResultCallback;
  140283. private _collisionConfiguration;
  140284. private _dispatcher;
  140285. private _overlappingPairCache;
  140286. private _solver;
  140287. private _softBodySolver;
  140288. private _tmpAmmoVectorA;
  140289. private _tmpAmmoVectorB;
  140290. private _tmpAmmoVectorC;
  140291. private _tmpAmmoVectorD;
  140292. private _tmpContactCallbackResult;
  140293. private _tmpAmmoVectorRCA;
  140294. private _tmpAmmoVectorRCB;
  140295. private _raycastResult;
  140296. private static readonly DISABLE_COLLISION_FLAG;
  140297. private static readonly KINEMATIC_FLAG;
  140298. private static readonly DISABLE_DEACTIVATION_FLAG;
  140299. /**
  140300. * Initializes the ammoJS plugin
  140301. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  140302. * @param ammoInjection can be used to inject your own ammo reference
  140303. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  140304. */
  140305. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  140306. /**
  140307. * Sets the gravity of the physics world (m/(s^2))
  140308. * @param gravity Gravity to set
  140309. */
  140310. setGravity(gravity: Vector3): void;
  140311. /**
  140312. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  140313. * @param timeStep timestep to use in seconds
  140314. */
  140315. setTimeStep(timeStep: number): void;
  140316. /**
  140317. * 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)
  140318. * @param fixedTimeStep fixedTimeStep to use in seconds
  140319. */
  140320. setFixedTimeStep(fixedTimeStep: number): void;
  140321. /**
  140322. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  140323. * @param maxSteps the maximum number of steps by the physics engine per frame
  140324. */
  140325. setMaxSteps(maxSteps: number): void;
  140326. /**
  140327. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  140328. * @returns the current timestep in seconds
  140329. */
  140330. getTimeStep(): number;
  140331. /**
  140332. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  140333. */
  140334. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  140335. private _isImpostorInContact;
  140336. private _isImpostorPairInContact;
  140337. private _stepSimulation;
  140338. /**
  140339. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  140340. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  140341. * After the step the babylon meshes are set to the position of the physics imposters
  140342. * @param delta amount of time to step forward
  140343. * @param impostors array of imposters to update before/after the step
  140344. */
  140345. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140346. /**
  140347. * Update babylon mesh to match physics world object
  140348. * @param impostor imposter to match
  140349. */
  140350. private _afterSoftStep;
  140351. /**
  140352. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140353. * @param impostor imposter to match
  140354. */
  140355. private _ropeStep;
  140356. /**
  140357. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140358. * @param impostor imposter to match
  140359. */
  140360. private _softbodyOrClothStep;
  140361. private _tmpMatrix;
  140362. /**
  140363. * Applies an impulse on the imposter
  140364. * @param impostor imposter to apply impulse to
  140365. * @param force amount of force to be applied to the imposter
  140366. * @param contactPoint the location to apply the impulse on the imposter
  140367. */
  140368. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140369. /**
  140370. * Applies a force on the imposter
  140371. * @param impostor imposter to apply force
  140372. * @param force amount of force to be applied to the imposter
  140373. * @param contactPoint the location to apply the force on the imposter
  140374. */
  140375. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140376. /**
  140377. * Creates a physics body using the plugin
  140378. * @param impostor the imposter to create the physics body on
  140379. */
  140380. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140381. /**
  140382. * Removes the physics body from the imposter and disposes of the body's memory
  140383. * @param impostor imposter to remove the physics body from
  140384. */
  140385. removePhysicsBody(impostor: PhysicsImpostor): void;
  140386. /**
  140387. * Generates a joint
  140388. * @param impostorJoint the imposter joint to create the joint with
  140389. */
  140390. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140391. /**
  140392. * Removes a joint
  140393. * @param impostorJoint the imposter joint to remove the joint from
  140394. */
  140395. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140396. private _addMeshVerts;
  140397. /**
  140398. * Initialise the soft body vertices to match its object's (mesh) vertices
  140399. * Softbody vertices (nodes) are in world space and to match this
  140400. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  140401. * @param impostor to create the softbody for
  140402. */
  140403. private _softVertexData;
  140404. /**
  140405. * Create an impostor's soft body
  140406. * @param impostor to create the softbody for
  140407. */
  140408. private _createSoftbody;
  140409. /**
  140410. * Create cloth for an impostor
  140411. * @param impostor to create the softbody for
  140412. */
  140413. private _createCloth;
  140414. /**
  140415. * Create rope for an impostor
  140416. * @param impostor to create the softbody for
  140417. */
  140418. private _createRope;
  140419. /**
  140420. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  140421. * @param impostor to create the custom physics shape for
  140422. */
  140423. private _createCustom;
  140424. private _addHullVerts;
  140425. private _createShape;
  140426. /**
  140427. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  140428. * @param impostor imposter containing the physics body and babylon object
  140429. */
  140430. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140431. /**
  140432. * Sets the babylon object's position/rotation from the physics body's position/rotation
  140433. * @param impostor imposter containing the physics body and babylon object
  140434. * @param newPosition new position
  140435. * @param newRotation new rotation
  140436. */
  140437. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140438. /**
  140439. * If this plugin is supported
  140440. * @returns true if its supported
  140441. */
  140442. isSupported(): boolean;
  140443. /**
  140444. * Sets the linear velocity of the physics body
  140445. * @param impostor imposter to set the velocity on
  140446. * @param velocity velocity to set
  140447. */
  140448. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140449. /**
  140450. * Sets the angular velocity of the physics body
  140451. * @param impostor imposter to set the velocity on
  140452. * @param velocity velocity to set
  140453. */
  140454. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140455. /**
  140456. * gets the linear velocity
  140457. * @param impostor imposter to get linear velocity from
  140458. * @returns linear velocity
  140459. */
  140460. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140461. /**
  140462. * gets the angular velocity
  140463. * @param impostor imposter to get angular velocity from
  140464. * @returns angular velocity
  140465. */
  140466. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140467. /**
  140468. * Sets the mass of physics body
  140469. * @param impostor imposter to set the mass on
  140470. * @param mass mass to set
  140471. */
  140472. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140473. /**
  140474. * Gets the mass of the physics body
  140475. * @param impostor imposter to get the mass from
  140476. * @returns mass
  140477. */
  140478. getBodyMass(impostor: PhysicsImpostor): number;
  140479. /**
  140480. * Gets friction of the impostor
  140481. * @param impostor impostor to get friction from
  140482. * @returns friction value
  140483. */
  140484. getBodyFriction(impostor: PhysicsImpostor): number;
  140485. /**
  140486. * Sets friction of the impostor
  140487. * @param impostor impostor to set friction on
  140488. * @param friction friction value
  140489. */
  140490. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140491. /**
  140492. * Gets restitution of the impostor
  140493. * @param impostor impostor to get restitution from
  140494. * @returns restitution value
  140495. */
  140496. getBodyRestitution(impostor: PhysicsImpostor): number;
  140497. /**
  140498. * Sets resitution of the impostor
  140499. * @param impostor impostor to set resitution on
  140500. * @param restitution resitution value
  140501. */
  140502. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140503. /**
  140504. * Gets pressure inside the impostor
  140505. * @param impostor impostor to get pressure from
  140506. * @returns pressure value
  140507. */
  140508. getBodyPressure(impostor: PhysicsImpostor): number;
  140509. /**
  140510. * Sets pressure inside a soft body impostor
  140511. * Cloth and rope must remain 0 pressure
  140512. * @param impostor impostor to set pressure on
  140513. * @param pressure pressure value
  140514. */
  140515. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  140516. /**
  140517. * Gets stiffness of the impostor
  140518. * @param impostor impostor to get stiffness from
  140519. * @returns pressure value
  140520. */
  140521. getBodyStiffness(impostor: PhysicsImpostor): number;
  140522. /**
  140523. * Sets stiffness of the impostor
  140524. * @param impostor impostor to set stiffness on
  140525. * @param stiffness stiffness value from 0 to 1
  140526. */
  140527. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  140528. /**
  140529. * Gets velocityIterations of the impostor
  140530. * @param impostor impostor to get velocity iterations from
  140531. * @returns velocityIterations value
  140532. */
  140533. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  140534. /**
  140535. * Sets velocityIterations of the impostor
  140536. * @param impostor impostor to set velocity iterations on
  140537. * @param velocityIterations velocityIterations value
  140538. */
  140539. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  140540. /**
  140541. * Gets positionIterations of the impostor
  140542. * @param impostor impostor to get position iterations from
  140543. * @returns positionIterations value
  140544. */
  140545. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  140546. /**
  140547. * Sets positionIterations of the impostor
  140548. * @param impostor impostor to set position on
  140549. * @param positionIterations positionIterations value
  140550. */
  140551. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  140552. /**
  140553. * Append an anchor to a cloth object
  140554. * @param impostor is the cloth impostor to add anchor to
  140555. * @param otherImpostor is the rigid impostor to anchor to
  140556. * @param width ratio across width from 0 to 1
  140557. * @param height ratio up height from 0 to 1
  140558. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  140559. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140560. */
  140561. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140562. /**
  140563. * Append an hook to a rope object
  140564. * @param impostor is the rope impostor to add hook to
  140565. * @param otherImpostor is the rigid impostor to hook to
  140566. * @param length ratio along the rope from 0 to 1
  140567. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  140568. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140569. */
  140570. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140571. /**
  140572. * Sleeps the physics body and stops it from being active
  140573. * @param impostor impostor to sleep
  140574. */
  140575. sleepBody(impostor: PhysicsImpostor): void;
  140576. /**
  140577. * Activates the physics body
  140578. * @param impostor impostor to activate
  140579. */
  140580. wakeUpBody(impostor: PhysicsImpostor): void;
  140581. /**
  140582. * Updates the distance parameters of the joint
  140583. * @param joint joint to update
  140584. * @param maxDistance maximum distance of the joint
  140585. * @param minDistance minimum distance of the joint
  140586. */
  140587. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140588. /**
  140589. * Sets a motor on the joint
  140590. * @param joint joint to set motor on
  140591. * @param speed speed of the motor
  140592. * @param maxForce maximum force of the motor
  140593. * @param motorIndex index of the motor
  140594. */
  140595. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140596. /**
  140597. * Sets the motors limit
  140598. * @param joint joint to set limit on
  140599. * @param upperLimit upper limit
  140600. * @param lowerLimit lower limit
  140601. */
  140602. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140603. /**
  140604. * Syncs the position and rotation of a mesh with the impostor
  140605. * @param mesh mesh to sync
  140606. * @param impostor impostor to update the mesh with
  140607. */
  140608. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140609. /**
  140610. * Gets the radius of the impostor
  140611. * @param impostor impostor to get radius from
  140612. * @returns the radius
  140613. */
  140614. getRadius(impostor: PhysicsImpostor): number;
  140615. /**
  140616. * Gets the box size of the impostor
  140617. * @param impostor impostor to get box size from
  140618. * @param result the resulting box size
  140619. */
  140620. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140621. /**
  140622. * Disposes of the impostor
  140623. */
  140624. dispose(): void;
  140625. /**
  140626. * Does a raycast in the physics world
  140627. * @param from when should the ray start?
  140628. * @param to when should the ray end?
  140629. * @returns PhysicsRaycastResult
  140630. */
  140631. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140632. }
  140633. }
  140634. declare module BABYLON {
  140635. interface AbstractScene {
  140636. /**
  140637. * The list of reflection probes added to the scene
  140638. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140639. */
  140640. reflectionProbes: Array<ReflectionProbe>;
  140641. /**
  140642. * Removes the given reflection probe from this scene.
  140643. * @param toRemove The reflection probe to remove
  140644. * @returns The index of the removed reflection probe
  140645. */
  140646. removeReflectionProbe(toRemove: ReflectionProbe): number;
  140647. /**
  140648. * Adds the given reflection probe to this scene.
  140649. * @param newReflectionProbe The reflection probe to add
  140650. */
  140651. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  140652. }
  140653. /**
  140654. * Class used to generate realtime reflection / refraction cube textures
  140655. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140656. */
  140657. export class ReflectionProbe {
  140658. /** defines the name of the probe */
  140659. name: string;
  140660. private _scene;
  140661. private _renderTargetTexture;
  140662. private _projectionMatrix;
  140663. private _viewMatrix;
  140664. private _target;
  140665. private _add;
  140666. private _attachedMesh;
  140667. private _invertYAxis;
  140668. /** Gets or sets probe position (center of the cube map) */
  140669. position: Vector3;
  140670. /**
  140671. * Creates a new reflection probe
  140672. * @param name defines the name of the probe
  140673. * @param size defines the texture resolution (for each face)
  140674. * @param scene defines the hosting scene
  140675. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  140676. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  140677. */
  140678. constructor(
  140679. /** defines the name of the probe */
  140680. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  140681. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  140682. get samples(): number;
  140683. set samples(value: number);
  140684. /** Gets or sets the refresh rate to use (on every frame by default) */
  140685. get refreshRate(): number;
  140686. set refreshRate(value: number);
  140687. /**
  140688. * Gets the hosting scene
  140689. * @returns a Scene
  140690. */
  140691. getScene(): Scene;
  140692. /** Gets the internal CubeTexture used to render to */
  140693. get cubeTexture(): RenderTargetTexture;
  140694. /** Gets the list of meshes to render */
  140695. get renderList(): Nullable<AbstractMesh[]>;
  140696. /**
  140697. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  140698. * @param mesh defines the mesh to attach to
  140699. */
  140700. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  140701. /**
  140702. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  140703. * @param renderingGroupId The rendering group id corresponding to its index
  140704. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  140705. */
  140706. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  140707. /**
  140708. * Clean all associated resources
  140709. */
  140710. dispose(): void;
  140711. /**
  140712. * Converts the reflection probe information to a readable string for debug purpose.
  140713. * @param fullDetails Supports for multiple levels of logging within scene loading
  140714. * @returns the human readable reflection probe info
  140715. */
  140716. toString(fullDetails?: boolean): string;
  140717. /**
  140718. * Get the class name of the relfection probe.
  140719. * @returns "ReflectionProbe"
  140720. */
  140721. getClassName(): string;
  140722. /**
  140723. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  140724. * @returns The JSON representation of the texture
  140725. */
  140726. serialize(): any;
  140727. /**
  140728. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  140729. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  140730. * @param scene Define the scene the parsed reflection probe should be instantiated in
  140731. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  140732. * @returns The parsed reflection probe if successful
  140733. */
  140734. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  140735. }
  140736. }
  140737. declare module BABYLON {
  140738. /** @hidden */
  140739. export var _BabylonLoaderRegistered: boolean;
  140740. /**
  140741. * Helps setting up some configuration for the babylon file loader.
  140742. */
  140743. export class BabylonFileLoaderConfiguration {
  140744. /**
  140745. * The loader does not allow injecting custom physix engine into the plugins.
  140746. * Unfortunately in ES6, we need to manually inject them into the plugin.
  140747. * So you could set this variable to your engine import to make it work.
  140748. */
  140749. static LoaderInjectedPhysicsEngine: any;
  140750. }
  140751. }
  140752. declare module BABYLON {
  140753. /**
  140754. * The Physically based simple base material of BJS.
  140755. *
  140756. * This enables better naming and convention enforcements on top of the pbrMaterial.
  140757. * It is used as the base class for both the specGloss and metalRough conventions.
  140758. */
  140759. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  140760. /**
  140761. * Number of Simultaneous lights allowed on the material.
  140762. */
  140763. maxSimultaneousLights: number;
  140764. /**
  140765. * If sets to true, disables all the lights affecting the material.
  140766. */
  140767. disableLighting: boolean;
  140768. /**
  140769. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  140770. */
  140771. environmentTexture: BaseTexture;
  140772. /**
  140773. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  140774. */
  140775. invertNormalMapX: boolean;
  140776. /**
  140777. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  140778. */
  140779. invertNormalMapY: boolean;
  140780. /**
  140781. * Normal map used in the model.
  140782. */
  140783. normalTexture: BaseTexture;
  140784. /**
  140785. * Emissivie color used to self-illuminate the model.
  140786. */
  140787. emissiveColor: Color3;
  140788. /**
  140789. * Emissivie texture used to self-illuminate the model.
  140790. */
  140791. emissiveTexture: BaseTexture;
  140792. /**
  140793. * Occlusion Channel Strenght.
  140794. */
  140795. occlusionStrength: number;
  140796. /**
  140797. * Occlusion Texture of the material (adding extra occlusion effects).
  140798. */
  140799. occlusionTexture: BaseTexture;
  140800. /**
  140801. * Defines the alpha limits in alpha test mode.
  140802. */
  140803. alphaCutOff: number;
  140804. /**
  140805. * Gets the current double sided mode.
  140806. */
  140807. get doubleSided(): boolean;
  140808. /**
  140809. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  140810. */
  140811. set doubleSided(value: boolean);
  140812. /**
  140813. * Stores the pre-calculated light information of a mesh in a texture.
  140814. */
  140815. lightmapTexture: BaseTexture;
  140816. /**
  140817. * If true, the light map contains occlusion information instead of lighting info.
  140818. */
  140819. useLightmapAsShadowmap: boolean;
  140820. /**
  140821. * Instantiates a new PBRMaterial instance.
  140822. *
  140823. * @param name The material name
  140824. * @param scene The scene the material will be use in.
  140825. */
  140826. constructor(name: string, scene: Scene);
  140827. getClassName(): string;
  140828. }
  140829. }
  140830. declare module BABYLON {
  140831. /**
  140832. * The PBR material of BJS following the metal roughness convention.
  140833. *
  140834. * This fits to the PBR convention in the GLTF definition:
  140835. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  140836. */
  140837. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  140838. /**
  140839. * The base color has two different interpretations depending on the value of metalness.
  140840. * When the material is a metal, the base color is the specific measured reflectance value
  140841. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  140842. * of the material.
  140843. */
  140844. baseColor: Color3;
  140845. /**
  140846. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  140847. * well as opacity information in the alpha channel.
  140848. */
  140849. baseTexture: BaseTexture;
  140850. /**
  140851. * Specifies the metallic scalar value of the material.
  140852. * Can also be used to scale the metalness values of the metallic texture.
  140853. */
  140854. metallic: number;
  140855. /**
  140856. * Specifies the roughness scalar value of the material.
  140857. * Can also be used to scale the roughness values of the metallic texture.
  140858. */
  140859. roughness: number;
  140860. /**
  140861. * Texture containing both the metallic value in the B channel and the
  140862. * roughness value in the G channel to keep better precision.
  140863. */
  140864. metallicRoughnessTexture: BaseTexture;
  140865. /**
  140866. * Instantiates a new PBRMetalRoughnessMaterial instance.
  140867. *
  140868. * @param name The material name
  140869. * @param scene The scene the material will be use in.
  140870. */
  140871. constructor(name: string, scene: Scene);
  140872. /**
  140873. * Return the currrent class name of the material.
  140874. */
  140875. getClassName(): string;
  140876. /**
  140877. * Makes a duplicate of the current material.
  140878. * @param name - name to use for the new material.
  140879. */
  140880. clone(name: string): PBRMetallicRoughnessMaterial;
  140881. /**
  140882. * Serialize the material to a parsable JSON object.
  140883. */
  140884. serialize(): any;
  140885. /**
  140886. * Parses a JSON object correponding to the serialize function.
  140887. */
  140888. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  140889. }
  140890. }
  140891. declare module BABYLON {
  140892. /**
  140893. * The PBR material of BJS following the specular glossiness convention.
  140894. *
  140895. * This fits to the PBR convention in the GLTF definition:
  140896. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  140897. */
  140898. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  140899. /**
  140900. * Specifies the diffuse color of the material.
  140901. */
  140902. diffuseColor: Color3;
  140903. /**
  140904. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  140905. * channel.
  140906. */
  140907. diffuseTexture: BaseTexture;
  140908. /**
  140909. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  140910. */
  140911. specularColor: Color3;
  140912. /**
  140913. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  140914. */
  140915. glossiness: number;
  140916. /**
  140917. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  140918. */
  140919. specularGlossinessTexture: BaseTexture;
  140920. /**
  140921. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  140922. *
  140923. * @param name The material name
  140924. * @param scene The scene the material will be use in.
  140925. */
  140926. constructor(name: string, scene: Scene);
  140927. /**
  140928. * Return the currrent class name of the material.
  140929. */
  140930. getClassName(): string;
  140931. /**
  140932. * Makes a duplicate of the current material.
  140933. * @param name - name to use for the new material.
  140934. */
  140935. clone(name: string): PBRSpecularGlossinessMaterial;
  140936. /**
  140937. * Serialize the material to a parsable JSON object.
  140938. */
  140939. serialize(): any;
  140940. /**
  140941. * Parses a JSON object correponding to the serialize function.
  140942. */
  140943. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  140944. }
  140945. }
  140946. declare module BABYLON {
  140947. /**
  140948. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  140949. * It can help converting any input color in a desired output one. This can then be used to create effects
  140950. * from sepia, black and white to sixties or futuristic rendering...
  140951. *
  140952. * The only supported format is currently 3dl.
  140953. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  140954. */
  140955. export class ColorGradingTexture extends BaseTexture {
  140956. /**
  140957. * The texture URL.
  140958. */
  140959. url: string;
  140960. /**
  140961. * Empty line regex stored for GC.
  140962. */
  140963. private static _noneEmptyLineRegex;
  140964. private _textureMatrix;
  140965. private _onLoad;
  140966. /**
  140967. * Instantiates a ColorGradingTexture from the following parameters.
  140968. *
  140969. * @param url The location of the color gradind data (currently only supporting 3dl)
  140970. * @param sceneOrEngine The scene or engine the texture will be used in
  140971. * @param onLoad defines a callback triggered when the texture has been loaded
  140972. */
  140973. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  140974. /**
  140975. * Fires the onload event from the constructor if requested.
  140976. */
  140977. private _triggerOnLoad;
  140978. /**
  140979. * Returns the texture matrix used in most of the material.
  140980. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  140981. */
  140982. getTextureMatrix(): Matrix;
  140983. /**
  140984. * Occurs when the file being loaded is a .3dl LUT file.
  140985. */
  140986. private load3dlTexture;
  140987. /**
  140988. * Starts the loading process of the texture.
  140989. */
  140990. private loadTexture;
  140991. /**
  140992. * Clones the color gradind texture.
  140993. */
  140994. clone(): ColorGradingTexture;
  140995. /**
  140996. * Called during delayed load for textures.
  140997. */
  140998. delayLoad(): void;
  140999. /**
  141000. * Parses a color grading texture serialized by Babylon.
  141001. * @param parsedTexture The texture information being parsedTexture
  141002. * @param scene The scene to load the texture in
  141003. * @param rootUrl The root url of the data assets to load
  141004. * @return A color gradind texture
  141005. */
  141006. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  141007. /**
  141008. * Serializes the LUT texture to json format.
  141009. */
  141010. serialize(): any;
  141011. }
  141012. }
  141013. declare module BABYLON {
  141014. /**
  141015. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  141016. */
  141017. export class EquiRectangularCubeTexture extends BaseTexture {
  141018. /** The six faces of the cube. */
  141019. private static _FacesMapping;
  141020. private _noMipmap;
  141021. private _onLoad;
  141022. private _onError;
  141023. /** The size of the cubemap. */
  141024. private _size;
  141025. /** The buffer of the image. */
  141026. private _buffer;
  141027. /** The width of the input image. */
  141028. private _width;
  141029. /** The height of the input image. */
  141030. private _height;
  141031. /** The URL to the image. */
  141032. url: string;
  141033. /**
  141034. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  141035. * @param url The location of the image
  141036. * @param scene The scene the texture will be used in
  141037. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  141038. * @param noMipmap Forces to not generate the mipmap if true
  141039. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  141040. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  141041. * @param onLoad — defines a callback called when texture is loaded
  141042. * @param onError — defines a callback called if there is an error
  141043. */
  141044. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  141045. /**
  141046. * Load the image data, by putting the image on a canvas and extracting its buffer.
  141047. */
  141048. private loadImage;
  141049. /**
  141050. * Convert the image buffer into a cubemap and create a CubeTexture.
  141051. */
  141052. private loadTexture;
  141053. /**
  141054. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  141055. * @param buffer The ArrayBuffer that should be converted.
  141056. * @returns The buffer as Float32Array.
  141057. */
  141058. private getFloat32ArrayFromArrayBuffer;
  141059. /**
  141060. * Get the current class name of the texture useful for serialization or dynamic coding.
  141061. * @returns "EquiRectangularCubeTexture"
  141062. */
  141063. getClassName(): string;
  141064. /**
  141065. * Create a clone of the current EquiRectangularCubeTexture and return it.
  141066. * @returns A clone of the current EquiRectangularCubeTexture.
  141067. */
  141068. clone(): EquiRectangularCubeTexture;
  141069. }
  141070. }
  141071. declare module BABYLON {
  141072. /**
  141073. * Defines the options related to the creation of an HtmlElementTexture
  141074. */
  141075. export interface IHtmlElementTextureOptions {
  141076. /**
  141077. * Defines wether mip maps should be created or not.
  141078. */
  141079. generateMipMaps?: boolean;
  141080. /**
  141081. * Defines the sampling mode of the texture.
  141082. */
  141083. samplingMode?: number;
  141084. /**
  141085. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  141086. */
  141087. engine: Nullable<ThinEngine>;
  141088. /**
  141089. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  141090. */
  141091. scene: Nullable<Scene>;
  141092. }
  141093. /**
  141094. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  141095. * To be as efficient as possible depending on your constraints nothing aside the first upload
  141096. * is automatically managed.
  141097. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  141098. * in your application.
  141099. *
  141100. * As the update is not automatic, you need to call them manually.
  141101. */
  141102. export class HtmlElementTexture extends BaseTexture {
  141103. /**
  141104. * The texture URL.
  141105. */
  141106. element: HTMLVideoElement | HTMLCanvasElement;
  141107. private static readonly DefaultOptions;
  141108. private _textureMatrix;
  141109. private _isVideo;
  141110. private _generateMipMaps;
  141111. private _samplingMode;
  141112. /**
  141113. * Instantiates a HtmlElementTexture from the following parameters.
  141114. *
  141115. * @param name Defines the name of the texture
  141116. * @param element Defines the video or canvas the texture is filled with
  141117. * @param options Defines the other none mandatory texture creation options
  141118. */
  141119. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  141120. private _createInternalTexture;
  141121. /**
  141122. * Returns the texture matrix used in most of the material.
  141123. */
  141124. getTextureMatrix(): Matrix;
  141125. /**
  141126. * Updates the content of the texture.
  141127. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  141128. */
  141129. update(invertY?: Nullable<boolean>): void;
  141130. }
  141131. }
  141132. declare module BABYLON {
  141133. /**
  141134. * Based on jsTGALoader - Javascript loader for TGA file
  141135. * By Vincent Thibault
  141136. * @see http://blog.robrowser.com/javascript-tga-loader.html
  141137. */
  141138. export class TGATools {
  141139. private static _TYPE_INDEXED;
  141140. private static _TYPE_RGB;
  141141. private static _TYPE_GREY;
  141142. private static _TYPE_RLE_INDEXED;
  141143. private static _TYPE_RLE_RGB;
  141144. private static _TYPE_RLE_GREY;
  141145. private static _ORIGIN_MASK;
  141146. private static _ORIGIN_SHIFT;
  141147. private static _ORIGIN_BL;
  141148. private static _ORIGIN_BR;
  141149. private static _ORIGIN_UL;
  141150. private static _ORIGIN_UR;
  141151. /**
  141152. * Gets the header of a TGA file
  141153. * @param data defines the TGA data
  141154. * @returns the header
  141155. */
  141156. static GetTGAHeader(data: Uint8Array): any;
  141157. /**
  141158. * Uploads TGA content to a Babylon Texture
  141159. * @hidden
  141160. */
  141161. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  141162. /** @hidden */
  141163. 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;
  141164. /** @hidden */
  141165. 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;
  141166. /** @hidden */
  141167. 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;
  141168. /** @hidden */
  141169. 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;
  141170. /** @hidden */
  141171. 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;
  141172. /** @hidden */
  141173. 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;
  141174. }
  141175. }
  141176. declare module BABYLON {
  141177. /**
  141178. * Implementation of the TGA Texture Loader.
  141179. * @hidden
  141180. */
  141181. export class _TGATextureLoader implements IInternalTextureLoader {
  141182. /**
  141183. * Defines wether the loader supports cascade loading the different faces.
  141184. */
  141185. readonly supportCascades: boolean;
  141186. /**
  141187. * This returns if the loader support the current file information.
  141188. * @param extension defines the file extension of the file being loaded
  141189. * @returns true if the loader can load the specified file
  141190. */
  141191. canLoad(extension: string): boolean;
  141192. /**
  141193. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141194. * @param data contains the texture data
  141195. * @param texture defines the BabylonJS internal texture
  141196. * @param createPolynomials will be true if polynomials have been requested
  141197. * @param onLoad defines the callback to trigger once the texture is ready
  141198. * @param onError defines the callback to trigger in case of error
  141199. */
  141200. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141201. /**
  141202. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141203. * @param data contains the texture data
  141204. * @param texture defines the BabylonJS internal texture
  141205. * @param callback defines the method to call once ready to upload
  141206. */
  141207. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141208. }
  141209. }
  141210. declare module BABYLON {
  141211. /**
  141212. * Info about the .basis files
  141213. */
  141214. class BasisFileInfo {
  141215. /**
  141216. * If the file has alpha
  141217. */
  141218. hasAlpha: boolean;
  141219. /**
  141220. * Info about each image of the basis file
  141221. */
  141222. images: Array<{
  141223. levels: Array<{
  141224. width: number;
  141225. height: number;
  141226. transcodedPixels: ArrayBufferView;
  141227. }>;
  141228. }>;
  141229. }
  141230. /**
  141231. * Result of transcoding a basis file
  141232. */
  141233. class TranscodeResult {
  141234. /**
  141235. * Info about the .basis file
  141236. */
  141237. fileInfo: BasisFileInfo;
  141238. /**
  141239. * Format to use when loading the file
  141240. */
  141241. format: number;
  141242. }
  141243. /**
  141244. * Configuration options for the Basis transcoder
  141245. */
  141246. export class BasisTranscodeConfiguration {
  141247. /**
  141248. * Supported compression formats used to determine the supported output format of the transcoder
  141249. */
  141250. supportedCompressionFormats?: {
  141251. /**
  141252. * etc1 compression format
  141253. */
  141254. etc1?: boolean;
  141255. /**
  141256. * s3tc compression format
  141257. */
  141258. s3tc?: boolean;
  141259. /**
  141260. * pvrtc compression format
  141261. */
  141262. pvrtc?: boolean;
  141263. /**
  141264. * etc2 compression format
  141265. */
  141266. etc2?: boolean;
  141267. };
  141268. /**
  141269. * If mipmap levels should be loaded for transcoded images (Default: true)
  141270. */
  141271. loadMipmapLevels?: boolean;
  141272. /**
  141273. * Index of a single image to load (Default: all images)
  141274. */
  141275. loadSingleImage?: number;
  141276. }
  141277. /**
  141278. * Used to load .Basis files
  141279. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  141280. */
  141281. export class BasisTools {
  141282. private static _IgnoreSupportedFormats;
  141283. /**
  141284. * URL to use when loading the basis transcoder
  141285. */
  141286. static JSModuleURL: string;
  141287. /**
  141288. * URL to use when loading the wasm module for the transcoder
  141289. */
  141290. static WasmModuleURL: string;
  141291. /**
  141292. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  141293. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  141294. * @returns internal format corresponding to the Basis format
  141295. */
  141296. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  141297. private static _WorkerPromise;
  141298. private static _Worker;
  141299. private static _actionId;
  141300. private static _CreateWorkerAsync;
  141301. /**
  141302. * Transcodes a loaded image file to compressed pixel data
  141303. * @param data image data to transcode
  141304. * @param config configuration options for the transcoding
  141305. * @returns a promise resulting in the transcoded image
  141306. */
  141307. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  141308. /**
  141309. * Loads a texture from the transcode result
  141310. * @param texture texture load to
  141311. * @param transcodeResult the result of transcoding the basis file to load from
  141312. */
  141313. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  141314. }
  141315. }
  141316. declare module BABYLON {
  141317. /**
  141318. * Loader for .basis file format
  141319. */
  141320. export class _BasisTextureLoader implements IInternalTextureLoader {
  141321. /**
  141322. * Defines whether the loader supports cascade loading the different faces.
  141323. */
  141324. readonly supportCascades: boolean;
  141325. /**
  141326. * This returns if the loader support the current file information.
  141327. * @param extension defines the file extension of the file being loaded
  141328. * @returns true if the loader can load the specified file
  141329. */
  141330. canLoad(extension: string): boolean;
  141331. /**
  141332. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141333. * @param data contains the texture data
  141334. * @param texture defines the BabylonJS internal texture
  141335. * @param createPolynomials will be true if polynomials have been requested
  141336. * @param onLoad defines the callback to trigger once the texture is ready
  141337. * @param onError defines the callback to trigger in case of error
  141338. */
  141339. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141340. /**
  141341. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141342. * @param data contains the texture data
  141343. * @param texture defines the BabylonJS internal texture
  141344. * @param callback defines the method to call once ready to upload
  141345. */
  141346. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141347. }
  141348. }
  141349. declare module BABYLON {
  141350. /**
  141351. * Defines the basic options interface of a TexturePacker Frame
  141352. */
  141353. export interface ITexturePackerFrame {
  141354. /**
  141355. * The frame ID
  141356. */
  141357. id: number;
  141358. /**
  141359. * The frames Scale
  141360. */
  141361. scale: Vector2;
  141362. /**
  141363. * The Frames offset
  141364. */
  141365. offset: Vector2;
  141366. }
  141367. /**
  141368. * This is a support class for frame Data on texture packer sets.
  141369. */
  141370. export class TexturePackerFrame implements ITexturePackerFrame {
  141371. /**
  141372. * The frame ID
  141373. */
  141374. id: number;
  141375. /**
  141376. * The frames Scale
  141377. */
  141378. scale: Vector2;
  141379. /**
  141380. * The Frames offset
  141381. */
  141382. offset: Vector2;
  141383. /**
  141384. * Initializes a texture package frame.
  141385. * @param id The numerical frame identifier
  141386. * @param scale Scalar Vector2 for UV frame
  141387. * @param offset Vector2 for the frame position in UV units.
  141388. * @returns TexturePackerFrame
  141389. */
  141390. constructor(id: number, scale: Vector2, offset: Vector2);
  141391. }
  141392. }
  141393. declare module BABYLON {
  141394. /**
  141395. * Defines the basic options interface of a TexturePacker
  141396. */
  141397. export interface ITexturePackerOptions {
  141398. /**
  141399. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  141400. */
  141401. map?: string[];
  141402. /**
  141403. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141404. */
  141405. uvsIn?: string;
  141406. /**
  141407. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141408. */
  141409. uvsOut?: string;
  141410. /**
  141411. * number representing the layout style. Defaults to LAYOUT_STRIP
  141412. */
  141413. layout?: number;
  141414. /**
  141415. * number of columns if using custom column count layout(2). This defaults to 4.
  141416. */
  141417. colnum?: number;
  141418. /**
  141419. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  141420. */
  141421. updateInputMeshes?: boolean;
  141422. /**
  141423. * boolean flag to dispose all the source textures. Defaults to true.
  141424. */
  141425. disposeSources?: boolean;
  141426. /**
  141427. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  141428. */
  141429. fillBlanks?: boolean;
  141430. /**
  141431. * string value representing the context fill style color. Defaults to 'black'.
  141432. */
  141433. customFillColor?: string;
  141434. /**
  141435. * Width and Height Value of each Frame in the TexturePacker Sets
  141436. */
  141437. frameSize?: number;
  141438. /**
  141439. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  141440. */
  141441. paddingRatio?: number;
  141442. /**
  141443. * Number that declares the fill method for the padding gutter.
  141444. */
  141445. paddingMode?: number;
  141446. /**
  141447. * If in SUBUV_COLOR padding mode what color to use.
  141448. */
  141449. paddingColor?: Color3 | Color4;
  141450. }
  141451. /**
  141452. * Defines the basic interface of a TexturePacker JSON File
  141453. */
  141454. export interface ITexturePackerJSON {
  141455. /**
  141456. * The frame ID
  141457. */
  141458. name: string;
  141459. /**
  141460. * The base64 channel data
  141461. */
  141462. sets: any;
  141463. /**
  141464. * The options of the Packer
  141465. */
  141466. options: ITexturePackerOptions;
  141467. /**
  141468. * The frame data of the Packer
  141469. */
  141470. frames: Array<number>;
  141471. }
  141472. /**
  141473. * This is a support class that generates a series of packed texture sets.
  141474. * @see https://doc.babylonjs.com/babylon101/materials
  141475. */
  141476. export class TexturePacker {
  141477. /** Packer Layout Constant 0 */
  141478. static readonly LAYOUT_STRIP: number;
  141479. /** Packer Layout Constant 1 */
  141480. static readonly LAYOUT_POWER2: number;
  141481. /** Packer Layout Constant 2 */
  141482. static readonly LAYOUT_COLNUM: number;
  141483. /** Packer Layout Constant 0 */
  141484. static readonly SUBUV_WRAP: number;
  141485. /** Packer Layout Constant 1 */
  141486. static readonly SUBUV_EXTEND: number;
  141487. /** Packer Layout Constant 2 */
  141488. static readonly SUBUV_COLOR: number;
  141489. /** The Name of the Texture Package */
  141490. name: string;
  141491. /** The scene scope of the TexturePacker */
  141492. scene: Scene;
  141493. /** The Meshes to target */
  141494. meshes: AbstractMesh[];
  141495. /** Arguments passed with the Constructor */
  141496. options: ITexturePackerOptions;
  141497. /** The promise that is started upon initialization */
  141498. promise: Nullable<Promise<TexturePacker | string>>;
  141499. /** The Container object for the channel sets that are generated */
  141500. sets: object;
  141501. /** The Container array for the frames that are generated */
  141502. frames: TexturePackerFrame[];
  141503. /** The expected number of textures the system is parsing. */
  141504. private _expecting;
  141505. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  141506. private _paddingValue;
  141507. /**
  141508. * Initializes a texture package series from an array of meshes or a single mesh.
  141509. * @param name The name of the package
  141510. * @param meshes The target meshes to compose the package from
  141511. * @param options The arguments that texture packer should follow while building.
  141512. * @param scene The scene which the textures are scoped to.
  141513. * @returns TexturePacker
  141514. */
  141515. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  141516. /**
  141517. * Starts the package process
  141518. * @param resolve The promises resolution function
  141519. * @returns TexturePacker
  141520. */
  141521. private _createFrames;
  141522. /**
  141523. * Calculates the Size of the Channel Sets
  141524. * @returns Vector2
  141525. */
  141526. private _calculateSize;
  141527. /**
  141528. * Calculates the UV data for the frames.
  141529. * @param baseSize the base frameSize
  141530. * @param padding the base frame padding
  141531. * @param dtSize size of the Dynamic Texture for that channel
  141532. * @param dtUnits is 1/dtSize
  141533. * @param update flag to update the input meshes
  141534. */
  141535. private _calculateMeshUVFrames;
  141536. /**
  141537. * Calculates the frames Offset.
  141538. * @param index of the frame
  141539. * @returns Vector2
  141540. */
  141541. private _getFrameOffset;
  141542. /**
  141543. * Updates a Mesh to the frame data
  141544. * @param mesh that is the target
  141545. * @param frameID or the frame index
  141546. */
  141547. private _updateMeshUV;
  141548. /**
  141549. * Updates a Meshes materials to use the texture packer channels
  141550. * @param m is the mesh to target
  141551. * @param force all channels on the packer to be set.
  141552. */
  141553. private _updateTextureReferences;
  141554. /**
  141555. * Public method to set a Mesh to a frame
  141556. * @param m that is the target
  141557. * @param frameID or the frame index
  141558. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  141559. */
  141560. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  141561. /**
  141562. * Starts the async promise to compile the texture packer.
  141563. * @returns Promise<void>
  141564. */
  141565. processAsync(): Promise<void>;
  141566. /**
  141567. * Disposes all textures associated with this packer
  141568. */
  141569. dispose(): void;
  141570. /**
  141571. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  141572. * @param imageType is the image type to use.
  141573. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  141574. */
  141575. download(imageType?: string, quality?: number): void;
  141576. /**
  141577. * Public method to load a texturePacker JSON file.
  141578. * @param data of the JSON file in string format.
  141579. */
  141580. updateFromJSON(data: string): void;
  141581. }
  141582. }
  141583. declare module BABYLON {
  141584. /**
  141585. * 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.
  141586. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141587. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141588. */
  141589. export class CustomProceduralTexture extends ProceduralTexture {
  141590. private _animate;
  141591. private _time;
  141592. private _config;
  141593. private _texturePath;
  141594. /**
  141595. * Instantiates a new Custom Procedural Texture.
  141596. * 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.
  141597. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141598. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141599. * @param name Define the name of the texture
  141600. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  141601. * @param size Define the size of the texture to create
  141602. * @param scene Define the scene the texture belongs to
  141603. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  141604. * @param generateMipMaps Define if the texture should creates mip maps or not
  141605. */
  141606. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141607. private _loadJson;
  141608. /**
  141609. * Is the texture ready to be used ? (rendered at least once)
  141610. * @returns true if ready, otherwise, false.
  141611. */
  141612. isReady(): boolean;
  141613. /**
  141614. * Render the texture to its associated render target.
  141615. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  141616. */
  141617. render(useCameraPostProcess?: boolean): void;
  141618. /**
  141619. * Update the list of dependant textures samplers in the shader.
  141620. */
  141621. updateTextures(): void;
  141622. /**
  141623. * Update the uniform values of the procedural texture in the shader.
  141624. */
  141625. updateShaderUniforms(): void;
  141626. /**
  141627. * Define if the texture animates or not.
  141628. */
  141629. get animate(): boolean;
  141630. set animate(value: boolean);
  141631. }
  141632. }
  141633. declare module BABYLON {
  141634. /** @hidden */
  141635. export var noisePixelShader: {
  141636. name: string;
  141637. shader: string;
  141638. };
  141639. }
  141640. declare module BABYLON {
  141641. /**
  141642. * Class used to generate noise procedural textures
  141643. */
  141644. export class NoiseProceduralTexture extends ProceduralTexture {
  141645. /** Gets or sets the start time (default is 0) */
  141646. time: number;
  141647. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  141648. brightness: number;
  141649. /** Defines the number of octaves to process */
  141650. octaves: number;
  141651. /** Defines the level of persistence (0.8 by default) */
  141652. persistence: number;
  141653. /** Gets or sets animation speed factor (default is 1) */
  141654. animationSpeedFactor: number;
  141655. /**
  141656. * Creates a new NoiseProceduralTexture
  141657. * @param name defines the name fo the texture
  141658. * @param size defines the size of the texture (default is 256)
  141659. * @param scene defines the hosting scene
  141660. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  141661. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  141662. */
  141663. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141664. private _updateShaderUniforms;
  141665. protected _getDefines(): string;
  141666. /** Generate the current state of the procedural texture */
  141667. render(useCameraPostProcess?: boolean): void;
  141668. /**
  141669. * Serializes this noise procedural texture
  141670. * @returns a serialized noise procedural texture object
  141671. */
  141672. serialize(): any;
  141673. /**
  141674. * Clone the texture.
  141675. * @returns the cloned texture
  141676. */
  141677. clone(): NoiseProceduralTexture;
  141678. /**
  141679. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  141680. * @param parsedTexture defines parsed texture data
  141681. * @param scene defines the current scene
  141682. * @param rootUrl defines the root URL containing noise procedural texture information
  141683. * @returns a parsed NoiseProceduralTexture
  141684. */
  141685. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  141686. }
  141687. }
  141688. declare module BABYLON {
  141689. /**
  141690. * Raw cube texture where the raw buffers are passed in
  141691. */
  141692. export class RawCubeTexture extends CubeTexture {
  141693. /**
  141694. * Creates a cube texture where the raw buffers are passed in.
  141695. * @param scene defines the scene the texture is attached to
  141696. * @param data defines the array of data to use to create each face
  141697. * @param size defines the size of the textures
  141698. * @param format defines the format of the data
  141699. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  141700. * @param generateMipMaps defines if the engine should generate the mip levels
  141701. * @param invertY defines if data must be stored with Y axis inverted
  141702. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  141703. * @param compression defines the compression used (null by default)
  141704. */
  141705. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  141706. /**
  141707. * Updates the raw cube texture.
  141708. * @param data defines the data to store
  141709. * @param format defines the data format
  141710. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  141711. * @param invertY defines if data must be stored with Y axis inverted
  141712. * @param compression defines the compression used (null by default)
  141713. * @param level defines which level of the texture to update
  141714. */
  141715. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  141716. /**
  141717. * Updates a raw cube texture with RGBD encoded data.
  141718. * @param data defines the array of data [mipmap][face] to use to create each face
  141719. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  141720. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  141721. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  141722. * @returns a promsie that resolves when the operation is complete
  141723. */
  141724. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  141725. /**
  141726. * Clones the raw cube texture.
  141727. * @return a new cube texture
  141728. */
  141729. clone(): CubeTexture;
  141730. /** @hidden */
  141731. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  141732. }
  141733. }
  141734. declare module BABYLON {
  141735. /**
  141736. * Class used to store 2D array textures containing user data
  141737. */
  141738. export class RawTexture2DArray extends Texture {
  141739. /** Gets or sets the texture format to use */
  141740. format: number;
  141741. /**
  141742. * Create a new RawTexture2DArray
  141743. * @param data defines the data of the texture
  141744. * @param width defines the width of the texture
  141745. * @param height defines the height of the texture
  141746. * @param depth defines the number of layers of the texture
  141747. * @param format defines the texture format to use
  141748. * @param scene defines the hosting scene
  141749. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141750. * @param invertY defines if texture must be stored with Y axis inverted
  141751. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141752. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141753. */
  141754. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141755. /** Gets or sets the texture format to use */
  141756. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141757. /**
  141758. * Update the texture with new data
  141759. * @param data defines the data to store in the texture
  141760. */
  141761. update(data: ArrayBufferView): void;
  141762. }
  141763. }
  141764. declare module BABYLON {
  141765. /**
  141766. * Class used to store 3D textures containing user data
  141767. */
  141768. export class RawTexture3D extends Texture {
  141769. /** Gets or sets the texture format to use */
  141770. format: number;
  141771. /**
  141772. * Create a new RawTexture3D
  141773. * @param data defines the data of the texture
  141774. * @param width defines the width of the texture
  141775. * @param height defines the height of the texture
  141776. * @param depth defines the depth of the texture
  141777. * @param format defines the texture format to use
  141778. * @param scene defines the hosting scene
  141779. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141780. * @param invertY defines if texture must be stored with Y axis inverted
  141781. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141782. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141783. */
  141784. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141785. /** Gets or sets the texture format to use */
  141786. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141787. /**
  141788. * Update the texture with new data
  141789. * @param data defines the data to store in the texture
  141790. */
  141791. update(data: ArrayBufferView): void;
  141792. }
  141793. }
  141794. declare module BABYLON {
  141795. /**
  141796. * Creates a refraction texture used by refraction channel of the standard material.
  141797. * It is like a mirror but to see through a material.
  141798. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141799. */
  141800. export class RefractionTexture extends RenderTargetTexture {
  141801. /**
  141802. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  141803. * 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.
  141804. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141805. */
  141806. refractionPlane: Plane;
  141807. /**
  141808. * Define how deep under the surface we should see.
  141809. */
  141810. depth: number;
  141811. /**
  141812. * Creates a refraction texture used by refraction channel of the standard material.
  141813. * It is like a mirror but to see through a material.
  141814. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141815. * @param name Define the texture name
  141816. * @param size Define the size of the underlying texture
  141817. * @param scene Define the scene the refraction belongs to
  141818. * @param generateMipMaps Define if we need to generate mips level for the refraction
  141819. */
  141820. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  141821. /**
  141822. * Clone the refraction texture.
  141823. * @returns the cloned texture
  141824. */
  141825. clone(): RefractionTexture;
  141826. /**
  141827. * Serialize the texture to a JSON representation you could use in Parse later on
  141828. * @returns the serialized JSON representation
  141829. */
  141830. serialize(): any;
  141831. }
  141832. }
  141833. declare module BABYLON {
  141834. /**
  141835. * Block used to add support for vertex skinning (bones)
  141836. */
  141837. export class BonesBlock extends NodeMaterialBlock {
  141838. /**
  141839. * Creates a new BonesBlock
  141840. * @param name defines the block name
  141841. */
  141842. constructor(name: string);
  141843. /**
  141844. * Initialize the block and prepare the context for build
  141845. * @param state defines the state that will be used for the build
  141846. */
  141847. initialize(state: NodeMaterialBuildState): void;
  141848. /**
  141849. * Gets the current class name
  141850. * @returns the class name
  141851. */
  141852. getClassName(): string;
  141853. /**
  141854. * Gets the matrix indices input component
  141855. */
  141856. get matricesIndices(): NodeMaterialConnectionPoint;
  141857. /**
  141858. * Gets the matrix weights input component
  141859. */
  141860. get matricesWeights(): NodeMaterialConnectionPoint;
  141861. /**
  141862. * Gets the extra matrix indices input component
  141863. */
  141864. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  141865. /**
  141866. * Gets the extra matrix weights input component
  141867. */
  141868. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  141869. /**
  141870. * Gets the world input component
  141871. */
  141872. get world(): NodeMaterialConnectionPoint;
  141873. /**
  141874. * Gets the output component
  141875. */
  141876. get output(): NodeMaterialConnectionPoint;
  141877. autoConfigure(material: NodeMaterial): void;
  141878. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  141879. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141880. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141881. protected _buildBlock(state: NodeMaterialBuildState): this;
  141882. }
  141883. }
  141884. declare module BABYLON {
  141885. /**
  141886. * Block used to add support for instances
  141887. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  141888. */
  141889. export class InstancesBlock extends NodeMaterialBlock {
  141890. /**
  141891. * Creates a new InstancesBlock
  141892. * @param name defines the block name
  141893. */
  141894. constructor(name: string);
  141895. /**
  141896. * Gets the current class name
  141897. * @returns the class name
  141898. */
  141899. getClassName(): string;
  141900. /**
  141901. * Gets the first world row input component
  141902. */
  141903. get world0(): NodeMaterialConnectionPoint;
  141904. /**
  141905. * Gets the second world row input component
  141906. */
  141907. get world1(): NodeMaterialConnectionPoint;
  141908. /**
  141909. * Gets the third world row input component
  141910. */
  141911. get world2(): NodeMaterialConnectionPoint;
  141912. /**
  141913. * Gets the forth world row input component
  141914. */
  141915. get world3(): NodeMaterialConnectionPoint;
  141916. /**
  141917. * Gets the world input component
  141918. */
  141919. get world(): NodeMaterialConnectionPoint;
  141920. /**
  141921. * Gets the output component
  141922. */
  141923. get output(): NodeMaterialConnectionPoint;
  141924. /**
  141925. * Gets the isntanceID component
  141926. */
  141927. get instanceID(): NodeMaterialConnectionPoint;
  141928. autoConfigure(material: NodeMaterial): void;
  141929. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  141930. protected _buildBlock(state: NodeMaterialBuildState): this;
  141931. }
  141932. }
  141933. declare module BABYLON {
  141934. /**
  141935. * Block used to add morph targets support to vertex shader
  141936. */
  141937. export class MorphTargetsBlock extends NodeMaterialBlock {
  141938. private _repeatableContentAnchor;
  141939. /**
  141940. * Create a new MorphTargetsBlock
  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 position input component
  141951. */
  141952. get position(): NodeMaterialConnectionPoint;
  141953. /**
  141954. * Gets the normal input component
  141955. */
  141956. get normal(): NodeMaterialConnectionPoint;
  141957. /**
  141958. * Gets the tangent input component
  141959. */
  141960. get tangent(): NodeMaterialConnectionPoint;
  141961. /**
  141962. * Gets the tangent input component
  141963. */
  141964. get uv(): NodeMaterialConnectionPoint;
  141965. /**
  141966. * Gets the position output component
  141967. */
  141968. get positionOutput(): NodeMaterialConnectionPoint;
  141969. /**
  141970. * Gets the normal output component
  141971. */
  141972. get normalOutput(): NodeMaterialConnectionPoint;
  141973. /**
  141974. * Gets the tangent output component
  141975. */
  141976. get tangentOutput(): NodeMaterialConnectionPoint;
  141977. /**
  141978. * Gets the tangent output component
  141979. */
  141980. get uvOutput(): NodeMaterialConnectionPoint;
  141981. initialize(state: NodeMaterialBuildState): void;
  141982. autoConfigure(material: NodeMaterial): void;
  141983. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141984. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141985. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  141986. protected _buildBlock(state: NodeMaterialBuildState): this;
  141987. }
  141988. }
  141989. declare module BABYLON {
  141990. /**
  141991. * Block used to get data information from a light
  141992. */
  141993. export class LightInformationBlock extends NodeMaterialBlock {
  141994. private _lightDataUniformName;
  141995. private _lightColorUniformName;
  141996. private _lightTypeDefineName;
  141997. /**
  141998. * Gets or sets the light associated with this block
  141999. */
  142000. light: Nullable<Light>;
  142001. /**
  142002. * Creates a new LightInformationBlock
  142003. * @param name defines the block name
  142004. */
  142005. constructor(name: string);
  142006. /**
  142007. * Gets the current class name
  142008. * @returns the class name
  142009. */
  142010. getClassName(): string;
  142011. /**
  142012. * Gets the world position input component
  142013. */
  142014. get worldPosition(): NodeMaterialConnectionPoint;
  142015. /**
  142016. * Gets the direction output component
  142017. */
  142018. get direction(): NodeMaterialConnectionPoint;
  142019. /**
  142020. * Gets the direction output component
  142021. */
  142022. get color(): NodeMaterialConnectionPoint;
  142023. /**
  142024. * Gets the direction output component
  142025. */
  142026. get intensity(): NodeMaterialConnectionPoint;
  142027. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142028. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142029. protected _buildBlock(state: NodeMaterialBuildState): this;
  142030. serialize(): any;
  142031. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142032. }
  142033. }
  142034. declare module BABYLON {
  142035. /**
  142036. * Block used to add image processing support to fragment shader
  142037. */
  142038. export class ImageProcessingBlock extends NodeMaterialBlock {
  142039. /**
  142040. * Create a new ImageProcessingBlock
  142041. * @param name defines the block name
  142042. */
  142043. constructor(name: string);
  142044. /**
  142045. * Gets the current class name
  142046. * @returns the class name
  142047. */
  142048. getClassName(): string;
  142049. /**
  142050. * Gets the color input component
  142051. */
  142052. get color(): NodeMaterialConnectionPoint;
  142053. /**
  142054. * Gets the output component
  142055. */
  142056. get output(): NodeMaterialConnectionPoint;
  142057. /**
  142058. * Initialize the block and prepare the context for build
  142059. * @param state defines the state that will be used for the build
  142060. */
  142061. initialize(state: NodeMaterialBuildState): void;
  142062. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  142063. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142064. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142065. protected _buildBlock(state: NodeMaterialBuildState): this;
  142066. }
  142067. }
  142068. declare module BABYLON {
  142069. /**
  142070. * Block used to pertub normals based on a normal map
  142071. */
  142072. export class PerturbNormalBlock extends NodeMaterialBlock {
  142073. private _tangentSpaceParameterName;
  142074. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  142075. invertX: boolean;
  142076. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  142077. invertY: boolean;
  142078. /**
  142079. * Create a new PerturbNormalBlock
  142080. * @param name defines the block name
  142081. */
  142082. constructor(name: string);
  142083. /**
  142084. * Gets the current class name
  142085. * @returns the class name
  142086. */
  142087. getClassName(): string;
  142088. /**
  142089. * Gets the world position input component
  142090. */
  142091. get worldPosition(): NodeMaterialConnectionPoint;
  142092. /**
  142093. * Gets the world normal input component
  142094. */
  142095. get worldNormal(): NodeMaterialConnectionPoint;
  142096. /**
  142097. * Gets the world tangent input component
  142098. */
  142099. get worldTangent(): NodeMaterialConnectionPoint;
  142100. /**
  142101. * Gets the uv input component
  142102. */
  142103. get uv(): NodeMaterialConnectionPoint;
  142104. /**
  142105. * Gets the normal map color input component
  142106. */
  142107. get normalMapColor(): NodeMaterialConnectionPoint;
  142108. /**
  142109. * Gets the strength input component
  142110. */
  142111. get strength(): NodeMaterialConnectionPoint;
  142112. /**
  142113. * Gets the output component
  142114. */
  142115. get output(): NodeMaterialConnectionPoint;
  142116. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142117. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142118. autoConfigure(material: NodeMaterial): void;
  142119. protected _buildBlock(state: NodeMaterialBuildState): this;
  142120. protected _dumpPropertiesCode(): string;
  142121. serialize(): any;
  142122. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142123. }
  142124. }
  142125. declare module BABYLON {
  142126. /**
  142127. * Block used to discard a pixel if a value is smaller than a cutoff
  142128. */
  142129. export class DiscardBlock extends NodeMaterialBlock {
  142130. /**
  142131. * Create a new DiscardBlock
  142132. * @param name defines the block name
  142133. */
  142134. constructor(name: string);
  142135. /**
  142136. * Gets the current class name
  142137. * @returns the class name
  142138. */
  142139. getClassName(): string;
  142140. /**
  142141. * Gets the color input component
  142142. */
  142143. get value(): NodeMaterialConnectionPoint;
  142144. /**
  142145. * Gets the cutoff input component
  142146. */
  142147. get cutoff(): NodeMaterialConnectionPoint;
  142148. protected _buildBlock(state: NodeMaterialBuildState): this;
  142149. }
  142150. }
  142151. declare module BABYLON {
  142152. /**
  142153. * Block used to test if the fragment shader is front facing
  142154. */
  142155. export class FrontFacingBlock extends NodeMaterialBlock {
  142156. /**
  142157. * Creates a new FrontFacingBlock
  142158. * @param name defines the block name
  142159. */
  142160. constructor(name: string);
  142161. /**
  142162. * Gets the current class name
  142163. * @returns the class name
  142164. */
  142165. getClassName(): string;
  142166. /**
  142167. * Gets the output component
  142168. */
  142169. get output(): NodeMaterialConnectionPoint;
  142170. protected _buildBlock(state: NodeMaterialBuildState): this;
  142171. }
  142172. }
  142173. declare module BABYLON {
  142174. /**
  142175. * Block used to get the derivative value on x and y of a given input
  142176. */
  142177. export class DerivativeBlock extends NodeMaterialBlock {
  142178. /**
  142179. * Create a new DerivativeBlock
  142180. * @param name defines the block name
  142181. */
  142182. constructor(name: string);
  142183. /**
  142184. * Gets the current class name
  142185. * @returns the class name
  142186. */
  142187. getClassName(): string;
  142188. /**
  142189. * Gets the input component
  142190. */
  142191. get input(): NodeMaterialConnectionPoint;
  142192. /**
  142193. * Gets the derivative output on x
  142194. */
  142195. get dx(): NodeMaterialConnectionPoint;
  142196. /**
  142197. * Gets the derivative output on y
  142198. */
  142199. get dy(): NodeMaterialConnectionPoint;
  142200. protected _buildBlock(state: NodeMaterialBuildState): this;
  142201. }
  142202. }
  142203. declare module BABYLON {
  142204. /**
  142205. * Block used to make gl_FragCoord available
  142206. */
  142207. export class FragCoordBlock extends NodeMaterialBlock {
  142208. /**
  142209. * Creates a new FragCoordBlock
  142210. * @param name defines the block name
  142211. */
  142212. constructor(name: string);
  142213. /**
  142214. * Gets the current class name
  142215. * @returns the class name
  142216. */
  142217. getClassName(): string;
  142218. /**
  142219. * Gets the xy component
  142220. */
  142221. get xy(): NodeMaterialConnectionPoint;
  142222. /**
  142223. * Gets the xyz component
  142224. */
  142225. get xyz(): NodeMaterialConnectionPoint;
  142226. /**
  142227. * Gets the xyzw component
  142228. */
  142229. get xyzw(): NodeMaterialConnectionPoint;
  142230. /**
  142231. * Gets the x component
  142232. */
  142233. get x(): NodeMaterialConnectionPoint;
  142234. /**
  142235. * Gets the y component
  142236. */
  142237. get y(): NodeMaterialConnectionPoint;
  142238. /**
  142239. * Gets the z component
  142240. */
  142241. get z(): NodeMaterialConnectionPoint;
  142242. /**
  142243. * Gets the w component
  142244. */
  142245. get output(): NodeMaterialConnectionPoint;
  142246. protected writeOutputs(state: NodeMaterialBuildState): string;
  142247. protected _buildBlock(state: NodeMaterialBuildState): this;
  142248. }
  142249. }
  142250. declare module BABYLON {
  142251. /**
  142252. * Block used to get the screen sizes
  142253. */
  142254. export class ScreenSizeBlock extends NodeMaterialBlock {
  142255. private _varName;
  142256. private _scene;
  142257. /**
  142258. * Creates a new ScreenSizeBlock
  142259. * @param name defines the block name
  142260. */
  142261. constructor(name: string);
  142262. /**
  142263. * Gets the current class name
  142264. * @returns the class name
  142265. */
  142266. getClassName(): string;
  142267. /**
  142268. * Gets the xy component
  142269. */
  142270. get xy(): NodeMaterialConnectionPoint;
  142271. /**
  142272. * Gets the x component
  142273. */
  142274. get x(): NodeMaterialConnectionPoint;
  142275. /**
  142276. * Gets the y component
  142277. */
  142278. get y(): NodeMaterialConnectionPoint;
  142279. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142280. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  142281. protected _buildBlock(state: NodeMaterialBuildState): this;
  142282. }
  142283. }
  142284. declare module BABYLON {
  142285. /**
  142286. * Block used to add support for scene fog
  142287. */
  142288. export class FogBlock extends NodeMaterialBlock {
  142289. private _fogDistanceName;
  142290. private _fogParameters;
  142291. /**
  142292. * Create a new FogBlock
  142293. * @param name defines the block name
  142294. */
  142295. constructor(name: string);
  142296. /**
  142297. * Gets the current class name
  142298. * @returns the class name
  142299. */
  142300. getClassName(): string;
  142301. /**
  142302. * Gets the world position input component
  142303. */
  142304. get worldPosition(): NodeMaterialConnectionPoint;
  142305. /**
  142306. * Gets the view input component
  142307. */
  142308. get view(): NodeMaterialConnectionPoint;
  142309. /**
  142310. * Gets the color input component
  142311. */
  142312. get input(): NodeMaterialConnectionPoint;
  142313. /**
  142314. * Gets the fog color input component
  142315. */
  142316. get fogColor(): NodeMaterialConnectionPoint;
  142317. /**
  142318. * Gets the output component
  142319. */
  142320. get output(): NodeMaterialConnectionPoint;
  142321. autoConfigure(material: NodeMaterial): void;
  142322. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142323. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142324. protected _buildBlock(state: NodeMaterialBuildState): this;
  142325. }
  142326. }
  142327. declare module BABYLON {
  142328. /**
  142329. * Block used to add light in the fragment shader
  142330. */
  142331. export class LightBlock extends NodeMaterialBlock {
  142332. private _lightId;
  142333. /**
  142334. * Gets or sets the light associated with this block
  142335. */
  142336. light: Nullable<Light>;
  142337. /**
  142338. * Create a new LightBlock
  142339. * @param name defines the block name
  142340. */
  142341. constructor(name: string);
  142342. /**
  142343. * Gets the current class name
  142344. * @returns the class name
  142345. */
  142346. getClassName(): string;
  142347. /**
  142348. * Gets the world position input component
  142349. */
  142350. get worldPosition(): NodeMaterialConnectionPoint;
  142351. /**
  142352. * Gets the world normal input component
  142353. */
  142354. get worldNormal(): NodeMaterialConnectionPoint;
  142355. /**
  142356. * Gets the camera (or eye) position component
  142357. */
  142358. get cameraPosition(): NodeMaterialConnectionPoint;
  142359. /**
  142360. * Gets the glossiness component
  142361. */
  142362. get glossiness(): NodeMaterialConnectionPoint;
  142363. /**
  142364. * Gets the glossinness power component
  142365. */
  142366. get glossPower(): NodeMaterialConnectionPoint;
  142367. /**
  142368. * Gets the diffuse color component
  142369. */
  142370. get diffuseColor(): NodeMaterialConnectionPoint;
  142371. /**
  142372. * Gets the specular color component
  142373. */
  142374. get specularColor(): NodeMaterialConnectionPoint;
  142375. /**
  142376. * Gets the diffuse output component
  142377. */
  142378. get diffuseOutput(): NodeMaterialConnectionPoint;
  142379. /**
  142380. * Gets the specular output component
  142381. */
  142382. get specularOutput(): NodeMaterialConnectionPoint;
  142383. /**
  142384. * Gets the shadow output component
  142385. */
  142386. get shadow(): NodeMaterialConnectionPoint;
  142387. autoConfigure(material: NodeMaterial): void;
  142388. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142389. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  142390. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142391. private _injectVertexCode;
  142392. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  142393. serialize(): any;
  142394. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142395. }
  142396. }
  142397. declare module BABYLON {
  142398. /**
  142399. * Block used to read a reflection texture from a sampler
  142400. */
  142401. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  142402. /**
  142403. * Create a new ReflectionTextureBlock
  142404. * @param name defines the block name
  142405. */
  142406. constructor(name: string);
  142407. /**
  142408. * Gets the current class name
  142409. * @returns the class name
  142410. */
  142411. getClassName(): string;
  142412. /**
  142413. * Gets the world position input component
  142414. */
  142415. get position(): NodeMaterialConnectionPoint;
  142416. /**
  142417. * Gets the world position input component
  142418. */
  142419. get worldPosition(): NodeMaterialConnectionPoint;
  142420. /**
  142421. * Gets the world normal input component
  142422. */
  142423. get worldNormal(): NodeMaterialConnectionPoint;
  142424. /**
  142425. * Gets the world input component
  142426. */
  142427. get world(): NodeMaterialConnectionPoint;
  142428. /**
  142429. * Gets the camera (or eye) position component
  142430. */
  142431. get cameraPosition(): NodeMaterialConnectionPoint;
  142432. /**
  142433. * Gets the view input component
  142434. */
  142435. get view(): NodeMaterialConnectionPoint;
  142436. /**
  142437. * Gets the rgb output component
  142438. */
  142439. get rgb(): NodeMaterialConnectionPoint;
  142440. /**
  142441. * Gets the rgba output component
  142442. */
  142443. get rgba(): NodeMaterialConnectionPoint;
  142444. /**
  142445. * Gets the r output component
  142446. */
  142447. get r(): NodeMaterialConnectionPoint;
  142448. /**
  142449. * Gets the g output component
  142450. */
  142451. get g(): NodeMaterialConnectionPoint;
  142452. /**
  142453. * Gets the b output component
  142454. */
  142455. get b(): NodeMaterialConnectionPoint;
  142456. /**
  142457. * Gets the a output component
  142458. */
  142459. get a(): NodeMaterialConnectionPoint;
  142460. autoConfigure(material: NodeMaterial): void;
  142461. protected _buildBlock(state: NodeMaterialBuildState): this;
  142462. }
  142463. }
  142464. declare module BABYLON {
  142465. /**
  142466. * Block used to add 2 vectors
  142467. */
  142468. export class AddBlock extends NodeMaterialBlock {
  142469. /**
  142470. * Creates a new AddBlock
  142471. * @param name defines the block name
  142472. */
  142473. constructor(name: string);
  142474. /**
  142475. * Gets the current class name
  142476. * @returns the class name
  142477. */
  142478. getClassName(): string;
  142479. /**
  142480. * Gets the left operand input component
  142481. */
  142482. get left(): NodeMaterialConnectionPoint;
  142483. /**
  142484. * Gets the right operand input component
  142485. */
  142486. get right(): NodeMaterialConnectionPoint;
  142487. /**
  142488. * Gets the output component
  142489. */
  142490. get output(): NodeMaterialConnectionPoint;
  142491. protected _buildBlock(state: NodeMaterialBuildState): this;
  142492. }
  142493. }
  142494. declare module BABYLON {
  142495. /**
  142496. * Block used to scale a vector by a float
  142497. */
  142498. export class ScaleBlock extends NodeMaterialBlock {
  142499. /**
  142500. * Creates a new ScaleBlock
  142501. * @param name defines the block name
  142502. */
  142503. constructor(name: string);
  142504. /**
  142505. * Gets the current class name
  142506. * @returns the class name
  142507. */
  142508. getClassName(): string;
  142509. /**
  142510. * Gets the input component
  142511. */
  142512. get input(): NodeMaterialConnectionPoint;
  142513. /**
  142514. * Gets the factor input component
  142515. */
  142516. get factor(): NodeMaterialConnectionPoint;
  142517. /**
  142518. * Gets the output component
  142519. */
  142520. get output(): NodeMaterialConnectionPoint;
  142521. protected _buildBlock(state: NodeMaterialBuildState): this;
  142522. }
  142523. }
  142524. declare module BABYLON {
  142525. /**
  142526. * Block used to clamp a float
  142527. */
  142528. export class ClampBlock extends NodeMaterialBlock {
  142529. /** Gets or sets the minimum range */
  142530. minimum: number;
  142531. /** Gets or sets the maximum range */
  142532. maximum: number;
  142533. /**
  142534. * Creates a new ClampBlock
  142535. * @param name defines the block name
  142536. */
  142537. constructor(name: string);
  142538. /**
  142539. * Gets the current class name
  142540. * @returns the class name
  142541. */
  142542. getClassName(): string;
  142543. /**
  142544. * Gets the value input component
  142545. */
  142546. get value(): NodeMaterialConnectionPoint;
  142547. /**
  142548. * Gets the output component
  142549. */
  142550. get output(): NodeMaterialConnectionPoint;
  142551. protected _buildBlock(state: NodeMaterialBuildState): this;
  142552. protected _dumpPropertiesCode(): string;
  142553. serialize(): any;
  142554. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142555. }
  142556. }
  142557. declare module BABYLON {
  142558. /**
  142559. * Block used to apply a cross product between 2 vectors
  142560. */
  142561. export class CrossBlock extends NodeMaterialBlock {
  142562. /**
  142563. * Creates a new CrossBlock
  142564. * @param name defines the block name
  142565. */
  142566. constructor(name: string);
  142567. /**
  142568. * Gets the current class name
  142569. * @returns the class name
  142570. */
  142571. getClassName(): string;
  142572. /**
  142573. * Gets the left operand input component
  142574. */
  142575. get left(): NodeMaterialConnectionPoint;
  142576. /**
  142577. * Gets the right operand input component
  142578. */
  142579. get right(): NodeMaterialConnectionPoint;
  142580. /**
  142581. * Gets the output component
  142582. */
  142583. get output(): NodeMaterialConnectionPoint;
  142584. protected _buildBlock(state: NodeMaterialBuildState): this;
  142585. }
  142586. }
  142587. declare module BABYLON {
  142588. /**
  142589. * Block used to apply a dot product between 2 vectors
  142590. */
  142591. export class DotBlock extends NodeMaterialBlock {
  142592. /**
  142593. * Creates a new DotBlock
  142594. * @param name defines the block name
  142595. */
  142596. constructor(name: string);
  142597. /**
  142598. * Gets the current class name
  142599. * @returns the class name
  142600. */
  142601. getClassName(): string;
  142602. /**
  142603. * Gets the left operand input component
  142604. */
  142605. get left(): NodeMaterialConnectionPoint;
  142606. /**
  142607. * Gets the right operand input component
  142608. */
  142609. get right(): NodeMaterialConnectionPoint;
  142610. /**
  142611. * Gets the output component
  142612. */
  142613. get output(): NodeMaterialConnectionPoint;
  142614. protected _buildBlock(state: NodeMaterialBuildState): this;
  142615. }
  142616. }
  142617. declare module BABYLON {
  142618. /**
  142619. * Block used to normalize a vector
  142620. */
  142621. export class NormalizeBlock extends NodeMaterialBlock {
  142622. /**
  142623. * Creates a new NormalizeBlock
  142624. * @param name defines the block name
  142625. */
  142626. constructor(name: string);
  142627. /**
  142628. * Gets the current class name
  142629. * @returns the class name
  142630. */
  142631. getClassName(): string;
  142632. /**
  142633. * Gets the input component
  142634. */
  142635. get input(): NodeMaterialConnectionPoint;
  142636. /**
  142637. * Gets the output component
  142638. */
  142639. get output(): NodeMaterialConnectionPoint;
  142640. protected _buildBlock(state: NodeMaterialBuildState): this;
  142641. }
  142642. }
  142643. declare module BABYLON {
  142644. /**
  142645. * Operations supported by the Trigonometry block
  142646. */
  142647. export enum TrigonometryBlockOperations {
  142648. /** Cos */
  142649. Cos = 0,
  142650. /** Sin */
  142651. Sin = 1,
  142652. /** Abs */
  142653. Abs = 2,
  142654. /** Exp */
  142655. Exp = 3,
  142656. /** Exp2 */
  142657. Exp2 = 4,
  142658. /** Round */
  142659. Round = 5,
  142660. /** Floor */
  142661. Floor = 6,
  142662. /** Ceiling */
  142663. Ceiling = 7,
  142664. /** Square root */
  142665. Sqrt = 8,
  142666. /** Log */
  142667. Log = 9,
  142668. /** Tangent */
  142669. Tan = 10,
  142670. /** Arc tangent */
  142671. ArcTan = 11,
  142672. /** Arc cosinus */
  142673. ArcCos = 12,
  142674. /** Arc sinus */
  142675. ArcSin = 13,
  142676. /** Fraction */
  142677. Fract = 14,
  142678. /** Sign */
  142679. Sign = 15,
  142680. /** To radians (from degrees) */
  142681. Radians = 16,
  142682. /** To degrees (from radians) */
  142683. Degrees = 17
  142684. }
  142685. /**
  142686. * Block used to apply trigonometry operation to floats
  142687. */
  142688. export class TrigonometryBlock extends NodeMaterialBlock {
  142689. /**
  142690. * Gets or sets the operation applied by the block
  142691. */
  142692. operation: TrigonometryBlockOperations;
  142693. /**
  142694. * Creates a new TrigonometryBlock
  142695. * @param name defines the block name
  142696. */
  142697. constructor(name: string);
  142698. /**
  142699. * Gets the current class name
  142700. * @returns the class name
  142701. */
  142702. getClassName(): string;
  142703. /**
  142704. * Gets the input component
  142705. */
  142706. get input(): NodeMaterialConnectionPoint;
  142707. /**
  142708. * Gets the output component
  142709. */
  142710. get output(): NodeMaterialConnectionPoint;
  142711. protected _buildBlock(state: NodeMaterialBuildState): this;
  142712. serialize(): any;
  142713. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142714. protected _dumpPropertiesCode(): string;
  142715. }
  142716. }
  142717. declare module BABYLON {
  142718. /**
  142719. * Block used to create a Color3/4 out of individual inputs (one for each component)
  142720. */
  142721. export class ColorMergerBlock extends NodeMaterialBlock {
  142722. /**
  142723. * Create a new ColorMergerBlock
  142724. * @param name defines the block name
  142725. */
  142726. constructor(name: string);
  142727. /**
  142728. * Gets the current class name
  142729. * @returns the class name
  142730. */
  142731. getClassName(): string;
  142732. /**
  142733. * Gets the rgb component (input)
  142734. */
  142735. get rgbIn(): NodeMaterialConnectionPoint;
  142736. /**
  142737. * Gets the r component (input)
  142738. */
  142739. get r(): NodeMaterialConnectionPoint;
  142740. /**
  142741. * Gets the g component (input)
  142742. */
  142743. get g(): NodeMaterialConnectionPoint;
  142744. /**
  142745. * Gets the b component (input)
  142746. */
  142747. get b(): NodeMaterialConnectionPoint;
  142748. /**
  142749. * Gets the a component (input)
  142750. */
  142751. get a(): NodeMaterialConnectionPoint;
  142752. /**
  142753. * Gets the rgba component (output)
  142754. */
  142755. get rgba(): NodeMaterialConnectionPoint;
  142756. /**
  142757. * Gets the rgb component (output)
  142758. */
  142759. get rgbOut(): NodeMaterialConnectionPoint;
  142760. /**
  142761. * Gets the rgb component (output)
  142762. * @deprecated Please use rgbOut instead.
  142763. */
  142764. get rgb(): NodeMaterialConnectionPoint;
  142765. protected _buildBlock(state: NodeMaterialBuildState): this;
  142766. }
  142767. }
  142768. declare module BABYLON {
  142769. /**
  142770. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  142771. */
  142772. export class VectorSplitterBlock extends NodeMaterialBlock {
  142773. /**
  142774. * Create a new VectorSplitterBlock
  142775. * @param name defines the block name
  142776. */
  142777. constructor(name: string);
  142778. /**
  142779. * Gets the current class name
  142780. * @returns the class name
  142781. */
  142782. getClassName(): string;
  142783. /**
  142784. * Gets the xyzw component (input)
  142785. */
  142786. get xyzw(): NodeMaterialConnectionPoint;
  142787. /**
  142788. * Gets the xyz component (input)
  142789. */
  142790. get xyzIn(): NodeMaterialConnectionPoint;
  142791. /**
  142792. * Gets the xy component (input)
  142793. */
  142794. get xyIn(): NodeMaterialConnectionPoint;
  142795. /**
  142796. * Gets the xyz component (output)
  142797. */
  142798. get xyzOut(): NodeMaterialConnectionPoint;
  142799. /**
  142800. * Gets the xy component (output)
  142801. */
  142802. get xyOut(): NodeMaterialConnectionPoint;
  142803. /**
  142804. * Gets the x component (output)
  142805. */
  142806. get x(): NodeMaterialConnectionPoint;
  142807. /**
  142808. * Gets the y component (output)
  142809. */
  142810. get y(): NodeMaterialConnectionPoint;
  142811. /**
  142812. * Gets the z component (output)
  142813. */
  142814. get z(): NodeMaterialConnectionPoint;
  142815. /**
  142816. * Gets the w component (output)
  142817. */
  142818. get w(): NodeMaterialConnectionPoint;
  142819. protected _inputRename(name: string): string;
  142820. protected _outputRename(name: string): string;
  142821. protected _buildBlock(state: NodeMaterialBuildState): this;
  142822. }
  142823. }
  142824. declare module BABYLON {
  142825. /**
  142826. * Block used to lerp between 2 values
  142827. */
  142828. export class LerpBlock extends NodeMaterialBlock {
  142829. /**
  142830. * Creates a new LerpBlock
  142831. * @param name defines the block name
  142832. */
  142833. constructor(name: string);
  142834. /**
  142835. * Gets the current class name
  142836. * @returns the class name
  142837. */
  142838. getClassName(): string;
  142839. /**
  142840. * Gets the left operand input component
  142841. */
  142842. get left(): NodeMaterialConnectionPoint;
  142843. /**
  142844. * Gets the right operand input component
  142845. */
  142846. get right(): NodeMaterialConnectionPoint;
  142847. /**
  142848. * Gets the gradient operand input component
  142849. */
  142850. get gradient(): NodeMaterialConnectionPoint;
  142851. /**
  142852. * Gets the output component
  142853. */
  142854. get output(): NodeMaterialConnectionPoint;
  142855. protected _buildBlock(state: NodeMaterialBuildState): this;
  142856. }
  142857. }
  142858. declare module BABYLON {
  142859. /**
  142860. * Block used to divide 2 vectors
  142861. */
  142862. export class DivideBlock extends NodeMaterialBlock {
  142863. /**
  142864. * Creates a new DivideBlock
  142865. * @param name defines the block name
  142866. */
  142867. constructor(name: string);
  142868. /**
  142869. * Gets the current class name
  142870. * @returns the class name
  142871. */
  142872. getClassName(): string;
  142873. /**
  142874. * Gets the left operand input component
  142875. */
  142876. get left(): NodeMaterialConnectionPoint;
  142877. /**
  142878. * Gets the right operand input component
  142879. */
  142880. get right(): NodeMaterialConnectionPoint;
  142881. /**
  142882. * Gets the output component
  142883. */
  142884. get output(): NodeMaterialConnectionPoint;
  142885. protected _buildBlock(state: NodeMaterialBuildState): this;
  142886. }
  142887. }
  142888. declare module BABYLON {
  142889. /**
  142890. * Block used to subtract 2 vectors
  142891. */
  142892. export class SubtractBlock extends NodeMaterialBlock {
  142893. /**
  142894. * Creates a new SubtractBlock
  142895. * @param name defines the block name
  142896. */
  142897. constructor(name: string);
  142898. /**
  142899. * Gets the current class name
  142900. * @returns the class name
  142901. */
  142902. getClassName(): string;
  142903. /**
  142904. * Gets the left operand input component
  142905. */
  142906. get left(): NodeMaterialConnectionPoint;
  142907. /**
  142908. * Gets the right operand input component
  142909. */
  142910. get right(): NodeMaterialConnectionPoint;
  142911. /**
  142912. * Gets the output component
  142913. */
  142914. get output(): NodeMaterialConnectionPoint;
  142915. protected _buildBlock(state: NodeMaterialBuildState): this;
  142916. }
  142917. }
  142918. declare module BABYLON {
  142919. /**
  142920. * Block used to step a value
  142921. */
  142922. export class StepBlock extends NodeMaterialBlock {
  142923. /**
  142924. * Creates a new StepBlock
  142925. * @param name defines the block name
  142926. */
  142927. constructor(name: string);
  142928. /**
  142929. * Gets the current class name
  142930. * @returns the class name
  142931. */
  142932. getClassName(): string;
  142933. /**
  142934. * Gets the value operand input component
  142935. */
  142936. get value(): NodeMaterialConnectionPoint;
  142937. /**
  142938. * Gets the edge operand input component
  142939. */
  142940. get edge(): NodeMaterialConnectionPoint;
  142941. /**
  142942. * Gets the output component
  142943. */
  142944. get output(): NodeMaterialConnectionPoint;
  142945. protected _buildBlock(state: NodeMaterialBuildState): this;
  142946. }
  142947. }
  142948. declare module BABYLON {
  142949. /**
  142950. * Block used to get the opposite (1 - x) of a value
  142951. */
  142952. export class OneMinusBlock extends NodeMaterialBlock {
  142953. /**
  142954. * Creates a new OneMinusBlock
  142955. * @param name defines the block name
  142956. */
  142957. constructor(name: string);
  142958. /**
  142959. * Gets the current class name
  142960. * @returns the class name
  142961. */
  142962. getClassName(): string;
  142963. /**
  142964. * Gets the input component
  142965. */
  142966. get input(): NodeMaterialConnectionPoint;
  142967. /**
  142968. * Gets the output component
  142969. */
  142970. get output(): NodeMaterialConnectionPoint;
  142971. protected _buildBlock(state: NodeMaterialBuildState): this;
  142972. }
  142973. }
  142974. declare module BABYLON {
  142975. /**
  142976. * Block used to get the view direction
  142977. */
  142978. export class ViewDirectionBlock extends NodeMaterialBlock {
  142979. /**
  142980. * Creates a new ViewDirectionBlock
  142981. * @param name defines the block name
  142982. */
  142983. constructor(name: string);
  142984. /**
  142985. * Gets the current class name
  142986. * @returns the class name
  142987. */
  142988. getClassName(): string;
  142989. /**
  142990. * Gets the world position component
  142991. */
  142992. get worldPosition(): NodeMaterialConnectionPoint;
  142993. /**
  142994. * Gets the camera position component
  142995. */
  142996. get cameraPosition(): NodeMaterialConnectionPoint;
  142997. /**
  142998. * Gets the output component
  142999. */
  143000. get output(): NodeMaterialConnectionPoint;
  143001. autoConfigure(material: NodeMaterial): void;
  143002. protected _buildBlock(state: NodeMaterialBuildState): this;
  143003. }
  143004. }
  143005. declare module BABYLON {
  143006. /**
  143007. * Block used to compute fresnel value
  143008. */
  143009. export class FresnelBlock extends NodeMaterialBlock {
  143010. /**
  143011. * Create a new FresnelBlock
  143012. * @param name defines the block name
  143013. */
  143014. constructor(name: string);
  143015. /**
  143016. * Gets the current class name
  143017. * @returns the class name
  143018. */
  143019. getClassName(): string;
  143020. /**
  143021. * Gets the world normal input component
  143022. */
  143023. get worldNormal(): NodeMaterialConnectionPoint;
  143024. /**
  143025. * Gets the view direction input component
  143026. */
  143027. get viewDirection(): NodeMaterialConnectionPoint;
  143028. /**
  143029. * Gets the bias input component
  143030. */
  143031. get bias(): NodeMaterialConnectionPoint;
  143032. /**
  143033. * Gets the camera (or eye) position component
  143034. */
  143035. get power(): NodeMaterialConnectionPoint;
  143036. /**
  143037. * Gets the fresnel output component
  143038. */
  143039. get fresnel(): NodeMaterialConnectionPoint;
  143040. autoConfigure(material: NodeMaterial): void;
  143041. protected _buildBlock(state: NodeMaterialBuildState): this;
  143042. }
  143043. }
  143044. declare module BABYLON {
  143045. /**
  143046. * Block used to get the max of 2 values
  143047. */
  143048. export class MaxBlock extends NodeMaterialBlock {
  143049. /**
  143050. * Creates a new MaxBlock
  143051. * @param name defines the block name
  143052. */
  143053. constructor(name: string);
  143054. /**
  143055. * Gets the current class name
  143056. * @returns the class name
  143057. */
  143058. getClassName(): string;
  143059. /**
  143060. * Gets the left operand input component
  143061. */
  143062. get left(): NodeMaterialConnectionPoint;
  143063. /**
  143064. * Gets the right operand input component
  143065. */
  143066. get right(): NodeMaterialConnectionPoint;
  143067. /**
  143068. * Gets the output component
  143069. */
  143070. get output(): NodeMaterialConnectionPoint;
  143071. protected _buildBlock(state: NodeMaterialBuildState): this;
  143072. }
  143073. }
  143074. declare module BABYLON {
  143075. /**
  143076. * Block used to get the min of 2 values
  143077. */
  143078. export class MinBlock extends NodeMaterialBlock {
  143079. /**
  143080. * Creates a new MinBlock
  143081. * @param name defines the block name
  143082. */
  143083. constructor(name: string);
  143084. /**
  143085. * Gets the current class name
  143086. * @returns the class name
  143087. */
  143088. getClassName(): string;
  143089. /**
  143090. * Gets the left operand input component
  143091. */
  143092. get left(): NodeMaterialConnectionPoint;
  143093. /**
  143094. * Gets the right operand input component
  143095. */
  143096. get right(): NodeMaterialConnectionPoint;
  143097. /**
  143098. * Gets the output component
  143099. */
  143100. get output(): NodeMaterialConnectionPoint;
  143101. protected _buildBlock(state: NodeMaterialBuildState): this;
  143102. }
  143103. }
  143104. declare module BABYLON {
  143105. /**
  143106. * Block used to get the distance between 2 values
  143107. */
  143108. export class DistanceBlock extends NodeMaterialBlock {
  143109. /**
  143110. * Creates a new DistanceBlock
  143111. * @param name defines the block name
  143112. */
  143113. constructor(name: string);
  143114. /**
  143115. * Gets the current class name
  143116. * @returns the class name
  143117. */
  143118. getClassName(): string;
  143119. /**
  143120. * Gets the left operand input component
  143121. */
  143122. get left(): NodeMaterialConnectionPoint;
  143123. /**
  143124. * Gets the right operand input component
  143125. */
  143126. get right(): NodeMaterialConnectionPoint;
  143127. /**
  143128. * Gets the output component
  143129. */
  143130. get output(): NodeMaterialConnectionPoint;
  143131. protected _buildBlock(state: NodeMaterialBuildState): this;
  143132. }
  143133. }
  143134. declare module BABYLON {
  143135. /**
  143136. * Block used to get the length of a vector
  143137. */
  143138. export class LengthBlock extends NodeMaterialBlock {
  143139. /**
  143140. * Creates a new LengthBlock
  143141. * @param name defines the block name
  143142. */
  143143. constructor(name: string);
  143144. /**
  143145. * Gets the current class name
  143146. * @returns the class name
  143147. */
  143148. getClassName(): string;
  143149. /**
  143150. * Gets the value input component
  143151. */
  143152. get value(): NodeMaterialConnectionPoint;
  143153. /**
  143154. * Gets the output component
  143155. */
  143156. get output(): NodeMaterialConnectionPoint;
  143157. protected _buildBlock(state: NodeMaterialBuildState): this;
  143158. }
  143159. }
  143160. declare module BABYLON {
  143161. /**
  143162. * Block used to get negative version of a value (i.e. x * -1)
  143163. */
  143164. export class NegateBlock extends NodeMaterialBlock {
  143165. /**
  143166. * Creates a new NegateBlock
  143167. * @param name defines the block name
  143168. */
  143169. constructor(name: string);
  143170. /**
  143171. * Gets the current class name
  143172. * @returns the class name
  143173. */
  143174. getClassName(): string;
  143175. /**
  143176. * Gets the value input component
  143177. */
  143178. get value(): NodeMaterialConnectionPoint;
  143179. /**
  143180. * Gets the output component
  143181. */
  143182. get output(): NodeMaterialConnectionPoint;
  143183. protected _buildBlock(state: NodeMaterialBuildState): this;
  143184. }
  143185. }
  143186. declare module BABYLON {
  143187. /**
  143188. * Block used to get the value of the first parameter raised to the power of the second
  143189. */
  143190. export class PowBlock extends NodeMaterialBlock {
  143191. /**
  143192. * Creates a new PowBlock
  143193. * @param name defines the block name
  143194. */
  143195. constructor(name: string);
  143196. /**
  143197. * Gets the current class name
  143198. * @returns the class name
  143199. */
  143200. getClassName(): string;
  143201. /**
  143202. * Gets the value operand input component
  143203. */
  143204. get value(): NodeMaterialConnectionPoint;
  143205. /**
  143206. * Gets the power operand input component
  143207. */
  143208. get power(): NodeMaterialConnectionPoint;
  143209. /**
  143210. * Gets the output component
  143211. */
  143212. get output(): NodeMaterialConnectionPoint;
  143213. protected _buildBlock(state: NodeMaterialBuildState): this;
  143214. }
  143215. }
  143216. declare module BABYLON {
  143217. /**
  143218. * Block used to get a random number
  143219. */
  143220. export class RandomNumberBlock extends NodeMaterialBlock {
  143221. /**
  143222. * Creates a new RandomNumberBlock
  143223. * @param name defines the block name
  143224. */
  143225. constructor(name: string);
  143226. /**
  143227. * Gets the current class name
  143228. * @returns the class name
  143229. */
  143230. getClassName(): string;
  143231. /**
  143232. * Gets the seed input component
  143233. */
  143234. get seed(): NodeMaterialConnectionPoint;
  143235. /**
  143236. * Gets the output component
  143237. */
  143238. get output(): NodeMaterialConnectionPoint;
  143239. protected _buildBlock(state: NodeMaterialBuildState): this;
  143240. }
  143241. }
  143242. declare module BABYLON {
  143243. /**
  143244. * Block used to compute arc tangent of 2 values
  143245. */
  143246. export class ArcTan2Block extends NodeMaterialBlock {
  143247. /**
  143248. * Creates a new ArcTan2Block
  143249. * @param name defines the block name
  143250. */
  143251. constructor(name: string);
  143252. /**
  143253. * Gets the current class name
  143254. * @returns the class name
  143255. */
  143256. getClassName(): string;
  143257. /**
  143258. * Gets the x operand input component
  143259. */
  143260. get x(): NodeMaterialConnectionPoint;
  143261. /**
  143262. * Gets the y operand input component
  143263. */
  143264. get y(): NodeMaterialConnectionPoint;
  143265. /**
  143266. * Gets the output component
  143267. */
  143268. get output(): NodeMaterialConnectionPoint;
  143269. protected _buildBlock(state: NodeMaterialBuildState): this;
  143270. }
  143271. }
  143272. declare module BABYLON {
  143273. /**
  143274. * Block used to smooth step a value
  143275. */
  143276. export class SmoothStepBlock extends NodeMaterialBlock {
  143277. /**
  143278. * Creates a new SmoothStepBlock
  143279. * @param name defines the block name
  143280. */
  143281. constructor(name: string);
  143282. /**
  143283. * Gets the current class name
  143284. * @returns the class name
  143285. */
  143286. getClassName(): string;
  143287. /**
  143288. * Gets the value operand input component
  143289. */
  143290. get value(): NodeMaterialConnectionPoint;
  143291. /**
  143292. * Gets the first edge operand input component
  143293. */
  143294. get edge0(): NodeMaterialConnectionPoint;
  143295. /**
  143296. * Gets the second edge operand input component
  143297. */
  143298. get edge1(): NodeMaterialConnectionPoint;
  143299. /**
  143300. * Gets the output component
  143301. */
  143302. get output(): NodeMaterialConnectionPoint;
  143303. protected _buildBlock(state: NodeMaterialBuildState): this;
  143304. }
  143305. }
  143306. declare module BABYLON {
  143307. /**
  143308. * Block used to get the reciprocal (1 / x) of a value
  143309. */
  143310. export class ReciprocalBlock extends NodeMaterialBlock {
  143311. /**
  143312. * Creates a new ReciprocalBlock
  143313. * @param name defines the block name
  143314. */
  143315. constructor(name: string);
  143316. /**
  143317. * Gets the current class name
  143318. * @returns the class name
  143319. */
  143320. getClassName(): string;
  143321. /**
  143322. * Gets the input component
  143323. */
  143324. get input(): NodeMaterialConnectionPoint;
  143325. /**
  143326. * Gets the output component
  143327. */
  143328. get output(): NodeMaterialConnectionPoint;
  143329. protected _buildBlock(state: NodeMaterialBuildState): this;
  143330. }
  143331. }
  143332. declare module BABYLON {
  143333. /**
  143334. * Block used to replace a color by another one
  143335. */
  143336. export class ReplaceColorBlock extends NodeMaterialBlock {
  143337. /**
  143338. * Creates a new ReplaceColorBlock
  143339. * @param name defines the block name
  143340. */
  143341. constructor(name: string);
  143342. /**
  143343. * Gets the current class name
  143344. * @returns the class name
  143345. */
  143346. getClassName(): string;
  143347. /**
  143348. * Gets the value input component
  143349. */
  143350. get value(): NodeMaterialConnectionPoint;
  143351. /**
  143352. * Gets the reference input component
  143353. */
  143354. get reference(): NodeMaterialConnectionPoint;
  143355. /**
  143356. * Gets the distance input component
  143357. */
  143358. get distance(): NodeMaterialConnectionPoint;
  143359. /**
  143360. * Gets the replacement input component
  143361. */
  143362. get replacement(): NodeMaterialConnectionPoint;
  143363. /**
  143364. * Gets the output component
  143365. */
  143366. get output(): NodeMaterialConnectionPoint;
  143367. protected _buildBlock(state: NodeMaterialBuildState): this;
  143368. }
  143369. }
  143370. declare module BABYLON {
  143371. /**
  143372. * Block used to posterize a value
  143373. * @see https://en.wikipedia.org/wiki/Posterization
  143374. */
  143375. export class PosterizeBlock extends NodeMaterialBlock {
  143376. /**
  143377. * Creates a new PosterizeBlock
  143378. * @param name defines the block name
  143379. */
  143380. constructor(name: string);
  143381. /**
  143382. * Gets the current class name
  143383. * @returns the class name
  143384. */
  143385. getClassName(): string;
  143386. /**
  143387. * Gets the value input component
  143388. */
  143389. get value(): NodeMaterialConnectionPoint;
  143390. /**
  143391. * Gets the steps input component
  143392. */
  143393. get steps(): NodeMaterialConnectionPoint;
  143394. /**
  143395. * Gets the output component
  143396. */
  143397. get output(): NodeMaterialConnectionPoint;
  143398. protected _buildBlock(state: NodeMaterialBuildState): this;
  143399. }
  143400. }
  143401. declare module BABYLON {
  143402. /**
  143403. * Operations supported by the Wave block
  143404. */
  143405. export enum WaveBlockKind {
  143406. /** SawTooth */
  143407. SawTooth = 0,
  143408. /** Square */
  143409. Square = 1,
  143410. /** Triangle */
  143411. Triangle = 2
  143412. }
  143413. /**
  143414. * Block used to apply wave operation to floats
  143415. */
  143416. export class WaveBlock extends NodeMaterialBlock {
  143417. /**
  143418. * Gets or sets the kibnd of wave to be applied by the block
  143419. */
  143420. kind: WaveBlockKind;
  143421. /**
  143422. * Creates a new WaveBlock
  143423. * @param name defines the block name
  143424. */
  143425. constructor(name: string);
  143426. /**
  143427. * Gets the current class name
  143428. * @returns the class name
  143429. */
  143430. getClassName(): string;
  143431. /**
  143432. * Gets the input component
  143433. */
  143434. get input(): NodeMaterialConnectionPoint;
  143435. /**
  143436. * Gets the output component
  143437. */
  143438. get output(): NodeMaterialConnectionPoint;
  143439. protected _buildBlock(state: NodeMaterialBuildState): this;
  143440. serialize(): any;
  143441. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143442. }
  143443. }
  143444. declare module BABYLON {
  143445. /**
  143446. * Class used to store a color step for the GradientBlock
  143447. */
  143448. export class GradientBlockColorStep {
  143449. /**
  143450. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143451. */
  143452. step: number;
  143453. /**
  143454. * Gets or sets the color associated with this step
  143455. */
  143456. color: Color3;
  143457. /**
  143458. * Creates a new GradientBlockColorStep
  143459. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  143460. * @param color defines the color associated with this step
  143461. */
  143462. constructor(
  143463. /**
  143464. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143465. */
  143466. step: number,
  143467. /**
  143468. * Gets or sets the color associated with this step
  143469. */
  143470. color: Color3);
  143471. }
  143472. /**
  143473. * Block used to return a color from a gradient based on an input value between 0 and 1
  143474. */
  143475. export class GradientBlock extends NodeMaterialBlock {
  143476. /**
  143477. * Gets or sets the list of color steps
  143478. */
  143479. colorSteps: GradientBlockColorStep[];
  143480. /**
  143481. * Creates a new GradientBlock
  143482. * @param name defines the block name
  143483. */
  143484. constructor(name: string);
  143485. /**
  143486. * Gets the current class name
  143487. * @returns the class name
  143488. */
  143489. getClassName(): string;
  143490. /**
  143491. * Gets the gradient input component
  143492. */
  143493. get gradient(): NodeMaterialConnectionPoint;
  143494. /**
  143495. * Gets the output component
  143496. */
  143497. get output(): NodeMaterialConnectionPoint;
  143498. private _writeColorConstant;
  143499. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143500. serialize(): any;
  143501. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143502. protected _dumpPropertiesCode(): string;
  143503. }
  143504. }
  143505. declare module BABYLON {
  143506. /**
  143507. * Block used to normalize lerp between 2 values
  143508. */
  143509. export class NLerpBlock extends NodeMaterialBlock {
  143510. /**
  143511. * Creates a new NLerpBlock
  143512. * @param name defines the block name
  143513. */
  143514. constructor(name: string);
  143515. /**
  143516. * Gets the current class name
  143517. * @returns the class name
  143518. */
  143519. getClassName(): string;
  143520. /**
  143521. * Gets the left operand input component
  143522. */
  143523. get left(): NodeMaterialConnectionPoint;
  143524. /**
  143525. * Gets the right operand input component
  143526. */
  143527. get right(): NodeMaterialConnectionPoint;
  143528. /**
  143529. * Gets the gradient operand input component
  143530. */
  143531. get gradient(): NodeMaterialConnectionPoint;
  143532. /**
  143533. * Gets the output component
  143534. */
  143535. get output(): NodeMaterialConnectionPoint;
  143536. protected _buildBlock(state: NodeMaterialBuildState): this;
  143537. }
  143538. }
  143539. declare module BABYLON {
  143540. /**
  143541. * block used to Generate a Worley Noise 3D Noise Pattern
  143542. */
  143543. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  143544. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  143545. manhattanDistance: boolean;
  143546. /**
  143547. * Creates a new WorleyNoise3DBlock
  143548. * @param name defines the block name
  143549. */
  143550. constructor(name: string);
  143551. /**
  143552. * Gets the current class name
  143553. * @returns the class name
  143554. */
  143555. getClassName(): string;
  143556. /**
  143557. * Gets the seed input component
  143558. */
  143559. get seed(): NodeMaterialConnectionPoint;
  143560. /**
  143561. * Gets the jitter input component
  143562. */
  143563. get jitter(): NodeMaterialConnectionPoint;
  143564. /**
  143565. * Gets the output component
  143566. */
  143567. get output(): NodeMaterialConnectionPoint;
  143568. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143569. /**
  143570. * Exposes the properties to the UI?
  143571. */
  143572. protected _dumpPropertiesCode(): string;
  143573. /**
  143574. * Exposes the properties to the Seralize?
  143575. */
  143576. serialize(): any;
  143577. /**
  143578. * Exposes the properties to the deseralize?
  143579. */
  143580. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143581. }
  143582. }
  143583. declare module BABYLON {
  143584. /**
  143585. * block used to Generate a Simplex Perlin 3d Noise Pattern
  143586. */
  143587. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  143588. /**
  143589. * Creates a new SimplexPerlin3DBlock
  143590. * @param name defines the block name
  143591. */
  143592. constructor(name: string);
  143593. /**
  143594. * Gets the current class name
  143595. * @returns the class name
  143596. */
  143597. getClassName(): string;
  143598. /**
  143599. * Gets the seed operand input component
  143600. */
  143601. get seed(): NodeMaterialConnectionPoint;
  143602. /**
  143603. * Gets the output component
  143604. */
  143605. get output(): NodeMaterialConnectionPoint;
  143606. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143607. }
  143608. }
  143609. declare module BABYLON {
  143610. /**
  143611. * Block used to blend normals
  143612. */
  143613. export class NormalBlendBlock extends NodeMaterialBlock {
  143614. /**
  143615. * Creates a new NormalBlendBlock
  143616. * @param name defines the block name
  143617. */
  143618. constructor(name: string);
  143619. /**
  143620. * Gets the current class name
  143621. * @returns the class name
  143622. */
  143623. getClassName(): string;
  143624. /**
  143625. * Gets the first input component
  143626. */
  143627. get normalMap0(): NodeMaterialConnectionPoint;
  143628. /**
  143629. * Gets the second input component
  143630. */
  143631. get normalMap1(): NodeMaterialConnectionPoint;
  143632. /**
  143633. * Gets the output component
  143634. */
  143635. get output(): NodeMaterialConnectionPoint;
  143636. protected _buildBlock(state: NodeMaterialBuildState): this;
  143637. }
  143638. }
  143639. declare module BABYLON {
  143640. /**
  143641. * Block used to rotate a 2d vector by a given angle
  143642. */
  143643. export class Rotate2dBlock extends NodeMaterialBlock {
  143644. /**
  143645. * Creates a new Rotate2dBlock
  143646. * @param name defines the block name
  143647. */
  143648. constructor(name: string);
  143649. /**
  143650. * Gets the current class name
  143651. * @returns the class name
  143652. */
  143653. getClassName(): string;
  143654. /**
  143655. * Gets the input vector
  143656. */
  143657. get input(): NodeMaterialConnectionPoint;
  143658. /**
  143659. * Gets the input angle
  143660. */
  143661. get angle(): NodeMaterialConnectionPoint;
  143662. /**
  143663. * Gets the output component
  143664. */
  143665. get output(): NodeMaterialConnectionPoint;
  143666. autoConfigure(material: NodeMaterial): void;
  143667. protected _buildBlock(state: NodeMaterialBuildState): this;
  143668. }
  143669. }
  143670. declare module BABYLON {
  143671. /**
  143672. * Block used to get the reflected vector from a direction and a normal
  143673. */
  143674. export class ReflectBlock extends NodeMaterialBlock {
  143675. /**
  143676. * Creates a new ReflectBlock
  143677. * @param name defines the block name
  143678. */
  143679. constructor(name: string);
  143680. /**
  143681. * Gets the current class name
  143682. * @returns the class name
  143683. */
  143684. getClassName(): string;
  143685. /**
  143686. * Gets the incident component
  143687. */
  143688. get incident(): NodeMaterialConnectionPoint;
  143689. /**
  143690. * Gets the normal component
  143691. */
  143692. get normal(): NodeMaterialConnectionPoint;
  143693. /**
  143694. * Gets the output component
  143695. */
  143696. get output(): NodeMaterialConnectionPoint;
  143697. protected _buildBlock(state: NodeMaterialBuildState): this;
  143698. }
  143699. }
  143700. declare module BABYLON {
  143701. /**
  143702. * Block used to get the refracted vector from a direction and a normal
  143703. */
  143704. export class RefractBlock extends NodeMaterialBlock {
  143705. /**
  143706. * Creates a new RefractBlock
  143707. * @param name defines the block name
  143708. */
  143709. constructor(name: string);
  143710. /**
  143711. * Gets the current class name
  143712. * @returns the class name
  143713. */
  143714. getClassName(): string;
  143715. /**
  143716. * Gets the incident component
  143717. */
  143718. get incident(): NodeMaterialConnectionPoint;
  143719. /**
  143720. * Gets the normal component
  143721. */
  143722. get normal(): NodeMaterialConnectionPoint;
  143723. /**
  143724. * Gets the index of refraction component
  143725. */
  143726. get ior(): NodeMaterialConnectionPoint;
  143727. /**
  143728. * Gets the output component
  143729. */
  143730. get output(): NodeMaterialConnectionPoint;
  143731. protected _buildBlock(state: NodeMaterialBuildState): this;
  143732. }
  143733. }
  143734. declare module BABYLON {
  143735. /**
  143736. * Block used to desaturate a color
  143737. */
  143738. export class DesaturateBlock extends NodeMaterialBlock {
  143739. /**
  143740. * Creates a new DesaturateBlock
  143741. * @param name defines the block name
  143742. */
  143743. constructor(name: string);
  143744. /**
  143745. * Gets the current class name
  143746. * @returns the class name
  143747. */
  143748. getClassName(): string;
  143749. /**
  143750. * Gets the color operand input component
  143751. */
  143752. get color(): NodeMaterialConnectionPoint;
  143753. /**
  143754. * Gets the level operand input component
  143755. */
  143756. get level(): NodeMaterialConnectionPoint;
  143757. /**
  143758. * Gets the output component
  143759. */
  143760. get output(): NodeMaterialConnectionPoint;
  143761. protected _buildBlock(state: NodeMaterialBuildState): this;
  143762. }
  143763. }
  143764. declare module BABYLON {
  143765. /**
  143766. * Block used to implement the ambient occlusion module of the PBR material
  143767. */
  143768. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  143769. /**
  143770. * Create a new AmbientOcclusionBlock
  143771. * @param name defines the block name
  143772. */
  143773. constructor(name: string);
  143774. /**
  143775. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  143776. */
  143777. useAmbientInGrayScale: boolean;
  143778. /**
  143779. * Initialize the block and prepare the context for build
  143780. * @param state defines the state that will be used for the build
  143781. */
  143782. initialize(state: NodeMaterialBuildState): void;
  143783. /**
  143784. * Gets the current class name
  143785. * @returns the class name
  143786. */
  143787. getClassName(): string;
  143788. /**
  143789. * Gets the texture input component
  143790. */
  143791. get texture(): NodeMaterialConnectionPoint;
  143792. /**
  143793. * Gets the texture intensity component
  143794. */
  143795. get intensity(): NodeMaterialConnectionPoint;
  143796. /**
  143797. * Gets the direct light intensity input component
  143798. */
  143799. get directLightIntensity(): NodeMaterialConnectionPoint;
  143800. /**
  143801. * Gets the ambient occlusion object output component
  143802. */
  143803. get ambientOcclusion(): NodeMaterialConnectionPoint;
  143804. /**
  143805. * Gets the main code of the block (fragment side)
  143806. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  143807. * @returns the shader code
  143808. */
  143809. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  143810. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143811. protected _buildBlock(state: NodeMaterialBuildState): this;
  143812. protected _dumpPropertiesCode(): string;
  143813. serialize(): any;
  143814. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143815. }
  143816. }
  143817. declare module BABYLON {
  143818. /**
  143819. * Block used to implement the reflection module of the PBR material
  143820. */
  143821. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  143822. /** @hidden */
  143823. _defineLODReflectionAlpha: string;
  143824. /** @hidden */
  143825. _defineLinearSpecularReflection: string;
  143826. private _vEnvironmentIrradianceName;
  143827. /** @hidden */
  143828. _vReflectionMicrosurfaceInfosName: string;
  143829. /** @hidden */
  143830. _vReflectionInfosName: string;
  143831. /** @hidden */
  143832. _vReflectionFilteringInfoName: string;
  143833. private _scene;
  143834. /**
  143835. * The three properties below are set by the main PBR block prior to calling methods of this class.
  143836. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  143837. * It's less burden on the user side in the editor part.
  143838. */
  143839. /** @hidden */
  143840. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  143841. /** @hidden */
  143842. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  143843. /** @hidden */
  143844. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  143845. /**
  143846. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  143847. * diffuse part of the IBL.
  143848. */
  143849. useSphericalHarmonics: boolean;
  143850. /**
  143851. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  143852. */
  143853. forceIrradianceInFragment: boolean;
  143854. /**
  143855. * Create a new ReflectionBlock
  143856. * @param name defines the block name
  143857. */
  143858. constructor(name: string);
  143859. /**
  143860. * Gets the current class name
  143861. * @returns the class name
  143862. */
  143863. getClassName(): string;
  143864. /**
  143865. * Gets the position input component
  143866. */
  143867. get position(): NodeMaterialConnectionPoint;
  143868. /**
  143869. * Gets the world position input component
  143870. */
  143871. get worldPosition(): NodeMaterialConnectionPoint;
  143872. /**
  143873. * Gets the world normal input component
  143874. */
  143875. get worldNormal(): NodeMaterialConnectionPoint;
  143876. /**
  143877. * Gets the world input component
  143878. */
  143879. get world(): NodeMaterialConnectionPoint;
  143880. /**
  143881. * Gets the camera (or eye) position component
  143882. */
  143883. get cameraPosition(): NodeMaterialConnectionPoint;
  143884. /**
  143885. * Gets the view input component
  143886. */
  143887. get view(): NodeMaterialConnectionPoint;
  143888. /**
  143889. * Gets the color input component
  143890. */
  143891. get color(): NodeMaterialConnectionPoint;
  143892. /**
  143893. * Gets the reflection object output component
  143894. */
  143895. get reflection(): NodeMaterialConnectionPoint;
  143896. /**
  143897. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  143898. */
  143899. get hasTexture(): boolean;
  143900. /**
  143901. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  143902. */
  143903. get reflectionColor(): string;
  143904. protected _getTexture(): Nullable<BaseTexture>;
  143905. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143906. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143907. /**
  143908. * Gets the code to inject in the vertex shader
  143909. * @param state current state of the node material building
  143910. * @returns the shader code
  143911. */
  143912. handleVertexSide(state: NodeMaterialBuildState): string;
  143913. /**
  143914. * Gets the main code of the block (fragment side)
  143915. * @param state current state of the node material building
  143916. * @param normalVarName name of the existing variable corresponding to the normal
  143917. * @returns the shader code
  143918. */
  143919. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  143920. protected _buildBlock(state: NodeMaterialBuildState): this;
  143921. protected _dumpPropertiesCode(): string;
  143922. serialize(): any;
  143923. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143924. }
  143925. }
  143926. declare module BABYLON {
  143927. /**
  143928. * Block used to implement the sheen module of the PBR material
  143929. */
  143930. export class SheenBlock extends NodeMaterialBlock {
  143931. /**
  143932. * Create a new SheenBlock
  143933. * @param name defines the block name
  143934. */
  143935. constructor(name: string);
  143936. /**
  143937. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  143938. * It allows the strength of the sheen effect to not depend on the base color of the material,
  143939. * making it easier to setup and tweak the effect
  143940. */
  143941. albedoScaling: boolean;
  143942. /**
  143943. * Defines if the sheen is linked to the sheen color.
  143944. */
  143945. linkSheenWithAlbedo: boolean;
  143946. /**
  143947. * Initialize the block and prepare the context for build
  143948. * @param state defines the state that will be used for the build
  143949. */
  143950. initialize(state: NodeMaterialBuildState): void;
  143951. /**
  143952. * Gets the current class name
  143953. * @returns the class name
  143954. */
  143955. getClassName(): string;
  143956. /**
  143957. * Gets the intensity input component
  143958. */
  143959. get intensity(): NodeMaterialConnectionPoint;
  143960. /**
  143961. * Gets the color input component
  143962. */
  143963. get color(): NodeMaterialConnectionPoint;
  143964. /**
  143965. * Gets the roughness input component
  143966. */
  143967. get roughness(): NodeMaterialConnectionPoint;
  143968. /**
  143969. * Gets the sheen object output component
  143970. */
  143971. get sheen(): NodeMaterialConnectionPoint;
  143972. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143973. /**
  143974. * Gets the main code of the block (fragment side)
  143975. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  143976. * @returns the shader code
  143977. */
  143978. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  143979. protected _buildBlock(state: NodeMaterialBuildState): this;
  143980. protected _dumpPropertiesCode(): string;
  143981. serialize(): any;
  143982. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143983. }
  143984. }
  143985. declare module BABYLON {
  143986. /**
  143987. * Block used to implement the reflectivity module of the PBR material
  143988. */
  143989. export class ReflectivityBlock extends NodeMaterialBlock {
  143990. private _metallicReflectanceColor;
  143991. private _metallicF0Factor;
  143992. /** @hidden */
  143993. _vMetallicReflectanceFactorsName: string;
  143994. /**
  143995. * The property below is set by the main PBR block prior to calling methods of this class.
  143996. */
  143997. /** @hidden */
  143998. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  143999. /**
  144000. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  144001. */
  144002. useAmbientOcclusionFromMetallicTextureRed: boolean;
  144003. /**
  144004. * Specifies if the metallic texture contains the metallness information in its blue channel.
  144005. */
  144006. useMetallnessFromMetallicTextureBlue: boolean;
  144007. /**
  144008. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  144009. */
  144010. useRoughnessFromMetallicTextureAlpha: boolean;
  144011. /**
  144012. * Specifies if the metallic texture contains the roughness information in its green channel.
  144013. */
  144014. useRoughnessFromMetallicTextureGreen: boolean;
  144015. /**
  144016. * Create a new ReflectivityBlock
  144017. * @param name defines the block name
  144018. */
  144019. constructor(name: string);
  144020. /**
  144021. * Initialize the block and prepare the context for build
  144022. * @param state defines the state that will be used for the build
  144023. */
  144024. initialize(state: NodeMaterialBuildState): void;
  144025. /**
  144026. * Gets the current class name
  144027. * @returns the class name
  144028. */
  144029. getClassName(): string;
  144030. /**
  144031. * Gets the metallic input component
  144032. */
  144033. get metallic(): NodeMaterialConnectionPoint;
  144034. /**
  144035. * Gets the roughness input component
  144036. */
  144037. get roughness(): NodeMaterialConnectionPoint;
  144038. /**
  144039. * Gets the texture input component
  144040. */
  144041. get texture(): NodeMaterialConnectionPoint;
  144042. /**
  144043. * Gets the reflectivity object output component
  144044. */
  144045. get reflectivity(): NodeMaterialConnectionPoint;
  144046. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144047. /**
  144048. * Gets the main code of the block (fragment side)
  144049. * @param state current state of the node material building
  144050. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  144051. * @returns the shader code
  144052. */
  144053. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  144054. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144055. protected _buildBlock(state: NodeMaterialBuildState): this;
  144056. protected _dumpPropertiesCode(): string;
  144057. serialize(): any;
  144058. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144059. }
  144060. }
  144061. declare module BABYLON {
  144062. /**
  144063. * Block used to implement the anisotropy module of the PBR material
  144064. */
  144065. export class AnisotropyBlock extends NodeMaterialBlock {
  144066. /**
  144067. * The two properties below are set by the main PBR block prior to calling methods of this class.
  144068. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144069. * It's less burden on the user side in the editor part.
  144070. */
  144071. /** @hidden */
  144072. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144073. /** @hidden */
  144074. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144075. /**
  144076. * Create a new AnisotropyBlock
  144077. * @param name defines the block name
  144078. */
  144079. constructor(name: string);
  144080. /**
  144081. * Initialize the block and prepare the context for build
  144082. * @param state defines the state that will be used for the build
  144083. */
  144084. initialize(state: NodeMaterialBuildState): void;
  144085. /**
  144086. * Gets the current class name
  144087. * @returns the class name
  144088. */
  144089. getClassName(): string;
  144090. /**
  144091. * Gets the intensity input component
  144092. */
  144093. get intensity(): NodeMaterialConnectionPoint;
  144094. /**
  144095. * Gets the direction input component
  144096. */
  144097. get direction(): NodeMaterialConnectionPoint;
  144098. /**
  144099. * Gets the texture input component
  144100. */
  144101. get texture(): NodeMaterialConnectionPoint;
  144102. /**
  144103. * Gets the uv input component
  144104. */
  144105. get uv(): NodeMaterialConnectionPoint;
  144106. /**
  144107. * Gets the worldTangent input component
  144108. */
  144109. get worldTangent(): NodeMaterialConnectionPoint;
  144110. /**
  144111. * Gets the anisotropy object output component
  144112. */
  144113. get anisotropy(): NodeMaterialConnectionPoint;
  144114. private _generateTBNSpace;
  144115. /**
  144116. * Gets the main code of the block (fragment side)
  144117. * @param state current state of the node material building
  144118. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144119. * @returns the shader code
  144120. */
  144121. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  144122. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144123. protected _buildBlock(state: NodeMaterialBuildState): this;
  144124. }
  144125. }
  144126. declare module BABYLON {
  144127. /**
  144128. * Block used to implement the clear coat module of the PBR material
  144129. */
  144130. export class ClearCoatBlock extends NodeMaterialBlock {
  144131. private _scene;
  144132. /**
  144133. * Create a new ClearCoatBlock
  144134. * @param name defines the block name
  144135. */
  144136. constructor(name: string);
  144137. /**
  144138. * Initialize the block and prepare the context for build
  144139. * @param state defines the state that will be used for the build
  144140. */
  144141. initialize(state: NodeMaterialBuildState): void;
  144142. /**
  144143. * Gets the current class name
  144144. * @returns the class name
  144145. */
  144146. getClassName(): string;
  144147. /**
  144148. * Gets the intensity input component
  144149. */
  144150. get intensity(): NodeMaterialConnectionPoint;
  144151. /**
  144152. * Gets the roughness input component
  144153. */
  144154. get roughness(): NodeMaterialConnectionPoint;
  144155. /**
  144156. * Gets the ior input component
  144157. */
  144158. get ior(): NodeMaterialConnectionPoint;
  144159. /**
  144160. * Gets the texture input component
  144161. */
  144162. get texture(): NodeMaterialConnectionPoint;
  144163. /**
  144164. * Gets the bump texture input component
  144165. */
  144166. get bumpTexture(): NodeMaterialConnectionPoint;
  144167. /**
  144168. * Gets the uv input component
  144169. */
  144170. get uv(): NodeMaterialConnectionPoint;
  144171. /**
  144172. * Gets the tint color input component
  144173. */
  144174. get tintColor(): NodeMaterialConnectionPoint;
  144175. /**
  144176. * Gets the tint "at distance" input component
  144177. */
  144178. get tintAtDistance(): NodeMaterialConnectionPoint;
  144179. /**
  144180. * Gets the tint thickness input component
  144181. */
  144182. get tintThickness(): NodeMaterialConnectionPoint;
  144183. /**
  144184. * Gets the world tangent input component
  144185. */
  144186. get worldTangent(): NodeMaterialConnectionPoint;
  144187. /**
  144188. * Gets the clear coat object output component
  144189. */
  144190. get clearcoat(): NodeMaterialConnectionPoint;
  144191. autoConfigure(material: NodeMaterial): void;
  144192. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144193. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144194. private _generateTBNSpace;
  144195. /**
  144196. * Gets the main code of the block (fragment side)
  144197. * @param state current state of the node material building
  144198. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  144199. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144200. * @param worldPosVarName name of the variable holding the world position
  144201. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144202. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  144203. * @param worldNormalVarName name of the variable holding the world normal
  144204. * @returns the shader code
  144205. */
  144206. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  144207. protected _buildBlock(state: NodeMaterialBuildState): this;
  144208. }
  144209. }
  144210. declare module BABYLON {
  144211. /**
  144212. * Block used to implement the sub surface module of the PBR material
  144213. */
  144214. export class SubSurfaceBlock extends NodeMaterialBlock {
  144215. /**
  144216. * Create a new SubSurfaceBlock
  144217. * @param name defines the block name
  144218. */
  144219. constructor(name: string);
  144220. /**
  144221. * Stores the intensity of the different subsurface effects in the thickness texture.
  144222. * * the green channel is the translucency intensity.
  144223. * * the blue channel is the scattering intensity.
  144224. * * the alpha channel is the refraction intensity.
  144225. */
  144226. useMaskFromThicknessTexture: boolean;
  144227. /**
  144228. * Initialize the block and prepare the context for build
  144229. * @param state defines the state that will be used for the build
  144230. */
  144231. initialize(state: NodeMaterialBuildState): void;
  144232. /**
  144233. * Gets the current class name
  144234. * @returns the class name
  144235. */
  144236. getClassName(): string;
  144237. /**
  144238. * Gets the min thickness input component
  144239. */
  144240. get minThickness(): NodeMaterialConnectionPoint;
  144241. /**
  144242. * Gets the max thickness input component
  144243. */
  144244. get maxThickness(): NodeMaterialConnectionPoint;
  144245. /**
  144246. * Gets the thickness texture component
  144247. */
  144248. get thicknessTexture(): NodeMaterialConnectionPoint;
  144249. /**
  144250. * Gets the tint color input component
  144251. */
  144252. get tintColor(): NodeMaterialConnectionPoint;
  144253. /**
  144254. * Gets the translucency intensity input component
  144255. */
  144256. get translucencyIntensity(): NodeMaterialConnectionPoint;
  144257. /**
  144258. * Gets the translucency diffusion distance input component
  144259. */
  144260. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  144261. /**
  144262. * Gets the refraction object parameters
  144263. */
  144264. get refraction(): NodeMaterialConnectionPoint;
  144265. /**
  144266. * Gets the sub surface object output component
  144267. */
  144268. get subsurface(): NodeMaterialConnectionPoint;
  144269. autoConfigure(material: NodeMaterial): void;
  144270. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144271. /**
  144272. * Gets the main code of the block (fragment side)
  144273. * @param state current state of the node material building
  144274. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  144275. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144276. * @param worldPosVarName name of the variable holding the world position
  144277. * @returns the shader code
  144278. */
  144279. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  144280. protected _buildBlock(state: NodeMaterialBuildState): this;
  144281. }
  144282. }
  144283. declare module BABYLON {
  144284. /**
  144285. * Block used to implement the PBR metallic/roughness model
  144286. */
  144287. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  144288. /**
  144289. * Gets or sets the light associated with this block
  144290. */
  144291. light: Nullable<Light>;
  144292. private _lightId;
  144293. private _scene;
  144294. private _environmentBRDFTexture;
  144295. private _environmentBrdfSamplerName;
  144296. private _vNormalWName;
  144297. private _invertNormalName;
  144298. /**
  144299. * Create a new ReflectionBlock
  144300. * @param name defines the block name
  144301. */
  144302. constructor(name: string);
  144303. /**
  144304. * Intensity of the direct lights e.g. the four lights available in your scene.
  144305. * This impacts both the direct diffuse and specular highlights.
  144306. */
  144307. directIntensity: number;
  144308. /**
  144309. * Intensity of the environment e.g. how much the environment will light the object
  144310. * either through harmonics for rough material or through the refelction for shiny ones.
  144311. */
  144312. environmentIntensity: number;
  144313. /**
  144314. * This is a special control allowing the reduction of the specular highlights coming from the
  144315. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  144316. */
  144317. specularIntensity: number;
  144318. /**
  144319. * Defines the falloff type used in this material.
  144320. * It by default is Physical.
  144321. */
  144322. lightFalloff: number;
  144323. /**
  144324. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  144325. */
  144326. useAlphaFromAlbedoTexture: boolean;
  144327. /**
  144328. * Specifies that alpha test should be used
  144329. */
  144330. useAlphaTest: boolean;
  144331. /**
  144332. * Defines the alpha limits in alpha test mode.
  144333. */
  144334. alphaTestCutoff: number;
  144335. /**
  144336. * Specifies that alpha blending should be used
  144337. */
  144338. useAlphaBlending: boolean;
  144339. /**
  144340. * Defines if the alpha value should be determined via the rgb values.
  144341. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  144342. */
  144343. opacityRGB: boolean;
  144344. /**
  144345. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  144346. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  144347. */
  144348. useRadianceOverAlpha: boolean;
  144349. /**
  144350. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  144351. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  144352. */
  144353. useSpecularOverAlpha: boolean;
  144354. /**
  144355. * Enables specular anti aliasing in the PBR shader.
  144356. * It will both interacts on the Geometry for analytical and IBL lighting.
  144357. * It also prefilter the roughness map based on the bump values.
  144358. */
  144359. enableSpecularAntiAliasing: boolean;
  144360. /**
  144361. * Enables realtime filtering on the texture.
  144362. */
  144363. realTimeFiltering: boolean;
  144364. /**
  144365. * Quality switch for realtime filtering
  144366. */
  144367. realTimeFilteringQuality: number;
  144368. /**
  144369. * Defines if the material uses energy conservation.
  144370. */
  144371. useEnergyConservation: boolean;
  144372. /**
  144373. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  144374. * too much the area relying on ambient texture to define their ambient occlusion.
  144375. */
  144376. useRadianceOcclusion: boolean;
  144377. /**
  144378. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  144379. * makes the reflect vector face the model (under horizon).
  144380. */
  144381. useHorizonOcclusion: boolean;
  144382. /**
  144383. * If set to true, no lighting calculations will be applied.
  144384. */
  144385. unlit: boolean;
  144386. /**
  144387. * Force normal to face away from face.
  144388. */
  144389. forceNormalForward: boolean;
  144390. /**
  144391. * Defines the material debug mode.
  144392. * It helps seeing only some components of the material while troubleshooting.
  144393. */
  144394. debugMode: number;
  144395. /**
  144396. * Specify from where on screen the debug mode should start.
  144397. * The value goes from -1 (full screen) to 1 (not visible)
  144398. * It helps with side by side comparison against the final render
  144399. * This defaults to 0
  144400. */
  144401. debugLimit: number;
  144402. /**
  144403. * As the default viewing range might not be enough (if the ambient is really small for instance)
  144404. * You can use the factor to better multiply the final value.
  144405. */
  144406. debugFactor: number;
  144407. /**
  144408. * Initialize the block and prepare the context for build
  144409. * @param state defines the state that will be used for the build
  144410. */
  144411. initialize(state: NodeMaterialBuildState): void;
  144412. /**
  144413. * Gets the current class name
  144414. * @returns the class name
  144415. */
  144416. getClassName(): string;
  144417. /**
  144418. * Gets the world position input component
  144419. */
  144420. get worldPosition(): NodeMaterialConnectionPoint;
  144421. /**
  144422. * Gets the world normal input component
  144423. */
  144424. get worldNormal(): NodeMaterialConnectionPoint;
  144425. /**
  144426. * Gets the perturbed normal input component
  144427. */
  144428. get perturbedNormal(): NodeMaterialConnectionPoint;
  144429. /**
  144430. * Gets the camera position input component
  144431. */
  144432. get cameraPosition(): NodeMaterialConnectionPoint;
  144433. /**
  144434. * Gets the base color input component
  144435. */
  144436. get baseColor(): NodeMaterialConnectionPoint;
  144437. /**
  144438. * Gets the opacity texture input component
  144439. */
  144440. get opacityTexture(): NodeMaterialConnectionPoint;
  144441. /**
  144442. * Gets the ambient color input component
  144443. */
  144444. get ambientColor(): NodeMaterialConnectionPoint;
  144445. /**
  144446. * Gets the reflectivity object parameters
  144447. */
  144448. get reflectivity(): NodeMaterialConnectionPoint;
  144449. /**
  144450. * Gets the ambient occlusion object parameters
  144451. */
  144452. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144453. /**
  144454. * Gets the reflection object parameters
  144455. */
  144456. get reflection(): NodeMaterialConnectionPoint;
  144457. /**
  144458. * Gets the sheen object parameters
  144459. */
  144460. get sheen(): NodeMaterialConnectionPoint;
  144461. /**
  144462. * Gets the clear coat object parameters
  144463. */
  144464. get clearcoat(): NodeMaterialConnectionPoint;
  144465. /**
  144466. * Gets the sub surface object parameters
  144467. */
  144468. get subsurface(): NodeMaterialConnectionPoint;
  144469. /**
  144470. * Gets the anisotropy object parameters
  144471. */
  144472. get anisotropy(): NodeMaterialConnectionPoint;
  144473. /**
  144474. * Gets the ambient output component
  144475. */
  144476. get ambient(): NodeMaterialConnectionPoint;
  144477. /**
  144478. * Gets the diffuse output component
  144479. */
  144480. get diffuse(): NodeMaterialConnectionPoint;
  144481. /**
  144482. * Gets the specular output component
  144483. */
  144484. get specular(): NodeMaterialConnectionPoint;
  144485. /**
  144486. * Gets the sheen output component
  144487. */
  144488. get sheenDir(): NodeMaterialConnectionPoint;
  144489. /**
  144490. * Gets the clear coat output component
  144491. */
  144492. get clearcoatDir(): NodeMaterialConnectionPoint;
  144493. /**
  144494. * Gets the indirect diffuse output component
  144495. */
  144496. get diffuseIndirect(): NodeMaterialConnectionPoint;
  144497. /**
  144498. * Gets the indirect specular output component
  144499. */
  144500. get specularIndirect(): NodeMaterialConnectionPoint;
  144501. /**
  144502. * Gets the indirect sheen output component
  144503. */
  144504. get sheenIndirect(): NodeMaterialConnectionPoint;
  144505. /**
  144506. * Gets the indirect clear coat output component
  144507. */
  144508. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  144509. /**
  144510. * Gets the refraction output component
  144511. */
  144512. get refraction(): NodeMaterialConnectionPoint;
  144513. /**
  144514. * Gets the global lighting output component
  144515. */
  144516. get lighting(): NodeMaterialConnectionPoint;
  144517. /**
  144518. * Gets the shadow output component
  144519. */
  144520. get shadow(): NodeMaterialConnectionPoint;
  144521. /**
  144522. * Gets the alpha output component
  144523. */
  144524. get alpha(): NodeMaterialConnectionPoint;
  144525. autoConfigure(material: NodeMaterial): void;
  144526. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144527. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  144528. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144529. private _injectVertexCode;
  144530. /**
  144531. * Gets the code corresponding to the albedo/opacity module
  144532. * @returns the shader code
  144533. */
  144534. getAlbedoOpacityCode(): string;
  144535. protected _buildBlock(state: NodeMaterialBuildState): this;
  144536. protected _dumpPropertiesCode(): string;
  144537. serialize(): any;
  144538. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144539. }
  144540. }
  144541. declare module BABYLON {
  144542. /**
  144543. * Block used to compute value of one parameter modulo another
  144544. */
  144545. export class ModBlock extends NodeMaterialBlock {
  144546. /**
  144547. * Creates a new ModBlock
  144548. * @param name defines the block name
  144549. */
  144550. constructor(name: string);
  144551. /**
  144552. * Gets the current class name
  144553. * @returns the class name
  144554. */
  144555. getClassName(): string;
  144556. /**
  144557. * Gets the left operand input component
  144558. */
  144559. get left(): NodeMaterialConnectionPoint;
  144560. /**
  144561. * Gets the right operand input component
  144562. */
  144563. get right(): NodeMaterialConnectionPoint;
  144564. /**
  144565. * Gets the output component
  144566. */
  144567. get output(): NodeMaterialConnectionPoint;
  144568. protected _buildBlock(state: NodeMaterialBuildState): this;
  144569. }
  144570. }
  144571. declare module BABYLON {
  144572. /**
  144573. * Helper class to push actions to a pool of workers.
  144574. */
  144575. export class WorkerPool implements IDisposable {
  144576. private _workerInfos;
  144577. private _pendingActions;
  144578. /**
  144579. * Constructor
  144580. * @param workers Array of workers to use for actions
  144581. */
  144582. constructor(workers: Array<Worker>);
  144583. /**
  144584. * Terminates all workers and clears any pending actions.
  144585. */
  144586. dispose(): void;
  144587. /**
  144588. * Pushes an action to the worker pool. If all the workers are active, the action will be
  144589. * pended until a worker has completed its action.
  144590. * @param action The action to perform. Call onComplete when the action is complete.
  144591. */
  144592. push(action: (worker: Worker, onComplete: () => void) => void): void;
  144593. private _execute;
  144594. }
  144595. }
  144596. declare module BABYLON {
  144597. /**
  144598. * Configuration for Draco compression
  144599. */
  144600. export interface IDracoCompressionConfiguration {
  144601. /**
  144602. * Configuration for the decoder.
  144603. */
  144604. decoder: {
  144605. /**
  144606. * The url to the WebAssembly module.
  144607. */
  144608. wasmUrl?: string;
  144609. /**
  144610. * The url to the WebAssembly binary.
  144611. */
  144612. wasmBinaryUrl?: string;
  144613. /**
  144614. * The url to the fallback JavaScript module.
  144615. */
  144616. fallbackUrl?: string;
  144617. };
  144618. }
  144619. /**
  144620. * Draco compression (https://google.github.io/draco/)
  144621. *
  144622. * This class wraps the Draco module.
  144623. *
  144624. * **Encoder**
  144625. *
  144626. * The encoder is not currently implemented.
  144627. *
  144628. * **Decoder**
  144629. *
  144630. * 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.
  144631. *
  144632. * To update the configuration, use the following code:
  144633. * ```javascript
  144634. * DracoCompression.Configuration = {
  144635. * decoder: {
  144636. * wasmUrl: "<url to the WebAssembly library>",
  144637. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  144638. * fallbackUrl: "<url to the fallback JavaScript library>",
  144639. * }
  144640. * };
  144641. * ```
  144642. *
  144643. * 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.
  144644. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  144645. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  144646. *
  144647. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  144648. * ```javascript
  144649. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  144650. * ```
  144651. *
  144652. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  144653. */
  144654. export class DracoCompression implements IDisposable {
  144655. private _workerPoolPromise?;
  144656. private _decoderModulePromise?;
  144657. /**
  144658. * The configuration. Defaults to the following urls:
  144659. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  144660. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  144661. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  144662. */
  144663. static Configuration: IDracoCompressionConfiguration;
  144664. /**
  144665. * Returns true if the decoder configuration is available.
  144666. */
  144667. static get DecoderAvailable(): boolean;
  144668. /**
  144669. * Default number of workers to create when creating the draco compression object.
  144670. */
  144671. static DefaultNumWorkers: number;
  144672. private static GetDefaultNumWorkers;
  144673. private static _Default;
  144674. /**
  144675. * Default instance for the draco compression object.
  144676. */
  144677. static get Default(): DracoCompression;
  144678. /**
  144679. * Constructor
  144680. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  144681. */
  144682. constructor(numWorkers?: number);
  144683. /**
  144684. * Stop all async operations and release resources.
  144685. */
  144686. dispose(): void;
  144687. /**
  144688. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  144689. * @returns a promise that resolves when ready
  144690. */
  144691. whenReadyAsync(): Promise<void>;
  144692. /**
  144693. * Decode Draco compressed mesh data to vertex data.
  144694. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  144695. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  144696. * @returns A promise that resolves with the decoded vertex data
  144697. */
  144698. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  144699. [kind: string]: number;
  144700. }): Promise<VertexData>;
  144701. }
  144702. }
  144703. declare module BABYLON {
  144704. /**
  144705. * Class for building Constructive Solid Geometry
  144706. */
  144707. export class CSG {
  144708. private polygons;
  144709. /**
  144710. * The world matrix
  144711. */
  144712. matrix: Matrix;
  144713. /**
  144714. * Stores the position
  144715. */
  144716. position: Vector3;
  144717. /**
  144718. * Stores the rotation
  144719. */
  144720. rotation: Vector3;
  144721. /**
  144722. * Stores the rotation quaternion
  144723. */
  144724. rotationQuaternion: Nullable<Quaternion>;
  144725. /**
  144726. * Stores the scaling vector
  144727. */
  144728. scaling: Vector3;
  144729. /**
  144730. * Convert the Mesh to CSG
  144731. * @param mesh The Mesh to convert to CSG
  144732. * @returns A new CSG from the Mesh
  144733. */
  144734. static FromMesh(mesh: Mesh): CSG;
  144735. /**
  144736. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  144737. * @param polygons Polygons used to construct a CSG solid
  144738. */
  144739. private static FromPolygons;
  144740. /**
  144741. * Clones, or makes a deep copy, of the CSG
  144742. * @returns A new CSG
  144743. */
  144744. clone(): CSG;
  144745. /**
  144746. * Unions this CSG with another CSG
  144747. * @param csg The CSG to union against this CSG
  144748. * @returns The unioned CSG
  144749. */
  144750. union(csg: CSG): CSG;
  144751. /**
  144752. * Unions this CSG with another CSG in place
  144753. * @param csg The CSG to union against this CSG
  144754. */
  144755. unionInPlace(csg: CSG): void;
  144756. /**
  144757. * Subtracts this CSG with another CSG
  144758. * @param csg The CSG to subtract against this CSG
  144759. * @returns A new CSG
  144760. */
  144761. subtract(csg: CSG): CSG;
  144762. /**
  144763. * Subtracts this CSG with another CSG in place
  144764. * @param csg The CSG to subtact against this CSG
  144765. */
  144766. subtractInPlace(csg: CSG): void;
  144767. /**
  144768. * Intersect this CSG with another CSG
  144769. * @param csg The CSG to intersect against this CSG
  144770. * @returns A new CSG
  144771. */
  144772. intersect(csg: CSG): CSG;
  144773. /**
  144774. * Intersects this CSG with another CSG in place
  144775. * @param csg The CSG to intersect against this CSG
  144776. */
  144777. intersectInPlace(csg: CSG): void;
  144778. /**
  144779. * Return a new CSG solid with solid and empty space switched. This solid is
  144780. * not modified.
  144781. * @returns A new CSG solid with solid and empty space switched
  144782. */
  144783. inverse(): CSG;
  144784. /**
  144785. * Inverses the CSG in place
  144786. */
  144787. inverseInPlace(): void;
  144788. /**
  144789. * This is used to keep meshes transformations so they can be restored
  144790. * when we build back a Babylon Mesh
  144791. * NB : All CSG operations are performed in world coordinates
  144792. * @param csg The CSG to copy the transform attributes from
  144793. * @returns This CSG
  144794. */
  144795. copyTransformAttributes(csg: CSG): CSG;
  144796. /**
  144797. * Build Raw mesh from CSG
  144798. * Coordinates here are in world space
  144799. * @param name The name of the mesh geometry
  144800. * @param scene The Scene
  144801. * @param keepSubMeshes Specifies if the submeshes should be kept
  144802. * @returns A new Mesh
  144803. */
  144804. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144805. /**
  144806. * Build Mesh from CSG taking material and transforms into account
  144807. * @param name The name of the Mesh
  144808. * @param material The material of the Mesh
  144809. * @param scene The Scene
  144810. * @param keepSubMeshes Specifies if submeshes should be kept
  144811. * @returns The new Mesh
  144812. */
  144813. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144814. }
  144815. }
  144816. declare module BABYLON {
  144817. /**
  144818. * Class used to create a trail following a mesh
  144819. */
  144820. export class TrailMesh extends Mesh {
  144821. private _generator;
  144822. private _autoStart;
  144823. private _running;
  144824. private _diameter;
  144825. private _length;
  144826. private _sectionPolygonPointsCount;
  144827. private _sectionVectors;
  144828. private _sectionNormalVectors;
  144829. private _beforeRenderObserver;
  144830. /**
  144831. * @constructor
  144832. * @param name The value used by scene.getMeshByName() to do a lookup.
  144833. * @param generator The mesh or transform node to generate a trail.
  144834. * @param scene The scene to add this mesh to.
  144835. * @param diameter Diameter of trailing mesh. Default is 1.
  144836. * @param length Length of trailing mesh. Default is 60.
  144837. * @param autoStart Automatically start trailing mesh. Default true.
  144838. */
  144839. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  144840. /**
  144841. * "TrailMesh"
  144842. * @returns "TrailMesh"
  144843. */
  144844. getClassName(): string;
  144845. private _createMesh;
  144846. /**
  144847. * Start trailing mesh.
  144848. */
  144849. start(): void;
  144850. /**
  144851. * Stop trailing mesh.
  144852. */
  144853. stop(): void;
  144854. /**
  144855. * Update trailing mesh geometry.
  144856. */
  144857. update(): void;
  144858. /**
  144859. * Returns a new TrailMesh object.
  144860. * @param name is a string, the name given to the new mesh
  144861. * @param newGenerator use new generator object for cloned trail mesh
  144862. * @returns a new mesh
  144863. */
  144864. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  144865. /**
  144866. * Serializes this trail mesh
  144867. * @param serializationObject object to write serialization to
  144868. */
  144869. serialize(serializationObject: any): void;
  144870. /**
  144871. * Parses a serialized trail mesh
  144872. * @param parsedMesh the serialized mesh
  144873. * @param scene the scene to create the trail mesh in
  144874. * @returns the created trail mesh
  144875. */
  144876. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  144877. }
  144878. }
  144879. declare module BABYLON {
  144880. /**
  144881. * Class containing static functions to help procedurally build meshes
  144882. */
  144883. export class TiledBoxBuilder {
  144884. /**
  144885. * Creates a box mesh
  144886. * 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)
  144887. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144888. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144889. * * 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
  144890. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144891. * @param name defines the name of the mesh
  144892. * @param options defines the options used to create the mesh
  144893. * @param scene defines the hosting scene
  144894. * @returns the box mesh
  144895. */
  144896. static CreateTiledBox(name: string, options: {
  144897. pattern?: number;
  144898. width?: number;
  144899. height?: number;
  144900. depth?: number;
  144901. tileSize?: number;
  144902. tileWidth?: number;
  144903. tileHeight?: number;
  144904. alignHorizontal?: number;
  144905. alignVertical?: number;
  144906. faceUV?: Vector4[];
  144907. faceColors?: Color4[];
  144908. sideOrientation?: number;
  144909. updatable?: boolean;
  144910. }, scene?: Nullable<Scene>): Mesh;
  144911. }
  144912. }
  144913. declare module BABYLON {
  144914. /**
  144915. * Class containing static functions to help procedurally build meshes
  144916. */
  144917. export class TorusKnotBuilder {
  144918. /**
  144919. * Creates a torus knot mesh
  144920. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  144921. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  144922. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  144923. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  144924. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144925. * * 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
  144926. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144927. * @param name defines the name of the mesh
  144928. * @param options defines the options used to create the mesh
  144929. * @param scene defines the hosting scene
  144930. * @returns the torus knot mesh
  144931. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  144932. */
  144933. static CreateTorusKnot(name: string, options: {
  144934. radius?: number;
  144935. tube?: number;
  144936. radialSegments?: number;
  144937. tubularSegments?: number;
  144938. p?: number;
  144939. q?: number;
  144940. updatable?: boolean;
  144941. sideOrientation?: number;
  144942. frontUVs?: Vector4;
  144943. backUVs?: Vector4;
  144944. }, scene: any): Mesh;
  144945. }
  144946. }
  144947. declare module BABYLON {
  144948. /**
  144949. * Polygon
  144950. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  144951. */
  144952. export class Polygon {
  144953. /**
  144954. * Creates a rectangle
  144955. * @param xmin bottom X coord
  144956. * @param ymin bottom Y coord
  144957. * @param xmax top X coord
  144958. * @param ymax top Y coord
  144959. * @returns points that make the resulting rectation
  144960. */
  144961. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  144962. /**
  144963. * Creates a circle
  144964. * @param radius radius of circle
  144965. * @param cx scale in x
  144966. * @param cy scale in y
  144967. * @param numberOfSides number of sides that make up the circle
  144968. * @returns points that make the resulting circle
  144969. */
  144970. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  144971. /**
  144972. * Creates a polygon from input string
  144973. * @param input Input polygon data
  144974. * @returns the parsed points
  144975. */
  144976. static Parse(input: string): Vector2[];
  144977. /**
  144978. * Starts building a polygon from x and y coordinates
  144979. * @param x x coordinate
  144980. * @param y y coordinate
  144981. * @returns the started path2
  144982. */
  144983. static StartingAt(x: number, y: number): Path2;
  144984. }
  144985. /**
  144986. * Builds a polygon
  144987. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  144988. */
  144989. export class PolygonMeshBuilder {
  144990. private _points;
  144991. private _outlinepoints;
  144992. private _holes;
  144993. private _name;
  144994. private _scene;
  144995. private _epoints;
  144996. private _eholes;
  144997. private _addToepoint;
  144998. /**
  144999. * Babylon reference to the earcut plugin.
  145000. */
  145001. bjsEarcut: any;
  145002. /**
  145003. * Creates a PolygonMeshBuilder
  145004. * @param name name of the builder
  145005. * @param contours Path of the polygon
  145006. * @param scene scene to add to when creating the mesh
  145007. * @param earcutInjection can be used to inject your own earcut reference
  145008. */
  145009. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  145010. /**
  145011. * Adds a whole within the polygon
  145012. * @param hole Array of points defining the hole
  145013. * @returns this
  145014. */
  145015. addHole(hole: Vector2[]): PolygonMeshBuilder;
  145016. /**
  145017. * Creates the polygon
  145018. * @param updatable If the mesh should be updatable
  145019. * @param depth The depth of the mesh created
  145020. * @returns the created mesh
  145021. */
  145022. build(updatable?: boolean, depth?: number): Mesh;
  145023. /**
  145024. * Creates the polygon
  145025. * @param depth The depth of the mesh created
  145026. * @returns the created VertexData
  145027. */
  145028. buildVertexData(depth?: number): VertexData;
  145029. /**
  145030. * Adds a side to the polygon
  145031. * @param positions points that make the polygon
  145032. * @param normals normals of the polygon
  145033. * @param uvs uvs of the polygon
  145034. * @param indices indices of the polygon
  145035. * @param bounds bounds of the polygon
  145036. * @param points points of the polygon
  145037. * @param depth depth of the polygon
  145038. * @param flip flip of the polygon
  145039. */
  145040. private addSide;
  145041. }
  145042. }
  145043. declare module BABYLON {
  145044. /**
  145045. * Class containing static functions to help procedurally build meshes
  145046. */
  145047. export class PolygonBuilder {
  145048. /**
  145049. * Creates a polygon mesh
  145050. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145051. * * 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
  145052. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145053. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145054. * * 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)
  145055. * * Remember you can only change the shape positions, not their number when updating a polygon
  145056. * @param name defines the name of the mesh
  145057. * @param options defines the options used to create the mesh
  145058. * @param scene defines the hosting scene
  145059. * @param earcutInjection can be used to inject your own earcut reference
  145060. * @returns the polygon mesh
  145061. */
  145062. static CreatePolygon(name: string, options: {
  145063. shape: Vector3[];
  145064. holes?: Vector3[][];
  145065. depth?: number;
  145066. faceUV?: Vector4[];
  145067. faceColors?: Color4[];
  145068. updatable?: boolean;
  145069. sideOrientation?: number;
  145070. frontUVs?: Vector4;
  145071. backUVs?: Vector4;
  145072. wrap?: boolean;
  145073. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145074. /**
  145075. * Creates an extruded polygon mesh, with depth in the Y direction.
  145076. * * 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)
  145077. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145078. * @param name defines the name of the mesh
  145079. * @param options defines the options used to create the mesh
  145080. * @param scene defines the hosting scene
  145081. * @param earcutInjection can be used to inject your own earcut reference
  145082. * @returns the polygon mesh
  145083. */
  145084. static ExtrudePolygon(name: string, options: {
  145085. shape: Vector3[];
  145086. holes?: Vector3[][];
  145087. depth?: number;
  145088. faceUV?: Vector4[];
  145089. faceColors?: Color4[];
  145090. updatable?: boolean;
  145091. sideOrientation?: number;
  145092. frontUVs?: Vector4;
  145093. backUVs?: Vector4;
  145094. wrap?: boolean;
  145095. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145096. }
  145097. }
  145098. declare module BABYLON {
  145099. /**
  145100. * Class containing static functions to help procedurally build meshes
  145101. */
  145102. export class LatheBuilder {
  145103. /**
  145104. * Creates lathe mesh.
  145105. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145106. * * 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
  145107. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145108. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145109. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145110. * * 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
  145111. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145112. * * 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
  145113. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145114. * * 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
  145115. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145116. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145117. * @param name defines the name of the mesh
  145118. * @param options defines the options used to create the mesh
  145119. * @param scene defines the hosting scene
  145120. * @returns the lathe mesh
  145121. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145122. */
  145123. static CreateLathe(name: string, options: {
  145124. shape: Vector3[];
  145125. radius?: number;
  145126. tessellation?: number;
  145127. clip?: number;
  145128. arc?: number;
  145129. closed?: boolean;
  145130. updatable?: boolean;
  145131. sideOrientation?: number;
  145132. frontUVs?: Vector4;
  145133. backUVs?: Vector4;
  145134. cap?: number;
  145135. invertUV?: boolean;
  145136. }, scene?: Nullable<Scene>): Mesh;
  145137. }
  145138. }
  145139. declare module BABYLON {
  145140. /**
  145141. * Class containing static functions to help procedurally build meshes
  145142. */
  145143. export class TiledPlaneBuilder {
  145144. /**
  145145. * Creates a tiled plane mesh
  145146. * * The parameter `pattern` will, depending on value, do nothing or
  145147. * * * flip (reflect about central vertical) alternate tiles across and up
  145148. * * * flip every tile on alternate rows
  145149. * * * rotate (180 degs) alternate tiles across and up
  145150. * * * rotate every tile on alternate rows
  145151. * * * flip and rotate alternate tiles across and up
  145152. * * * flip and rotate every tile on alternate rows
  145153. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  145154. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  145155. * * 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
  145156. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145157. * * 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)
  145158. * * 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)
  145159. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145160. * @param name defines the name of the mesh
  145161. * @param options defines the options used to create the mesh
  145162. * @param scene defines the hosting scene
  145163. * @returns the box mesh
  145164. */
  145165. static CreateTiledPlane(name: string, options: {
  145166. pattern?: number;
  145167. tileSize?: number;
  145168. tileWidth?: number;
  145169. tileHeight?: number;
  145170. size?: number;
  145171. width?: number;
  145172. height?: number;
  145173. alignHorizontal?: number;
  145174. alignVertical?: number;
  145175. sideOrientation?: number;
  145176. frontUVs?: Vector4;
  145177. backUVs?: Vector4;
  145178. updatable?: boolean;
  145179. }, scene?: Nullable<Scene>): Mesh;
  145180. }
  145181. }
  145182. declare module BABYLON {
  145183. /**
  145184. * Class containing static functions to help procedurally build meshes
  145185. */
  145186. export class TubeBuilder {
  145187. /**
  145188. * Creates a tube mesh.
  145189. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145190. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145191. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145192. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145193. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145194. * * 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)
  145195. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145196. * * 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
  145197. * * 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
  145198. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145199. * * 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
  145200. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145201. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145202. * @param name defines the name of the mesh
  145203. * @param options defines the options used to create the mesh
  145204. * @param scene defines the hosting scene
  145205. * @returns the tube mesh
  145206. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145207. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145208. */
  145209. static CreateTube(name: string, options: {
  145210. path: Vector3[];
  145211. radius?: number;
  145212. tessellation?: number;
  145213. radiusFunction?: {
  145214. (i: number, distance: number): number;
  145215. };
  145216. cap?: number;
  145217. arc?: number;
  145218. updatable?: boolean;
  145219. sideOrientation?: number;
  145220. frontUVs?: Vector4;
  145221. backUVs?: Vector4;
  145222. instance?: Mesh;
  145223. invertUV?: boolean;
  145224. }, scene?: Nullable<Scene>): Mesh;
  145225. }
  145226. }
  145227. declare module BABYLON {
  145228. /**
  145229. * Class containing static functions to help procedurally build meshes
  145230. */
  145231. export class IcoSphereBuilder {
  145232. /**
  145233. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145234. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145235. * * 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`)
  145236. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145237. * * 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
  145238. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145239. * * 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
  145240. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  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 icosahedron mesh
  145245. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145246. */
  145247. static CreateIcoSphere(name: string, options: {
  145248. radius?: number;
  145249. radiusX?: number;
  145250. radiusY?: number;
  145251. radiusZ?: number;
  145252. flat?: boolean;
  145253. subdivisions?: number;
  145254. sideOrientation?: number;
  145255. frontUVs?: Vector4;
  145256. backUVs?: Vector4;
  145257. updatable?: boolean;
  145258. }, scene?: Nullable<Scene>): Mesh;
  145259. }
  145260. }
  145261. declare module BABYLON {
  145262. /**
  145263. * Class containing static functions to help procedurally build meshes
  145264. */
  145265. export class DecalBuilder {
  145266. /**
  145267. * Creates a decal mesh.
  145268. * 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
  145269. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145270. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145271. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145272. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145273. * @param name defines the name of the mesh
  145274. * @param sourceMesh defines the mesh where the decal must be applied
  145275. * @param options defines the options used to create the mesh
  145276. * @param scene defines the hosting scene
  145277. * @returns the decal mesh
  145278. * @see https://doc.babylonjs.com/how_to/decals
  145279. */
  145280. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145281. position?: Vector3;
  145282. normal?: Vector3;
  145283. size?: Vector3;
  145284. angle?: number;
  145285. }): Mesh;
  145286. }
  145287. }
  145288. declare module BABYLON {
  145289. /**
  145290. * Class containing static functions to help procedurally build meshes
  145291. */
  145292. export class MeshBuilder {
  145293. /**
  145294. * Creates a box mesh
  145295. * * The parameter `size` sets the size (float) of each box side (default 1)
  145296. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  145297. * * 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)
  145298. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145299. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145300. * * 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
  145301. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145302. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145303. * @param name defines the name of the mesh
  145304. * @param options defines the options used to create the mesh
  145305. * @param scene defines the hosting scene
  145306. * @returns the box mesh
  145307. */
  145308. static CreateBox(name: string, options: {
  145309. size?: number;
  145310. width?: number;
  145311. height?: number;
  145312. depth?: number;
  145313. faceUV?: Vector4[];
  145314. faceColors?: Color4[];
  145315. sideOrientation?: number;
  145316. frontUVs?: Vector4;
  145317. backUVs?: Vector4;
  145318. wrap?: boolean;
  145319. topBaseAt?: number;
  145320. bottomBaseAt?: number;
  145321. updatable?: boolean;
  145322. }, scene?: Nullable<Scene>): Mesh;
  145323. /**
  145324. * Creates a tiled box mesh
  145325. * * faceTiles sets the pattern, tile size and number of tiles for a face
  145326. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145327. * @param name defines the name of the mesh
  145328. * @param options defines the options used to create the mesh
  145329. * @param scene defines the hosting scene
  145330. * @returns the tiled box mesh
  145331. */
  145332. static CreateTiledBox(name: string, options: {
  145333. pattern?: number;
  145334. size?: number;
  145335. width?: number;
  145336. height?: number;
  145337. depth: number;
  145338. tileSize?: number;
  145339. tileWidth?: number;
  145340. tileHeight?: number;
  145341. faceUV?: Vector4[];
  145342. faceColors?: Color4[];
  145343. alignHorizontal?: number;
  145344. alignVertical?: number;
  145345. sideOrientation?: number;
  145346. updatable?: boolean;
  145347. }, scene?: Nullable<Scene>): Mesh;
  145348. /**
  145349. * Creates a sphere mesh
  145350. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  145351. * * 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`)
  145352. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  145353. * * 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
  145354. * * 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)
  145355. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145356. * * 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
  145357. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145358. * @param name defines the name of the mesh
  145359. * @param options defines the options used to create the mesh
  145360. * @param scene defines the hosting scene
  145361. * @returns the sphere mesh
  145362. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  145363. */
  145364. static CreateSphere(name: string, options: {
  145365. segments?: number;
  145366. diameter?: number;
  145367. diameterX?: number;
  145368. diameterY?: number;
  145369. diameterZ?: number;
  145370. arc?: number;
  145371. slice?: number;
  145372. sideOrientation?: number;
  145373. frontUVs?: Vector4;
  145374. backUVs?: Vector4;
  145375. updatable?: boolean;
  145376. }, scene?: Nullable<Scene>): Mesh;
  145377. /**
  145378. * Creates a plane polygonal mesh. By default, this is a disc
  145379. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  145380. * * 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
  145381. * * 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
  145382. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145383. * * 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
  145384. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145385. * @param name defines the name of the mesh
  145386. * @param options defines the options used to create the mesh
  145387. * @param scene defines the hosting scene
  145388. * @returns the plane polygonal mesh
  145389. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  145390. */
  145391. static CreateDisc(name: string, options: {
  145392. radius?: number;
  145393. tessellation?: number;
  145394. arc?: number;
  145395. updatable?: boolean;
  145396. sideOrientation?: number;
  145397. frontUVs?: Vector4;
  145398. backUVs?: Vector4;
  145399. }, scene?: Nullable<Scene>): Mesh;
  145400. /**
  145401. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145402. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145403. * * 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`)
  145404. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145405. * * 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
  145406. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145407. * * 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
  145408. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145409. * @param name defines the name of the mesh
  145410. * @param options defines the options used to create the mesh
  145411. * @param scene defines the hosting scene
  145412. * @returns the icosahedron mesh
  145413. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145414. */
  145415. static CreateIcoSphere(name: string, options: {
  145416. radius?: number;
  145417. radiusX?: number;
  145418. radiusY?: number;
  145419. radiusZ?: number;
  145420. flat?: boolean;
  145421. subdivisions?: number;
  145422. sideOrientation?: number;
  145423. frontUVs?: Vector4;
  145424. backUVs?: Vector4;
  145425. updatable?: boolean;
  145426. }, scene?: Nullable<Scene>): Mesh;
  145427. /**
  145428. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145429. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  145430. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  145431. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  145432. * * 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
  145433. * * 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
  145434. * * 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
  145435. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145436. * * 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
  145437. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145438. * * 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
  145439. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  145440. * * 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
  145441. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  145442. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145443. * @param name defines the name of the mesh
  145444. * @param options defines the options used to create the mesh
  145445. * @param scene defines the hosting scene
  145446. * @returns the ribbon mesh
  145447. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  145448. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145449. */
  145450. static CreateRibbon(name: string, options: {
  145451. pathArray: Vector3[][];
  145452. closeArray?: boolean;
  145453. closePath?: boolean;
  145454. offset?: number;
  145455. updatable?: boolean;
  145456. sideOrientation?: number;
  145457. frontUVs?: Vector4;
  145458. backUVs?: Vector4;
  145459. instance?: Mesh;
  145460. invertUV?: boolean;
  145461. uvs?: Vector2[];
  145462. colors?: Color4[];
  145463. }, scene?: Nullable<Scene>): Mesh;
  145464. /**
  145465. * Creates a cylinder or a cone mesh
  145466. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  145467. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  145468. * * 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.
  145469. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  145470. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  145471. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  145472. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  145473. * * 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).
  145474. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  145475. * * 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).
  145476. * * 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
  145477. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  145478. * * 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
  145479. * * 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.
  145480. * * If `enclose` is false, a ring surface is one element.
  145481. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  145482. * * 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
  145483. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145484. * * 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
  145485. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145486. * @param name defines the name of the mesh
  145487. * @param options defines the options used to create the mesh
  145488. * @param scene defines the hosting scene
  145489. * @returns the cylinder mesh
  145490. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  145491. */
  145492. static CreateCylinder(name: string, options: {
  145493. height?: number;
  145494. diameterTop?: number;
  145495. diameterBottom?: number;
  145496. diameter?: number;
  145497. tessellation?: number;
  145498. subdivisions?: number;
  145499. arc?: number;
  145500. faceColors?: Color4[];
  145501. faceUV?: Vector4[];
  145502. updatable?: boolean;
  145503. hasRings?: boolean;
  145504. enclose?: boolean;
  145505. cap?: number;
  145506. sideOrientation?: number;
  145507. frontUVs?: Vector4;
  145508. backUVs?: Vector4;
  145509. }, scene?: Nullable<Scene>): Mesh;
  145510. /**
  145511. * Creates a torus mesh
  145512. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  145513. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  145514. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  145515. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145516. * * 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
  145517. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145518. * @param name defines the name of the mesh
  145519. * @param options defines the options used to create the mesh
  145520. * @param scene defines the hosting scene
  145521. * @returns the torus mesh
  145522. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  145523. */
  145524. static CreateTorus(name: string, options: {
  145525. diameter?: number;
  145526. thickness?: number;
  145527. tessellation?: number;
  145528. updatable?: boolean;
  145529. sideOrientation?: number;
  145530. frontUVs?: Vector4;
  145531. backUVs?: Vector4;
  145532. }, scene?: Nullable<Scene>): Mesh;
  145533. /**
  145534. * Creates a torus knot mesh
  145535. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145536. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145537. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145538. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145539. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145540. * * 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
  145541. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145542. * @param name defines the name of the mesh
  145543. * @param options defines the options used to create the mesh
  145544. * @param scene defines the hosting scene
  145545. * @returns the torus knot mesh
  145546. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145547. */
  145548. static CreateTorusKnot(name: string, options: {
  145549. radius?: number;
  145550. tube?: number;
  145551. radialSegments?: number;
  145552. tubularSegments?: number;
  145553. p?: number;
  145554. q?: number;
  145555. updatable?: boolean;
  145556. sideOrientation?: number;
  145557. frontUVs?: Vector4;
  145558. backUVs?: Vector4;
  145559. }, scene?: Nullable<Scene>): Mesh;
  145560. /**
  145561. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  145562. * * 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
  145563. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  145564. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  145565. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  145566. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  145567. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  145568. * * 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
  145569. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  145570. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145571. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  145572. * @param name defines the name of the new line system
  145573. * @param options defines the options used to create the line system
  145574. * @param scene defines the hosting scene
  145575. * @returns a new line system mesh
  145576. */
  145577. static CreateLineSystem(name: string, options: {
  145578. lines: Vector3[][];
  145579. updatable?: boolean;
  145580. instance?: Nullable<LinesMesh>;
  145581. colors?: Nullable<Color4[][]>;
  145582. useVertexAlpha?: boolean;
  145583. }, scene: Nullable<Scene>): LinesMesh;
  145584. /**
  145585. * Creates a line mesh
  145586. * 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
  145587. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145588. * * The parameter `points` is an array successive Vector3
  145589. * * 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
  145590. * * The optional parameter `colors` is an array of successive Color4, one per line point
  145591. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  145592. * * When updating an instance, remember that only point positions can change, not the number of points
  145593. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145594. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  145595. * @param name defines the name of the new line system
  145596. * @param options defines the options used to create the line system
  145597. * @param scene defines the hosting scene
  145598. * @returns a new line mesh
  145599. */
  145600. static CreateLines(name: string, options: {
  145601. points: Vector3[];
  145602. updatable?: boolean;
  145603. instance?: Nullable<LinesMesh>;
  145604. colors?: Color4[];
  145605. useVertexAlpha?: boolean;
  145606. }, scene?: Nullable<Scene>): LinesMesh;
  145607. /**
  145608. * Creates a dashed line mesh
  145609. * * 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
  145610. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145611. * * The parameter `points` is an array successive Vector3
  145612. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  145613. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  145614. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  145615. * * 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
  145616. * * When updating an instance, remember that only point positions can change, not the number of points
  145617. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145618. * @param name defines the name of the mesh
  145619. * @param options defines the options used to create the mesh
  145620. * @param scene defines the hosting scene
  145621. * @returns the dashed line mesh
  145622. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  145623. */
  145624. static CreateDashedLines(name: string, options: {
  145625. points: Vector3[];
  145626. dashSize?: number;
  145627. gapSize?: number;
  145628. dashNb?: number;
  145629. updatable?: boolean;
  145630. instance?: LinesMesh;
  145631. }, scene?: Nullable<Scene>): LinesMesh;
  145632. /**
  145633. * 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.
  145634. * * 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.
  145635. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145636. * * 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.
  145637. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  145638. * * 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
  145639. * * 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
  145640. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  145641. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145642. * * 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
  145643. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  145644. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145645. * @param name defines the name of the mesh
  145646. * @param options defines the options used to create the mesh
  145647. * @param scene defines the hosting scene
  145648. * @returns the extruded shape mesh
  145649. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145650. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145651. */
  145652. static ExtrudeShape(name: string, options: {
  145653. shape: Vector3[];
  145654. path: Vector3[];
  145655. scale?: number;
  145656. rotation?: number;
  145657. cap?: number;
  145658. updatable?: boolean;
  145659. sideOrientation?: number;
  145660. frontUVs?: Vector4;
  145661. backUVs?: Vector4;
  145662. instance?: Mesh;
  145663. invertUV?: boolean;
  145664. }, scene?: Nullable<Scene>): Mesh;
  145665. /**
  145666. * Creates an custom extruded shape mesh.
  145667. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  145668. * * 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.
  145669. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145670. * * 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
  145671. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  145672. * * 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
  145673. * * It must returns a float value that will be the scale value applied to the shape on each path point
  145674. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  145675. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  145676. * * 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
  145677. * * 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
  145678. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  145679. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145680. * * 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
  145681. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145682. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145683. * @param name defines the name of the mesh
  145684. * @param options defines the options used to create the mesh
  145685. * @param scene defines the hosting scene
  145686. * @returns the custom extruded shape mesh
  145687. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  145688. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145689. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145690. */
  145691. static ExtrudeShapeCustom(name: string, options: {
  145692. shape: Vector3[];
  145693. path: Vector3[];
  145694. scaleFunction?: any;
  145695. rotationFunction?: any;
  145696. ribbonCloseArray?: boolean;
  145697. ribbonClosePath?: boolean;
  145698. cap?: number;
  145699. updatable?: boolean;
  145700. sideOrientation?: number;
  145701. frontUVs?: Vector4;
  145702. backUVs?: Vector4;
  145703. instance?: Mesh;
  145704. invertUV?: boolean;
  145705. }, scene?: Nullable<Scene>): Mesh;
  145706. /**
  145707. * Creates lathe mesh.
  145708. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145709. * * 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
  145710. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145711. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145712. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145713. * * 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
  145714. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145715. * * 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
  145716. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145717. * * 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
  145718. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145719. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145720. * @param name defines the name of the mesh
  145721. * @param options defines the options used to create the mesh
  145722. * @param scene defines the hosting scene
  145723. * @returns the lathe mesh
  145724. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145725. */
  145726. static CreateLathe(name: string, options: {
  145727. shape: Vector3[];
  145728. radius?: number;
  145729. tessellation?: number;
  145730. clip?: number;
  145731. arc?: number;
  145732. closed?: boolean;
  145733. updatable?: boolean;
  145734. sideOrientation?: number;
  145735. frontUVs?: Vector4;
  145736. backUVs?: Vector4;
  145737. cap?: number;
  145738. invertUV?: boolean;
  145739. }, scene?: Nullable<Scene>): Mesh;
  145740. /**
  145741. * Creates a tiled plane mesh
  145742. * * You can set a limited pattern arrangement with the tiles
  145743. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145744. * * 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
  145745. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145746. * @param name defines the name of the mesh
  145747. * @param options defines the options used to create the mesh
  145748. * @param scene defines the hosting scene
  145749. * @returns the plane mesh
  145750. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145751. */
  145752. static CreateTiledPlane(name: string, options: {
  145753. pattern?: number;
  145754. tileSize?: number;
  145755. tileWidth?: number;
  145756. tileHeight?: number;
  145757. size?: number;
  145758. width?: number;
  145759. height?: number;
  145760. alignHorizontal?: number;
  145761. alignVertical?: number;
  145762. sideOrientation?: number;
  145763. frontUVs?: Vector4;
  145764. backUVs?: Vector4;
  145765. updatable?: boolean;
  145766. }, scene?: Nullable<Scene>): Mesh;
  145767. /**
  145768. * Creates a plane mesh
  145769. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  145770. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  145771. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  145772. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145773. * * 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
  145774. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145775. * @param name defines the name of the mesh
  145776. * @param options defines the options used to create the mesh
  145777. * @param scene defines the hosting scene
  145778. * @returns the plane mesh
  145779. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145780. */
  145781. static CreatePlane(name: string, options: {
  145782. size?: number;
  145783. width?: number;
  145784. height?: number;
  145785. sideOrientation?: number;
  145786. frontUVs?: Vector4;
  145787. backUVs?: Vector4;
  145788. updatable?: boolean;
  145789. sourcePlane?: Plane;
  145790. }, scene?: Nullable<Scene>): Mesh;
  145791. /**
  145792. * Creates a ground mesh
  145793. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  145794. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  145795. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145796. * @param name defines the name of the mesh
  145797. * @param options defines the options used to create the mesh
  145798. * @param scene defines the hosting scene
  145799. * @returns the ground mesh
  145800. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  145801. */
  145802. static CreateGround(name: string, options: {
  145803. width?: number;
  145804. height?: number;
  145805. subdivisions?: number;
  145806. subdivisionsX?: number;
  145807. subdivisionsY?: number;
  145808. updatable?: boolean;
  145809. }, scene?: Nullable<Scene>): Mesh;
  145810. /**
  145811. * Creates a tiled ground mesh
  145812. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  145813. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  145814. * * 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
  145815. * * 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
  145816. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145817. * @param name defines the name of the mesh
  145818. * @param options defines the options used to create the mesh
  145819. * @param scene defines the hosting scene
  145820. * @returns the tiled ground mesh
  145821. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  145822. */
  145823. static CreateTiledGround(name: string, options: {
  145824. xmin: number;
  145825. zmin: number;
  145826. xmax: number;
  145827. zmax: number;
  145828. subdivisions?: {
  145829. w: number;
  145830. h: number;
  145831. };
  145832. precision?: {
  145833. w: number;
  145834. h: number;
  145835. };
  145836. updatable?: boolean;
  145837. }, scene?: Nullable<Scene>): Mesh;
  145838. /**
  145839. * Creates a ground mesh from a height map
  145840. * * The parameter `url` sets the URL of the height map image resource.
  145841. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  145842. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  145843. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  145844. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  145845. * * 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.
  145846. * * 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).
  145847. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  145848. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145849. * @param name defines the name of the mesh
  145850. * @param url defines the url to the height map
  145851. * @param options defines the options used to create the mesh
  145852. * @param scene defines the hosting scene
  145853. * @returns the ground mesh
  145854. * @see https://doc.babylonjs.com/babylon101/height_map
  145855. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  145856. */
  145857. static CreateGroundFromHeightMap(name: string, url: string, options: {
  145858. width?: number;
  145859. height?: number;
  145860. subdivisions?: number;
  145861. minHeight?: number;
  145862. maxHeight?: number;
  145863. colorFilter?: Color3;
  145864. alphaFilter?: number;
  145865. updatable?: boolean;
  145866. onReady?: (mesh: GroundMesh) => void;
  145867. }, scene?: Nullable<Scene>): GroundMesh;
  145868. /**
  145869. * Creates a polygon mesh
  145870. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145871. * * 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
  145872. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145873. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145874. * * 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)
  145875. * * Remember you can only change the shape positions, not their number when updating a polygon
  145876. * @param name defines the name of the mesh
  145877. * @param options defines the options used to create the mesh
  145878. * @param scene defines the hosting scene
  145879. * @param earcutInjection can be used to inject your own earcut reference
  145880. * @returns the polygon mesh
  145881. */
  145882. static CreatePolygon(name: string, options: {
  145883. shape: Vector3[];
  145884. holes?: Vector3[][];
  145885. depth?: number;
  145886. faceUV?: Vector4[];
  145887. faceColors?: Color4[];
  145888. updatable?: boolean;
  145889. sideOrientation?: number;
  145890. frontUVs?: Vector4;
  145891. backUVs?: Vector4;
  145892. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145893. /**
  145894. * Creates an extruded polygon mesh, with depth in the Y direction.
  145895. * * 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)
  145896. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145897. * @param name defines the name of the mesh
  145898. * @param options defines the options used to create the mesh
  145899. * @param scene defines the hosting scene
  145900. * @param earcutInjection can be used to inject your own earcut reference
  145901. * @returns the polygon mesh
  145902. */
  145903. static ExtrudePolygon(name: string, options: {
  145904. shape: Vector3[];
  145905. holes?: Vector3[][];
  145906. depth?: number;
  145907. faceUV?: Vector4[];
  145908. faceColors?: Color4[];
  145909. updatable?: boolean;
  145910. sideOrientation?: number;
  145911. frontUVs?: Vector4;
  145912. backUVs?: Vector4;
  145913. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145914. /**
  145915. * Creates a tube mesh.
  145916. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145917. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145918. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145919. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145920. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145921. * * 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)
  145922. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145923. * * 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
  145924. * * 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
  145925. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145926. * * 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
  145927. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145928. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145929. * @param name defines the name of the mesh
  145930. * @param options defines the options used to create the mesh
  145931. * @param scene defines the hosting scene
  145932. * @returns the tube mesh
  145933. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145934. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145935. */
  145936. static CreateTube(name: string, options: {
  145937. path: Vector3[];
  145938. radius?: number;
  145939. tessellation?: number;
  145940. radiusFunction?: {
  145941. (i: number, distance: number): number;
  145942. };
  145943. cap?: number;
  145944. arc?: number;
  145945. updatable?: boolean;
  145946. sideOrientation?: number;
  145947. frontUVs?: Vector4;
  145948. backUVs?: Vector4;
  145949. instance?: Mesh;
  145950. invertUV?: boolean;
  145951. }, scene?: Nullable<Scene>): Mesh;
  145952. /**
  145953. * Creates a polyhedron mesh
  145954. * * 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
  145955. * * The parameter `size` (positive float, default 1) sets the polygon size
  145956. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  145957. * * 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`
  145958. * * 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
  145959. * * 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)`)
  145960. * * 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
  145961. * * 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
  145962. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145963. * * 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
  145964. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145965. * @param name defines the name of the mesh
  145966. * @param options defines the options used to create the mesh
  145967. * @param scene defines the hosting scene
  145968. * @returns the polyhedron mesh
  145969. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  145970. */
  145971. static CreatePolyhedron(name: string, options: {
  145972. type?: number;
  145973. size?: number;
  145974. sizeX?: number;
  145975. sizeY?: number;
  145976. sizeZ?: number;
  145977. custom?: any;
  145978. faceUV?: Vector4[];
  145979. faceColors?: Color4[];
  145980. flat?: boolean;
  145981. updatable?: boolean;
  145982. sideOrientation?: number;
  145983. frontUVs?: Vector4;
  145984. backUVs?: Vector4;
  145985. }, scene?: Nullable<Scene>): Mesh;
  145986. /**
  145987. * Creates a decal mesh.
  145988. * 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
  145989. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145990. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145991. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145992. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145993. * @param name defines the name of the mesh
  145994. * @param sourceMesh defines the mesh where the decal must be applied
  145995. * @param options defines the options used to create the mesh
  145996. * @param scene defines the hosting scene
  145997. * @returns the decal mesh
  145998. * @see https://doc.babylonjs.com/how_to/decals
  145999. */
  146000. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  146001. position?: Vector3;
  146002. normal?: Vector3;
  146003. size?: Vector3;
  146004. angle?: number;
  146005. }): Mesh;
  146006. }
  146007. }
  146008. declare module BABYLON {
  146009. /**
  146010. * A simplifier interface for future simplification implementations
  146011. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146012. */
  146013. export interface ISimplifier {
  146014. /**
  146015. * Simplification of a given mesh according to the given settings.
  146016. * Since this requires computation, it is assumed that the function runs async.
  146017. * @param settings The settings of the simplification, including quality and distance
  146018. * @param successCallback A callback that will be called after the mesh was simplified.
  146019. * @param errorCallback in case of an error, this callback will be called. optional.
  146020. */
  146021. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  146022. }
  146023. /**
  146024. * Expected simplification settings.
  146025. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  146026. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146027. */
  146028. export interface ISimplificationSettings {
  146029. /**
  146030. * Gets or sets the expected quality
  146031. */
  146032. quality: number;
  146033. /**
  146034. * Gets or sets the distance when this optimized version should be used
  146035. */
  146036. distance: number;
  146037. /**
  146038. * Gets an already optimized mesh
  146039. */
  146040. optimizeMesh?: boolean;
  146041. }
  146042. /**
  146043. * Class used to specify simplification options
  146044. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146045. */
  146046. export class SimplificationSettings implements ISimplificationSettings {
  146047. /** expected quality */
  146048. quality: number;
  146049. /** distance when this optimized version should be used */
  146050. distance: number;
  146051. /** already optimized mesh */
  146052. optimizeMesh?: boolean | undefined;
  146053. /**
  146054. * Creates a SimplificationSettings
  146055. * @param quality expected quality
  146056. * @param distance distance when this optimized version should be used
  146057. * @param optimizeMesh already optimized mesh
  146058. */
  146059. constructor(
  146060. /** expected quality */
  146061. quality: number,
  146062. /** distance when this optimized version should be used */
  146063. distance: number,
  146064. /** already optimized mesh */
  146065. optimizeMesh?: boolean | undefined);
  146066. }
  146067. /**
  146068. * Interface used to define a simplification task
  146069. */
  146070. export interface ISimplificationTask {
  146071. /**
  146072. * Array of settings
  146073. */
  146074. settings: Array<ISimplificationSettings>;
  146075. /**
  146076. * Simplification type
  146077. */
  146078. simplificationType: SimplificationType;
  146079. /**
  146080. * Mesh to simplify
  146081. */
  146082. mesh: Mesh;
  146083. /**
  146084. * Callback called on success
  146085. */
  146086. successCallback?: () => void;
  146087. /**
  146088. * Defines if parallel processing can be used
  146089. */
  146090. parallelProcessing: boolean;
  146091. }
  146092. /**
  146093. * Queue used to order the simplification tasks
  146094. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146095. */
  146096. export class SimplificationQueue {
  146097. private _simplificationArray;
  146098. /**
  146099. * Gets a boolean indicating that the process is still running
  146100. */
  146101. running: boolean;
  146102. /**
  146103. * Creates a new queue
  146104. */
  146105. constructor();
  146106. /**
  146107. * Adds a new simplification task
  146108. * @param task defines a task to add
  146109. */
  146110. addTask(task: ISimplificationTask): void;
  146111. /**
  146112. * Execute next task
  146113. */
  146114. executeNext(): void;
  146115. /**
  146116. * Execute a simplification task
  146117. * @param task defines the task to run
  146118. */
  146119. runSimplification(task: ISimplificationTask): void;
  146120. private getSimplifier;
  146121. }
  146122. /**
  146123. * The implemented types of simplification
  146124. * At the moment only Quadratic Error Decimation is implemented
  146125. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146126. */
  146127. export enum SimplificationType {
  146128. /** Quadratic error decimation */
  146129. QUADRATIC = 0
  146130. }
  146131. /**
  146132. * An implementation of the Quadratic Error simplification algorithm.
  146133. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  146134. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  146135. * @author RaananW
  146136. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146137. */
  146138. export class QuadraticErrorSimplification implements ISimplifier {
  146139. private _mesh;
  146140. private triangles;
  146141. private vertices;
  146142. private references;
  146143. private _reconstructedMesh;
  146144. /** Gets or sets the number pf sync interations */
  146145. syncIterations: number;
  146146. /** Gets or sets the aggressiveness of the simplifier */
  146147. aggressiveness: number;
  146148. /** Gets or sets the number of allowed iterations for decimation */
  146149. decimationIterations: number;
  146150. /** Gets or sets the espilon to use for bounding box computation */
  146151. boundingBoxEpsilon: number;
  146152. /**
  146153. * Creates a new QuadraticErrorSimplification
  146154. * @param _mesh defines the target mesh
  146155. */
  146156. constructor(_mesh: Mesh);
  146157. /**
  146158. * Simplification of a given mesh according to the given settings.
  146159. * Since this requires computation, it is assumed that the function runs async.
  146160. * @param settings The settings of the simplification, including quality and distance
  146161. * @param successCallback A callback that will be called after the mesh was simplified.
  146162. */
  146163. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  146164. private runDecimation;
  146165. private initWithMesh;
  146166. private init;
  146167. private reconstructMesh;
  146168. private initDecimatedMesh;
  146169. private isFlipped;
  146170. private updateTriangles;
  146171. private identifyBorder;
  146172. private updateMesh;
  146173. private vertexError;
  146174. private calculateError;
  146175. }
  146176. }
  146177. declare module BABYLON {
  146178. interface Scene {
  146179. /** @hidden (Backing field) */
  146180. _simplificationQueue: SimplificationQueue;
  146181. /**
  146182. * Gets or sets the simplification queue attached to the scene
  146183. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146184. */
  146185. simplificationQueue: SimplificationQueue;
  146186. }
  146187. interface Mesh {
  146188. /**
  146189. * Simplify the mesh according to the given array of settings.
  146190. * Function will return immediately and will simplify async
  146191. * @param settings a collection of simplification settings
  146192. * @param parallelProcessing should all levels calculate parallel or one after the other
  146193. * @param simplificationType the type of simplification to run
  146194. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  146195. * @returns the current mesh
  146196. */
  146197. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  146198. }
  146199. /**
  146200. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  146201. * created in a scene
  146202. */
  146203. export class SimplicationQueueSceneComponent implements ISceneComponent {
  146204. /**
  146205. * The component name helpfull to identify the component in the list of scene components.
  146206. */
  146207. readonly name: string;
  146208. /**
  146209. * The scene the component belongs to.
  146210. */
  146211. scene: Scene;
  146212. /**
  146213. * Creates a new instance of the component for the given scene
  146214. * @param scene Defines the scene to register the component in
  146215. */
  146216. constructor(scene: Scene);
  146217. /**
  146218. * Registers the component in a given scene
  146219. */
  146220. register(): void;
  146221. /**
  146222. * Rebuilds the elements related to this component in case of
  146223. * context lost for instance.
  146224. */
  146225. rebuild(): void;
  146226. /**
  146227. * Disposes the component and the associated ressources
  146228. */
  146229. dispose(): void;
  146230. private _beforeCameraUpdate;
  146231. }
  146232. }
  146233. declare module BABYLON {
  146234. interface Mesh {
  146235. /**
  146236. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  146237. */
  146238. thinInstanceEnablePicking: boolean;
  146239. /**
  146240. * Creates a new thin instance
  146241. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  146242. * @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
  146243. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  146244. */
  146245. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  146246. /**
  146247. * Adds the transformation (matrix) of the current mesh as a thin instance
  146248. * @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
  146249. * @returns the thin instance index number
  146250. */
  146251. thinInstanceAddSelf(refresh: boolean): number;
  146252. /**
  146253. * Registers a custom attribute to be used with thin instances
  146254. * @param kind name of the attribute
  146255. * @param stride size in floats of the attribute
  146256. */
  146257. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  146258. /**
  146259. * Sets the matrix of a thin instance
  146260. * @param index index of the thin instance
  146261. * @param matrix matrix to set
  146262. * @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
  146263. */
  146264. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  146265. /**
  146266. * Sets the value of a custom attribute for a thin instance
  146267. * @param kind name of the attribute
  146268. * @param index index of the thin instance
  146269. * @param value value to set
  146270. * @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
  146271. */
  146272. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  146273. /**
  146274. * 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.
  146275. */
  146276. thinInstanceCount: number;
  146277. /**
  146278. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  146279. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  146280. * @param buffer buffer to set
  146281. * @param stride size in floats of each value of the buffer
  146282. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  146283. */
  146284. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  146285. /**
  146286. * Gets the list of world matrices
  146287. * @return an array containing all the world matrices from the thin instances
  146288. */
  146289. thinInstanceGetWorldMatrices(): Matrix[];
  146290. /**
  146291. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  146292. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  146293. */
  146294. thinInstanceBufferUpdated(kind: string): void;
  146295. /**
  146296. * Applies a partial update to a buffer directly on the GPU
  146297. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  146298. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  146299. * @param data the data to set in the GPU buffer
  146300. * @param offset the offset in the GPU buffer where to update the data
  146301. */
  146302. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  146303. /**
  146304. * Refreshes the bounding info, taking into account all the thin instances defined
  146305. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  146306. */
  146307. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  146308. /** @hidden */
  146309. _thinInstanceInitializeUserStorage(): void;
  146310. /** @hidden */
  146311. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  146312. /** @hidden */
  146313. _userThinInstanceBuffersStorage: {
  146314. data: {
  146315. [key: string]: Float32Array;
  146316. };
  146317. sizes: {
  146318. [key: string]: number;
  146319. };
  146320. vertexBuffers: {
  146321. [key: string]: Nullable<VertexBuffer>;
  146322. };
  146323. strides: {
  146324. [key: string]: number;
  146325. };
  146326. };
  146327. }
  146328. }
  146329. declare module BABYLON {
  146330. /**
  146331. * Navigation plugin interface to add navigation constrained by a navigation mesh
  146332. */
  146333. export interface INavigationEnginePlugin {
  146334. /**
  146335. * plugin name
  146336. */
  146337. name: string;
  146338. /**
  146339. * Creates a navigation mesh
  146340. * @param meshes array of all the geometry used to compute the navigatio mesh
  146341. * @param parameters bunch of parameters used to filter geometry
  146342. */
  146343. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146344. /**
  146345. * Create a navigation mesh debug mesh
  146346. * @param scene is where the mesh will be added
  146347. * @returns debug display mesh
  146348. */
  146349. createDebugNavMesh(scene: Scene): Mesh;
  146350. /**
  146351. * Get a navigation mesh constrained position, closest to the parameter position
  146352. * @param position world position
  146353. * @returns the closest point to position constrained by the navigation mesh
  146354. */
  146355. getClosestPoint(position: Vector3): Vector3;
  146356. /**
  146357. * Get a navigation mesh constrained position, closest to the parameter position
  146358. * @param position world position
  146359. * @param result output the closest point to position constrained by the navigation mesh
  146360. */
  146361. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146362. /**
  146363. * Get a navigation mesh constrained position, within a particular radius
  146364. * @param position world position
  146365. * @param maxRadius the maximum distance to the constrained world position
  146366. * @returns the closest point to position constrained by the navigation mesh
  146367. */
  146368. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146369. /**
  146370. * Get a navigation mesh constrained position, within a particular radius
  146371. * @param position world position
  146372. * @param maxRadius the maximum distance to the constrained world position
  146373. * @param result output the closest point to position constrained by the navigation mesh
  146374. */
  146375. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146376. /**
  146377. * Compute the final position from a segment made of destination-position
  146378. * @param position world position
  146379. * @param destination world position
  146380. * @returns the resulting point along the navmesh
  146381. */
  146382. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146383. /**
  146384. * Compute the final position from a segment made of destination-position
  146385. * @param position world position
  146386. * @param destination world position
  146387. * @param result output the resulting point along the navmesh
  146388. */
  146389. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146390. /**
  146391. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146392. * @param start world position
  146393. * @param end world position
  146394. * @returns array containing world position composing the path
  146395. */
  146396. computePath(start: Vector3, end: Vector3): Vector3[];
  146397. /**
  146398. * If this plugin is supported
  146399. * @returns true if plugin is supported
  146400. */
  146401. isSupported(): boolean;
  146402. /**
  146403. * Create a new Crowd so you can add agents
  146404. * @param maxAgents the maximum agent count in the crowd
  146405. * @param maxAgentRadius the maximum radius an agent can have
  146406. * @param scene to attach the crowd to
  146407. * @returns the crowd you can add agents to
  146408. */
  146409. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146410. /**
  146411. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146412. * The queries will try to find a solution within those bounds
  146413. * default is (1,1,1)
  146414. * @param extent x,y,z value that define the extent around the queries point of reference
  146415. */
  146416. setDefaultQueryExtent(extent: Vector3): void;
  146417. /**
  146418. * Get the Bounding box extent specified by setDefaultQueryExtent
  146419. * @returns the box extent values
  146420. */
  146421. getDefaultQueryExtent(): Vector3;
  146422. /**
  146423. * build the navmesh from a previously saved state using getNavmeshData
  146424. * @param data the Uint8Array returned by getNavmeshData
  146425. */
  146426. buildFromNavmeshData(data: Uint8Array): void;
  146427. /**
  146428. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146429. * @returns data the Uint8Array that can be saved and reused
  146430. */
  146431. getNavmeshData(): Uint8Array;
  146432. /**
  146433. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146434. * @param result output the box extent values
  146435. */
  146436. getDefaultQueryExtentToRef(result: Vector3): void;
  146437. /**
  146438. * Release all resources
  146439. */
  146440. dispose(): void;
  146441. }
  146442. /**
  146443. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  146444. */
  146445. export interface ICrowd {
  146446. /**
  146447. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146448. * You can attach anything to that node. The node position is updated in the scene update tick.
  146449. * @param pos world position that will be constrained by the navigation mesh
  146450. * @param parameters agent parameters
  146451. * @param transform hooked to the agent that will be update by the scene
  146452. * @returns agent index
  146453. */
  146454. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146455. /**
  146456. * Returns the agent position in world space
  146457. * @param index agent index returned by addAgent
  146458. * @returns world space position
  146459. */
  146460. getAgentPosition(index: number): Vector3;
  146461. /**
  146462. * Gets the agent position result in world space
  146463. * @param index agent index returned by addAgent
  146464. * @param result output world space position
  146465. */
  146466. getAgentPositionToRef(index: number, result: Vector3): void;
  146467. /**
  146468. * Gets the agent velocity in world space
  146469. * @param index agent index returned by addAgent
  146470. * @returns world space velocity
  146471. */
  146472. getAgentVelocity(index: number): Vector3;
  146473. /**
  146474. * Gets the agent velocity result in world space
  146475. * @param index agent index returned by addAgent
  146476. * @param result output world space velocity
  146477. */
  146478. getAgentVelocityToRef(index: number, result: Vector3): void;
  146479. /**
  146480. * remove a particular agent previously created
  146481. * @param index agent index returned by addAgent
  146482. */
  146483. removeAgent(index: number): void;
  146484. /**
  146485. * get the list of all agents attached to this crowd
  146486. * @returns list of agent indices
  146487. */
  146488. getAgents(): number[];
  146489. /**
  146490. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146491. * @param deltaTime in seconds
  146492. */
  146493. update(deltaTime: number): void;
  146494. /**
  146495. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146496. * @param index agent index returned by addAgent
  146497. * @param destination targeted world position
  146498. */
  146499. agentGoto(index: number, destination: Vector3): void;
  146500. /**
  146501. * Teleport the agent to a new position
  146502. * @param index agent index returned by addAgent
  146503. * @param destination targeted world position
  146504. */
  146505. agentTeleport(index: number, destination: Vector3): void;
  146506. /**
  146507. * Update agent parameters
  146508. * @param index agent index returned by addAgent
  146509. * @param parameters agent parameters
  146510. */
  146511. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146512. /**
  146513. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146514. * The queries will try to find a solution within those bounds
  146515. * default is (1,1,1)
  146516. * @param extent x,y,z value that define the extent around the queries point of reference
  146517. */
  146518. setDefaultQueryExtent(extent: Vector3): void;
  146519. /**
  146520. * Get the Bounding box extent specified by setDefaultQueryExtent
  146521. * @returns the box extent values
  146522. */
  146523. getDefaultQueryExtent(): Vector3;
  146524. /**
  146525. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146526. * @param result output the box extent values
  146527. */
  146528. getDefaultQueryExtentToRef(result: Vector3): void;
  146529. /**
  146530. * Release all resources
  146531. */
  146532. dispose(): void;
  146533. }
  146534. /**
  146535. * Configures an agent
  146536. */
  146537. export interface IAgentParameters {
  146538. /**
  146539. * Agent radius. [Limit: >= 0]
  146540. */
  146541. radius: number;
  146542. /**
  146543. * Agent height. [Limit: > 0]
  146544. */
  146545. height: number;
  146546. /**
  146547. * Maximum allowed acceleration. [Limit: >= 0]
  146548. */
  146549. maxAcceleration: number;
  146550. /**
  146551. * Maximum allowed speed. [Limit: >= 0]
  146552. */
  146553. maxSpeed: number;
  146554. /**
  146555. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  146556. */
  146557. collisionQueryRange: number;
  146558. /**
  146559. * The path visibility optimization range. [Limit: > 0]
  146560. */
  146561. pathOptimizationRange: number;
  146562. /**
  146563. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  146564. */
  146565. separationWeight: number;
  146566. }
  146567. /**
  146568. * Configures the navigation mesh creation
  146569. */
  146570. export interface INavMeshParameters {
  146571. /**
  146572. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  146573. */
  146574. cs: number;
  146575. /**
  146576. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  146577. */
  146578. ch: number;
  146579. /**
  146580. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  146581. */
  146582. walkableSlopeAngle: number;
  146583. /**
  146584. * Minimum floor to 'ceiling' height that will still allow the floor area to
  146585. * be considered walkable. [Limit: >= 3] [Units: vx]
  146586. */
  146587. walkableHeight: number;
  146588. /**
  146589. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  146590. */
  146591. walkableClimb: number;
  146592. /**
  146593. * The distance to erode/shrink the walkable area of the heightfield away from
  146594. * obstructions. [Limit: >=0] [Units: vx]
  146595. */
  146596. walkableRadius: number;
  146597. /**
  146598. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  146599. */
  146600. maxEdgeLen: number;
  146601. /**
  146602. * The maximum distance a simplfied contour's border edges should deviate
  146603. * the original raw contour. [Limit: >=0] [Units: vx]
  146604. */
  146605. maxSimplificationError: number;
  146606. /**
  146607. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  146608. */
  146609. minRegionArea: number;
  146610. /**
  146611. * Any regions with a span count smaller than this value will, if possible,
  146612. * be merged with larger regions. [Limit: >=0] [Units: vx]
  146613. */
  146614. mergeRegionArea: number;
  146615. /**
  146616. * The maximum number of vertices allowed for polygons generated during the
  146617. * contour to polygon conversion process. [Limit: >= 3]
  146618. */
  146619. maxVertsPerPoly: number;
  146620. /**
  146621. * Sets the sampling distance to use when generating the detail mesh.
  146622. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  146623. */
  146624. detailSampleDist: number;
  146625. /**
  146626. * The maximum distance the detail mesh surface should deviate from heightfield
  146627. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  146628. */
  146629. detailSampleMaxError: number;
  146630. }
  146631. }
  146632. declare module BABYLON {
  146633. /**
  146634. * RecastJS navigation plugin
  146635. */
  146636. export class RecastJSPlugin implements INavigationEnginePlugin {
  146637. /**
  146638. * Reference to the Recast library
  146639. */
  146640. bjsRECAST: any;
  146641. /**
  146642. * plugin name
  146643. */
  146644. name: string;
  146645. /**
  146646. * the first navmesh created. We might extend this to support multiple navmeshes
  146647. */
  146648. navMesh: any;
  146649. /**
  146650. * Initializes the recastJS plugin
  146651. * @param recastInjection can be used to inject your own recast reference
  146652. */
  146653. constructor(recastInjection?: any);
  146654. /**
  146655. * Creates a navigation mesh
  146656. * @param meshes array of all the geometry used to compute the navigatio mesh
  146657. * @param parameters bunch of parameters used to filter geometry
  146658. */
  146659. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146660. /**
  146661. * Create a navigation mesh debug mesh
  146662. * @param scene is where the mesh will be added
  146663. * @returns debug display mesh
  146664. */
  146665. createDebugNavMesh(scene: Scene): Mesh;
  146666. /**
  146667. * Get a navigation mesh constrained position, closest to the parameter position
  146668. * @param position world position
  146669. * @returns the closest point to position constrained by the navigation mesh
  146670. */
  146671. getClosestPoint(position: Vector3): Vector3;
  146672. /**
  146673. * Get a navigation mesh constrained position, closest to the parameter position
  146674. * @param position world position
  146675. * @param result output the closest point to position constrained by the navigation mesh
  146676. */
  146677. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146678. /**
  146679. * Get a navigation mesh constrained position, within a particular radius
  146680. * @param position world position
  146681. * @param maxRadius the maximum distance to the constrained world position
  146682. * @returns the closest point to position constrained by the navigation mesh
  146683. */
  146684. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146685. /**
  146686. * Get a navigation mesh constrained position, within a particular radius
  146687. * @param position world position
  146688. * @param maxRadius the maximum distance to the constrained world position
  146689. * @param result output the closest point to position constrained by the navigation mesh
  146690. */
  146691. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146692. /**
  146693. * Compute the final position from a segment made of destination-position
  146694. * @param position world position
  146695. * @param destination world position
  146696. * @returns the resulting point along the navmesh
  146697. */
  146698. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146699. /**
  146700. * Compute the final position from a segment made of destination-position
  146701. * @param position world position
  146702. * @param destination world position
  146703. * @param result output the resulting point along the navmesh
  146704. */
  146705. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146706. /**
  146707. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146708. * @param start world position
  146709. * @param end world position
  146710. * @returns array containing world position composing the path
  146711. */
  146712. computePath(start: Vector3, end: Vector3): Vector3[];
  146713. /**
  146714. * Create a new Crowd so you can add agents
  146715. * @param maxAgents the maximum agent count in the crowd
  146716. * @param maxAgentRadius the maximum radius an agent can have
  146717. * @param scene to attach the crowd to
  146718. * @returns the crowd you can add agents to
  146719. */
  146720. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146721. /**
  146722. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146723. * The queries will try to find a solution within those bounds
  146724. * default is (1,1,1)
  146725. * @param extent x,y,z value that define the extent around the queries point of reference
  146726. */
  146727. setDefaultQueryExtent(extent: Vector3): void;
  146728. /**
  146729. * Get the Bounding box extent specified by setDefaultQueryExtent
  146730. * @returns the box extent values
  146731. */
  146732. getDefaultQueryExtent(): Vector3;
  146733. /**
  146734. * build the navmesh from a previously saved state using getNavmeshData
  146735. * @param data the Uint8Array returned by getNavmeshData
  146736. */
  146737. buildFromNavmeshData(data: Uint8Array): void;
  146738. /**
  146739. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146740. * @returns data the Uint8Array that can be saved and reused
  146741. */
  146742. getNavmeshData(): Uint8Array;
  146743. /**
  146744. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146745. * @param result output the box extent values
  146746. */
  146747. getDefaultQueryExtentToRef(result: Vector3): void;
  146748. /**
  146749. * Disposes
  146750. */
  146751. dispose(): void;
  146752. /**
  146753. * If this plugin is supported
  146754. * @returns true if plugin is supported
  146755. */
  146756. isSupported(): boolean;
  146757. }
  146758. /**
  146759. * Recast detour crowd implementation
  146760. */
  146761. export class RecastJSCrowd implements ICrowd {
  146762. /**
  146763. * Recast/detour plugin
  146764. */
  146765. bjsRECASTPlugin: RecastJSPlugin;
  146766. /**
  146767. * Link to the detour crowd
  146768. */
  146769. recastCrowd: any;
  146770. /**
  146771. * One transform per agent
  146772. */
  146773. transforms: TransformNode[];
  146774. /**
  146775. * All agents created
  146776. */
  146777. agents: number[];
  146778. /**
  146779. * Link to the scene is kept to unregister the crowd from the scene
  146780. */
  146781. private _scene;
  146782. /**
  146783. * Observer for crowd updates
  146784. */
  146785. private _onBeforeAnimationsObserver;
  146786. /**
  146787. * Constructor
  146788. * @param plugin recastJS plugin
  146789. * @param maxAgents the maximum agent count in the crowd
  146790. * @param maxAgentRadius the maximum radius an agent can have
  146791. * @param scene to attach the crowd to
  146792. * @returns the crowd you can add agents to
  146793. */
  146794. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  146795. /**
  146796. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146797. * You can attach anything to that node. The node position is updated in the scene update tick.
  146798. * @param pos world position that will be constrained by the navigation mesh
  146799. * @param parameters agent parameters
  146800. * @param transform hooked to the agent that will be update by the scene
  146801. * @returns agent index
  146802. */
  146803. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146804. /**
  146805. * Returns the agent position in world space
  146806. * @param index agent index returned by addAgent
  146807. * @returns world space position
  146808. */
  146809. getAgentPosition(index: number): Vector3;
  146810. /**
  146811. * Returns the agent position result in world space
  146812. * @param index agent index returned by addAgent
  146813. * @param result output world space position
  146814. */
  146815. getAgentPositionToRef(index: number, result: Vector3): void;
  146816. /**
  146817. * Returns the agent velocity in world space
  146818. * @param index agent index returned by addAgent
  146819. * @returns world space velocity
  146820. */
  146821. getAgentVelocity(index: number): Vector3;
  146822. /**
  146823. * Returns the agent velocity result in world space
  146824. * @param index agent index returned by addAgent
  146825. * @param result output world space velocity
  146826. */
  146827. getAgentVelocityToRef(index: number, result: Vector3): void;
  146828. /**
  146829. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146830. * @param index agent index returned by addAgent
  146831. * @param destination targeted world position
  146832. */
  146833. agentGoto(index: number, destination: Vector3): void;
  146834. /**
  146835. * Teleport the agent to a new position
  146836. * @param index agent index returned by addAgent
  146837. * @param destination targeted world position
  146838. */
  146839. agentTeleport(index: number, destination: Vector3): void;
  146840. /**
  146841. * Update agent parameters
  146842. * @param index agent index returned by addAgent
  146843. * @param parameters agent parameters
  146844. */
  146845. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146846. /**
  146847. * remove a particular agent previously created
  146848. * @param index agent index returned by addAgent
  146849. */
  146850. removeAgent(index: number): void;
  146851. /**
  146852. * get the list of all agents attached to this crowd
  146853. * @returns list of agent indices
  146854. */
  146855. getAgents(): number[];
  146856. /**
  146857. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146858. * @param deltaTime in seconds
  146859. */
  146860. update(deltaTime: number): void;
  146861. /**
  146862. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146863. * The queries will try to find a solution within those bounds
  146864. * default is (1,1,1)
  146865. * @param extent x,y,z value that define the extent around the queries point of reference
  146866. */
  146867. setDefaultQueryExtent(extent: Vector3): void;
  146868. /**
  146869. * Get the Bounding box extent specified by setDefaultQueryExtent
  146870. * @returns the box extent values
  146871. */
  146872. getDefaultQueryExtent(): Vector3;
  146873. /**
  146874. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146875. * @param result output the box extent values
  146876. */
  146877. getDefaultQueryExtentToRef(result: Vector3): void;
  146878. /**
  146879. * Release all resources
  146880. */
  146881. dispose(): void;
  146882. }
  146883. }
  146884. declare module BABYLON {
  146885. /**
  146886. * Class used to enable access to IndexedDB
  146887. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  146888. */
  146889. export class Database implements IOfflineProvider {
  146890. private _callbackManifestChecked;
  146891. private _currentSceneUrl;
  146892. private _db;
  146893. private _enableSceneOffline;
  146894. private _enableTexturesOffline;
  146895. private _manifestVersionFound;
  146896. private _mustUpdateRessources;
  146897. private _hasReachedQuota;
  146898. private _isSupported;
  146899. private _idbFactory;
  146900. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  146901. private static IsUASupportingBlobStorage;
  146902. /**
  146903. * Gets a boolean indicating if Database storate is enabled (off by default)
  146904. */
  146905. static IDBStorageEnabled: boolean;
  146906. /**
  146907. * Gets a boolean indicating if scene must be saved in the database
  146908. */
  146909. get enableSceneOffline(): boolean;
  146910. /**
  146911. * Gets a boolean indicating if textures must be saved in the database
  146912. */
  146913. get enableTexturesOffline(): boolean;
  146914. /**
  146915. * Creates a new Database
  146916. * @param urlToScene defines the url to load the scene
  146917. * @param callbackManifestChecked defines the callback to use when manifest is checked
  146918. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  146919. */
  146920. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  146921. private static _ParseURL;
  146922. private static _ReturnFullUrlLocation;
  146923. private _checkManifestFile;
  146924. /**
  146925. * Open the database and make it available
  146926. * @param successCallback defines the callback to call on success
  146927. * @param errorCallback defines the callback to call on error
  146928. */
  146929. open(successCallback: () => void, errorCallback: () => void): void;
  146930. /**
  146931. * Loads an image from the database
  146932. * @param url defines the url to load from
  146933. * @param image defines the target DOM image
  146934. */
  146935. loadImage(url: string, image: HTMLImageElement): void;
  146936. private _loadImageFromDBAsync;
  146937. private _saveImageIntoDBAsync;
  146938. private _checkVersionFromDB;
  146939. private _loadVersionFromDBAsync;
  146940. private _saveVersionIntoDBAsync;
  146941. /**
  146942. * Loads a file from database
  146943. * @param url defines the URL to load from
  146944. * @param sceneLoaded defines a callback to call on success
  146945. * @param progressCallBack defines a callback to call when progress changed
  146946. * @param errorCallback defines a callback to call on error
  146947. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  146948. */
  146949. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  146950. private _loadFileAsync;
  146951. private _saveFileAsync;
  146952. /**
  146953. * Validates if xhr data is correct
  146954. * @param xhr defines the request to validate
  146955. * @param dataType defines the expected data type
  146956. * @returns true if data is correct
  146957. */
  146958. private static _ValidateXHRData;
  146959. }
  146960. }
  146961. declare module BABYLON {
  146962. /** @hidden */
  146963. export var gpuUpdateParticlesPixelShader: {
  146964. name: string;
  146965. shader: string;
  146966. };
  146967. }
  146968. declare module BABYLON {
  146969. /** @hidden */
  146970. export var gpuUpdateParticlesVertexShader: {
  146971. name: string;
  146972. shader: string;
  146973. };
  146974. }
  146975. declare module BABYLON {
  146976. /** @hidden */
  146977. export var clipPlaneFragmentDeclaration2: {
  146978. name: string;
  146979. shader: string;
  146980. };
  146981. }
  146982. declare module BABYLON {
  146983. /** @hidden */
  146984. export var gpuRenderParticlesPixelShader: {
  146985. name: string;
  146986. shader: string;
  146987. };
  146988. }
  146989. declare module BABYLON {
  146990. /** @hidden */
  146991. export var clipPlaneVertexDeclaration2: {
  146992. name: string;
  146993. shader: string;
  146994. };
  146995. }
  146996. declare module BABYLON {
  146997. /** @hidden */
  146998. export var gpuRenderParticlesVertexShader: {
  146999. name: string;
  147000. shader: string;
  147001. };
  147002. }
  147003. declare module BABYLON {
  147004. /**
  147005. * This represents a GPU particle system in Babylon
  147006. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  147007. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  147008. */
  147009. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  147010. /**
  147011. * The layer mask we are rendering the particles through.
  147012. */
  147013. layerMask: number;
  147014. private _capacity;
  147015. private _activeCount;
  147016. private _currentActiveCount;
  147017. private _accumulatedCount;
  147018. private _renderEffect;
  147019. private _updateEffect;
  147020. private _buffer0;
  147021. private _buffer1;
  147022. private _spriteBuffer;
  147023. private _updateVAO;
  147024. private _renderVAO;
  147025. private _targetIndex;
  147026. private _sourceBuffer;
  147027. private _targetBuffer;
  147028. private _currentRenderId;
  147029. private _started;
  147030. private _stopped;
  147031. private _timeDelta;
  147032. private _randomTexture;
  147033. private _randomTexture2;
  147034. private _attributesStrideSize;
  147035. private _updateEffectOptions;
  147036. private _randomTextureSize;
  147037. private _actualFrame;
  147038. private _customEffect;
  147039. private readonly _rawTextureWidth;
  147040. /**
  147041. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  147042. */
  147043. static get IsSupported(): boolean;
  147044. /**
  147045. * An event triggered when the system is disposed.
  147046. */
  147047. onDisposeObservable: Observable<IParticleSystem>;
  147048. /**
  147049. * Gets the maximum number of particles active at the same time.
  147050. * @returns The max number of active particles.
  147051. */
  147052. getCapacity(): number;
  147053. /**
  147054. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  147055. * to override the particles.
  147056. */
  147057. forceDepthWrite: boolean;
  147058. /**
  147059. * Gets or set the number of active particles
  147060. */
  147061. get activeParticleCount(): number;
  147062. set activeParticleCount(value: number);
  147063. private _preWarmDone;
  147064. /**
  147065. * Specifies if the particles are updated in emitter local space or world space.
  147066. */
  147067. isLocal: boolean;
  147068. /** Gets or sets a matrix to use to compute projection */
  147069. defaultProjectionMatrix: Matrix;
  147070. /**
  147071. * Is this system ready to be used/rendered
  147072. * @return true if the system is ready
  147073. */
  147074. isReady(): boolean;
  147075. /**
  147076. * Gets if the system has been started. (Note: this will still be true after stop is called)
  147077. * @returns True if it has been started, otherwise false.
  147078. */
  147079. isStarted(): boolean;
  147080. /**
  147081. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  147082. * @returns True if it has been stopped, otherwise false.
  147083. */
  147084. isStopped(): boolean;
  147085. /**
  147086. * Gets a boolean indicating that the system is stopping
  147087. * @returns true if the system is currently stopping
  147088. */
  147089. isStopping(): boolean;
  147090. /**
  147091. * Gets the number of particles active at the same time.
  147092. * @returns The number of active particles.
  147093. */
  147094. getActiveCount(): number;
  147095. /**
  147096. * Starts the particle system and begins to emit
  147097. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  147098. */
  147099. start(delay?: number): void;
  147100. /**
  147101. * Stops the particle system.
  147102. */
  147103. stop(): void;
  147104. /**
  147105. * Remove all active particles
  147106. */
  147107. reset(): void;
  147108. /**
  147109. * Returns the string "GPUParticleSystem"
  147110. * @returns a string containing the class name
  147111. */
  147112. getClassName(): string;
  147113. /**
  147114. * Gets the custom effect used to render the particles
  147115. * @param blendMode Blend mode for which the effect should be retrieved
  147116. * @returns The effect
  147117. */
  147118. getCustomEffect(blendMode?: number): Nullable<Effect>;
  147119. /**
  147120. * Sets the custom effect used to render the particles
  147121. * @param effect The effect to set
  147122. * @param blendMode Blend mode for which the effect should be set
  147123. */
  147124. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  147125. /** @hidden */
  147126. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  147127. /**
  147128. * Observable that will be called just before the particles are drawn
  147129. */
  147130. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  147131. /**
  147132. * Gets the name of the particle vertex shader
  147133. */
  147134. get vertexShaderName(): string;
  147135. private _colorGradientsTexture;
  147136. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  147137. /**
  147138. * Adds a new color gradient
  147139. * @param gradient defines the gradient to use (between 0 and 1)
  147140. * @param color1 defines the color to affect to the specified gradient
  147141. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  147142. * @returns the current particle system
  147143. */
  147144. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  147145. private _refreshColorGradient;
  147146. /** Force the system to rebuild all gradients that need to be resync */
  147147. forceRefreshGradients(): void;
  147148. /**
  147149. * Remove a specific color gradient
  147150. * @param gradient defines the gradient to remove
  147151. * @returns the current particle system
  147152. */
  147153. removeColorGradient(gradient: number): GPUParticleSystem;
  147154. private _angularSpeedGradientsTexture;
  147155. private _sizeGradientsTexture;
  147156. private _velocityGradientsTexture;
  147157. private _limitVelocityGradientsTexture;
  147158. private _dragGradientsTexture;
  147159. private _addFactorGradient;
  147160. /**
  147161. * Adds a new size gradient
  147162. * @param gradient defines the gradient to use (between 0 and 1)
  147163. * @param factor defines the size factor to affect to the specified gradient
  147164. * @returns the current particle system
  147165. */
  147166. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  147167. /**
  147168. * Remove a specific size gradient
  147169. * @param gradient defines the gradient to remove
  147170. * @returns the current particle system
  147171. */
  147172. removeSizeGradient(gradient: number): GPUParticleSystem;
  147173. private _refreshFactorGradient;
  147174. /**
  147175. * Adds a new angular speed gradient
  147176. * @param gradient defines the gradient to use (between 0 and 1)
  147177. * @param factor defines the angular speed to affect to the specified gradient
  147178. * @returns the current particle system
  147179. */
  147180. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  147181. /**
  147182. * Remove a specific angular speed gradient
  147183. * @param gradient defines the gradient to remove
  147184. * @returns the current particle system
  147185. */
  147186. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  147187. /**
  147188. * Adds a new velocity gradient
  147189. * @param gradient defines the gradient to use (between 0 and 1)
  147190. * @param factor defines the velocity to affect to the specified gradient
  147191. * @returns the current particle system
  147192. */
  147193. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147194. /**
  147195. * Remove a specific velocity gradient
  147196. * @param gradient defines the gradient to remove
  147197. * @returns the current particle system
  147198. */
  147199. removeVelocityGradient(gradient: number): GPUParticleSystem;
  147200. /**
  147201. * Adds a new limit velocity gradient
  147202. * @param gradient defines the gradient to use (between 0 and 1)
  147203. * @param factor defines the limit velocity value to affect to the specified gradient
  147204. * @returns the current particle system
  147205. */
  147206. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147207. /**
  147208. * Remove a specific limit velocity gradient
  147209. * @param gradient defines the gradient to remove
  147210. * @returns the current particle system
  147211. */
  147212. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  147213. /**
  147214. * Adds a new drag gradient
  147215. * @param gradient defines the gradient to use (between 0 and 1)
  147216. * @param factor defines the drag value to affect to the specified gradient
  147217. * @returns the current particle system
  147218. */
  147219. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  147220. /**
  147221. * Remove a specific drag gradient
  147222. * @param gradient defines the gradient to remove
  147223. * @returns the current particle system
  147224. */
  147225. removeDragGradient(gradient: number): GPUParticleSystem;
  147226. /**
  147227. * Not supported by GPUParticleSystem
  147228. * @param gradient defines the gradient to use (between 0 and 1)
  147229. * @param factor defines the emit rate value to affect to the specified gradient
  147230. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147231. * @returns the current particle system
  147232. */
  147233. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147234. /**
  147235. * Not supported by GPUParticleSystem
  147236. * @param gradient defines the gradient to remove
  147237. * @returns the current particle system
  147238. */
  147239. removeEmitRateGradient(gradient: number): IParticleSystem;
  147240. /**
  147241. * Not supported by GPUParticleSystem
  147242. * @param gradient defines the gradient to use (between 0 and 1)
  147243. * @param factor defines the start size value to affect to the specified gradient
  147244. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147245. * @returns the current particle system
  147246. */
  147247. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147248. /**
  147249. * Not supported by GPUParticleSystem
  147250. * @param gradient defines the gradient to remove
  147251. * @returns the current particle system
  147252. */
  147253. removeStartSizeGradient(gradient: number): IParticleSystem;
  147254. /**
  147255. * Not supported by GPUParticleSystem
  147256. * @param gradient defines the gradient to use (between 0 and 1)
  147257. * @param min defines the color remap minimal range
  147258. * @param max defines the color remap maximal range
  147259. * @returns the current particle system
  147260. */
  147261. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147262. /**
  147263. * Not supported by GPUParticleSystem
  147264. * @param gradient defines the gradient to remove
  147265. * @returns the current particle system
  147266. */
  147267. removeColorRemapGradient(): IParticleSystem;
  147268. /**
  147269. * Not supported by GPUParticleSystem
  147270. * @param gradient defines the gradient to use (between 0 and 1)
  147271. * @param min defines the alpha remap minimal range
  147272. * @param max defines the alpha remap maximal range
  147273. * @returns the current particle system
  147274. */
  147275. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147276. /**
  147277. * Not supported by GPUParticleSystem
  147278. * @param gradient defines the gradient to remove
  147279. * @returns the current particle system
  147280. */
  147281. removeAlphaRemapGradient(): IParticleSystem;
  147282. /**
  147283. * Not supported by GPUParticleSystem
  147284. * @param gradient defines the gradient to use (between 0 and 1)
  147285. * @param color defines the color to affect to the specified gradient
  147286. * @returns the current particle system
  147287. */
  147288. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  147289. /**
  147290. * Not supported by GPUParticleSystem
  147291. * @param gradient defines the gradient to remove
  147292. * @returns the current particle system
  147293. */
  147294. removeRampGradient(): IParticleSystem;
  147295. /**
  147296. * Not supported by GPUParticleSystem
  147297. * @returns the list of ramp gradients
  147298. */
  147299. getRampGradients(): Nullable<Array<Color3Gradient>>;
  147300. /**
  147301. * Not supported by GPUParticleSystem
  147302. * Gets or sets a boolean indicating that ramp gradients must be used
  147303. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  147304. */
  147305. get useRampGradients(): boolean;
  147306. set useRampGradients(value: boolean);
  147307. /**
  147308. * Not supported by GPUParticleSystem
  147309. * @param gradient defines the gradient to use (between 0 and 1)
  147310. * @param factor defines the life time factor to affect to the specified gradient
  147311. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147312. * @returns the current particle system
  147313. */
  147314. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147315. /**
  147316. * Not supported by GPUParticleSystem
  147317. * @param gradient defines the gradient to remove
  147318. * @returns the current particle system
  147319. */
  147320. removeLifeTimeGradient(gradient: number): IParticleSystem;
  147321. /**
  147322. * Instantiates a GPU particle system.
  147323. * 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.
  147324. * @param name The name of the particle system
  147325. * @param options The options used to create the system
  147326. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  147327. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  147328. * @param customEffect a custom effect used to change the way particles are rendered by default
  147329. */
  147330. constructor(name: string, options: Partial<{
  147331. capacity: number;
  147332. randomTextureSize: number;
  147333. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  147334. protected _reset(): void;
  147335. private _createUpdateVAO;
  147336. private _createRenderVAO;
  147337. private _initialize;
  147338. /** @hidden */
  147339. _recreateUpdateEffect(): void;
  147340. private _getEffect;
  147341. /**
  147342. * Fill the defines array according to the current settings of the particle system
  147343. * @param defines Array to be updated
  147344. * @param blendMode blend mode to take into account when updating the array
  147345. */
  147346. fillDefines(defines: Array<string>, blendMode?: number): void;
  147347. /**
  147348. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  147349. * @param uniforms Uniforms array to fill
  147350. * @param attributes Attributes array to fill
  147351. * @param samplers Samplers array to fill
  147352. */
  147353. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  147354. /** @hidden */
  147355. _recreateRenderEffect(): Effect;
  147356. /**
  147357. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  147358. * @param preWarm defines if we are in the pre-warmimg phase
  147359. */
  147360. animate(preWarm?: boolean): void;
  147361. private _createFactorGradientTexture;
  147362. private _createSizeGradientTexture;
  147363. private _createAngularSpeedGradientTexture;
  147364. private _createVelocityGradientTexture;
  147365. private _createLimitVelocityGradientTexture;
  147366. private _createDragGradientTexture;
  147367. private _createColorGradientTexture;
  147368. /**
  147369. * Renders the particle system in its current state
  147370. * @param preWarm defines if the system should only update the particles but not render them
  147371. * @returns the current number of particles
  147372. */
  147373. render(preWarm?: boolean): number;
  147374. /**
  147375. * Rebuilds the particle system
  147376. */
  147377. rebuild(): void;
  147378. private _releaseBuffers;
  147379. private _releaseVAOs;
  147380. /**
  147381. * Disposes the particle system and free the associated resources
  147382. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  147383. */
  147384. dispose(disposeTexture?: boolean): void;
  147385. /**
  147386. * Clones the particle system.
  147387. * @param name The name of the cloned object
  147388. * @param newEmitter The new emitter to use
  147389. * @returns the cloned particle system
  147390. */
  147391. clone(name: string, newEmitter: any): GPUParticleSystem;
  147392. /**
  147393. * Serializes the particle system to a JSON object
  147394. * @param serializeTexture defines if the texture must be serialized as well
  147395. * @returns the JSON object
  147396. */
  147397. serialize(serializeTexture?: boolean): any;
  147398. /**
  147399. * Parses a JSON object to create a GPU particle system.
  147400. * @param parsedParticleSystem The JSON object to parse
  147401. * @param sceneOrEngine The scene or the engine to create the particle system in
  147402. * @param rootUrl The root url to use to load external dependencies like texture
  147403. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  147404. * @returns the parsed GPU particle system
  147405. */
  147406. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  147407. }
  147408. }
  147409. declare module BABYLON {
  147410. /**
  147411. * Represents a set of particle systems working together to create a specific effect
  147412. */
  147413. export class ParticleSystemSet implements IDisposable {
  147414. /**
  147415. * Gets or sets base Assets URL
  147416. */
  147417. static BaseAssetsUrl: string;
  147418. private _emitterCreationOptions;
  147419. private _emitterNode;
  147420. /**
  147421. * Gets the particle system list
  147422. */
  147423. systems: IParticleSystem[];
  147424. /**
  147425. * Gets the emitter node used with this set
  147426. */
  147427. get emitterNode(): Nullable<TransformNode>;
  147428. /**
  147429. * Creates a new emitter mesh as a sphere
  147430. * @param options defines the options used to create the sphere
  147431. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  147432. * @param scene defines the hosting scene
  147433. */
  147434. setEmitterAsSphere(options: {
  147435. diameter: number;
  147436. segments: number;
  147437. color: Color3;
  147438. }, renderingGroupId: number, scene: Scene): void;
  147439. /**
  147440. * Starts all particle systems of the set
  147441. * @param emitter defines an optional mesh to use as emitter for the particle systems
  147442. */
  147443. start(emitter?: AbstractMesh): void;
  147444. /**
  147445. * Release all associated resources
  147446. */
  147447. dispose(): void;
  147448. /**
  147449. * Serialize the set into a JSON compatible object
  147450. * @param serializeTexture defines if the texture must be serialized as well
  147451. * @returns a JSON compatible representation of the set
  147452. */
  147453. serialize(serializeTexture?: boolean): any;
  147454. /**
  147455. * Parse a new ParticleSystemSet from a serialized source
  147456. * @param data defines a JSON compatible representation of the set
  147457. * @param scene defines the hosting scene
  147458. * @param gpu defines if we want GPU particles or CPU particles
  147459. * @returns a new ParticleSystemSet
  147460. */
  147461. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  147462. }
  147463. }
  147464. declare module BABYLON {
  147465. /**
  147466. * This class is made for on one-liner static method to help creating particle system set.
  147467. */
  147468. export class ParticleHelper {
  147469. /**
  147470. * Gets or sets base Assets URL
  147471. */
  147472. static BaseAssetsUrl: string;
  147473. /** Define the Url to load snippets */
  147474. static SnippetUrl: string;
  147475. /**
  147476. * Create a default particle system that you can tweak
  147477. * @param emitter defines the emitter to use
  147478. * @param capacity defines the system capacity (default is 500 particles)
  147479. * @param scene defines the hosting scene
  147480. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  147481. * @returns the new Particle system
  147482. */
  147483. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  147484. /**
  147485. * This is the main static method (one-liner) of this helper to create different particle systems
  147486. * @param type This string represents the type to the particle system to create
  147487. * @param scene The scene where the particle system should live
  147488. * @param gpu If the system will use gpu
  147489. * @returns the ParticleSystemSet created
  147490. */
  147491. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  147492. /**
  147493. * Static function used to export a particle system to a ParticleSystemSet variable.
  147494. * Please note that the emitter shape is not exported
  147495. * @param systems defines the particle systems to export
  147496. * @returns the created particle system set
  147497. */
  147498. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  147499. /**
  147500. * Creates a particle system from a snippet saved in a remote file
  147501. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  147502. * @param url defines the url to load from
  147503. * @param scene defines the hosting scene
  147504. * @param gpu If the system will use gpu
  147505. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147506. * @returns a promise that will resolve to the new particle system
  147507. */
  147508. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147509. /**
  147510. * Creates a particle system from a snippet saved by the particle system editor
  147511. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  147512. * @param scene defines the hosting scene
  147513. * @param gpu If the system will use gpu
  147514. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147515. * @returns a promise that will resolve to the new particle system
  147516. */
  147517. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147518. }
  147519. }
  147520. declare module BABYLON {
  147521. interface Engine {
  147522. /**
  147523. * Create an effect to use with particle systems.
  147524. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  147525. * the particle system for which you want to create a custom effect in the last parameter
  147526. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  147527. * @param uniformsNames defines a list of attribute names
  147528. * @param samplers defines an array of string used to represent textures
  147529. * @param defines defines the string containing the defines to use to compile the shaders
  147530. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  147531. * @param onCompiled defines a function to call when the effect creation is successful
  147532. * @param onError defines a function to call when the effect creation has failed
  147533. * @param particleSystem the particle system you want to create the effect for
  147534. * @returns the new Effect
  147535. */
  147536. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  147537. }
  147538. interface Mesh {
  147539. /**
  147540. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  147541. * @returns an array of IParticleSystem
  147542. */
  147543. getEmittedParticleSystems(): IParticleSystem[];
  147544. /**
  147545. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  147546. * @returns an array of IParticleSystem
  147547. */
  147548. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  147549. }
  147550. }
  147551. declare module BABYLON {
  147552. /** Defines the 4 color options */
  147553. export enum PointColor {
  147554. /** color value */
  147555. Color = 2,
  147556. /** uv value */
  147557. UV = 1,
  147558. /** random value */
  147559. Random = 0,
  147560. /** stated value */
  147561. Stated = 3
  147562. }
  147563. /**
  147564. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  147565. * 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.
  147566. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  147567. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  147568. *
  147569. * Full documentation here : TO BE ENTERED
  147570. */
  147571. export class PointsCloudSystem implements IDisposable {
  147572. /**
  147573. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  147574. * Example : var p = SPS.particles[i];
  147575. */
  147576. particles: CloudPoint[];
  147577. /**
  147578. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  147579. */
  147580. nbParticles: number;
  147581. /**
  147582. * This a counter for your own usage. It's not set by any SPS functions.
  147583. */
  147584. counter: number;
  147585. /**
  147586. * The PCS name. This name is also given to the underlying mesh.
  147587. */
  147588. name: string;
  147589. /**
  147590. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  147591. */
  147592. mesh: Mesh;
  147593. /**
  147594. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  147595. * Please read :
  147596. */
  147597. vars: any;
  147598. /**
  147599. * @hidden
  147600. */
  147601. _size: number;
  147602. private _scene;
  147603. private _promises;
  147604. private _positions;
  147605. private _indices;
  147606. private _normals;
  147607. private _colors;
  147608. private _uvs;
  147609. private _indices32;
  147610. private _positions32;
  147611. private _colors32;
  147612. private _uvs32;
  147613. private _updatable;
  147614. private _isVisibilityBoxLocked;
  147615. private _alwaysVisible;
  147616. private _groups;
  147617. private _groupCounter;
  147618. private _computeParticleColor;
  147619. private _computeParticleTexture;
  147620. private _computeParticleRotation;
  147621. private _computeBoundingBox;
  147622. private _isReady;
  147623. /**
  147624. * Creates a PCS (Points Cloud System) object
  147625. * @param name (String) is the PCS name, this will be the underlying mesh name
  147626. * @param pointSize (number) is the size for each point
  147627. * @param scene (Scene) is the scene in which the PCS is added
  147628. * @param options defines the options of the PCS e.g.
  147629. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  147630. */
  147631. constructor(name: string, pointSize: number, scene: Scene, options?: {
  147632. updatable?: boolean;
  147633. });
  147634. /**
  147635. * Builds the PCS underlying mesh. Returns a standard Mesh.
  147636. * If no points were added to the PCS, the returned mesh is just a single point.
  147637. * @returns a promise for the created mesh
  147638. */
  147639. buildMeshAsync(): Promise<Mesh>;
  147640. /**
  147641. * @hidden
  147642. */
  147643. private _buildMesh;
  147644. private _addParticle;
  147645. private _randomUnitVector;
  147646. private _getColorIndicesForCoord;
  147647. private _setPointsColorOrUV;
  147648. private _colorFromTexture;
  147649. private _calculateDensity;
  147650. /**
  147651. * Adds points to the PCS in random positions within a unit sphere
  147652. * @param nb (positive integer) the number of particles to be created from this model
  147653. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  147654. * @returns the number of groups in the system
  147655. */
  147656. addPoints(nb: number, pointFunction?: any): number;
  147657. /**
  147658. * Adds points to the PCS from the surface of the model shape
  147659. * @param mesh is any Mesh object that will be used as a surface model for the points
  147660. * @param nb (positive integer) the number of particles to be created from this model
  147661. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147662. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147663. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147664. * @returns the number of groups in the system
  147665. */
  147666. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147667. /**
  147668. * Adds points to the PCS inside the model shape
  147669. * @param mesh is any Mesh object that will be used as a surface model for the points
  147670. * @param nb (positive integer) the number of particles to be created from this model
  147671. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147672. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147673. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147674. * @returns the number of groups in the system
  147675. */
  147676. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147677. /**
  147678. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  147679. * This method calls `updateParticle()` for each particle of the SPS.
  147680. * For an animated SPS, it is usually called within the render loop.
  147681. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  147682. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  147683. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  147684. * @returns the PCS.
  147685. */
  147686. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  147687. /**
  147688. * Disposes the PCS.
  147689. */
  147690. dispose(): void;
  147691. /**
  147692. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  147693. * doc :
  147694. * @returns the PCS.
  147695. */
  147696. refreshVisibleSize(): PointsCloudSystem;
  147697. /**
  147698. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  147699. * @param size the size (float) of the visibility box
  147700. * note : this doesn't lock the PCS mesh bounding box.
  147701. * doc :
  147702. */
  147703. setVisibilityBox(size: number): void;
  147704. /**
  147705. * Gets whether the PCS is always visible or not
  147706. * doc :
  147707. */
  147708. get isAlwaysVisible(): boolean;
  147709. /**
  147710. * Sets the PCS as always visible or not
  147711. * doc :
  147712. */
  147713. set isAlwaysVisible(val: boolean);
  147714. /**
  147715. * Tells to `setParticles()` to compute the particle rotations or not
  147716. * Default value : false. The PCS is faster when it's set to false
  147717. * Note : particle rotations are only applied to parent particles
  147718. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  147719. */
  147720. set computeParticleRotation(val: boolean);
  147721. /**
  147722. * Tells to `setParticles()` to compute the particle colors or not.
  147723. * Default value : true. The PCS is faster when it's set to false.
  147724. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147725. */
  147726. set computeParticleColor(val: boolean);
  147727. set computeParticleTexture(val: boolean);
  147728. /**
  147729. * Gets if `setParticles()` computes the particle colors or not.
  147730. * Default value : false. The PCS is faster when it's set to false.
  147731. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147732. */
  147733. get computeParticleColor(): boolean;
  147734. /**
  147735. * Gets if `setParticles()` computes the particle textures or not.
  147736. * Default value : false. The PCS is faster when it's set to false.
  147737. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  147738. */
  147739. get computeParticleTexture(): boolean;
  147740. /**
  147741. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  147742. */
  147743. set computeBoundingBox(val: boolean);
  147744. /**
  147745. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  147746. */
  147747. get computeBoundingBox(): boolean;
  147748. /**
  147749. * This function does nothing. It may be overwritten to set all the particle first values.
  147750. * The PCS doesn't call this function, you may have to call it by your own.
  147751. * doc :
  147752. */
  147753. initParticles(): void;
  147754. /**
  147755. * This function does nothing. It may be overwritten to recycle a particle
  147756. * The PCS doesn't call this function, you can to call it
  147757. * doc :
  147758. * @param particle The particle to recycle
  147759. * @returns the recycled particle
  147760. */
  147761. recycleParticle(particle: CloudPoint): CloudPoint;
  147762. /**
  147763. * Updates a particle : this function should be overwritten by the user.
  147764. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  147765. * doc :
  147766. * @example : just set a particle position or velocity and recycle conditions
  147767. * @param particle The particle to update
  147768. * @returns the updated particle
  147769. */
  147770. updateParticle(particle: CloudPoint): CloudPoint;
  147771. /**
  147772. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  147773. * This does nothing and may be overwritten by the user.
  147774. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147775. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147776. * @param update the boolean update value actually passed to setParticles()
  147777. */
  147778. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147779. /**
  147780. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  147781. * This will be passed three parameters.
  147782. * This does nothing and may be overwritten by the user.
  147783. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147784. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147785. * @param update the boolean update value actually passed to setParticles()
  147786. */
  147787. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147788. }
  147789. }
  147790. declare module BABYLON {
  147791. /**
  147792. * Represents one particle of a points cloud system.
  147793. */
  147794. export class CloudPoint {
  147795. /**
  147796. * particle global index
  147797. */
  147798. idx: number;
  147799. /**
  147800. * The color of the particle
  147801. */
  147802. color: Nullable<Color4>;
  147803. /**
  147804. * The world space position of the particle.
  147805. */
  147806. position: Vector3;
  147807. /**
  147808. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  147809. */
  147810. rotation: Vector3;
  147811. /**
  147812. * The world space rotation quaternion of the particle.
  147813. */
  147814. rotationQuaternion: Nullable<Quaternion>;
  147815. /**
  147816. * The uv of the particle.
  147817. */
  147818. uv: Nullable<Vector2>;
  147819. /**
  147820. * The current speed of the particle.
  147821. */
  147822. velocity: Vector3;
  147823. /**
  147824. * The pivot point in the particle local space.
  147825. */
  147826. pivot: Vector3;
  147827. /**
  147828. * Must the particle be translated from its pivot point in its local space ?
  147829. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  147830. * Default : false
  147831. */
  147832. translateFromPivot: boolean;
  147833. /**
  147834. * Index of this particle in the global "positions" array (Internal use)
  147835. * @hidden
  147836. */
  147837. _pos: number;
  147838. /**
  147839. * @hidden Index of this particle in the global "indices" array (Internal use)
  147840. */
  147841. _ind: number;
  147842. /**
  147843. * Group this particle belongs to
  147844. */
  147845. _group: PointsGroup;
  147846. /**
  147847. * Group id of this particle
  147848. */
  147849. groupId: number;
  147850. /**
  147851. * Index of the particle in its group id (Internal use)
  147852. */
  147853. idxInGroup: number;
  147854. /**
  147855. * @hidden Particle BoundingInfo object (Internal use)
  147856. */
  147857. _boundingInfo: BoundingInfo;
  147858. /**
  147859. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  147860. */
  147861. _pcs: PointsCloudSystem;
  147862. /**
  147863. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  147864. */
  147865. _stillInvisible: boolean;
  147866. /**
  147867. * @hidden Last computed particle rotation matrix
  147868. */
  147869. _rotationMatrix: number[];
  147870. /**
  147871. * Parent particle Id, if any.
  147872. * Default null.
  147873. */
  147874. parentId: Nullable<number>;
  147875. /**
  147876. * @hidden Internal global position in the PCS.
  147877. */
  147878. _globalPosition: Vector3;
  147879. /**
  147880. * Creates a Point Cloud object.
  147881. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  147882. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  147883. * @param group (PointsGroup) is the group the particle belongs to
  147884. * @param groupId (integer) is the group identifier in the PCS.
  147885. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  147886. * @param pcs defines the PCS it is associated to
  147887. */
  147888. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  147889. /**
  147890. * get point size
  147891. */
  147892. get size(): Vector3;
  147893. /**
  147894. * Set point size
  147895. */
  147896. set size(scale: Vector3);
  147897. /**
  147898. * Legacy support, changed quaternion to rotationQuaternion
  147899. */
  147900. get quaternion(): Nullable<Quaternion>;
  147901. /**
  147902. * Legacy support, changed quaternion to rotationQuaternion
  147903. */
  147904. set quaternion(q: Nullable<Quaternion>);
  147905. /**
  147906. * Returns a boolean. True if the particle intersects a mesh, else false
  147907. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  147908. * @param target is the object (point or mesh) what the intersection is computed against
  147909. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  147910. * @returns true if it intersects
  147911. */
  147912. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  147913. /**
  147914. * get the rotation matrix of the particle
  147915. * @hidden
  147916. */
  147917. getRotationMatrix(m: Matrix): void;
  147918. }
  147919. /**
  147920. * Represents a group of points in a points cloud system
  147921. * * PCS internal tool, don't use it manually.
  147922. */
  147923. export class PointsGroup {
  147924. /**
  147925. * The group id
  147926. * @hidden
  147927. */
  147928. groupID: number;
  147929. /**
  147930. * image data for group (internal use)
  147931. * @hidden
  147932. */
  147933. _groupImageData: Nullable<ArrayBufferView>;
  147934. /**
  147935. * Image Width (internal use)
  147936. * @hidden
  147937. */
  147938. _groupImgWidth: number;
  147939. /**
  147940. * Image Height (internal use)
  147941. * @hidden
  147942. */
  147943. _groupImgHeight: number;
  147944. /**
  147945. * Custom position function (internal use)
  147946. * @hidden
  147947. */
  147948. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  147949. /**
  147950. * density per facet for surface points
  147951. * @hidden
  147952. */
  147953. _groupDensity: number[];
  147954. /**
  147955. * Only when points are colored by texture carries pointer to texture list array
  147956. * @hidden
  147957. */
  147958. _textureNb: number;
  147959. /**
  147960. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  147961. * PCS internal tool, don't use it manually.
  147962. * @hidden
  147963. */
  147964. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  147965. }
  147966. }
  147967. declare module BABYLON {
  147968. interface Scene {
  147969. /** @hidden (Backing field) */
  147970. _physicsEngine: Nullable<IPhysicsEngine>;
  147971. /** @hidden */
  147972. _physicsTimeAccumulator: number;
  147973. /**
  147974. * Gets the current physics engine
  147975. * @returns a IPhysicsEngine or null if none attached
  147976. */
  147977. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  147978. /**
  147979. * Enables physics to the current scene
  147980. * @param gravity defines the scene's gravity for the physics engine
  147981. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  147982. * @return a boolean indicating if the physics engine was initialized
  147983. */
  147984. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  147985. /**
  147986. * Disables and disposes the physics engine associated with the scene
  147987. */
  147988. disablePhysicsEngine(): void;
  147989. /**
  147990. * Gets a boolean indicating if there is an active physics engine
  147991. * @returns a boolean indicating if there is an active physics engine
  147992. */
  147993. isPhysicsEnabled(): boolean;
  147994. /**
  147995. * Deletes a physics compound impostor
  147996. * @param compound defines the compound to delete
  147997. */
  147998. deleteCompoundImpostor(compound: any): void;
  147999. /**
  148000. * An event triggered when physic simulation is about to be run
  148001. */
  148002. onBeforePhysicsObservable: Observable<Scene>;
  148003. /**
  148004. * An event triggered when physic simulation has been done
  148005. */
  148006. onAfterPhysicsObservable: Observable<Scene>;
  148007. }
  148008. interface AbstractMesh {
  148009. /** @hidden */
  148010. _physicsImpostor: Nullable<PhysicsImpostor>;
  148011. /**
  148012. * Gets or sets impostor used for physic simulation
  148013. * @see https://doc.babylonjs.com/features/physics_engine
  148014. */
  148015. physicsImpostor: Nullable<PhysicsImpostor>;
  148016. /**
  148017. * Gets the current physics impostor
  148018. * @see https://doc.babylonjs.com/features/physics_engine
  148019. * @returns a physics impostor or null
  148020. */
  148021. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  148022. /** Apply a physic impulse to the mesh
  148023. * @param force defines the force to apply
  148024. * @param contactPoint defines where to apply the force
  148025. * @returns the current mesh
  148026. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  148027. */
  148028. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  148029. /**
  148030. * Creates a physic joint between two meshes
  148031. * @param otherMesh defines the other mesh to use
  148032. * @param pivot1 defines the pivot to use on this mesh
  148033. * @param pivot2 defines the pivot to use on the other mesh
  148034. * @param options defines additional options (can be plugin dependent)
  148035. * @returns the current mesh
  148036. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  148037. */
  148038. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  148039. /** @hidden */
  148040. _disposePhysicsObserver: Nullable<Observer<Node>>;
  148041. }
  148042. /**
  148043. * Defines the physics engine scene component responsible to manage a physics engine
  148044. */
  148045. export class PhysicsEngineSceneComponent implements ISceneComponent {
  148046. /**
  148047. * The component name helpful to identify the component in the list of scene components.
  148048. */
  148049. readonly name: string;
  148050. /**
  148051. * The scene the component belongs to.
  148052. */
  148053. scene: Scene;
  148054. /**
  148055. * Creates a new instance of the component for the given scene
  148056. * @param scene Defines the scene to register the component in
  148057. */
  148058. constructor(scene: Scene);
  148059. /**
  148060. * Registers the component in a given scene
  148061. */
  148062. register(): void;
  148063. /**
  148064. * Rebuilds the elements related to this component in case of
  148065. * context lost for instance.
  148066. */
  148067. rebuild(): void;
  148068. /**
  148069. * Disposes the component and the associated ressources
  148070. */
  148071. dispose(): void;
  148072. }
  148073. }
  148074. declare module BABYLON {
  148075. /**
  148076. * A helper for physics simulations
  148077. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148078. */
  148079. export class PhysicsHelper {
  148080. private _scene;
  148081. private _physicsEngine;
  148082. /**
  148083. * Initializes the Physics helper
  148084. * @param scene Babylon.js scene
  148085. */
  148086. constructor(scene: Scene);
  148087. /**
  148088. * Applies a radial explosion impulse
  148089. * @param origin the origin of the explosion
  148090. * @param radiusOrEventOptions the radius or the options of radial explosion
  148091. * @param strength the explosion strength
  148092. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148093. * @returns A physics radial explosion event, or null
  148094. */
  148095. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148096. /**
  148097. * Applies a radial explosion force
  148098. * @param origin the origin of the explosion
  148099. * @param radiusOrEventOptions the radius or the options of radial explosion
  148100. * @param strength the explosion strength
  148101. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148102. * @returns A physics radial explosion event, or null
  148103. */
  148104. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148105. /**
  148106. * Creates a gravitational field
  148107. * @param origin the origin of the explosion
  148108. * @param radiusOrEventOptions the radius or the options of radial explosion
  148109. * @param strength the explosion strength
  148110. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148111. * @returns A physics gravitational field event, or null
  148112. */
  148113. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  148114. /**
  148115. * Creates a physics updraft event
  148116. * @param origin the origin of the updraft
  148117. * @param radiusOrEventOptions the radius or the options of the updraft
  148118. * @param strength the strength of the updraft
  148119. * @param height the height of the updraft
  148120. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  148121. * @returns A physics updraft event, or null
  148122. */
  148123. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  148124. /**
  148125. * Creates a physics vortex event
  148126. * @param origin the of the vortex
  148127. * @param radiusOrEventOptions the radius or the options of the vortex
  148128. * @param strength the strength of the vortex
  148129. * @param height the height of the vortex
  148130. * @returns a Physics vortex event, or null
  148131. * A physics vortex event or null
  148132. */
  148133. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  148134. }
  148135. /**
  148136. * Represents a physics radial explosion event
  148137. */
  148138. class PhysicsRadialExplosionEvent {
  148139. private _scene;
  148140. private _options;
  148141. private _sphere;
  148142. private _dataFetched;
  148143. /**
  148144. * Initializes a radial explosioin event
  148145. * @param _scene BabylonJS scene
  148146. * @param _options The options for the vortex event
  148147. */
  148148. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  148149. /**
  148150. * Returns the data related to the radial explosion event (sphere).
  148151. * @returns The radial explosion event data
  148152. */
  148153. getData(): PhysicsRadialExplosionEventData;
  148154. /**
  148155. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  148156. * @param impostor A physics imposter
  148157. * @param origin the origin of the explosion
  148158. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  148159. */
  148160. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  148161. /**
  148162. * Triggers affecterd impostors callbacks
  148163. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  148164. */
  148165. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  148166. /**
  148167. * Disposes the sphere.
  148168. * @param force Specifies if the sphere should be disposed by force
  148169. */
  148170. dispose(force?: boolean): void;
  148171. /*** Helpers ***/
  148172. private _prepareSphere;
  148173. private _intersectsWithSphere;
  148174. }
  148175. /**
  148176. * Represents a gravitational field event
  148177. */
  148178. class PhysicsGravitationalFieldEvent {
  148179. private _physicsHelper;
  148180. private _scene;
  148181. private _origin;
  148182. private _options;
  148183. private _tickCallback;
  148184. private _sphere;
  148185. private _dataFetched;
  148186. /**
  148187. * Initializes the physics gravitational field event
  148188. * @param _physicsHelper A physics helper
  148189. * @param _scene BabylonJS scene
  148190. * @param _origin The origin position of the gravitational field event
  148191. * @param _options The options for the vortex event
  148192. */
  148193. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  148194. /**
  148195. * Returns the data related to the gravitational field event (sphere).
  148196. * @returns A gravitational field event
  148197. */
  148198. getData(): PhysicsGravitationalFieldEventData;
  148199. /**
  148200. * Enables the gravitational field.
  148201. */
  148202. enable(): void;
  148203. /**
  148204. * Disables the gravitational field.
  148205. */
  148206. disable(): void;
  148207. /**
  148208. * Disposes the sphere.
  148209. * @param force The force to dispose from the gravitational field event
  148210. */
  148211. dispose(force?: boolean): void;
  148212. private _tick;
  148213. }
  148214. /**
  148215. * Represents a physics updraft event
  148216. */
  148217. class PhysicsUpdraftEvent {
  148218. private _scene;
  148219. private _origin;
  148220. private _options;
  148221. private _physicsEngine;
  148222. private _originTop;
  148223. private _originDirection;
  148224. private _tickCallback;
  148225. private _cylinder;
  148226. private _cylinderPosition;
  148227. private _dataFetched;
  148228. /**
  148229. * Initializes the physics updraft event
  148230. * @param _scene BabylonJS scene
  148231. * @param _origin The origin position of the updraft
  148232. * @param _options The options for the updraft event
  148233. */
  148234. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  148235. /**
  148236. * Returns the data related to the updraft event (cylinder).
  148237. * @returns A physics updraft event
  148238. */
  148239. getData(): PhysicsUpdraftEventData;
  148240. /**
  148241. * Enables the updraft.
  148242. */
  148243. enable(): void;
  148244. /**
  148245. * Disables the updraft.
  148246. */
  148247. disable(): void;
  148248. /**
  148249. * Disposes the cylinder.
  148250. * @param force Specifies if the updraft should be disposed by force
  148251. */
  148252. dispose(force?: boolean): void;
  148253. private getImpostorHitData;
  148254. private _tick;
  148255. /*** Helpers ***/
  148256. private _prepareCylinder;
  148257. private _intersectsWithCylinder;
  148258. }
  148259. /**
  148260. * Represents a physics vortex event
  148261. */
  148262. class PhysicsVortexEvent {
  148263. private _scene;
  148264. private _origin;
  148265. private _options;
  148266. private _physicsEngine;
  148267. private _originTop;
  148268. private _tickCallback;
  148269. private _cylinder;
  148270. private _cylinderPosition;
  148271. private _dataFetched;
  148272. /**
  148273. * Initializes the physics vortex event
  148274. * @param _scene The BabylonJS scene
  148275. * @param _origin The origin position of the vortex
  148276. * @param _options The options for the vortex event
  148277. */
  148278. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  148279. /**
  148280. * Returns the data related to the vortex event (cylinder).
  148281. * @returns The physics vortex event data
  148282. */
  148283. getData(): PhysicsVortexEventData;
  148284. /**
  148285. * Enables the vortex.
  148286. */
  148287. enable(): void;
  148288. /**
  148289. * Disables the cortex.
  148290. */
  148291. disable(): void;
  148292. /**
  148293. * Disposes the sphere.
  148294. * @param force
  148295. */
  148296. dispose(force?: boolean): void;
  148297. private getImpostorHitData;
  148298. private _tick;
  148299. /*** Helpers ***/
  148300. private _prepareCylinder;
  148301. private _intersectsWithCylinder;
  148302. }
  148303. /**
  148304. * Options fot the radial explosion event
  148305. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148306. */
  148307. export class PhysicsRadialExplosionEventOptions {
  148308. /**
  148309. * The radius of the sphere for the radial explosion.
  148310. */
  148311. radius: number;
  148312. /**
  148313. * The strenth of the explosion.
  148314. */
  148315. strength: number;
  148316. /**
  148317. * The strenght of the force in correspondence to the distance of the affected object
  148318. */
  148319. falloff: PhysicsRadialImpulseFalloff;
  148320. /**
  148321. * Sphere options for the radial explosion.
  148322. */
  148323. sphere: {
  148324. segments: number;
  148325. diameter: number;
  148326. };
  148327. /**
  148328. * Sphere options for the radial explosion.
  148329. */
  148330. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  148331. }
  148332. /**
  148333. * Options fot the updraft event
  148334. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148335. */
  148336. export class PhysicsUpdraftEventOptions {
  148337. /**
  148338. * The radius of the cylinder for the vortex
  148339. */
  148340. radius: number;
  148341. /**
  148342. * The strenth of the updraft.
  148343. */
  148344. strength: number;
  148345. /**
  148346. * The height of the cylinder for the updraft.
  148347. */
  148348. height: number;
  148349. /**
  148350. * The mode for the the updraft.
  148351. */
  148352. updraftMode: PhysicsUpdraftMode;
  148353. }
  148354. /**
  148355. * Options fot the vortex event
  148356. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148357. */
  148358. export class PhysicsVortexEventOptions {
  148359. /**
  148360. * The radius of the cylinder for the vortex
  148361. */
  148362. radius: number;
  148363. /**
  148364. * The strenth of the vortex.
  148365. */
  148366. strength: number;
  148367. /**
  148368. * The height of the cylinder for the vortex.
  148369. */
  148370. height: number;
  148371. /**
  148372. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  148373. */
  148374. centripetalForceThreshold: number;
  148375. /**
  148376. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  148377. */
  148378. centripetalForceMultiplier: number;
  148379. /**
  148380. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  148381. */
  148382. centrifugalForceMultiplier: number;
  148383. /**
  148384. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  148385. */
  148386. updraftForceMultiplier: number;
  148387. }
  148388. /**
  148389. * The strenght of the force in correspondence to the distance of the affected object
  148390. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148391. */
  148392. export enum PhysicsRadialImpulseFalloff {
  148393. /** Defines that impulse is constant in strength across it's whole radius */
  148394. Constant = 0,
  148395. /** Defines that impulse gets weaker if it's further from the origin */
  148396. Linear = 1
  148397. }
  148398. /**
  148399. * The strength of the force in correspondence to the distance of the affected object
  148400. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148401. */
  148402. export enum PhysicsUpdraftMode {
  148403. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  148404. Center = 0,
  148405. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  148406. Perpendicular = 1
  148407. }
  148408. /**
  148409. * Interface for a physics hit data
  148410. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148411. */
  148412. export interface PhysicsHitData {
  148413. /**
  148414. * The force applied at the contact point
  148415. */
  148416. force: Vector3;
  148417. /**
  148418. * The contact point
  148419. */
  148420. contactPoint: Vector3;
  148421. /**
  148422. * The distance from the origin to the contact point
  148423. */
  148424. distanceFromOrigin: number;
  148425. }
  148426. /**
  148427. * Interface for radial explosion event data
  148428. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148429. */
  148430. export interface PhysicsRadialExplosionEventData {
  148431. /**
  148432. * A sphere used for the radial explosion event
  148433. */
  148434. sphere: Mesh;
  148435. }
  148436. /**
  148437. * Interface for gravitational field event data
  148438. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148439. */
  148440. export interface PhysicsGravitationalFieldEventData {
  148441. /**
  148442. * A sphere mesh used for the gravitational field event
  148443. */
  148444. sphere: Mesh;
  148445. }
  148446. /**
  148447. * Interface for updraft event data
  148448. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148449. */
  148450. export interface PhysicsUpdraftEventData {
  148451. /**
  148452. * A cylinder used for the updraft event
  148453. */
  148454. cylinder: Mesh;
  148455. }
  148456. /**
  148457. * Interface for vortex event data
  148458. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148459. */
  148460. export interface PhysicsVortexEventData {
  148461. /**
  148462. * A cylinder used for the vortex event
  148463. */
  148464. cylinder: Mesh;
  148465. }
  148466. /**
  148467. * Interface for an affected physics impostor
  148468. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148469. */
  148470. export interface PhysicsAffectedImpostorWithData {
  148471. /**
  148472. * The impostor affected by the effect
  148473. */
  148474. impostor: PhysicsImpostor;
  148475. /**
  148476. * The data about the hit/horce from the explosion
  148477. */
  148478. hitData: PhysicsHitData;
  148479. }
  148480. }
  148481. declare module BABYLON {
  148482. /** @hidden */
  148483. export var blackAndWhitePixelShader: {
  148484. name: string;
  148485. shader: string;
  148486. };
  148487. }
  148488. declare module BABYLON {
  148489. /**
  148490. * Post process used to render in black and white
  148491. */
  148492. export class BlackAndWhitePostProcess extends PostProcess {
  148493. /**
  148494. * Linear about to convert he result to black and white (default: 1)
  148495. */
  148496. degree: number;
  148497. /**
  148498. * Gets a string identifying the name of the class
  148499. * @returns "BlackAndWhitePostProcess" string
  148500. */
  148501. getClassName(): string;
  148502. /**
  148503. * Creates a black and white post process
  148504. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  148505. * @param name The name of the effect.
  148506. * @param options The required width/height ratio to downsize to before computing the render pass.
  148507. * @param camera The camera to apply the render pass to.
  148508. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148509. * @param engine The engine which the post process will be applied. (default: current engine)
  148510. * @param reusable If the post process can be reused on the same frame. (default: false)
  148511. */
  148512. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148513. /** @hidden */
  148514. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  148515. }
  148516. }
  148517. declare module BABYLON {
  148518. /**
  148519. * This represents a set of one or more post processes in Babylon.
  148520. * A post process can be used to apply a shader to a texture after it is rendered.
  148521. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148522. */
  148523. export class PostProcessRenderEffect {
  148524. private _postProcesses;
  148525. private _getPostProcesses;
  148526. private _singleInstance;
  148527. private _cameras;
  148528. private _indicesForCamera;
  148529. /**
  148530. * Name of the effect
  148531. * @hidden
  148532. */
  148533. _name: string;
  148534. /**
  148535. * Instantiates a post process render effect.
  148536. * A post process can be used to apply a shader to a texture after it is rendered.
  148537. * @param engine The engine the effect is tied to
  148538. * @param name The name of the effect
  148539. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  148540. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  148541. */
  148542. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  148543. /**
  148544. * Checks if all the post processes in the effect are supported.
  148545. */
  148546. get isSupported(): boolean;
  148547. /**
  148548. * Updates the current state of the effect
  148549. * @hidden
  148550. */
  148551. _update(): void;
  148552. /**
  148553. * Attaches the effect on cameras
  148554. * @param cameras The camera to attach to.
  148555. * @hidden
  148556. */
  148557. _attachCameras(cameras: Camera): void;
  148558. /**
  148559. * Attaches the effect on cameras
  148560. * @param cameras The camera to attach to.
  148561. * @hidden
  148562. */
  148563. _attachCameras(cameras: Camera[]): void;
  148564. /**
  148565. * Detaches the effect on cameras
  148566. * @param cameras The camera to detatch from.
  148567. * @hidden
  148568. */
  148569. _detachCameras(cameras: Camera): void;
  148570. /**
  148571. * Detatches the effect on cameras
  148572. * @param cameras The camera to detatch from.
  148573. * @hidden
  148574. */
  148575. _detachCameras(cameras: Camera[]): void;
  148576. /**
  148577. * Enables the effect on given cameras
  148578. * @param cameras The camera to enable.
  148579. * @hidden
  148580. */
  148581. _enable(cameras: Camera): void;
  148582. /**
  148583. * Enables the effect on given cameras
  148584. * @param cameras The camera to enable.
  148585. * @hidden
  148586. */
  148587. _enable(cameras: Nullable<Camera[]>): void;
  148588. /**
  148589. * Disables the effect on the given cameras
  148590. * @param cameras The camera to disable.
  148591. * @hidden
  148592. */
  148593. _disable(cameras: Camera): void;
  148594. /**
  148595. * Disables the effect on the given cameras
  148596. * @param cameras The camera to disable.
  148597. * @hidden
  148598. */
  148599. _disable(cameras: Nullable<Camera[]>): void;
  148600. /**
  148601. * Gets a list of the post processes contained in the effect.
  148602. * @param camera The camera to get the post processes on.
  148603. * @returns The list of the post processes in the effect.
  148604. */
  148605. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  148606. }
  148607. }
  148608. declare module BABYLON {
  148609. /** @hidden */
  148610. export var extractHighlightsPixelShader: {
  148611. name: string;
  148612. shader: string;
  148613. };
  148614. }
  148615. declare module BABYLON {
  148616. /**
  148617. * 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.
  148618. */
  148619. export class ExtractHighlightsPostProcess extends PostProcess {
  148620. /**
  148621. * The luminance threshold, pixels below this value will be set to black.
  148622. */
  148623. threshold: number;
  148624. /** @hidden */
  148625. _exposure: number;
  148626. /**
  148627. * Post process which has the input texture to be used when performing highlight extraction
  148628. * @hidden
  148629. */
  148630. _inputPostProcess: Nullable<PostProcess>;
  148631. /**
  148632. * Gets a string identifying the name of the class
  148633. * @returns "ExtractHighlightsPostProcess" string
  148634. */
  148635. getClassName(): string;
  148636. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148637. }
  148638. }
  148639. declare module BABYLON {
  148640. /** @hidden */
  148641. export var bloomMergePixelShader: {
  148642. name: string;
  148643. shader: string;
  148644. };
  148645. }
  148646. declare module BABYLON {
  148647. /**
  148648. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148649. */
  148650. export class BloomMergePostProcess extends PostProcess {
  148651. /** Weight of the bloom to be added to the original input. */
  148652. weight: number;
  148653. /**
  148654. * Gets a string identifying the name of the class
  148655. * @returns "BloomMergePostProcess" string
  148656. */
  148657. getClassName(): string;
  148658. /**
  148659. * Creates a new instance of @see BloomMergePostProcess
  148660. * @param name The name of the effect.
  148661. * @param originalFromInput Post process which's input will be used for the merge.
  148662. * @param blurred Blurred highlights post process which's output will be used.
  148663. * @param weight Weight of the bloom to be added to the original input.
  148664. * @param options The required width/height ratio to downsize to before computing the render pass.
  148665. * @param camera The camera to apply the render pass to.
  148666. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148667. * @param engine The engine which the post process will be applied. (default: current engine)
  148668. * @param reusable If the post process can be reused on the same frame. (default: false)
  148669. * @param textureType Type of textures used when performing the post process. (default: 0)
  148670. * @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)
  148671. */
  148672. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  148673. /** Weight of the bloom to be added to the original input. */
  148674. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148675. }
  148676. }
  148677. declare module BABYLON {
  148678. /**
  148679. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  148680. */
  148681. export class BloomEffect extends PostProcessRenderEffect {
  148682. private bloomScale;
  148683. /**
  148684. * @hidden Internal
  148685. */
  148686. _effects: Array<PostProcess>;
  148687. /**
  148688. * @hidden Internal
  148689. */
  148690. _downscale: ExtractHighlightsPostProcess;
  148691. private _blurX;
  148692. private _blurY;
  148693. private _merge;
  148694. /**
  148695. * The luminance threshold to find bright areas of the image to bloom.
  148696. */
  148697. get threshold(): number;
  148698. set threshold(value: number);
  148699. /**
  148700. * The strength of the bloom.
  148701. */
  148702. get weight(): number;
  148703. set weight(value: number);
  148704. /**
  148705. * Specifies the size of the bloom blur kernel, relative to the final output size
  148706. */
  148707. get kernel(): number;
  148708. set kernel(value: number);
  148709. /**
  148710. * Creates a new instance of @see BloomEffect
  148711. * @param scene The scene the effect belongs to.
  148712. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  148713. * @param bloomKernel The size of the kernel to be used when applying the blur.
  148714. * @param bloomWeight The the strength of bloom.
  148715. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  148716. * @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)
  148717. */
  148718. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  148719. /**
  148720. * Disposes each of the internal effects for a given camera.
  148721. * @param camera The camera to dispose the effect on.
  148722. */
  148723. disposeEffects(camera: Camera): void;
  148724. /**
  148725. * @hidden Internal
  148726. */
  148727. _updateEffects(): void;
  148728. /**
  148729. * Internal
  148730. * @returns if all the contained post processes are ready.
  148731. * @hidden
  148732. */
  148733. _isReady(): boolean;
  148734. }
  148735. }
  148736. declare module BABYLON {
  148737. /** @hidden */
  148738. export var chromaticAberrationPixelShader: {
  148739. name: string;
  148740. shader: string;
  148741. };
  148742. }
  148743. declare module BABYLON {
  148744. /**
  148745. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  148746. */
  148747. export class ChromaticAberrationPostProcess extends PostProcess {
  148748. /**
  148749. * The amount of seperation of rgb channels (default: 30)
  148750. */
  148751. aberrationAmount: number;
  148752. /**
  148753. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  148754. */
  148755. radialIntensity: number;
  148756. /**
  148757. * 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))
  148758. */
  148759. direction: Vector2;
  148760. /**
  148761. * 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))
  148762. */
  148763. centerPosition: Vector2;
  148764. /** The width of the screen to apply the effect on */
  148765. screenWidth: number;
  148766. /** The height of the screen to apply the effect on */
  148767. screenHeight: number;
  148768. /**
  148769. * Gets a string identifying the name of the class
  148770. * @returns "ChromaticAberrationPostProcess" string
  148771. */
  148772. getClassName(): string;
  148773. /**
  148774. * Creates a new instance ChromaticAberrationPostProcess
  148775. * @param name The name of the effect.
  148776. * @param screenWidth The width of the screen to apply the effect on.
  148777. * @param screenHeight The height of the screen to apply the effect on.
  148778. * @param options The required width/height ratio to downsize to before computing the render pass.
  148779. * @param camera The camera to apply the render pass to.
  148780. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148781. * @param engine The engine which the post process will be applied. (default: current engine)
  148782. * @param reusable If the post process can be reused on the same frame. (default: false)
  148783. * @param textureType Type of textures used when performing the post process. (default: 0)
  148784. * @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)
  148785. */
  148786. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148787. /** @hidden */
  148788. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  148789. }
  148790. }
  148791. declare module BABYLON {
  148792. /** @hidden */
  148793. export var circleOfConfusionPixelShader: {
  148794. name: string;
  148795. shader: string;
  148796. };
  148797. }
  148798. declare module BABYLON {
  148799. /**
  148800. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  148801. */
  148802. export class CircleOfConfusionPostProcess extends PostProcess {
  148803. /**
  148804. * 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.
  148805. */
  148806. lensSize: number;
  148807. /**
  148808. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  148809. */
  148810. fStop: number;
  148811. /**
  148812. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  148813. */
  148814. focusDistance: number;
  148815. /**
  148816. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  148817. */
  148818. focalLength: number;
  148819. /**
  148820. * Gets a string identifying the name of the class
  148821. * @returns "CircleOfConfusionPostProcess" string
  148822. */
  148823. getClassName(): string;
  148824. private _depthTexture;
  148825. /**
  148826. * Creates a new instance CircleOfConfusionPostProcess
  148827. * @param name The name of the effect.
  148828. * @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.
  148829. * @param options The required width/height ratio to downsize to before computing the render pass.
  148830. * @param camera The camera to apply the render pass to.
  148831. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148832. * @param engine The engine which the post process will be applied. (default: current engine)
  148833. * @param reusable If the post process can be reused on the same frame. (default: false)
  148834. * @param textureType Type of textures used when performing the post process. (default: 0)
  148835. * @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)
  148836. */
  148837. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148838. /**
  148839. * 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.
  148840. */
  148841. set depthTexture(value: RenderTargetTexture);
  148842. }
  148843. }
  148844. declare module BABYLON {
  148845. /** @hidden */
  148846. export var colorCorrectionPixelShader: {
  148847. name: string;
  148848. shader: string;
  148849. };
  148850. }
  148851. declare module BABYLON {
  148852. /**
  148853. *
  148854. * This post-process allows the modification of rendered colors by using
  148855. * a 'look-up table' (LUT). This effect is also called Color Grading.
  148856. *
  148857. * The object needs to be provided an url to a texture containing the color
  148858. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  148859. * Use an image editing software to tweak the LUT to match your needs.
  148860. *
  148861. * For an example of a color LUT, see here:
  148862. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  148863. * For explanations on color grading, see here:
  148864. * @see http://udn.epicgames.com/Three/ColorGrading.html
  148865. *
  148866. */
  148867. export class ColorCorrectionPostProcess extends PostProcess {
  148868. private _colorTableTexture;
  148869. /**
  148870. * Gets the color table url used to create the LUT texture
  148871. */
  148872. colorTableUrl: string;
  148873. /**
  148874. * Gets a string identifying the name of the class
  148875. * @returns "ColorCorrectionPostProcess" string
  148876. */
  148877. getClassName(): string;
  148878. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148879. /** @hidden */
  148880. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  148881. }
  148882. }
  148883. declare module BABYLON {
  148884. /** @hidden */
  148885. export var convolutionPixelShader: {
  148886. name: string;
  148887. shader: string;
  148888. };
  148889. }
  148890. declare module BABYLON {
  148891. /**
  148892. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  148893. * input texture to perform effects such as edge detection or sharpening
  148894. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  148895. */
  148896. export class ConvolutionPostProcess extends PostProcess {
  148897. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  148898. kernel: number[];
  148899. /**
  148900. * Gets a string identifying the name of the class
  148901. * @returns "ConvolutionPostProcess" string
  148902. */
  148903. getClassName(): string;
  148904. /**
  148905. * Creates a new instance ConvolutionPostProcess
  148906. * @param name The name of the effect.
  148907. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  148908. * @param options The required width/height ratio to downsize to before computing the render pass.
  148909. * @param camera The camera to apply the render pass to.
  148910. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148911. * @param engine The engine which the post process will be applied. (default: current engine)
  148912. * @param reusable If the post process can be reused on the same frame. (default: false)
  148913. * @param textureType Type of textures used when performing the post process. (default: 0)
  148914. */
  148915. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  148916. /** @hidden */
  148917. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  148918. /**
  148919. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148920. */
  148921. static EdgeDetect0Kernel: number[];
  148922. /**
  148923. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148924. */
  148925. static EdgeDetect1Kernel: number[];
  148926. /**
  148927. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148928. */
  148929. static EdgeDetect2Kernel: number[];
  148930. /**
  148931. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148932. */
  148933. static SharpenKernel: number[];
  148934. /**
  148935. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148936. */
  148937. static EmbossKernel: number[];
  148938. /**
  148939. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148940. */
  148941. static GaussianKernel: number[];
  148942. }
  148943. }
  148944. declare module BABYLON {
  148945. /**
  148946. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  148947. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  148948. * based on samples that have a large difference in distance than the center pixel.
  148949. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  148950. */
  148951. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  148952. /**
  148953. * The direction the blur should be applied
  148954. */
  148955. direction: Vector2;
  148956. /**
  148957. * Gets a string identifying the name of the class
  148958. * @returns "DepthOfFieldBlurPostProcess" string
  148959. */
  148960. getClassName(): string;
  148961. /**
  148962. * Creates a new instance CircleOfConfusionPostProcess
  148963. * @param name The name of the effect.
  148964. * @param scene The scene the effect belongs to.
  148965. * @param direction The direction the blur should be applied.
  148966. * @param kernel The size of the kernel used to blur.
  148967. * @param options The required width/height ratio to downsize to before computing the render pass.
  148968. * @param camera The camera to apply the render pass to.
  148969. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  148970. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  148971. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148972. * @param engine The engine which the post process will be applied. (default: current engine)
  148973. * @param reusable If the post process can be reused on the same frame. (default: false)
  148974. * @param textureType Type of textures used when performing the post process. (default: 0)
  148975. * @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)
  148976. */
  148977. 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);
  148978. }
  148979. }
  148980. declare module BABYLON {
  148981. /** @hidden */
  148982. export var depthOfFieldMergePixelShader: {
  148983. name: string;
  148984. shader: string;
  148985. };
  148986. }
  148987. declare module BABYLON {
  148988. /**
  148989. * Options to be set when merging outputs from the default pipeline.
  148990. */
  148991. export class DepthOfFieldMergePostProcessOptions {
  148992. /**
  148993. * The original image to merge on top of
  148994. */
  148995. originalFromInput: PostProcess;
  148996. /**
  148997. * Parameters to perform the merge of the depth of field effect
  148998. */
  148999. depthOfField?: {
  149000. circleOfConfusion: PostProcess;
  149001. blurSteps: Array<PostProcess>;
  149002. };
  149003. /**
  149004. * Parameters to perform the merge of bloom effect
  149005. */
  149006. bloom?: {
  149007. blurred: PostProcess;
  149008. weight: number;
  149009. };
  149010. }
  149011. /**
  149012. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  149013. */
  149014. export class DepthOfFieldMergePostProcess extends PostProcess {
  149015. private blurSteps;
  149016. /**
  149017. * Gets a string identifying the name of the class
  149018. * @returns "DepthOfFieldMergePostProcess" string
  149019. */
  149020. getClassName(): string;
  149021. /**
  149022. * Creates a new instance of DepthOfFieldMergePostProcess
  149023. * @param name The name of the effect.
  149024. * @param originalFromInput Post process which's input will be used for the merge.
  149025. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  149026. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  149027. * @param options The required width/height ratio to downsize to before computing the render pass.
  149028. * @param camera The camera to apply the render pass to.
  149029. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149030. * @param engine The engine which the post process will be applied. (default: current engine)
  149031. * @param reusable If the post process can be reused on the same frame. (default: false)
  149032. * @param textureType Type of textures used when performing the post process. (default: 0)
  149033. * @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)
  149034. */
  149035. 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);
  149036. /**
  149037. * Updates the effect with the current post process compile time values and recompiles the shader.
  149038. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  149039. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  149040. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  149041. * @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
  149042. * @param onCompiled Called when the shader has been compiled.
  149043. * @param onError Called if there is an error when compiling a shader.
  149044. */
  149045. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  149046. }
  149047. }
  149048. declare module BABYLON {
  149049. /**
  149050. * Specifies the level of max blur that should be applied when using the depth of field effect
  149051. */
  149052. export enum DepthOfFieldEffectBlurLevel {
  149053. /**
  149054. * Subtle blur
  149055. */
  149056. Low = 0,
  149057. /**
  149058. * Medium blur
  149059. */
  149060. Medium = 1,
  149061. /**
  149062. * Large blur
  149063. */
  149064. High = 2
  149065. }
  149066. /**
  149067. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  149068. */
  149069. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  149070. private _circleOfConfusion;
  149071. /**
  149072. * @hidden Internal, blurs from high to low
  149073. */
  149074. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  149075. private _depthOfFieldBlurY;
  149076. private _dofMerge;
  149077. /**
  149078. * @hidden Internal post processes in depth of field effect
  149079. */
  149080. _effects: Array<PostProcess>;
  149081. /**
  149082. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  149083. */
  149084. set focalLength(value: number);
  149085. get focalLength(): number;
  149086. /**
  149087. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149088. */
  149089. set fStop(value: number);
  149090. get fStop(): number;
  149091. /**
  149092. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149093. */
  149094. set focusDistance(value: number);
  149095. get focusDistance(): number;
  149096. /**
  149097. * 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.
  149098. */
  149099. set lensSize(value: number);
  149100. get lensSize(): number;
  149101. /**
  149102. * Creates a new instance DepthOfFieldEffect
  149103. * @param scene The scene the effect belongs to.
  149104. * @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.
  149105. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  149106. * @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)
  149107. */
  149108. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  149109. /**
  149110. * Get the current class name of the current effet
  149111. * @returns "DepthOfFieldEffect"
  149112. */
  149113. getClassName(): string;
  149114. /**
  149115. * 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.
  149116. */
  149117. set depthTexture(value: RenderTargetTexture);
  149118. /**
  149119. * Disposes each of the internal effects for a given camera.
  149120. * @param camera The camera to dispose the effect on.
  149121. */
  149122. disposeEffects(camera: Camera): void;
  149123. /**
  149124. * @hidden Internal
  149125. */
  149126. _updateEffects(): void;
  149127. /**
  149128. * Internal
  149129. * @returns if all the contained post processes are ready.
  149130. * @hidden
  149131. */
  149132. _isReady(): boolean;
  149133. }
  149134. }
  149135. declare module BABYLON {
  149136. /** @hidden */
  149137. export var displayPassPixelShader: {
  149138. name: string;
  149139. shader: string;
  149140. };
  149141. }
  149142. declare module BABYLON {
  149143. /**
  149144. * DisplayPassPostProcess which produces an output the same as it's input
  149145. */
  149146. export class DisplayPassPostProcess extends PostProcess {
  149147. /**
  149148. * Gets a string identifying the name of the class
  149149. * @returns "DisplayPassPostProcess" string
  149150. */
  149151. getClassName(): string;
  149152. /**
  149153. * Creates the DisplayPassPostProcess
  149154. * @param name The name of the effect.
  149155. * @param options The required width/height ratio to downsize to before computing the render pass.
  149156. * @param camera The camera to apply the render pass to.
  149157. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149158. * @param engine The engine which the post process will be applied. (default: current engine)
  149159. * @param reusable If the post process can be reused on the same frame. (default: false)
  149160. */
  149161. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149162. /** @hidden */
  149163. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  149164. }
  149165. }
  149166. declare module BABYLON {
  149167. /** @hidden */
  149168. export var filterPixelShader: {
  149169. name: string;
  149170. shader: string;
  149171. };
  149172. }
  149173. declare module BABYLON {
  149174. /**
  149175. * Applies a kernel filter to the image
  149176. */
  149177. export class FilterPostProcess extends PostProcess {
  149178. /** The matrix to be applied to the image */
  149179. kernelMatrix: Matrix;
  149180. /**
  149181. * Gets a string identifying the name of the class
  149182. * @returns "FilterPostProcess" string
  149183. */
  149184. getClassName(): string;
  149185. /**
  149186. *
  149187. * @param name The name of the effect.
  149188. * @param kernelMatrix The matrix to be applied to the image
  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. */
  149195. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149196. /** @hidden */
  149197. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  149198. }
  149199. }
  149200. declare module BABYLON {
  149201. /** @hidden */
  149202. export var fxaaPixelShader: {
  149203. name: string;
  149204. shader: string;
  149205. };
  149206. }
  149207. declare module BABYLON {
  149208. /** @hidden */
  149209. export var fxaaVertexShader: {
  149210. name: string;
  149211. shader: string;
  149212. };
  149213. }
  149214. declare module BABYLON {
  149215. /**
  149216. * Fxaa post process
  149217. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  149218. */
  149219. export class FxaaPostProcess extends PostProcess {
  149220. /**
  149221. * Gets a string identifying the name of the class
  149222. * @returns "FxaaPostProcess" string
  149223. */
  149224. getClassName(): string;
  149225. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149226. private _getDefines;
  149227. /** @hidden */
  149228. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  149229. }
  149230. }
  149231. declare module BABYLON {
  149232. /** @hidden */
  149233. export var grainPixelShader: {
  149234. name: string;
  149235. shader: string;
  149236. };
  149237. }
  149238. declare module BABYLON {
  149239. /**
  149240. * The GrainPostProcess adds noise to the image at mid luminance levels
  149241. */
  149242. export class GrainPostProcess extends PostProcess {
  149243. /**
  149244. * The intensity of the grain added (default: 30)
  149245. */
  149246. intensity: number;
  149247. /**
  149248. * If the grain should be randomized on every frame
  149249. */
  149250. animated: boolean;
  149251. /**
  149252. * Gets a string identifying the name of the class
  149253. * @returns "GrainPostProcess" string
  149254. */
  149255. getClassName(): string;
  149256. /**
  149257. * Creates a new instance of @see GrainPostProcess
  149258. * @param name The name of the effect.
  149259. * @param options The required width/height ratio to downsize to before computing the render pass.
  149260. * @param camera The camera to apply the render pass to.
  149261. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149262. * @param engine The engine which the post process will be applied. (default: current engine)
  149263. * @param reusable If the post process can be reused on the same frame. (default: false)
  149264. * @param textureType Type of textures used when performing the post process. (default: 0)
  149265. * @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)
  149266. */
  149267. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149268. /** @hidden */
  149269. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  149270. }
  149271. }
  149272. declare module BABYLON {
  149273. /** @hidden */
  149274. export var highlightsPixelShader: {
  149275. name: string;
  149276. shader: string;
  149277. };
  149278. }
  149279. declare module BABYLON {
  149280. /**
  149281. * Extracts highlights from the image
  149282. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149283. */
  149284. export class HighlightsPostProcess extends PostProcess {
  149285. /**
  149286. * Gets a string identifying the name of the class
  149287. * @returns "HighlightsPostProcess" string
  149288. */
  149289. getClassName(): string;
  149290. /**
  149291. * Extracts highlights from the image
  149292. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149293. * @param name The name of the effect.
  149294. * @param options The required width/height ratio to downsize to before computing the render pass.
  149295. * @param camera The camera to apply the render pass to.
  149296. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149297. * @param engine The engine which the post process will be applied. (default: current engine)
  149298. * @param reusable If the post process can be reused on the same frame. (default: false)
  149299. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  149300. */
  149301. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149302. }
  149303. }
  149304. declare module BABYLON {
  149305. /** @hidden */
  149306. export var mrtFragmentDeclaration: {
  149307. name: string;
  149308. shader: string;
  149309. };
  149310. }
  149311. declare module BABYLON {
  149312. /** @hidden */
  149313. export var geometryPixelShader: {
  149314. name: string;
  149315. shader: string;
  149316. };
  149317. }
  149318. declare module BABYLON {
  149319. /** @hidden */
  149320. export var geometryVertexShader: {
  149321. name: string;
  149322. shader: string;
  149323. };
  149324. }
  149325. declare module BABYLON {
  149326. /** @hidden */
  149327. interface ISavedTransformationMatrix {
  149328. world: Matrix;
  149329. viewProjection: Matrix;
  149330. }
  149331. /**
  149332. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  149333. */
  149334. export class GeometryBufferRenderer {
  149335. /**
  149336. * Constant used to retrieve the position texture index in the G-Buffer textures array
  149337. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  149338. */
  149339. static readonly POSITION_TEXTURE_TYPE: number;
  149340. /**
  149341. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  149342. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  149343. */
  149344. static readonly VELOCITY_TEXTURE_TYPE: number;
  149345. /**
  149346. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  149347. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  149348. */
  149349. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  149350. /**
  149351. * Dictionary used to store the previous transformation matrices of each rendered mesh
  149352. * in order to compute objects velocities when enableVelocity is set to "true"
  149353. * @hidden
  149354. */
  149355. _previousTransformationMatrices: {
  149356. [index: number]: ISavedTransformationMatrix;
  149357. };
  149358. /**
  149359. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  149360. * in order to compute objects velocities when enableVelocity is set to "true"
  149361. * @hidden
  149362. */
  149363. _previousBonesTransformationMatrices: {
  149364. [index: number]: Float32Array;
  149365. };
  149366. /**
  149367. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  149368. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  149369. */
  149370. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  149371. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  149372. renderTransparentMeshes: boolean;
  149373. private _scene;
  149374. private _resizeObserver;
  149375. private _multiRenderTarget;
  149376. private _ratio;
  149377. private _enablePosition;
  149378. private _enableVelocity;
  149379. private _enableReflectivity;
  149380. private _positionIndex;
  149381. private _velocityIndex;
  149382. private _reflectivityIndex;
  149383. protected _effect: Effect;
  149384. protected _cachedDefines: string;
  149385. /**
  149386. * Set the render list (meshes to be rendered) used in the G buffer.
  149387. */
  149388. set renderList(meshes: Mesh[]);
  149389. /**
  149390. * Gets wether or not G buffer are supported by the running hardware.
  149391. * This requires draw buffer supports
  149392. */
  149393. get isSupported(): boolean;
  149394. /**
  149395. * Returns the index of the given texture type in the G-Buffer textures array
  149396. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  149397. * @returns the index of the given texture type in the G-Buffer textures array
  149398. */
  149399. getTextureIndex(textureType: number): number;
  149400. /**
  149401. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  149402. */
  149403. get enablePosition(): boolean;
  149404. /**
  149405. * Sets whether or not objects positions are enabled for the G buffer.
  149406. */
  149407. set enablePosition(enable: boolean);
  149408. /**
  149409. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  149410. */
  149411. get enableVelocity(): boolean;
  149412. /**
  149413. * Sets wether or not objects velocities are enabled for the G buffer.
  149414. */
  149415. set enableVelocity(enable: boolean);
  149416. /**
  149417. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  149418. */
  149419. get enableReflectivity(): boolean;
  149420. /**
  149421. * Sets wether or not objects roughness are enabled for the G buffer.
  149422. */
  149423. set enableReflectivity(enable: boolean);
  149424. /**
  149425. * Gets the scene associated with the buffer.
  149426. */
  149427. get scene(): Scene;
  149428. /**
  149429. * Gets the ratio used by the buffer during its creation.
  149430. * How big is the buffer related to the main canvas.
  149431. */
  149432. get ratio(): number;
  149433. /** @hidden */
  149434. static _SceneComponentInitialization: (scene: Scene) => void;
  149435. /**
  149436. * Creates a new G Buffer for the scene
  149437. * @param scene The scene the buffer belongs to
  149438. * @param ratio How big is the buffer related to the main canvas.
  149439. */
  149440. constructor(scene: Scene, ratio?: number);
  149441. /**
  149442. * Checks wether everything is ready to render a submesh to the G buffer.
  149443. * @param subMesh the submesh to check readiness for
  149444. * @param useInstances is the mesh drawn using instance or not
  149445. * @returns true if ready otherwise false
  149446. */
  149447. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  149448. /**
  149449. * Gets the current underlying G Buffer.
  149450. * @returns the buffer
  149451. */
  149452. getGBuffer(): MultiRenderTarget;
  149453. /**
  149454. * Gets the number of samples used to render the buffer (anti aliasing).
  149455. */
  149456. get samples(): number;
  149457. /**
  149458. * Sets the number of samples used to render the buffer (anti aliasing).
  149459. */
  149460. set samples(value: number);
  149461. /**
  149462. * Disposes the renderer and frees up associated resources.
  149463. */
  149464. dispose(): void;
  149465. protected _createRenderTargets(): void;
  149466. private _copyBonesTransformationMatrices;
  149467. }
  149468. }
  149469. declare module BABYLON {
  149470. interface Scene {
  149471. /** @hidden (Backing field) */
  149472. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149473. /**
  149474. * Gets or Sets the current geometry buffer associated to the scene.
  149475. */
  149476. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149477. /**
  149478. * Enables a GeometryBufferRender and associates it with the scene
  149479. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  149480. * @returns the GeometryBufferRenderer
  149481. */
  149482. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  149483. /**
  149484. * Disables the GeometryBufferRender associated with the scene
  149485. */
  149486. disableGeometryBufferRenderer(): void;
  149487. }
  149488. /**
  149489. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  149490. * in several rendering techniques.
  149491. */
  149492. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  149493. /**
  149494. * The component name helpful to identify the component in the list of scene components.
  149495. */
  149496. readonly name: string;
  149497. /**
  149498. * The scene the component belongs to.
  149499. */
  149500. scene: Scene;
  149501. /**
  149502. * Creates a new instance of the component for the given scene
  149503. * @param scene Defines the scene to register the component in
  149504. */
  149505. constructor(scene: Scene);
  149506. /**
  149507. * Registers the component in a given scene
  149508. */
  149509. register(): void;
  149510. /**
  149511. * Rebuilds the elements related to this component in case of
  149512. * context lost for instance.
  149513. */
  149514. rebuild(): void;
  149515. /**
  149516. * Disposes the component and the associated ressources
  149517. */
  149518. dispose(): void;
  149519. private _gatherRenderTargets;
  149520. }
  149521. }
  149522. declare module BABYLON {
  149523. /** @hidden */
  149524. export var motionBlurPixelShader: {
  149525. name: string;
  149526. shader: string;
  149527. };
  149528. }
  149529. declare module BABYLON {
  149530. /**
  149531. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  149532. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  149533. * As an example, all you have to do is to create the post-process:
  149534. * var mb = new BABYLON.MotionBlurPostProcess(
  149535. * 'mb', // The name of the effect.
  149536. * scene, // The scene containing the objects to blur according to their velocity.
  149537. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  149538. * camera // The camera to apply the render pass to.
  149539. * );
  149540. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  149541. */
  149542. export class MotionBlurPostProcess extends PostProcess {
  149543. /**
  149544. * Defines how much the image is blurred by the movement. Default value is equal to 1
  149545. */
  149546. motionStrength: number;
  149547. /**
  149548. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  149549. */
  149550. get motionBlurSamples(): number;
  149551. /**
  149552. * Sets the number of iterations to be used for motion blur quality
  149553. */
  149554. set motionBlurSamples(samples: number);
  149555. private _motionBlurSamples;
  149556. private _geometryBufferRenderer;
  149557. /**
  149558. * Gets a string identifying the name of the class
  149559. * @returns "MotionBlurPostProcess" string
  149560. */
  149561. getClassName(): string;
  149562. /**
  149563. * Creates a new instance MotionBlurPostProcess
  149564. * @param name The name of the effect.
  149565. * @param scene The scene containing the objects to blur according to their velocity.
  149566. * @param options The required width/height ratio to downsize to before computing the render pass.
  149567. * @param camera The camera to apply the render pass to.
  149568. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149569. * @param engine The engine which the post process will be applied. (default: current engine)
  149570. * @param reusable If the post process can be reused on the same frame. (default: false)
  149571. * @param textureType Type of textures used when performing the post process. (default: 0)
  149572. * @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)
  149573. */
  149574. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149575. /**
  149576. * Excludes the given skinned mesh from computing bones velocities.
  149577. * 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.
  149578. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  149579. */
  149580. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149581. /**
  149582. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  149583. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  149584. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  149585. */
  149586. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149587. /**
  149588. * Disposes the post process.
  149589. * @param camera The camera to dispose the post process on.
  149590. */
  149591. dispose(camera?: Camera): void;
  149592. /** @hidden */
  149593. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  149594. }
  149595. }
  149596. declare module BABYLON {
  149597. /** @hidden */
  149598. export var refractionPixelShader: {
  149599. name: string;
  149600. shader: string;
  149601. };
  149602. }
  149603. declare module BABYLON {
  149604. /**
  149605. * Post process which applies a refractin texture
  149606. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149607. */
  149608. export class RefractionPostProcess extends PostProcess {
  149609. private _refTexture;
  149610. private _ownRefractionTexture;
  149611. /** the base color of the refraction (used to taint the rendering) */
  149612. color: Color3;
  149613. /** simulated refraction depth */
  149614. depth: number;
  149615. /** the coefficient of the base color (0 to remove base color tainting) */
  149616. colorLevel: number;
  149617. /** Gets the url used to load the refraction texture */
  149618. refractionTextureUrl: string;
  149619. /**
  149620. * Gets or sets the refraction texture
  149621. * Please note that you are responsible for disposing the texture if you set it manually
  149622. */
  149623. get refractionTexture(): Texture;
  149624. set refractionTexture(value: Texture);
  149625. /**
  149626. * Gets a string identifying the name of the class
  149627. * @returns "RefractionPostProcess" string
  149628. */
  149629. getClassName(): string;
  149630. /**
  149631. * Initializes the RefractionPostProcess
  149632. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149633. * @param name The name of the effect.
  149634. * @param refractionTextureUrl Url of the refraction texture to use
  149635. * @param color the base color of the refraction (used to taint the rendering)
  149636. * @param depth simulated refraction depth
  149637. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  149638. * @param camera The camera to apply the render pass to.
  149639. * @param options The required width/height ratio to downsize to before computing the render pass.
  149640. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149641. * @param engine The engine which the post process will be applied. (default: current engine)
  149642. * @param reusable If the post process can be reused on the same frame. (default: false)
  149643. */
  149644. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149645. /**
  149646. * Disposes of the post process
  149647. * @param camera Camera to dispose post process on
  149648. */
  149649. dispose(camera: Camera): void;
  149650. /** @hidden */
  149651. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  149652. }
  149653. }
  149654. declare module BABYLON {
  149655. /** @hidden */
  149656. export var sharpenPixelShader: {
  149657. name: string;
  149658. shader: string;
  149659. };
  149660. }
  149661. declare module BABYLON {
  149662. /**
  149663. * The SharpenPostProcess applies a sharpen kernel to every pixel
  149664. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149665. */
  149666. export class SharpenPostProcess extends PostProcess {
  149667. /**
  149668. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  149669. */
  149670. colorAmount: number;
  149671. /**
  149672. * How much sharpness should be applied (default: 0.3)
  149673. */
  149674. edgeAmount: number;
  149675. /**
  149676. * Gets a string identifying the name of the class
  149677. * @returns "SharpenPostProcess" string
  149678. */
  149679. getClassName(): string;
  149680. /**
  149681. * Creates a new instance ConvolutionPostProcess
  149682. * @param name The name of the effect.
  149683. * @param options The required width/height ratio to downsize to before computing the render pass.
  149684. * @param camera The camera to apply the render pass to.
  149685. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149686. * @param engine The engine which the post process will be applied. (default: current engine)
  149687. * @param reusable If the post process can be reused on the same frame. (default: false)
  149688. * @param textureType Type of textures used when performing the post process. (default: 0)
  149689. * @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)
  149690. */
  149691. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149692. /** @hidden */
  149693. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  149694. }
  149695. }
  149696. declare module BABYLON {
  149697. /**
  149698. * PostProcessRenderPipeline
  149699. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149700. */
  149701. export class PostProcessRenderPipeline {
  149702. private engine;
  149703. private _renderEffects;
  149704. private _renderEffectsForIsolatedPass;
  149705. /**
  149706. * List of inspectable custom properties (used by the Inspector)
  149707. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  149708. */
  149709. inspectableCustomProperties: IInspectable[];
  149710. /**
  149711. * @hidden
  149712. */
  149713. protected _cameras: Camera[];
  149714. /** @hidden */
  149715. _name: string;
  149716. /**
  149717. * Gets pipeline name
  149718. */
  149719. get name(): string;
  149720. /** Gets the list of attached cameras */
  149721. get cameras(): Camera[];
  149722. /**
  149723. * Initializes a PostProcessRenderPipeline
  149724. * @param engine engine to add the pipeline to
  149725. * @param name name of the pipeline
  149726. */
  149727. constructor(engine: Engine, name: string);
  149728. /**
  149729. * Gets the class name
  149730. * @returns "PostProcessRenderPipeline"
  149731. */
  149732. getClassName(): string;
  149733. /**
  149734. * If all the render effects in the pipeline are supported
  149735. */
  149736. get isSupported(): boolean;
  149737. /**
  149738. * Adds an effect to the pipeline
  149739. * @param renderEffect the effect to add
  149740. */
  149741. addEffect(renderEffect: PostProcessRenderEffect): void;
  149742. /** @hidden */
  149743. _rebuild(): void;
  149744. /** @hidden */
  149745. _enableEffect(renderEffectName: string, cameras: Camera): void;
  149746. /** @hidden */
  149747. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  149748. /** @hidden */
  149749. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149750. /** @hidden */
  149751. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149752. /** @hidden */
  149753. _attachCameras(cameras: Camera, unique: boolean): void;
  149754. /** @hidden */
  149755. _attachCameras(cameras: Camera[], unique: boolean): void;
  149756. /** @hidden */
  149757. _detachCameras(cameras: Camera): void;
  149758. /** @hidden */
  149759. _detachCameras(cameras: Nullable<Camera[]>): void;
  149760. /** @hidden */
  149761. _update(): void;
  149762. /** @hidden */
  149763. _reset(): void;
  149764. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  149765. /**
  149766. * Sets the required values to the prepass renderer.
  149767. * @param prePassRenderer defines the prepass renderer to setup.
  149768. * @returns true if the pre pass is needed.
  149769. */
  149770. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  149771. /**
  149772. * Disposes of the pipeline
  149773. */
  149774. dispose(): void;
  149775. }
  149776. }
  149777. declare module BABYLON {
  149778. /**
  149779. * PostProcessRenderPipelineManager class
  149780. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149781. */
  149782. export class PostProcessRenderPipelineManager {
  149783. private _renderPipelines;
  149784. /**
  149785. * Initializes a PostProcessRenderPipelineManager
  149786. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149787. */
  149788. constructor();
  149789. /**
  149790. * Gets the list of supported render pipelines
  149791. */
  149792. get supportedPipelines(): PostProcessRenderPipeline[];
  149793. /**
  149794. * Adds a pipeline to the manager
  149795. * @param renderPipeline The pipeline to add
  149796. */
  149797. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  149798. /**
  149799. * Attaches a camera to the pipeline
  149800. * @param renderPipelineName The name of the pipeline to attach to
  149801. * @param cameras the camera to attach
  149802. * @param unique if the camera can be attached multiple times to the pipeline
  149803. */
  149804. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  149805. /**
  149806. * Detaches a camera from the pipeline
  149807. * @param renderPipelineName The name of the pipeline to detach from
  149808. * @param cameras the camera to detach
  149809. */
  149810. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  149811. /**
  149812. * Enables an effect by name on a pipeline
  149813. * @param renderPipelineName the name of the pipeline to enable the effect in
  149814. * @param renderEffectName the name of the effect to enable
  149815. * @param cameras the cameras that the effect should be enabled on
  149816. */
  149817. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149818. /**
  149819. * Disables an effect by name on a pipeline
  149820. * @param renderPipelineName the name of the pipeline to disable the effect in
  149821. * @param renderEffectName the name of the effect to disable
  149822. * @param cameras the cameras that the effect should be disabled on
  149823. */
  149824. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149825. /**
  149826. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  149827. */
  149828. update(): void;
  149829. /** @hidden */
  149830. _rebuild(): void;
  149831. /**
  149832. * Disposes of the manager and pipelines
  149833. */
  149834. dispose(): void;
  149835. }
  149836. }
  149837. declare module BABYLON {
  149838. interface Scene {
  149839. /** @hidden (Backing field) */
  149840. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149841. /**
  149842. * Gets the postprocess render pipeline manager
  149843. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149844. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149845. */
  149846. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149847. }
  149848. /**
  149849. * Defines the Render Pipeline scene component responsible to rendering pipelines
  149850. */
  149851. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  149852. /**
  149853. * The component name helpfull to identify the component in the list of scene components.
  149854. */
  149855. readonly name: string;
  149856. /**
  149857. * The scene the component belongs to.
  149858. */
  149859. scene: Scene;
  149860. /**
  149861. * Creates a new instance of the component for the given scene
  149862. * @param scene Defines the scene to register the component in
  149863. */
  149864. constructor(scene: Scene);
  149865. /**
  149866. * Registers the component in a given scene
  149867. */
  149868. register(): void;
  149869. /**
  149870. * Rebuilds the elements related to this component in case of
  149871. * context lost for instance.
  149872. */
  149873. rebuild(): void;
  149874. /**
  149875. * Disposes the component and the associated ressources
  149876. */
  149877. dispose(): void;
  149878. private _gatherRenderTargets;
  149879. }
  149880. }
  149881. declare module BABYLON {
  149882. /**
  149883. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  149884. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149885. */
  149886. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  149887. private _scene;
  149888. private _camerasToBeAttached;
  149889. /**
  149890. * ID of the sharpen post process,
  149891. */
  149892. private readonly SharpenPostProcessId;
  149893. /**
  149894. * @ignore
  149895. * ID of the image processing post process;
  149896. */
  149897. readonly ImageProcessingPostProcessId: string;
  149898. /**
  149899. * @ignore
  149900. * ID of the Fast Approximate Anti-Aliasing post process;
  149901. */
  149902. readonly FxaaPostProcessId: string;
  149903. /**
  149904. * ID of the chromatic aberration post process,
  149905. */
  149906. private readonly ChromaticAberrationPostProcessId;
  149907. /**
  149908. * ID of the grain post process
  149909. */
  149910. private readonly GrainPostProcessId;
  149911. /**
  149912. * Sharpen post process which will apply a sharpen convolution to enhance edges
  149913. */
  149914. sharpen: SharpenPostProcess;
  149915. private _sharpenEffect;
  149916. private bloom;
  149917. /**
  149918. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  149919. */
  149920. depthOfField: DepthOfFieldEffect;
  149921. /**
  149922. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  149923. */
  149924. fxaa: FxaaPostProcess;
  149925. /**
  149926. * Image post processing pass used to perform operations such as tone mapping or color grading.
  149927. */
  149928. imageProcessing: ImageProcessingPostProcess;
  149929. /**
  149930. * Chromatic aberration post process which will shift rgb colors in the image
  149931. */
  149932. chromaticAberration: ChromaticAberrationPostProcess;
  149933. private _chromaticAberrationEffect;
  149934. /**
  149935. * Grain post process which add noise to the image
  149936. */
  149937. grain: GrainPostProcess;
  149938. private _grainEffect;
  149939. /**
  149940. * Glow post process which adds a glow to emissive areas of the image
  149941. */
  149942. private _glowLayer;
  149943. /**
  149944. * Animations which can be used to tweak settings over a period of time
  149945. */
  149946. animations: Animation[];
  149947. private _imageProcessingConfigurationObserver;
  149948. private _sharpenEnabled;
  149949. private _bloomEnabled;
  149950. private _depthOfFieldEnabled;
  149951. private _depthOfFieldBlurLevel;
  149952. private _fxaaEnabled;
  149953. private _imageProcessingEnabled;
  149954. private _defaultPipelineTextureType;
  149955. private _bloomScale;
  149956. private _chromaticAberrationEnabled;
  149957. private _grainEnabled;
  149958. private _buildAllowed;
  149959. /**
  149960. * Gets active scene
  149961. */
  149962. get scene(): Scene;
  149963. /**
  149964. * Enable or disable the sharpen process from the pipeline
  149965. */
  149966. set sharpenEnabled(enabled: boolean);
  149967. get sharpenEnabled(): boolean;
  149968. private _resizeObserver;
  149969. private _hardwareScaleLevel;
  149970. private _bloomKernel;
  149971. /**
  149972. * Specifies the size of the bloom blur kernel, relative to the final output size
  149973. */
  149974. get bloomKernel(): number;
  149975. set bloomKernel(value: number);
  149976. /**
  149977. * Specifies the weight of the bloom in the final rendering
  149978. */
  149979. private _bloomWeight;
  149980. /**
  149981. * Specifies the luma threshold for the area that will be blurred by the bloom
  149982. */
  149983. private _bloomThreshold;
  149984. private _hdr;
  149985. /**
  149986. * The strength of the bloom.
  149987. */
  149988. set bloomWeight(value: number);
  149989. get bloomWeight(): number;
  149990. /**
  149991. * The strength of the bloom.
  149992. */
  149993. set bloomThreshold(value: number);
  149994. get bloomThreshold(): number;
  149995. /**
  149996. * The scale of the bloom, lower value will provide better performance.
  149997. */
  149998. set bloomScale(value: number);
  149999. get bloomScale(): number;
  150000. /**
  150001. * Enable or disable the bloom from the pipeline
  150002. */
  150003. set bloomEnabled(enabled: boolean);
  150004. get bloomEnabled(): boolean;
  150005. private _rebuildBloom;
  150006. /**
  150007. * If the depth of field is enabled.
  150008. */
  150009. get depthOfFieldEnabled(): boolean;
  150010. set depthOfFieldEnabled(enabled: boolean);
  150011. /**
  150012. * Blur level of the depth of field effect. (Higher blur will effect performance)
  150013. */
  150014. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  150015. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  150016. /**
  150017. * If the anti aliasing is enabled.
  150018. */
  150019. set fxaaEnabled(enabled: boolean);
  150020. get fxaaEnabled(): boolean;
  150021. private _samples;
  150022. /**
  150023. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  150024. */
  150025. set samples(sampleCount: number);
  150026. get samples(): number;
  150027. /**
  150028. * If image processing is enabled.
  150029. */
  150030. set imageProcessingEnabled(enabled: boolean);
  150031. get imageProcessingEnabled(): boolean;
  150032. /**
  150033. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  150034. */
  150035. set glowLayerEnabled(enabled: boolean);
  150036. get glowLayerEnabled(): boolean;
  150037. /**
  150038. * Gets the glow layer (or null if not defined)
  150039. */
  150040. get glowLayer(): Nullable<GlowLayer>;
  150041. /**
  150042. * Enable or disable the chromaticAberration process from the pipeline
  150043. */
  150044. set chromaticAberrationEnabled(enabled: boolean);
  150045. get chromaticAberrationEnabled(): boolean;
  150046. /**
  150047. * Enable or disable the grain process from the pipeline
  150048. */
  150049. set grainEnabled(enabled: boolean);
  150050. get grainEnabled(): boolean;
  150051. /**
  150052. * @constructor
  150053. * @param name - The rendering pipeline name (default: "")
  150054. * @param hdr - If high dynamic range textures should be used (default: true)
  150055. * @param scene - The scene linked to this pipeline (default: the last created scene)
  150056. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  150057. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  150058. */
  150059. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  150060. /**
  150061. * Get the class name
  150062. * @returns "DefaultRenderingPipeline"
  150063. */
  150064. getClassName(): string;
  150065. /**
  150066. * Force the compilation of the entire pipeline.
  150067. */
  150068. prepare(): void;
  150069. private _hasCleared;
  150070. private _prevPostProcess;
  150071. private _prevPrevPostProcess;
  150072. private _setAutoClearAndTextureSharing;
  150073. private _depthOfFieldSceneObserver;
  150074. private _buildPipeline;
  150075. private _disposePostProcesses;
  150076. /**
  150077. * Adds a camera to the pipeline
  150078. * @param camera the camera to be added
  150079. */
  150080. addCamera(camera: Camera): void;
  150081. /**
  150082. * Removes a camera from the pipeline
  150083. * @param camera the camera to remove
  150084. */
  150085. removeCamera(camera: Camera): void;
  150086. /**
  150087. * Dispose of the pipeline and stop all post processes
  150088. */
  150089. dispose(): void;
  150090. /**
  150091. * Serialize the rendering pipeline (Used when exporting)
  150092. * @returns the serialized object
  150093. */
  150094. serialize(): any;
  150095. /**
  150096. * Parse the serialized pipeline
  150097. * @param source Source pipeline.
  150098. * @param scene The scene to load the pipeline to.
  150099. * @param rootUrl The URL of the serialized pipeline.
  150100. * @returns An instantiated pipeline from the serialized object.
  150101. */
  150102. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  150103. }
  150104. }
  150105. declare module BABYLON {
  150106. /** @hidden */
  150107. export var lensHighlightsPixelShader: {
  150108. name: string;
  150109. shader: string;
  150110. };
  150111. }
  150112. declare module BABYLON {
  150113. /** @hidden */
  150114. export var depthOfFieldPixelShader: {
  150115. name: string;
  150116. shader: string;
  150117. };
  150118. }
  150119. declare module BABYLON {
  150120. /**
  150121. * BABYLON.JS Chromatic Aberration GLSL Shader
  150122. * Author: Olivier Guyot
  150123. * Separates very slightly R, G and B colors on the edges of the screen
  150124. * Inspired by Francois Tarlier & Martins Upitis
  150125. */
  150126. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  150127. /**
  150128. * @ignore
  150129. * The chromatic aberration PostProcess id in the pipeline
  150130. */
  150131. LensChromaticAberrationEffect: string;
  150132. /**
  150133. * @ignore
  150134. * The highlights enhancing PostProcess id in the pipeline
  150135. */
  150136. HighlightsEnhancingEffect: string;
  150137. /**
  150138. * @ignore
  150139. * The depth-of-field PostProcess id in the pipeline
  150140. */
  150141. LensDepthOfFieldEffect: string;
  150142. private _scene;
  150143. private _depthTexture;
  150144. private _grainTexture;
  150145. private _chromaticAberrationPostProcess;
  150146. private _highlightsPostProcess;
  150147. private _depthOfFieldPostProcess;
  150148. private _edgeBlur;
  150149. private _grainAmount;
  150150. private _chromaticAberration;
  150151. private _distortion;
  150152. private _highlightsGain;
  150153. private _highlightsThreshold;
  150154. private _dofDistance;
  150155. private _dofAperture;
  150156. private _dofDarken;
  150157. private _dofPentagon;
  150158. private _blurNoise;
  150159. /**
  150160. * @constructor
  150161. *
  150162. * Effect parameters are as follow:
  150163. * {
  150164. * chromatic_aberration: number; // from 0 to x (1 for realism)
  150165. * edge_blur: number; // from 0 to x (1 for realism)
  150166. * distortion: number; // from 0 to x (1 for realism)
  150167. * grain_amount: number; // from 0 to 1
  150168. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  150169. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  150170. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  150171. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  150172. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  150173. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  150174. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  150175. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  150176. * }
  150177. * Note: if an effect parameter is unset, effect is disabled
  150178. *
  150179. * @param name The rendering pipeline name
  150180. * @param parameters - An object containing all parameters (see above)
  150181. * @param scene The scene linked to this pipeline
  150182. * @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)
  150183. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150184. */
  150185. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  150186. /**
  150187. * Get the class name
  150188. * @returns "LensRenderingPipeline"
  150189. */
  150190. getClassName(): string;
  150191. /**
  150192. * Gets associated scene
  150193. */
  150194. get scene(): Scene;
  150195. /**
  150196. * Gets or sets the edge blur
  150197. */
  150198. get edgeBlur(): number;
  150199. set edgeBlur(value: number);
  150200. /**
  150201. * Gets or sets the grain amount
  150202. */
  150203. get grainAmount(): number;
  150204. set grainAmount(value: number);
  150205. /**
  150206. * Gets or sets the chromatic aberration amount
  150207. */
  150208. get chromaticAberration(): number;
  150209. set chromaticAberration(value: number);
  150210. /**
  150211. * Gets or sets the depth of field aperture
  150212. */
  150213. get dofAperture(): number;
  150214. set dofAperture(value: number);
  150215. /**
  150216. * Gets or sets the edge distortion
  150217. */
  150218. get edgeDistortion(): number;
  150219. set edgeDistortion(value: number);
  150220. /**
  150221. * Gets or sets the depth of field distortion
  150222. */
  150223. get dofDistortion(): number;
  150224. set dofDistortion(value: number);
  150225. /**
  150226. * Gets or sets the darken out of focus amount
  150227. */
  150228. get darkenOutOfFocus(): number;
  150229. set darkenOutOfFocus(value: number);
  150230. /**
  150231. * Gets or sets a boolean indicating if blur noise is enabled
  150232. */
  150233. get blurNoise(): boolean;
  150234. set blurNoise(value: boolean);
  150235. /**
  150236. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  150237. */
  150238. get pentagonBokeh(): boolean;
  150239. set pentagonBokeh(value: boolean);
  150240. /**
  150241. * Gets or sets the highlight grain amount
  150242. */
  150243. get highlightsGain(): number;
  150244. set highlightsGain(value: number);
  150245. /**
  150246. * Gets or sets the highlight threshold
  150247. */
  150248. get highlightsThreshold(): number;
  150249. set highlightsThreshold(value: number);
  150250. /**
  150251. * Sets the amount of blur at the edges
  150252. * @param amount blur amount
  150253. */
  150254. setEdgeBlur(amount: number): void;
  150255. /**
  150256. * Sets edge blur to 0
  150257. */
  150258. disableEdgeBlur(): void;
  150259. /**
  150260. * Sets the amout of grain
  150261. * @param amount Amount of grain
  150262. */
  150263. setGrainAmount(amount: number): void;
  150264. /**
  150265. * Set grain amount to 0
  150266. */
  150267. disableGrain(): void;
  150268. /**
  150269. * Sets the chromatic aberration amount
  150270. * @param amount amount of chromatic aberration
  150271. */
  150272. setChromaticAberration(amount: number): void;
  150273. /**
  150274. * Sets chromatic aberration amount to 0
  150275. */
  150276. disableChromaticAberration(): void;
  150277. /**
  150278. * Sets the EdgeDistortion amount
  150279. * @param amount amount of EdgeDistortion
  150280. */
  150281. setEdgeDistortion(amount: number): void;
  150282. /**
  150283. * Sets edge distortion to 0
  150284. */
  150285. disableEdgeDistortion(): void;
  150286. /**
  150287. * Sets the FocusDistance amount
  150288. * @param amount amount of FocusDistance
  150289. */
  150290. setFocusDistance(amount: number): void;
  150291. /**
  150292. * Disables depth of field
  150293. */
  150294. disableDepthOfField(): void;
  150295. /**
  150296. * Sets the Aperture amount
  150297. * @param amount amount of Aperture
  150298. */
  150299. setAperture(amount: number): void;
  150300. /**
  150301. * Sets the DarkenOutOfFocus amount
  150302. * @param amount amount of DarkenOutOfFocus
  150303. */
  150304. setDarkenOutOfFocus(amount: number): void;
  150305. private _pentagonBokehIsEnabled;
  150306. /**
  150307. * Creates a pentagon bokeh effect
  150308. */
  150309. enablePentagonBokeh(): void;
  150310. /**
  150311. * Disables the pentagon bokeh effect
  150312. */
  150313. disablePentagonBokeh(): void;
  150314. /**
  150315. * Enables noise blur
  150316. */
  150317. enableNoiseBlur(): void;
  150318. /**
  150319. * Disables noise blur
  150320. */
  150321. disableNoiseBlur(): void;
  150322. /**
  150323. * Sets the HighlightsGain amount
  150324. * @param amount amount of HighlightsGain
  150325. */
  150326. setHighlightsGain(amount: number): void;
  150327. /**
  150328. * Sets the HighlightsThreshold amount
  150329. * @param amount amount of HighlightsThreshold
  150330. */
  150331. setHighlightsThreshold(amount: number): void;
  150332. /**
  150333. * Disables highlights
  150334. */
  150335. disableHighlights(): void;
  150336. /**
  150337. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  150338. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  150339. */
  150340. dispose(disableDepthRender?: boolean): void;
  150341. private _createChromaticAberrationPostProcess;
  150342. private _createHighlightsPostProcess;
  150343. private _createDepthOfFieldPostProcess;
  150344. private _createGrainTexture;
  150345. }
  150346. }
  150347. declare module BABYLON {
  150348. /** @hidden */
  150349. export var ssao2PixelShader: {
  150350. name: string;
  150351. shader: string;
  150352. };
  150353. }
  150354. declare module BABYLON {
  150355. /** @hidden */
  150356. export var ssaoCombinePixelShader: {
  150357. name: string;
  150358. shader: string;
  150359. };
  150360. }
  150361. declare module BABYLON {
  150362. /**
  150363. * Render pipeline to produce ssao effect
  150364. */
  150365. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  150366. /**
  150367. * @ignore
  150368. * The PassPostProcess id in the pipeline that contains the original scene color
  150369. */
  150370. SSAOOriginalSceneColorEffect: string;
  150371. /**
  150372. * @ignore
  150373. * The SSAO PostProcess id in the pipeline
  150374. */
  150375. SSAORenderEffect: string;
  150376. /**
  150377. * @ignore
  150378. * The horizontal blur PostProcess id in the pipeline
  150379. */
  150380. SSAOBlurHRenderEffect: string;
  150381. /**
  150382. * @ignore
  150383. * The vertical blur PostProcess id in the pipeline
  150384. */
  150385. SSAOBlurVRenderEffect: string;
  150386. /**
  150387. * @ignore
  150388. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150389. */
  150390. SSAOCombineRenderEffect: string;
  150391. /**
  150392. * The output strength of the SSAO post-process. Default value is 1.0.
  150393. */
  150394. totalStrength: number;
  150395. /**
  150396. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  150397. */
  150398. maxZ: number;
  150399. /**
  150400. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  150401. */
  150402. minZAspect: number;
  150403. private _samples;
  150404. /**
  150405. * Number of samples used for the SSAO calculations. Default value is 8
  150406. */
  150407. set samples(n: number);
  150408. get samples(): number;
  150409. private _textureSamples;
  150410. /**
  150411. * Number of samples to use for antialiasing
  150412. */
  150413. set textureSamples(n: number);
  150414. get textureSamples(): number;
  150415. /**
  150416. * Force rendering the geometry through geometry buffer
  150417. */
  150418. private _forceGeometryBuffer;
  150419. /**
  150420. * Ratio object used for SSAO ratio and blur ratio
  150421. */
  150422. private _ratio;
  150423. /**
  150424. * Dynamically generated sphere sampler.
  150425. */
  150426. private _sampleSphere;
  150427. /**
  150428. * Blur filter offsets
  150429. */
  150430. private _samplerOffsets;
  150431. private _expensiveBlur;
  150432. /**
  150433. * If bilateral blur should be used
  150434. */
  150435. set expensiveBlur(b: boolean);
  150436. get expensiveBlur(): boolean;
  150437. /**
  150438. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  150439. */
  150440. radius: number;
  150441. /**
  150442. * The base color of the SSAO post-process
  150443. * The final result is "base + ssao" between [0, 1]
  150444. */
  150445. base: number;
  150446. /**
  150447. * Support test.
  150448. */
  150449. static get IsSupported(): boolean;
  150450. private _scene;
  150451. private _randomTexture;
  150452. private _originalColorPostProcess;
  150453. private _ssaoPostProcess;
  150454. private _blurHPostProcess;
  150455. private _blurVPostProcess;
  150456. private _ssaoCombinePostProcess;
  150457. private _prePassRenderer;
  150458. /**
  150459. * Gets active scene
  150460. */
  150461. get scene(): Scene;
  150462. /**
  150463. * @constructor
  150464. * @param name The rendering pipeline name
  150465. * @param scene The scene linked to this pipeline
  150466. * @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 }
  150467. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150468. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  150469. */
  150470. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  150471. /**
  150472. * Get the class name
  150473. * @returns "SSAO2RenderingPipeline"
  150474. */
  150475. getClassName(): string;
  150476. /**
  150477. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150478. */
  150479. dispose(disableGeometryBufferRenderer?: boolean): void;
  150480. private _createBlurPostProcess;
  150481. /** @hidden */
  150482. _rebuild(): void;
  150483. private _bits;
  150484. private _radicalInverse_VdC;
  150485. private _hammersley;
  150486. private _hemisphereSample_uniform;
  150487. private _generateHemisphere;
  150488. private _getDefinesForSSAO;
  150489. private _createSSAOPostProcess;
  150490. private _createSSAOCombinePostProcess;
  150491. private _createRandomTexture;
  150492. /**
  150493. * Serialize the rendering pipeline (Used when exporting)
  150494. * @returns the serialized object
  150495. */
  150496. serialize(): any;
  150497. /**
  150498. * Parse the serialized pipeline
  150499. * @param source Source pipeline.
  150500. * @param scene The scene to load the pipeline to.
  150501. * @param rootUrl The URL of the serialized pipeline.
  150502. * @returns An instantiated pipeline from the serialized object.
  150503. */
  150504. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  150505. /**
  150506. * Sets the required values to the prepass renderer.
  150507. * @param prePassRenderer defines the prepass renderer to setup
  150508. * @returns true if the pre pass is needed.
  150509. */
  150510. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  150511. }
  150512. }
  150513. declare module BABYLON {
  150514. /** @hidden */
  150515. export var ssaoPixelShader: {
  150516. name: string;
  150517. shader: string;
  150518. };
  150519. }
  150520. declare module BABYLON {
  150521. /**
  150522. * Render pipeline to produce ssao effect
  150523. */
  150524. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  150525. /**
  150526. * @ignore
  150527. * The PassPostProcess id in the pipeline that contains the original scene color
  150528. */
  150529. SSAOOriginalSceneColorEffect: string;
  150530. /**
  150531. * @ignore
  150532. * The SSAO PostProcess id in the pipeline
  150533. */
  150534. SSAORenderEffect: string;
  150535. /**
  150536. * @ignore
  150537. * The horizontal blur PostProcess id in the pipeline
  150538. */
  150539. SSAOBlurHRenderEffect: string;
  150540. /**
  150541. * @ignore
  150542. * The vertical blur PostProcess id in the pipeline
  150543. */
  150544. SSAOBlurVRenderEffect: string;
  150545. /**
  150546. * @ignore
  150547. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150548. */
  150549. SSAOCombineRenderEffect: string;
  150550. /**
  150551. * The output strength of the SSAO post-process. Default value is 1.0.
  150552. */
  150553. totalStrength: number;
  150554. /**
  150555. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  150556. */
  150557. radius: number;
  150558. /**
  150559. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  150560. * Must not be equal to fallOff and superior to fallOff.
  150561. * Default value is 0.0075
  150562. */
  150563. area: number;
  150564. /**
  150565. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  150566. * Must not be equal to area and inferior to area.
  150567. * Default value is 0.000001
  150568. */
  150569. fallOff: number;
  150570. /**
  150571. * The base color of the SSAO post-process
  150572. * The final result is "base + ssao" between [0, 1]
  150573. */
  150574. base: number;
  150575. private _scene;
  150576. private _depthTexture;
  150577. private _randomTexture;
  150578. private _originalColorPostProcess;
  150579. private _ssaoPostProcess;
  150580. private _blurHPostProcess;
  150581. private _blurVPostProcess;
  150582. private _ssaoCombinePostProcess;
  150583. private _firstUpdate;
  150584. /**
  150585. * Gets active scene
  150586. */
  150587. get scene(): Scene;
  150588. /**
  150589. * @constructor
  150590. * @param name - The rendering pipeline name
  150591. * @param scene - The scene linked to this pipeline
  150592. * @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 }
  150593. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  150594. */
  150595. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  150596. /**
  150597. * Get the class name
  150598. * @returns "SSAORenderingPipeline"
  150599. */
  150600. getClassName(): string;
  150601. /**
  150602. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150603. */
  150604. dispose(disableDepthRender?: boolean): void;
  150605. private _createBlurPostProcess;
  150606. /** @hidden */
  150607. _rebuild(): void;
  150608. private _createSSAOPostProcess;
  150609. private _createSSAOCombinePostProcess;
  150610. private _createRandomTexture;
  150611. }
  150612. }
  150613. declare module BABYLON {
  150614. /** @hidden */
  150615. export var screenSpaceReflectionPixelShader: {
  150616. name: string;
  150617. shader: string;
  150618. };
  150619. }
  150620. declare module BABYLON {
  150621. /**
  150622. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  150623. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  150624. */
  150625. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  150626. /**
  150627. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  150628. */
  150629. threshold: number;
  150630. /**
  150631. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  150632. */
  150633. strength: number;
  150634. /**
  150635. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  150636. */
  150637. reflectionSpecularFalloffExponent: number;
  150638. /**
  150639. * 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]
  150640. */
  150641. step: number;
  150642. /**
  150643. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  150644. */
  150645. roughnessFactor: number;
  150646. private _geometryBufferRenderer;
  150647. private _enableSmoothReflections;
  150648. private _reflectionSamples;
  150649. private _smoothSteps;
  150650. /**
  150651. * Gets a string identifying the name of the class
  150652. * @returns "ScreenSpaceReflectionPostProcess" string
  150653. */
  150654. getClassName(): string;
  150655. /**
  150656. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  150657. * @param name The name of the effect.
  150658. * @param scene The scene containing the objects to calculate reflections.
  150659. * @param options The required width/height ratio to downsize to before computing the render pass.
  150660. * @param camera The camera to apply the render pass to.
  150661. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150662. * @param engine The engine which the post process will be applied. (default: current engine)
  150663. * @param reusable If the post process can be reused on the same frame. (default: false)
  150664. * @param textureType Type of textures used when performing the post process. (default: 0)
  150665. * @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)
  150666. */
  150667. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150668. /**
  150669. * Gets wether or not smoothing reflections is enabled.
  150670. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150671. */
  150672. get enableSmoothReflections(): boolean;
  150673. /**
  150674. * Sets wether or not smoothing reflections is enabled.
  150675. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150676. */
  150677. set enableSmoothReflections(enabled: boolean);
  150678. /**
  150679. * Gets the number of samples taken while computing reflections. More samples count is high,
  150680. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150681. */
  150682. get reflectionSamples(): number;
  150683. /**
  150684. * Sets the number of samples taken while computing reflections. More samples count is high,
  150685. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150686. */
  150687. set reflectionSamples(samples: number);
  150688. /**
  150689. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  150690. * more the post-process will require GPU power and can generate a drop in FPS.
  150691. * Default value (5.0) work pretty well in all cases but can be adjusted.
  150692. */
  150693. get smoothSteps(): number;
  150694. set smoothSteps(steps: number);
  150695. private _updateEffectDefines;
  150696. /** @hidden */
  150697. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  150698. }
  150699. }
  150700. declare module BABYLON {
  150701. /** @hidden */
  150702. export var standardPixelShader: {
  150703. name: string;
  150704. shader: string;
  150705. };
  150706. }
  150707. declare module BABYLON {
  150708. /**
  150709. * Standard rendering pipeline
  150710. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150711. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  150712. */
  150713. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150714. /**
  150715. * Public members
  150716. */
  150717. /**
  150718. * Post-process which contains the original scene color before the pipeline applies all the effects
  150719. */
  150720. originalPostProcess: Nullable<PostProcess>;
  150721. /**
  150722. * Post-process used to down scale an image x4
  150723. */
  150724. downSampleX4PostProcess: Nullable<PostProcess>;
  150725. /**
  150726. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  150727. */
  150728. brightPassPostProcess: Nullable<PostProcess>;
  150729. /**
  150730. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  150731. */
  150732. blurHPostProcesses: PostProcess[];
  150733. /**
  150734. * Post-process array storing all the vertical blur post-processes used by the pipeline
  150735. */
  150736. blurVPostProcesses: PostProcess[];
  150737. /**
  150738. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  150739. */
  150740. textureAdderPostProcess: Nullable<PostProcess>;
  150741. /**
  150742. * Post-process used to create volumetric lighting effect
  150743. */
  150744. volumetricLightPostProcess: Nullable<PostProcess>;
  150745. /**
  150746. * Post-process used to smooth the previous volumetric light post-process on the X axis
  150747. */
  150748. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  150749. /**
  150750. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  150751. */
  150752. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  150753. /**
  150754. * Post-process used to merge the volumetric light effect and the real scene color
  150755. */
  150756. volumetricLightMergePostProces: Nullable<PostProcess>;
  150757. /**
  150758. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  150759. */
  150760. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  150761. /**
  150762. * Base post-process used to calculate the average luminance of the final image for HDR
  150763. */
  150764. luminancePostProcess: Nullable<PostProcess>;
  150765. /**
  150766. * Post-processes used to create down sample post-processes in order to get
  150767. * the average luminance of the final image for HDR
  150768. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  150769. */
  150770. luminanceDownSamplePostProcesses: PostProcess[];
  150771. /**
  150772. * Post-process used to create a HDR effect (light adaptation)
  150773. */
  150774. hdrPostProcess: Nullable<PostProcess>;
  150775. /**
  150776. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  150777. */
  150778. textureAdderFinalPostProcess: Nullable<PostProcess>;
  150779. /**
  150780. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  150781. */
  150782. lensFlareFinalPostProcess: Nullable<PostProcess>;
  150783. /**
  150784. * Post-process used to merge the final HDR post-process and the real scene color
  150785. */
  150786. hdrFinalPostProcess: Nullable<PostProcess>;
  150787. /**
  150788. * Post-process used to create a lens flare effect
  150789. */
  150790. lensFlarePostProcess: Nullable<PostProcess>;
  150791. /**
  150792. * Post-process that merges the result of the lens flare post-process and the real scene color
  150793. */
  150794. lensFlareComposePostProcess: Nullable<PostProcess>;
  150795. /**
  150796. * Post-process used to create a motion blur effect
  150797. */
  150798. motionBlurPostProcess: Nullable<PostProcess>;
  150799. /**
  150800. * Post-process used to create a depth of field effect
  150801. */
  150802. depthOfFieldPostProcess: Nullable<PostProcess>;
  150803. /**
  150804. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150805. */
  150806. fxaaPostProcess: Nullable<FxaaPostProcess>;
  150807. /**
  150808. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  150809. */
  150810. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  150811. /**
  150812. * Represents the brightness threshold in order to configure the illuminated surfaces
  150813. */
  150814. brightThreshold: number;
  150815. /**
  150816. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  150817. */
  150818. blurWidth: number;
  150819. /**
  150820. * Sets if the blur for highlighted surfaces must be only horizontal
  150821. */
  150822. horizontalBlur: boolean;
  150823. /**
  150824. * Gets the overall exposure used by the pipeline
  150825. */
  150826. get exposure(): number;
  150827. /**
  150828. * Sets the overall exposure used by the pipeline
  150829. */
  150830. set exposure(value: number);
  150831. /**
  150832. * Texture used typically to simulate "dirty" on camera lens
  150833. */
  150834. lensTexture: Nullable<Texture>;
  150835. /**
  150836. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  150837. */
  150838. volumetricLightCoefficient: number;
  150839. /**
  150840. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  150841. */
  150842. volumetricLightPower: number;
  150843. /**
  150844. * Used the set the blur intensity to smooth the volumetric lights
  150845. */
  150846. volumetricLightBlurScale: number;
  150847. /**
  150848. * Light (spot or directional) used to generate the volumetric lights rays
  150849. * The source light must have a shadow generate so the pipeline can get its
  150850. * depth map
  150851. */
  150852. sourceLight: Nullable<SpotLight | DirectionalLight>;
  150853. /**
  150854. * For eye adaptation, represents the minimum luminance the eye can see
  150855. */
  150856. hdrMinimumLuminance: number;
  150857. /**
  150858. * For eye adaptation, represents the decrease luminance speed
  150859. */
  150860. hdrDecreaseRate: number;
  150861. /**
  150862. * For eye adaptation, represents the increase luminance speed
  150863. */
  150864. hdrIncreaseRate: number;
  150865. /**
  150866. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150867. */
  150868. get hdrAutoExposure(): boolean;
  150869. /**
  150870. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150871. */
  150872. set hdrAutoExposure(value: boolean);
  150873. /**
  150874. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  150875. */
  150876. lensColorTexture: Nullable<Texture>;
  150877. /**
  150878. * The overall strengh for the lens flare effect
  150879. */
  150880. lensFlareStrength: number;
  150881. /**
  150882. * Dispersion coefficient for lens flare ghosts
  150883. */
  150884. lensFlareGhostDispersal: number;
  150885. /**
  150886. * Main lens flare halo width
  150887. */
  150888. lensFlareHaloWidth: number;
  150889. /**
  150890. * Based on the lens distortion effect, defines how much the lens flare result
  150891. * is distorted
  150892. */
  150893. lensFlareDistortionStrength: number;
  150894. /**
  150895. * Configures the blur intensity used for for lens flare (halo)
  150896. */
  150897. lensFlareBlurWidth: number;
  150898. /**
  150899. * Lens star texture must be used to simulate rays on the flares and is available
  150900. * in the documentation
  150901. */
  150902. lensStarTexture: Nullable<Texture>;
  150903. /**
  150904. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  150905. * flare effect by taking account of the dirt texture
  150906. */
  150907. lensFlareDirtTexture: Nullable<Texture>;
  150908. /**
  150909. * Represents the focal length for the depth of field effect
  150910. */
  150911. depthOfFieldDistance: number;
  150912. /**
  150913. * Represents the blur intensity for the blurred part of the depth of field effect
  150914. */
  150915. depthOfFieldBlurWidth: number;
  150916. /**
  150917. * Gets how much the image is blurred by the movement while using the motion blur post-process
  150918. */
  150919. get motionStrength(): number;
  150920. /**
  150921. * Sets how much the image is blurred by the movement while using the motion blur post-process
  150922. */
  150923. set motionStrength(strength: number);
  150924. /**
  150925. * Gets wether or not the motion blur post-process is object based or screen based.
  150926. */
  150927. get objectBasedMotionBlur(): boolean;
  150928. /**
  150929. * Sets wether or not the motion blur post-process should be object based or screen based
  150930. */
  150931. set objectBasedMotionBlur(value: boolean);
  150932. /**
  150933. * List of animations for the pipeline (IAnimatable implementation)
  150934. */
  150935. animations: Animation[];
  150936. /**
  150937. * Private members
  150938. */
  150939. private _scene;
  150940. private _currentDepthOfFieldSource;
  150941. private _basePostProcess;
  150942. private _fixedExposure;
  150943. private _currentExposure;
  150944. private _hdrAutoExposure;
  150945. private _hdrCurrentLuminance;
  150946. private _motionStrength;
  150947. private _isObjectBasedMotionBlur;
  150948. private _floatTextureType;
  150949. private _camerasToBeAttached;
  150950. private _ratio;
  150951. private _bloomEnabled;
  150952. private _depthOfFieldEnabled;
  150953. private _vlsEnabled;
  150954. private _lensFlareEnabled;
  150955. private _hdrEnabled;
  150956. private _motionBlurEnabled;
  150957. private _fxaaEnabled;
  150958. private _screenSpaceReflectionsEnabled;
  150959. private _motionBlurSamples;
  150960. private _volumetricLightStepsCount;
  150961. private _samples;
  150962. /**
  150963. * @ignore
  150964. * Specifies if the bloom pipeline is enabled
  150965. */
  150966. get BloomEnabled(): boolean;
  150967. set BloomEnabled(enabled: boolean);
  150968. /**
  150969. * @ignore
  150970. * Specifies if the depth of field pipeline is enabed
  150971. */
  150972. get DepthOfFieldEnabled(): boolean;
  150973. set DepthOfFieldEnabled(enabled: boolean);
  150974. /**
  150975. * @ignore
  150976. * Specifies if the lens flare pipeline is enabed
  150977. */
  150978. get LensFlareEnabled(): boolean;
  150979. set LensFlareEnabled(enabled: boolean);
  150980. /**
  150981. * @ignore
  150982. * Specifies if the HDR pipeline is enabled
  150983. */
  150984. get HDREnabled(): boolean;
  150985. set HDREnabled(enabled: boolean);
  150986. /**
  150987. * @ignore
  150988. * Specifies if the volumetric lights scattering effect is enabled
  150989. */
  150990. get VLSEnabled(): boolean;
  150991. set VLSEnabled(enabled: boolean);
  150992. /**
  150993. * @ignore
  150994. * Specifies if the motion blur effect is enabled
  150995. */
  150996. get MotionBlurEnabled(): boolean;
  150997. set MotionBlurEnabled(enabled: boolean);
  150998. /**
  150999. * Specifies if anti-aliasing is enabled
  151000. */
  151001. get fxaaEnabled(): boolean;
  151002. set fxaaEnabled(enabled: boolean);
  151003. /**
  151004. * Specifies if screen space reflections are enabled.
  151005. */
  151006. get screenSpaceReflectionsEnabled(): boolean;
  151007. set screenSpaceReflectionsEnabled(enabled: boolean);
  151008. /**
  151009. * Specifies the number of steps used to calculate the volumetric lights
  151010. * Typically in interval [50, 200]
  151011. */
  151012. get volumetricLightStepsCount(): number;
  151013. set volumetricLightStepsCount(count: number);
  151014. /**
  151015. * Specifies the number of samples used for the motion blur effect
  151016. * Typically in interval [16, 64]
  151017. */
  151018. get motionBlurSamples(): number;
  151019. set motionBlurSamples(samples: number);
  151020. /**
  151021. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  151022. */
  151023. get samples(): number;
  151024. set samples(sampleCount: number);
  151025. /**
  151026. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  151027. * @constructor
  151028. * @param name The rendering pipeline name
  151029. * @param scene The scene linked to this pipeline
  151030. * @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)
  151031. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  151032. * @param cameras The array of cameras that the rendering pipeline will be attached to
  151033. */
  151034. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  151035. private _buildPipeline;
  151036. private _createDownSampleX4PostProcess;
  151037. private _createBrightPassPostProcess;
  151038. private _createBlurPostProcesses;
  151039. private _createTextureAdderPostProcess;
  151040. private _createVolumetricLightPostProcess;
  151041. private _createLuminancePostProcesses;
  151042. private _createHdrPostProcess;
  151043. private _createLensFlarePostProcess;
  151044. private _createDepthOfFieldPostProcess;
  151045. private _createMotionBlurPostProcess;
  151046. private _getDepthTexture;
  151047. private _disposePostProcesses;
  151048. /**
  151049. * Dispose of the pipeline and stop all post processes
  151050. */
  151051. dispose(): void;
  151052. /**
  151053. * Serialize the rendering pipeline (Used when exporting)
  151054. * @returns the serialized object
  151055. */
  151056. serialize(): any;
  151057. /**
  151058. * Parse the serialized pipeline
  151059. * @param source Source pipeline.
  151060. * @param scene The scene to load the pipeline to.
  151061. * @param rootUrl The URL of the serialized pipeline.
  151062. * @returns An instantiated pipeline from the serialized object.
  151063. */
  151064. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  151065. /**
  151066. * Luminance steps
  151067. */
  151068. static LuminanceSteps: number;
  151069. }
  151070. }
  151071. declare module BABYLON {
  151072. /** @hidden */
  151073. export var stereoscopicInterlacePixelShader: {
  151074. name: string;
  151075. shader: string;
  151076. };
  151077. }
  151078. declare module BABYLON {
  151079. /**
  151080. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  151081. */
  151082. export class StereoscopicInterlacePostProcessI extends PostProcess {
  151083. private _stepSize;
  151084. private _passedProcess;
  151085. /**
  151086. * Gets a string identifying the name of the class
  151087. * @returns "StereoscopicInterlacePostProcessI" string
  151088. */
  151089. getClassName(): string;
  151090. /**
  151091. * Initializes a StereoscopicInterlacePostProcessI
  151092. * @param name The name of the effect.
  151093. * @param rigCameras The rig cameras to be appled to the post process
  151094. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  151095. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  151096. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151097. * @param engine The engine which the post process will be applied. (default: current engine)
  151098. * @param reusable If the post process can be reused on the same frame. (default: false)
  151099. */
  151100. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151101. }
  151102. /**
  151103. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  151104. */
  151105. export class StereoscopicInterlacePostProcess extends PostProcess {
  151106. private _stepSize;
  151107. private _passedProcess;
  151108. /**
  151109. * Gets a string identifying the name of the class
  151110. * @returns "StereoscopicInterlacePostProcess" string
  151111. */
  151112. getClassName(): string;
  151113. /**
  151114. * Initializes a StereoscopicInterlacePostProcess
  151115. * @param name The name of the effect.
  151116. * @param rigCameras The rig cameras to be appled to the post process
  151117. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  151118. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151119. * @param engine The engine which the post process will be applied. (default: current engine)
  151120. * @param reusable If the post process can be reused on the same frame. (default: false)
  151121. */
  151122. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151123. }
  151124. }
  151125. declare module BABYLON {
  151126. /** @hidden */
  151127. export var tonemapPixelShader: {
  151128. name: string;
  151129. shader: string;
  151130. };
  151131. }
  151132. declare module BABYLON {
  151133. /** Defines operator used for tonemapping */
  151134. export enum TonemappingOperator {
  151135. /** Hable */
  151136. Hable = 0,
  151137. /** Reinhard */
  151138. Reinhard = 1,
  151139. /** HejiDawson */
  151140. HejiDawson = 2,
  151141. /** Photographic */
  151142. Photographic = 3
  151143. }
  151144. /**
  151145. * Defines a post process to apply tone mapping
  151146. */
  151147. export class TonemapPostProcess extends PostProcess {
  151148. private _operator;
  151149. /** Defines the required exposure adjustement */
  151150. exposureAdjustment: number;
  151151. /**
  151152. * Gets a string identifying the name of the class
  151153. * @returns "TonemapPostProcess" string
  151154. */
  151155. getClassName(): string;
  151156. /**
  151157. * Creates a new TonemapPostProcess
  151158. * @param name defines the name of the postprocess
  151159. * @param _operator defines the operator to use
  151160. * @param exposureAdjustment defines the required exposure adjustement
  151161. * @param camera defines the camera to use (can be null)
  151162. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  151163. * @param engine defines the hosting engine (can be ignore if camera is set)
  151164. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  151165. */
  151166. constructor(name: string, _operator: TonemappingOperator,
  151167. /** Defines the required exposure adjustement */
  151168. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  151169. }
  151170. }
  151171. declare module BABYLON {
  151172. /** @hidden */
  151173. export var volumetricLightScatteringPixelShader: {
  151174. name: string;
  151175. shader: string;
  151176. };
  151177. }
  151178. declare module BABYLON {
  151179. /** @hidden */
  151180. export var volumetricLightScatteringPassVertexShader: {
  151181. name: string;
  151182. shader: string;
  151183. };
  151184. }
  151185. declare module BABYLON {
  151186. /** @hidden */
  151187. export var volumetricLightScatteringPassPixelShader: {
  151188. name: string;
  151189. shader: string;
  151190. };
  151191. }
  151192. declare module BABYLON {
  151193. /**
  151194. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  151195. */
  151196. export class VolumetricLightScatteringPostProcess extends PostProcess {
  151197. private _volumetricLightScatteringPass;
  151198. private _volumetricLightScatteringRTT;
  151199. private _viewPort;
  151200. private _screenCoordinates;
  151201. private _cachedDefines;
  151202. /**
  151203. * If not undefined, the mesh position is computed from the attached node position
  151204. */
  151205. attachedNode: {
  151206. position: Vector3;
  151207. };
  151208. /**
  151209. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  151210. */
  151211. customMeshPosition: Vector3;
  151212. /**
  151213. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  151214. */
  151215. useCustomMeshPosition: boolean;
  151216. /**
  151217. * If the post-process should inverse the light scattering direction
  151218. */
  151219. invert: boolean;
  151220. /**
  151221. * The internal mesh used by the post-process
  151222. */
  151223. mesh: Mesh;
  151224. /**
  151225. * @hidden
  151226. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  151227. */
  151228. get useDiffuseColor(): boolean;
  151229. set useDiffuseColor(useDiffuseColor: boolean);
  151230. /**
  151231. * Array containing the excluded meshes not rendered in the internal pass
  151232. */
  151233. excludedMeshes: AbstractMesh[];
  151234. /**
  151235. * Controls the overall intensity of the post-process
  151236. */
  151237. exposure: number;
  151238. /**
  151239. * Dissipates each sample's contribution in range [0, 1]
  151240. */
  151241. decay: number;
  151242. /**
  151243. * Controls the overall intensity of each sample
  151244. */
  151245. weight: number;
  151246. /**
  151247. * Controls the density of each sample
  151248. */
  151249. density: number;
  151250. /**
  151251. * @constructor
  151252. * @param name The post-process name
  151253. * @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)
  151254. * @param camera The camera that the post-process will be attached to
  151255. * @param mesh The mesh used to create the light scattering
  151256. * @param samples The post-process quality, default 100
  151257. * @param samplingModeThe post-process filtering mode
  151258. * @param engine The babylon engine
  151259. * @param reusable If the post-process is reusable
  151260. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  151261. */
  151262. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  151263. /**
  151264. * Returns the string "VolumetricLightScatteringPostProcess"
  151265. * @returns "VolumetricLightScatteringPostProcess"
  151266. */
  151267. getClassName(): string;
  151268. private _isReady;
  151269. /**
  151270. * Sets the new light position for light scattering effect
  151271. * @param position The new custom light position
  151272. */
  151273. setCustomMeshPosition(position: Vector3): void;
  151274. /**
  151275. * Returns the light position for light scattering effect
  151276. * @return Vector3 The custom light position
  151277. */
  151278. getCustomMeshPosition(): Vector3;
  151279. /**
  151280. * Disposes the internal assets and detaches the post-process from the camera
  151281. */
  151282. dispose(camera: Camera): void;
  151283. /**
  151284. * Returns the render target texture used by the post-process
  151285. * @return the render target texture used by the post-process
  151286. */
  151287. getPass(): RenderTargetTexture;
  151288. private _meshExcluded;
  151289. private _createPass;
  151290. private _updateMeshScreenCoordinates;
  151291. /**
  151292. * Creates a default mesh for the Volumeric Light Scattering post-process
  151293. * @param name The mesh name
  151294. * @param scene The scene where to create the mesh
  151295. * @return the default mesh
  151296. */
  151297. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  151298. }
  151299. }
  151300. declare module BABYLON {
  151301. /** @hidden */
  151302. export var screenSpaceCurvaturePixelShader: {
  151303. name: string;
  151304. shader: string;
  151305. };
  151306. }
  151307. declare module BABYLON {
  151308. /**
  151309. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  151310. */
  151311. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  151312. /**
  151313. * Defines how much ridge the curvature effect displays.
  151314. */
  151315. ridge: number;
  151316. /**
  151317. * Defines how much valley the curvature effect displays.
  151318. */
  151319. valley: number;
  151320. private _geometryBufferRenderer;
  151321. /**
  151322. * Gets a string identifying the name of the class
  151323. * @returns "ScreenSpaceCurvaturePostProcess" string
  151324. */
  151325. getClassName(): string;
  151326. /**
  151327. * Creates a new instance ScreenSpaceCurvaturePostProcess
  151328. * @param name The name of the effect.
  151329. * @param scene The scene containing the objects to blur according to their velocity.
  151330. * @param options The required width/height ratio to downsize to before computing the render pass.
  151331. * @param camera The camera to apply the render pass to.
  151332. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151333. * @param engine The engine which the post process will be applied. (default: current engine)
  151334. * @param reusable If the post process can be reused on the same frame. (default: false)
  151335. * @param textureType Type of textures used when performing the post process. (default: 0)
  151336. * @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)
  151337. */
  151338. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  151339. /**
  151340. * Support test.
  151341. */
  151342. static get IsSupported(): boolean;
  151343. /** @hidden */
  151344. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  151345. }
  151346. }
  151347. declare module BABYLON {
  151348. interface Scene {
  151349. /** @hidden (Backing field) */
  151350. _boundingBoxRenderer: BoundingBoxRenderer;
  151351. /** @hidden (Backing field) */
  151352. _forceShowBoundingBoxes: boolean;
  151353. /**
  151354. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  151355. */
  151356. forceShowBoundingBoxes: boolean;
  151357. /**
  151358. * Gets the bounding box renderer associated with the scene
  151359. * @returns a BoundingBoxRenderer
  151360. */
  151361. getBoundingBoxRenderer(): BoundingBoxRenderer;
  151362. }
  151363. interface AbstractMesh {
  151364. /** @hidden (Backing field) */
  151365. _showBoundingBox: boolean;
  151366. /**
  151367. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  151368. */
  151369. showBoundingBox: boolean;
  151370. }
  151371. /**
  151372. * Component responsible of rendering the bounding box of the meshes in a scene.
  151373. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  151374. */
  151375. export class BoundingBoxRenderer implements ISceneComponent {
  151376. /**
  151377. * The component name helpfull to identify the component in the list of scene components.
  151378. */
  151379. readonly name: string;
  151380. /**
  151381. * The scene the component belongs to.
  151382. */
  151383. scene: Scene;
  151384. /**
  151385. * Color of the bounding box lines placed in front of an object
  151386. */
  151387. frontColor: Color3;
  151388. /**
  151389. * Color of the bounding box lines placed behind an object
  151390. */
  151391. backColor: Color3;
  151392. /**
  151393. * Defines if the renderer should show the back lines or not
  151394. */
  151395. showBackLines: boolean;
  151396. /**
  151397. * Observable raised before rendering a bounding box
  151398. */
  151399. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  151400. /**
  151401. * Observable raised after rendering a bounding box
  151402. */
  151403. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  151404. /**
  151405. * @hidden
  151406. */
  151407. renderList: SmartArray<BoundingBox>;
  151408. private _colorShader;
  151409. private _vertexBuffers;
  151410. private _indexBuffer;
  151411. private _fillIndexBuffer;
  151412. private _fillIndexData;
  151413. /**
  151414. * Instantiates a new bounding box renderer in a scene.
  151415. * @param scene the scene the renderer renders in
  151416. */
  151417. constructor(scene: Scene);
  151418. /**
  151419. * Registers the component in a given scene
  151420. */
  151421. register(): void;
  151422. private _evaluateSubMesh;
  151423. private _activeMesh;
  151424. private _prepareRessources;
  151425. private _createIndexBuffer;
  151426. /**
  151427. * Rebuilds the elements related to this component in case of
  151428. * context lost for instance.
  151429. */
  151430. rebuild(): void;
  151431. /**
  151432. * @hidden
  151433. */
  151434. reset(): void;
  151435. /**
  151436. * Render the bounding boxes of a specific rendering group
  151437. * @param renderingGroupId defines the rendering group to render
  151438. */
  151439. render(renderingGroupId: number): void;
  151440. /**
  151441. * In case of occlusion queries, we can render the occlusion bounding box through this method
  151442. * @param mesh Define the mesh to render the occlusion bounding box for
  151443. */
  151444. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  151445. /**
  151446. * Dispose and release the resources attached to this renderer.
  151447. */
  151448. dispose(): void;
  151449. }
  151450. }
  151451. declare module BABYLON {
  151452. interface Scene {
  151453. /** @hidden (Backing field) */
  151454. _depthRenderer: {
  151455. [id: string]: DepthRenderer;
  151456. };
  151457. /**
  151458. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  151459. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  151460. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  151461. * @returns the created depth renderer
  151462. */
  151463. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  151464. /**
  151465. * Disables a depth renderer for a given camera
  151466. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  151467. */
  151468. disableDepthRenderer(camera?: Nullable<Camera>): void;
  151469. }
  151470. /**
  151471. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  151472. * in several rendering techniques.
  151473. */
  151474. export class DepthRendererSceneComponent implements ISceneComponent {
  151475. /**
  151476. * The component name helpfull to identify the component in the list of scene components.
  151477. */
  151478. readonly name: string;
  151479. /**
  151480. * The scene the component belongs to.
  151481. */
  151482. scene: Scene;
  151483. /**
  151484. * Creates a new instance of the component for the given scene
  151485. * @param scene Defines the scene to register the component in
  151486. */
  151487. constructor(scene: Scene);
  151488. /**
  151489. * Registers the component in a given scene
  151490. */
  151491. register(): void;
  151492. /**
  151493. * Rebuilds the elements related to this component in case of
  151494. * context lost for instance.
  151495. */
  151496. rebuild(): void;
  151497. /**
  151498. * Disposes the component and the associated ressources
  151499. */
  151500. dispose(): void;
  151501. private _gatherRenderTargets;
  151502. private _gatherActiveCameraRenderTargets;
  151503. }
  151504. }
  151505. declare module BABYLON {
  151506. interface AbstractScene {
  151507. /** @hidden (Backing field) */
  151508. _prePassRenderer: Nullable<PrePassRenderer>;
  151509. /**
  151510. * Gets or Sets the current prepass renderer associated to the scene.
  151511. */
  151512. prePassRenderer: Nullable<PrePassRenderer>;
  151513. /**
  151514. * Enables the prepass and associates it with the scene
  151515. * @returns the PrePassRenderer
  151516. */
  151517. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  151518. /**
  151519. * Disables the prepass associated with the scene
  151520. */
  151521. disablePrePassRenderer(): void;
  151522. }
  151523. /**
  151524. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  151525. * in several rendering techniques.
  151526. */
  151527. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  151528. /**
  151529. * The component name helpful to identify the component in the list of scene components.
  151530. */
  151531. readonly name: string;
  151532. /**
  151533. * The scene the component belongs to.
  151534. */
  151535. scene: Scene;
  151536. /**
  151537. * Creates a new instance of the component for the given scene
  151538. * @param scene Defines the scene to register the component in
  151539. */
  151540. constructor(scene: Scene);
  151541. /**
  151542. * Registers the component in a given scene
  151543. */
  151544. register(): void;
  151545. private _beforeCameraDraw;
  151546. private _afterCameraDraw;
  151547. private _beforeClearStage;
  151548. /**
  151549. * Serializes the component data to the specified json object
  151550. * @param serializationObject The object to serialize to
  151551. */
  151552. serialize(serializationObject: any): void;
  151553. /**
  151554. * Adds all the elements from the container to the scene
  151555. * @param container the container holding the elements
  151556. */
  151557. addFromContainer(container: AbstractScene): void;
  151558. /**
  151559. * Removes all the elements in the container from the scene
  151560. * @param container contains the elements to remove
  151561. * @param dispose if the removed element should be disposed (default: false)
  151562. */
  151563. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  151564. /**
  151565. * Rebuilds the elements related to this component in case of
  151566. * context lost for instance.
  151567. */
  151568. rebuild(): void;
  151569. /**
  151570. * Disposes the component and the associated ressources
  151571. */
  151572. dispose(): void;
  151573. }
  151574. }
  151575. declare module BABYLON {
  151576. /** @hidden */
  151577. export var outlinePixelShader: {
  151578. name: string;
  151579. shader: string;
  151580. };
  151581. }
  151582. declare module BABYLON {
  151583. /** @hidden */
  151584. export var outlineVertexShader: {
  151585. name: string;
  151586. shader: string;
  151587. };
  151588. }
  151589. declare module BABYLON {
  151590. interface Scene {
  151591. /** @hidden */
  151592. _outlineRenderer: OutlineRenderer;
  151593. /**
  151594. * Gets the outline renderer associated with the scene
  151595. * @returns a OutlineRenderer
  151596. */
  151597. getOutlineRenderer(): OutlineRenderer;
  151598. }
  151599. interface AbstractMesh {
  151600. /** @hidden (Backing field) */
  151601. _renderOutline: boolean;
  151602. /**
  151603. * Gets or sets a boolean indicating if the outline must be rendered as well
  151604. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  151605. */
  151606. renderOutline: boolean;
  151607. /** @hidden (Backing field) */
  151608. _renderOverlay: boolean;
  151609. /**
  151610. * Gets or sets a boolean indicating if the overlay must be rendered as well
  151611. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  151612. */
  151613. renderOverlay: boolean;
  151614. }
  151615. /**
  151616. * This class is responsible to draw bothe outline/overlay of meshes.
  151617. * It should not be used directly but through the available method on mesh.
  151618. */
  151619. export class OutlineRenderer implements ISceneComponent {
  151620. /**
  151621. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  151622. */
  151623. private static _StencilReference;
  151624. /**
  151625. * The name of the component. Each component must have a unique name.
  151626. */
  151627. name: string;
  151628. /**
  151629. * The scene the component belongs to.
  151630. */
  151631. scene: Scene;
  151632. /**
  151633. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  151634. */
  151635. zOffset: number;
  151636. private _engine;
  151637. private _effect;
  151638. private _cachedDefines;
  151639. private _savedDepthWrite;
  151640. /**
  151641. * Instantiates a new outline renderer. (There could be only one per scene).
  151642. * @param scene Defines the scene it belongs to
  151643. */
  151644. constructor(scene: Scene);
  151645. /**
  151646. * Register the component to one instance of a scene.
  151647. */
  151648. register(): void;
  151649. /**
  151650. * Rebuilds the elements related to this component in case of
  151651. * context lost for instance.
  151652. */
  151653. rebuild(): void;
  151654. /**
  151655. * Disposes the component and the associated ressources.
  151656. */
  151657. dispose(): void;
  151658. /**
  151659. * Renders the outline in the canvas.
  151660. * @param subMesh Defines the sumesh to render
  151661. * @param batch Defines the batch of meshes in case of instances
  151662. * @param useOverlay Defines if the rendering is for the overlay or the outline
  151663. */
  151664. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  151665. /**
  151666. * Returns whether or not the outline renderer is ready for a given submesh.
  151667. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  151668. * @param subMesh Defines the submesh to check readyness for
  151669. * @param useInstances Defines wheter wee are trying to render instances or not
  151670. * @returns true if ready otherwise false
  151671. */
  151672. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  151673. private _beforeRenderingMesh;
  151674. private _afterRenderingMesh;
  151675. }
  151676. }
  151677. declare module BABYLON {
  151678. /**
  151679. * Defines the basic options interface of a Sprite Frame Source Size.
  151680. */
  151681. export interface ISpriteJSONSpriteSourceSize {
  151682. /**
  151683. * number of the original width of the Frame
  151684. */
  151685. w: number;
  151686. /**
  151687. * number of the original height of the Frame
  151688. */
  151689. h: number;
  151690. }
  151691. /**
  151692. * Defines the basic options interface of a Sprite Frame Data.
  151693. */
  151694. export interface ISpriteJSONSpriteFrameData {
  151695. /**
  151696. * number of the x offset of the Frame
  151697. */
  151698. x: number;
  151699. /**
  151700. * number of the y offset of the Frame
  151701. */
  151702. y: number;
  151703. /**
  151704. * number of the width of the Frame
  151705. */
  151706. w: number;
  151707. /**
  151708. * number of the height of the Frame
  151709. */
  151710. h: number;
  151711. }
  151712. /**
  151713. * Defines the basic options interface of a JSON Sprite.
  151714. */
  151715. export interface ISpriteJSONSprite {
  151716. /**
  151717. * string name of the Frame
  151718. */
  151719. filename: string;
  151720. /**
  151721. * ISpriteJSONSpriteFrame basic object of the frame data
  151722. */
  151723. frame: ISpriteJSONSpriteFrameData;
  151724. /**
  151725. * boolean to flag is the frame was rotated.
  151726. */
  151727. rotated: boolean;
  151728. /**
  151729. * boolean to flag is the frame was trimmed.
  151730. */
  151731. trimmed: boolean;
  151732. /**
  151733. * ISpriteJSONSpriteFrame basic object of the source data
  151734. */
  151735. spriteSourceSize: ISpriteJSONSpriteFrameData;
  151736. /**
  151737. * ISpriteJSONSpriteFrame basic object of the source data
  151738. */
  151739. sourceSize: ISpriteJSONSpriteSourceSize;
  151740. }
  151741. /**
  151742. * Defines the basic options interface of a JSON atlas.
  151743. */
  151744. export interface ISpriteJSONAtlas {
  151745. /**
  151746. * Array of objects that contain the frame data.
  151747. */
  151748. frames: Array<ISpriteJSONSprite>;
  151749. /**
  151750. * object basic object containing the sprite meta data.
  151751. */
  151752. meta?: object;
  151753. }
  151754. }
  151755. declare module BABYLON {
  151756. /** @hidden */
  151757. export var spriteMapPixelShader: {
  151758. name: string;
  151759. shader: string;
  151760. };
  151761. }
  151762. declare module BABYLON {
  151763. /** @hidden */
  151764. export var spriteMapVertexShader: {
  151765. name: string;
  151766. shader: string;
  151767. };
  151768. }
  151769. declare module BABYLON {
  151770. /**
  151771. * Defines the basic options interface of a SpriteMap
  151772. */
  151773. export interface ISpriteMapOptions {
  151774. /**
  151775. * Vector2 of the number of cells in the grid.
  151776. */
  151777. stageSize?: Vector2;
  151778. /**
  151779. * Vector2 of the size of the output plane in World Units.
  151780. */
  151781. outputSize?: Vector2;
  151782. /**
  151783. * Vector3 of the position of the output plane in World Units.
  151784. */
  151785. outputPosition?: Vector3;
  151786. /**
  151787. * Vector3 of the rotation of the output plane.
  151788. */
  151789. outputRotation?: Vector3;
  151790. /**
  151791. * number of layers that the system will reserve in resources.
  151792. */
  151793. layerCount?: number;
  151794. /**
  151795. * number of max animation frames a single cell will reserve in resources.
  151796. */
  151797. maxAnimationFrames?: number;
  151798. /**
  151799. * number cell index of the base tile when the system compiles.
  151800. */
  151801. baseTile?: number;
  151802. /**
  151803. * boolean flip the sprite after its been repositioned by the framing data.
  151804. */
  151805. flipU?: boolean;
  151806. /**
  151807. * Vector3 scalar of the global RGB values of the SpriteMap.
  151808. */
  151809. colorMultiply?: Vector3;
  151810. }
  151811. /**
  151812. * Defines the IDisposable interface in order to be cleanable from resources.
  151813. */
  151814. export interface ISpriteMap extends IDisposable {
  151815. /**
  151816. * String name of the SpriteMap.
  151817. */
  151818. name: string;
  151819. /**
  151820. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  151821. */
  151822. atlasJSON: ISpriteJSONAtlas;
  151823. /**
  151824. * Texture of the SpriteMap.
  151825. */
  151826. spriteSheet: Texture;
  151827. /**
  151828. * The parameters to initialize the SpriteMap with.
  151829. */
  151830. options: ISpriteMapOptions;
  151831. }
  151832. /**
  151833. * Class used to manage a grid restricted sprite deployment on an Output plane.
  151834. */
  151835. export class SpriteMap implements ISpriteMap {
  151836. /** The Name of the spriteMap */
  151837. name: string;
  151838. /** The JSON file with the frame and meta data */
  151839. atlasJSON: ISpriteJSONAtlas;
  151840. /** The systems Sprite Sheet Texture */
  151841. spriteSheet: Texture;
  151842. /** Arguments passed with the Constructor */
  151843. options: ISpriteMapOptions;
  151844. /** Public Sprite Storage array, parsed from atlasJSON */
  151845. sprites: Array<ISpriteJSONSprite>;
  151846. /** Returns the Number of Sprites in the System */
  151847. get spriteCount(): number;
  151848. /** Returns the Position of Output Plane*/
  151849. get position(): Vector3;
  151850. /** Returns the Position of Output Plane*/
  151851. set position(v: Vector3);
  151852. /** Returns the Rotation of Output Plane*/
  151853. get rotation(): Vector3;
  151854. /** Returns the Rotation of Output Plane*/
  151855. set rotation(v: Vector3);
  151856. /** Sets the AnimationMap*/
  151857. get animationMap(): RawTexture;
  151858. /** Sets the AnimationMap*/
  151859. set animationMap(v: RawTexture);
  151860. /** Scene that the SpriteMap was created in */
  151861. private _scene;
  151862. /** Texture Buffer of Float32 that holds tile frame data*/
  151863. private _frameMap;
  151864. /** Texture Buffers of Float32 that holds tileMap data*/
  151865. private _tileMaps;
  151866. /** Texture Buffer of Float32 that holds Animation Data*/
  151867. private _animationMap;
  151868. /** Custom ShaderMaterial Central to the System*/
  151869. private _material;
  151870. /** Custom ShaderMaterial Central to the System*/
  151871. private _output;
  151872. /** Systems Time Ticker*/
  151873. private _time;
  151874. /**
  151875. * Creates a new SpriteMap
  151876. * @param name defines the SpriteMaps Name
  151877. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  151878. * @param spriteSheet is the Texture that the Sprites are on.
  151879. * @param options a basic deployment configuration
  151880. * @param scene The Scene that the map is deployed on
  151881. */
  151882. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  151883. /**
  151884. * Returns tileID location
  151885. * @returns Vector2 the cell position ID
  151886. */
  151887. getTileID(): Vector2;
  151888. /**
  151889. * Gets the UV location of the mouse over the SpriteMap.
  151890. * @returns Vector2 the UV position of the mouse interaction
  151891. */
  151892. getMousePosition(): Vector2;
  151893. /**
  151894. * Creates the "frame" texture Buffer
  151895. * -------------------------------------
  151896. * Structure of frames
  151897. * "filename": "Falling-Water-2.png",
  151898. * "frame": {"x":69,"y":103,"w":24,"h":32},
  151899. * "rotated": true,
  151900. * "trimmed": true,
  151901. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  151902. * "sourceSize": {"w":32,"h":32}
  151903. * @returns RawTexture of the frameMap
  151904. */
  151905. private _createFrameBuffer;
  151906. /**
  151907. * Creates the tileMap texture Buffer
  151908. * @param buffer normally and array of numbers, or a false to generate from scratch
  151909. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  151910. * @returns RawTexture of the tileMap
  151911. */
  151912. private _createTileBuffer;
  151913. /**
  151914. * Modifies the data of the tileMaps
  151915. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  151916. * @param pos is the iVector2 Coordinates of the Tile
  151917. * @param tile The SpriteIndex of the new Tile
  151918. */
  151919. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  151920. /**
  151921. * Creates the animationMap texture Buffer
  151922. * @param buffer normally and array of numbers, or a false to generate from scratch
  151923. * @returns RawTexture of the animationMap
  151924. */
  151925. private _createTileAnimationBuffer;
  151926. /**
  151927. * Modifies the data of the animationMap
  151928. * @param cellID is the Index of the Sprite
  151929. * @param _frame is the target Animation frame
  151930. * @param toCell is the Target Index of the next frame of the animation
  151931. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  151932. * @param speed is a global scalar of the time variable on the map.
  151933. */
  151934. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  151935. /**
  151936. * Exports the .tilemaps file
  151937. */
  151938. saveTileMaps(): void;
  151939. /**
  151940. * Imports the .tilemaps file
  151941. * @param url of the .tilemaps file
  151942. */
  151943. loadTileMaps(url: string): void;
  151944. /**
  151945. * Release associated resources
  151946. */
  151947. dispose(): void;
  151948. }
  151949. }
  151950. declare module BABYLON {
  151951. /**
  151952. * Class used to manage multiple sprites of different sizes on the same spritesheet
  151953. * @see https://doc.babylonjs.com/babylon101/sprites
  151954. */
  151955. export class SpritePackedManager extends SpriteManager {
  151956. /** defines the packed manager's name */
  151957. name: string;
  151958. /**
  151959. * Creates a new sprite manager from a packed sprite sheet
  151960. * @param name defines the manager's name
  151961. * @param imgUrl defines the sprite sheet url
  151962. * @param capacity defines the maximum allowed number of sprites
  151963. * @param scene defines the hosting scene
  151964. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  151965. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  151966. * @param samplingMode defines the smapling mode to use with spritesheet
  151967. * @param fromPacked set to true; do not alter
  151968. */
  151969. constructor(
  151970. /** defines the packed manager's name */
  151971. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  151972. }
  151973. }
  151974. declare module BABYLON {
  151975. /**
  151976. * Defines the list of states available for a task inside a AssetsManager
  151977. */
  151978. export enum AssetTaskState {
  151979. /**
  151980. * Initialization
  151981. */
  151982. INIT = 0,
  151983. /**
  151984. * Running
  151985. */
  151986. RUNNING = 1,
  151987. /**
  151988. * Done
  151989. */
  151990. DONE = 2,
  151991. /**
  151992. * Error
  151993. */
  151994. ERROR = 3
  151995. }
  151996. /**
  151997. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  151998. */
  151999. export abstract class AbstractAssetTask {
  152000. /**
  152001. * Task name
  152002. */ name: string;
  152003. /**
  152004. * Callback called when the task is successful
  152005. */
  152006. onSuccess: (task: any) => void;
  152007. /**
  152008. * Callback called when the task is not successful
  152009. */
  152010. onError: (task: any, message?: string, exception?: any) => void;
  152011. /**
  152012. * Creates a new AssetsManager
  152013. * @param name defines the name of the task
  152014. */
  152015. constructor(
  152016. /**
  152017. * Task name
  152018. */ name: string);
  152019. private _isCompleted;
  152020. private _taskState;
  152021. private _errorObject;
  152022. /**
  152023. * Get if the task is completed
  152024. */
  152025. get isCompleted(): boolean;
  152026. /**
  152027. * Gets the current state of the task
  152028. */
  152029. get taskState(): AssetTaskState;
  152030. /**
  152031. * Gets the current error object (if task is in error)
  152032. */
  152033. get errorObject(): {
  152034. message?: string;
  152035. exception?: any;
  152036. };
  152037. /**
  152038. * Internal only
  152039. * @hidden
  152040. */
  152041. _setErrorObject(message?: string, exception?: any): void;
  152042. /**
  152043. * Execute the current task
  152044. * @param scene defines the scene where you want your assets to be loaded
  152045. * @param onSuccess is a callback called when the task is successfully executed
  152046. * @param onError is a callback called if an error occurs
  152047. */
  152048. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152049. /**
  152050. * Execute the current task
  152051. * @param scene defines the scene where you want your assets to be loaded
  152052. * @param onSuccess is a callback called when the task is successfully executed
  152053. * @param onError is a callback called if an error occurs
  152054. */
  152055. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152056. /**
  152057. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  152058. * This can be used with failed tasks that have the reason for failure fixed.
  152059. */
  152060. reset(): void;
  152061. private onErrorCallback;
  152062. private onDoneCallback;
  152063. }
  152064. /**
  152065. * Define the interface used by progress events raised during assets loading
  152066. */
  152067. export interface IAssetsProgressEvent {
  152068. /**
  152069. * Defines the number of remaining tasks to process
  152070. */
  152071. remainingCount: number;
  152072. /**
  152073. * Defines the total number of tasks
  152074. */
  152075. totalCount: number;
  152076. /**
  152077. * Defines the task that was just processed
  152078. */
  152079. task: AbstractAssetTask;
  152080. }
  152081. /**
  152082. * Class used to share progress information about assets loading
  152083. */
  152084. export class AssetsProgressEvent implements IAssetsProgressEvent {
  152085. /**
  152086. * Defines the number of remaining tasks to process
  152087. */
  152088. remainingCount: number;
  152089. /**
  152090. * Defines the total number of tasks
  152091. */
  152092. totalCount: number;
  152093. /**
  152094. * Defines the task that was just processed
  152095. */
  152096. task: AbstractAssetTask;
  152097. /**
  152098. * Creates a AssetsProgressEvent
  152099. * @param remainingCount defines the number of remaining tasks to process
  152100. * @param totalCount defines the total number of tasks
  152101. * @param task defines the task that was just processed
  152102. */
  152103. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  152104. }
  152105. /**
  152106. * Define a task used by AssetsManager to load assets into a container
  152107. */
  152108. export class ContainerAssetTask extends AbstractAssetTask {
  152109. /**
  152110. * Defines the name of the task
  152111. */
  152112. name: string;
  152113. /**
  152114. * Defines the list of mesh's names you want to load
  152115. */
  152116. meshesNames: any;
  152117. /**
  152118. * Defines the root url to use as a base to load your meshes and associated resources
  152119. */
  152120. rootUrl: string;
  152121. /**
  152122. * Defines the filename or File of the scene to load from
  152123. */
  152124. sceneFilename: string | File;
  152125. /**
  152126. * Get the loaded asset container
  152127. */
  152128. loadedContainer: AssetContainer;
  152129. /**
  152130. * Gets the list of loaded meshes
  152131. */
  152132. loadedMeshes: Array<AbstractMesh>;
  152133. /**
  152134. * Gets the list of loaded particle systems
  152135. */
  152136. loadedParticleSystems: Array<IParticleSystem>;
  152137. /**
  152138. * Gets the list of loaded skeletons
  152139. */
  152140. loadedSkeletons: Array<Skeleton>;
  152141. /**
  152142. * Gets the list of loaded animation groups
  152143. */
  152144. loadedAnimationGroups: Array<AnimationGroup>;
  152145. /**
  152146. * Callback called when the task is successful
  152147. */
  152148. onSuccess: (task: ContainerAssetTask) => void;
  152149. /**
  152150. * Callback called when the task is successful
  152151. */
  152152. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  152153. /**
  152154. * Creates a new ContainerAssetTask
  152155. * @param name defines the name of the task
  152156. * @param meshesNames defines the list of mesh's names you want to load
  152157. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152158. * @param sceneFilename defines the filename or File of the scene to load from
  152159. */
  152160. constructor(
  152161. /**
  152162. * Defines the name of the task
  152163. */
  152164. name: string,
  152165. /**
  152166. * Defines the list of mesh's names you want to load
  152167. */
  152168. meshesNames: any,
  152169. /**
  152170. * Defines the root url to use as a base to load your meshes and associated resources
  152171. */
  152172. rootUrl: string,
  152173. /**
  152174. * Defines the filename or File of the scene to load from
  152175. */
  152176. sceneFilename: string | File);
  152177. /**
  152178. * Execute the current task
  152179. * @param scene defines the scene where you want your assets to be loaded
  152180. * @param onSuccess is a callback called when the task is successfully executed
  152181. * @param onError is a callback called if an error occurs
  152182. */
  152183. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152184. }
  152185. /**
  152186. * Define a task used by AssetsManager to load meshes
  152187. */
  152188. export class MeshAssetTask extends AbstractAssetTask {
  152189. /**
  152190. * Defines the name of the task
  152191. */
  152192. name: string;
  152193. /**
  152194. * Defines the list of mesh's names you want to load
  152195. */
  152196. meshesNames: any;
  152197. /**
  152198. * Defines the root url to use as a base to load your meshes and associated resources
  152199. */
  152200. rootUrl: string;
  152201. /**
  152202. * Defines the filename or File of the scene to load from
  152203. */
  152204. sceneFilename: string | File;
  152205. /**
  152206. * Gets the list of loaded meshes
  152207. */
  152208. loadedMeshes: Array<AbstractMesh>;
  152209. /**
  152210. * Gets the list of loaded particle systems
  152211. */
  152212. loadedParticleSystems: Array<IParticleSystem>;
  152213. /**
  152214. * Gets the list of loaded skeletons
  152215. */
  152216. loadedSkeletons: Array<Skeleton>;
  152217. /**
  152218. * Gets the list of loaded animation groups
  152219. */
  152220. loadedAnimationGroups: Array<AnimationGroup>;
  152221. /**
  152222. * Callback called when the task is successful
  152223. */
  152224. onSuccess: (task: MeshAssetTask) => void;
  152225. /**
  152226. * Callback called when the task is successful
  152227. */
  152228. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  152229. /**
  152230. * Creates a new MeshAssetTask
  152231. * @param name defines the name of the task
  152232. * @param meshesNames defines the list of mesh's names you want to load
  152233. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152234. * @param sceneFilename defines the filename or File of the scene to load from
  152235. */
  152236. constructor(
  152237. /**
  152238. * Defines the name of the task
  152239. */
  152240. name: string,
  152241. /**
  152242. * Defines the list of mesh's names you want to load
  152243. */
  152244. meshesNames: any,
  152245. /**
  152246. * Defines the root url to use as a base to load your meshes and associated resources
  152247. */
  152248. rootUrl: string,
  152249. /**
  152250. * Defines the filename or File of the scene to load from
  152251. */
  152252. sceneFilename: string | File);
  152253. /**
  152254. * Execute the current task
  152255. * @param scene defines the scene where you want your assets to be loaded
  152256. * @param onSuccess is a callback called when the task is successfully executed
  152257. * @param onError is a callback called if an error occurs
  152258. */
  152259. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152260. }
  152261. /**
  152262. * Define a task used by AssetsManager to load text content
  152263. */
  152264. export class TextFileAssetTask extends AbstractAssetTask {
  152265. /**
  152266. * Defines the name of the task
  152267. */
  152268. name: string;
  152269. /**
  152270. * Defines the location of the file to load
  152271. */
  152272. url: string;
  152273. /**
  152274. * Gets the loaded text string
  152275. */
  152276. text: string;
  152277. /**
  152278. * Callback called when the task is successful
  152279. */
  152280. onSuccess: (task: TextFileAssetTask) => void;
  152281. /**
  152282. * Callback called when the task is successful
  152283. */
  152284. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  152285. /**
  152286. * Creates a new TextFileAssetTask object
  152287. * @param name defines the name of the task
  152288. * @param url defines the location of the file to load
  152289. */
  152290. constructor(
  152291. /**
  152292. * Defines the name of the task
  152293. */
  152294. name: string,
  152295. /**
  152296. * Defines the location of the file to load
  152297. */
  152298. url: string);
  152299. /**
  152300. * Execute the current task
  152301. * @param scene defines the scene where you want your assets to be loaded
  152302. * @param onSuccess is a callback called when the task is successfully executed
  152303. * @param onError is a callback called if an error occurs
  152304. */
  152305. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152306. }
  152307. /**
  152308. * Define a task used by AssetsManager to load binary data
  152309. */
  152310. export class BinaryFileAssetTask extends AbstractAssetTask {
  152311. /**
  152312. * Defines the name of the task
  152313. */
  152314. name: string;
  152315. /**
  152316. * Defines the location of the file to load
  152317. */
  152318. url: string;
  152319. /**
  152320. * Gets the lodaded data (as an array buffer)
  152321. */
  152322. data: ArrayBuffer;
  152323. /**
  152324. * Callback called when the task is successful
  152325. */
  152326. onSuccess: (task: BinaryFileAssetTask) => void;
  152327. /**
  152328. * Callback called when the task is successful
  152329. */
  152330. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  152331. /**
  152332. * Creates a new BinaryFileAssetTask object
  152333. * @param name defines the name of the new task
  152334. * @param url defines the location of the file to load
  152335. */
  152336. constructor(
  152337. /**
  152338. * Defines the name of the task
  152339. */
  152340. name: string,
  152341. /**
  152342. * Defines the location of the file to load
  152343. */
  152344. url: string);
  152345. /**
  152346. * Execute the current task
  152347. * @param scene defines the scene where you want your assets to be loaded
  152348. * @param onSuccess is a callback called when the task is successfully executed
  152349. * @param onError is a callback called if an error occurs
  152350. */
  152351. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152352. }
  152353. /**
  152354. * Define a task used by AssetsManager to load images
  152355. */
  152356. export class ImageAssetTask extends AbstractAssetTask {
  152357. /**
  152358. * Defines the name of the task
  152359. */
  152360. name: string;
  152361. /**
  152362. * Defines the location of the image to load
  152363. */
  152364. url: string;
  152365. /**
  152366. * Gets the loaded images
  152367. */
  152368. image: HTMLImageElement;
  152369. /**
  152370. * Callback called when the task is successful
  152371. */
  152372. onSuccess: (task: ImageAssetTask) => void;
  152373. /**
  152374. * Callback called when the task is successful
  152375. */
  152376. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  152377. /**
  152378. * Creates a new ImageAssetTask
  152379. * @param name defines the name of the task
  152380. * @param url defines the location of the image to load
  152381. */
  152382. constructor(
  152383. /**
  152384. * Defines the name of the task
  152385. */
  152386. name: string,
  152387. /**
  152388. * Defines the location of the image to load
  152389. */
  152390. url: string);
  152391. /**
  152392. * Execute the current task
  152393. * @param scene defines the scene where you want your assets to be loaded
  152394. * @param onSuccess is a callback called when the task is successfully executed
  152395. * @param onError is a callback called if an error occurs
  152396. */
  152397. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152398. }
  152399. /**
  152400. * Defines the interface used by texture loading tasks
  152401. */
  152402. export interface ITextureAssetTask<TEX extends BaseTexture> {
  152403. /**
  152404. * Gets the loaded texture
  152405. */
  152406. texture: TEX;
  152407. }
  152408. /**
  152409. * Define a task used by AssetsManager to load 2D textures
  152410. */
  152411. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  152412. /**
  152413. * Defines the name of the task
  152414. */
  152415. name: string;
  152416. /**
  152417. * Defines the location of the file to load
  152418. */
  152419. url: string;
  152420. /**
  152421. * Defines if mipmap should not be generated (default is false)
  152422. */
  152423. noMipmap?: boolean | undefined;
  152424. /**
  152425. * Defines if texture must be inverted on Y axis (default is true)
  152426. */
  152427. invertY: boolean;
  152428. /**
  152429. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152430. */
  152431. samplingMode: number;
  152432. /**
  152433. * Gets the loaded texture
  152434. */
  152435. texture: Texture;
  152436. /**
  152437. * Callback called when the task is successful
  152438. */
  152439. onSuccess: (task: TextureAssetTask) => void;
  152440. /**
  152441. * Callback called when the task is successful
  152442. */
  152443. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  152444. /**
  152445. * Creates a new TextureAssetTask object
  152446. * @param name defines the name of the task
  152447. * @param url defines the location of the file to load
  152448. * @param noMipmap defines if mipmap should not be generated (default is false)
  152449. * @param invertY defines if texture must be inverted on Y axis (default is true)
  152450. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152451. */
  152452. constructor(
  152453. /**
  152454. * Defines the name of the task
  152455. */
  152456. name: string,
  152457. /**
  152458. * Defines the location of the file to load
  152459. */
  152460. url: string,
  152461. /**
  152462. * Defines if mipmap should not be generated (default is false)
  152463. */
  152464. noMipmap?: boolean | undefined,
  152465. /**
  152466. * Defines if texture must be inverted on Y axis (default is true)
  152467. */
  152468. invertY?: boolean,
  152469. /**
  152470. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152471. */
  152472. samplingMode?: number);
  152473. /**
  152474. * Execute the current task
  152475. * @param scene defines the scene where you want your assets to be loaded
  152476. * @param onSuccess is a callback called when the task is successfully executed
  152477. * @param onError is a callback called if an error occurs
  152478. */
  152479. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152480. }
  152481. /**
  152482. * Define a task used by AssetsManager to load cube textures
  152483. */
  152484. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  152485. /**
  152486. * Defines the name of the task
  152487. */
  152488. name: string;
  152489. /**
  152490. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152491. */
  152492. url: string;
  152493. /**
  152494. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152495. */
  152496. extensions?: string[] | undefined;
  152497. /**
  152498. * Defines if mipmaps should not be generated (default is false)
  152499. */
  152500. noMipmap?: boolean | undefined;
  152501. /**
  152502. * Defines the explicit list of files (undefined by default)
  152503. */
  152504. files?: string[] | undefined;
  152505. /**
  152506. * Gets the loaded texture
  152507. */
  152508. texture: CubeTexture;
  152509. /**
  152510. * Callback called when the task is successful
  152511. */
  152512. onSuccess: (task: CubeTextureAssetTask) => void;
  152513. /**
  152514. * Callback called when the task is successful
  152515. */
  152516. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  152517. /**
  152518. * Creates a new CubeTextureAssetTask
  152519. * @param name defines the name of the task
  152520. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152521. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152522. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152523. * @param files defines the explicit list of files (undefined by default)
  152524. */
  152525. constructor(
  152526. /**
  152527. * Defines the name of the task
  152528. */
  152529. name: string,
  152530. /**
  152531. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152532. */
  152533. url: string,
  152534. /**
  152535. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152536. */
  152537. extensions?: string[] | undefined,
  152538. /**
  152539. * Defines if mipmaps should not be generated (default is false)
  152540. */
  152541. noMipmap?: boolean | undefined,
  152542. /**
  152543. * Defines the explicit list of files (undefined by default)
  152544. */
  152545. files?: string[] | undefined);
  152546. /**
  152547. * Execute the current task
  152548. * @param scene defines the scene where you want your assets to be loaded
  152549. * @param onSuccess is a callback called when the task is successfully executed
  152550. * @param onError is a callback called if an error occurs
  152551. */
  152552. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152553. }
  152554. /**
  152555. * Define a task used by AssetsManager to load HDR cube textures
  152556. */
  152557. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  152558. /**
  152559. * Defines the name of the task
  152560. */
  152561. name: string;
  152562. /**
  152563. * Defines the location of the file to load
  152564. */
  152565. url: string;
  152566. /**
  152567. * Defines the desired size (the more it increases the longer the generation will be)
  152568. */
  152569. size: number;
  152570. /**
  152571. * Defines if mipmaps should not be generated (default is false)
  152572. */
  152573. noMipmap: boolean;
  152574. /**
  152575. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152576. */
  152577. generateHarmonics: boolean;
  152578. /**
  152579. * 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)
  152580. */
  152581. gammaSpace: boolean;
  152582. /**
  152583. * Internal Use Only
  152584. */
  152585. reserved: boolean;
  152586. /**
  152587. * Gets the loaded texture
  152588. */
  152589. texture: HDRCubeTexture;
  152590. /**
  152591. * Callback called when the task is successful
  152592. */
  152593. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  152594. /**
  152595. * Callback called when the task is successful
  152596. */
  152597. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  152598. /**
  152599. * Creates a new HDRCubeTextureAssetTask object
  152600. * @param name defines the name of the task
  152601. * @param url defines the location of the file to load
  152602. * @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.
  152603. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152604. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152605. * @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)
  152606. * @param reserved Internal use only
  152607. */
  152608. constructor(
  152609. /**
  152610. * Defines the name of the task
  152611. */
  152612. name: string,
  152613. /**
  152614. * Defines the location of the file to load
  152615. */
  152616. url: string,
  152617. /**
  152618. * Defines the desired size (the more it increases the longer the generation will be)
  152619. */
  152620. size: number,
  152621. /**
  152622. * Defines if mipmaps should not be generated (default is false)
  152623. */
  152624. noMipmap?: boolean,
  152625. /**
  152626. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152627. */
  152628. generateHarmonics?: boolean,
  152629. /**
  152630. * 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)
  152631. */
  152632. gammaSpace?: boolean,
  152633. /**
  152634. * Internal Use Only
  152635. */
  152636. reserved?: boolean);
  152637. /**
  152638. * Execute the current task
  152639. * @param scene defines the scene where you want your assets to be loaded
  152640. * @param onSuccess is a callback called when the task is successfully executed
  152641. * @param onError is a callback called if an error occurs
  152642. */
  152643. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152644. }
  152645. /**
  152646. * Define a task used by AssetsManager to load Equirectangular cube textures
  152647. */
  152648. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  152649. /**
  152650. * Defines the name of the task
  152651. */
  152652. name: string;
  152653. /**
  152654. * Defines the location of the file to load
  152655. */
  152656. url: string;
  152657. /**
  152658. * Defines the desired size (the more it increases the longer the generation will be)
  152659. */
  152660. size: number;
  152661. /**
  152662. * Defines if mipmaps should not be generated (default is false)
  152663. */
  152664. noMipmap: boolean;
  152665. /**
  152666. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152667. * but the standard material would require them in Gamma space) (default is true)
  152668. */
  152669. gammaSpace: boolean;
  152670. /**
  152671. * Gets the loaded texture
  152672. */
  152673. texture: EquiRectangularCubeTexture;
  152674. /**
  152675. * Callback called when the task is successful
  152676. */
  152677. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  152678. /**
  152679. * Callback called when the task is successful
  152680. */
  152681. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  152682. /**
  152683. * Creates a new EquiRectangularCubeTextureAssetTask object
  152684. * @param name defines the name of the task
  152685. * @param url defines the location of the file to load
  152686. * @param size defines the desired size (the more it increases the longer the generation will be)
  152687. * If the size is omitted this implies you are using a preprocessed cubemap.
  152688. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152689. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  152690. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  152691. * (default is true)
  152692. */
  152693. constructor(
  152694. /**
  152695. * Defines the name of the task
  152696. */
  152697. name: string,
  152698. /**
  152699. * Defines the location of the file to load
  152700. */
  152701. url: string,
  152702. /**
  152703. * Defines the desired size (the more it increases the longer the generation will be)
  152704. */
  152705. size: number,
  152706. /**
  152707. * Defines if mipmaps should not be generated (default is false)
  152708. */
  152709. noMipmap?: boolean,
  152710. /**
  152711. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152712. * but the standard material would require them in Gamma space) (default is true)
  152713. */
  152714. gammaSpace?: boolean);
  152715. /**
  152716. * Execute the current task
  152717. * @param scene defines the scene where you want your assets to be loaded
  152718. * @param onSuccess is a callback called when the task is successfully executed
  152719. * @param onError is a callback called if an error occurs
  152720. */
  152721. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152722. }
  152723. /**
  152724. * This class can be used to easily import assets into a scene
  152725. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  152726. */
  152727. export class AssetsManager {
  152728. private _scene;
  152729. private _isLoading;
  152730. protected _tasks: AbstractAssetTask[];
  152731. protected _waitingTasksCount: number;
  152732. protected _totalTasksCount: number;
  152733. /**
  152734. * Callback called when all tasks are processed
  152735. */
  152736. onFinish: (tasks: AbstractAssetTask[]) => void;
  152737. /**
  152738. * Callback called when a task is successful
  152739. */
  152740. onTaskSuccess: (task: AbstractAssetTask) => void;
  152741. /**
  152742. * Callback called when a task had an error
  152743. */
  152744. onTaskError: (task: AbstractAssetTask) => void;
  152745. /**
  152746. * Callback called when a task is done (whatever the result is)
  152747. */
  152748. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  152749. /**
  152750. * Observable called when all tasks are processed
  152751. */
  152752. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  152753. /**
  152754. * Observable called when a task had an error
  152755. */
  152756. onTaskErrorObservable: Observable<AbstractAssetTask>;
  152757. /**
  152758. * Observable called when all tasks were executed
  152759. */
  152760. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  152761. /**
  152762. * Observable called when a task is done (whatever the result is)
  152763. */
  152764. onProgressObservable: Observable<IAssetsProgressEvent>;
  152765. /**
  152766. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  152767. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  152768. */
  152769. useDefaultLoadingScreen: boolean;
  152770. /**
  152771. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  152772. * when all assets have been downloaded.
  152773. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  152774. */
  152775. autoHideLoadingUI: boolean;
  152776. /**
  152777. * Creates a new AssetsManager
  152778. * @param scene defines the scene to work on
  152779. */
  152780. constructor(scene: Scene);
  152781. /**
  152782. * Add a ContainerAssetTask to the list of active tasks
  152783. * @param taskName defines the name of the new task
  152784. * @param meshesNames defines the name of meshes to load
  152785. * @param rootUrl defines the root url to use to locate files
  152786. * @param sceneFilename defines the filename of the scene file
  152787. * @returns a new ContainerAssetTask object
  152788. */
  152789. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  152790. /**
  152791. * Add a MeshAssetTask to the list of active tasks
  152792. * @param taskName defines the name of the new task
  152793. * @param meshesNames defines the name of meshes to load
  152794. * @param rootUrl defines the root url to use to locate files
  152795. * @param sceneFilename defines the filename of the scene file
  152796. * @returns a new MeshAssetTask object
  152797. */
  152798. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  152799. /**
  152800. * Add a TextFileAssetTask to the list of active tasks
  152801. * @param taskName defines the name of the new task
  152802. * @param url defines the url of the file to load
  152803. * @returns a new TextFileAssetTask object
  152804. */
  152805. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  152806. /**
  152807. * Add a BinaryFileAssetTask to the list of active tasks
  152808. * @param taskName defines the name of the new task
  152809. * @param url defines the url of the file to load
  152810. * @returns a new BinaryFileAssetTask object
  152811. */
  152812. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  152813. /**
  152814. * Add a ImageAssetTask to the list of active tasks
  152815. * @param taskName defines the name of the new task
  152816. * @param url defines the url of the file to load
  152817. * @returns a new ImageAssetTask object
  152818. */
  152819. addImageTask(taskName: string, url: string): ImageAssetTask;
  152820. /**
  152821. * Add a TextureAssetTask to the list of active tasks
  152822. * @param taskName defines the name of the new task
  152823. * @param url defines the url of the file to load
  152824. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152825. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  152826. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  152827. * @returns a new TextureAssetTask object
  152828. */
  152829. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  152830. /**
  152831. * Add a CubeTextureAssetTask to the list of active tasks
  152832. * @param taskName defines the name of the new task
  152833. * @param url defines the url of the file to load
  152834. * @param extensions defines the extension to use to load the cube map (can be null)
  152835. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152836. * @param files defines the list of files to load (can be null)
  152837. * @returns a new CubeTextureAssetTask object
  152838. */
  152839. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  152840. /**
  152841. *
  152842. * Add a HDRCubeTextureAssetTask to the list of active tasks
  152843. * @param taskName defines the name of the new task
  152844. * @param url defines the url of the file to load
  152845. * @param size defines the size you want for the cubemap (can be null)
  152846. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152847. * @param generateHarmonics defines if you want to automatically generate (true by default)
  152848. * @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)
  152849. * @param reserved Internal use only
  152850. * @returns a new HDRCubeTextureAssetTask object
  152851. */
  152852. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  152853. /**
  152854. *
  152855. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  152856. * @param taskName defines the name of the new task
  152857. * @param url defines the url of the file to load
  152858. * @param size defines the size you want for the cubemap (can be null)
  152859. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152860. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  152861. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  152862. * @returns a new EquiRectangularCubeTextureAssetTask object
  152863. */
  152864. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  152865. /**
  152866. * Remove a task from the assets manager.
  152867. * @param task the task to remove
  152868. */
  152869. removeTask(task: AbstractAssetTask): void;
  152870. private _decreaseWaitingTasksCount;
  152871. private _runTask;
  152872. /**
  152873. * Reset the AssetsManager and remove all tasks
  152874. * @return the current instance of the AssetsManager
  152875. */
  152876. reset(): AssetsManager;
  152877. /**
  152878. * Start the loading process
  152879. * @return the current instance of the AssetsManager
  152880. */
  152881. load(): AssetsManager;
  152882. /**
  152883. * Start the loading process as an async operation
  152884. * @return a promise returning the list of failed tasks
  152885. */
  152886. loadAsync(): Promise<void>;
  152887. }
  152888. }
  152889. declare module BABYLON {
  152890. /**
  152891. * Wrapper class for promise with external resolve and reject.
  152892. */
  152893. export class Deferred<T> {
  152894. /**
  152895. * The promise associated with this deferred object.
  152896. */
  152897. readonly promise: Promise<T>;
  152898. private _resolve;
  152899. private _reject;
  152900. /**
  152901. * The resolve method of the promise associated with this deferred object.
  152902. */
  152903. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  152904. /**
  152905. * The reject method of the promise associated with this deferred object.
  152906. */
  152907. get reject(): (reason?: any) => void;
  152908. /**
  152909. * Constructor for this deferred object.
  152910. */
  152911. constructor();
  152912. }
  152913. }
  152914. declare module BABYLON {
  152915. /**
  152916. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  152917. */
  152918. export class MeshExploder {
  152919. private _centerMesh;
  152920. private _meshes;
  152921. private _meshesOrigins;
  152922. private _toCenterVectors;
  152923. private _scaledDirection;
  152924. private _newPosition;
  152925. private _centerPosition;
  152926. /**
  152927. * Explodes meshes from a center mesh.
  152928. * @param meshes The meshes to explode.
  152929. * @param centerMesh The mesh to be center of explosion.
  152930. */
  152931. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  152932. private _setCenterMesh;
  152933. /**
  152934. * Get class name
  152935. * @returns "MeshExploder"
  152936. */
  152937. getClassName(): string;
  152938. /**
  152939. * "Exploded meshes"
  152940. * @returns Array of meshes with the centerMesh at index 0.
  152941. */
  152942. getMeshes(): Array<Mesh>;
  152943. /**
  152944. * Explodes meshes giving a specific direction
  152945. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  152946. */
  152947. explode(direction?: number): void;
  152948. }
  152949. }
  152950. declare module BABYLON {
  152951. /**
  152952. * Class used to help managing file picking and drag'n'drop
  152953. */
  152954. export class FilesInput {
  152955. /**
  152956. * List of files ready to be loaded
  152957. */
  152958. static get FilesToLoad(): {
  152959. [key: string]: File;
  152960. };
  152961. /**
  152962. * Callback called when a file is processed
  152963. */
  152964. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  152965. private _engine;
  152966. private _currentScene;
  152967. private _sceneLoadedCallback;
  152968. private _progressCallback;
  152969. private _additionalRenderLoopLogicCallback;
  152970. private _textureLoadingCallback;
  152971. private _startingProcessingFilesCallback;
  152972. private _onReloadCallback;
  152973. private _errorCallback;
  152974. private _elementToMonitor;
  152975. private _sceneFileToLoad;
  152976. private _filesToLoad;
  152977. /**
  152978. * Creates a new FilesInput
  152979. * @param engine defines the rendering engine
  152980. * @param scene defines the hosting scene
  152981. * @param sceneLoadedCallback callback called when scene is loaded
  152982. * @param progressCallback callback called to track progress
  152983. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  152984. * @param textureLoadingCallback callback called when a texture is loading
  152985. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  152986. * @param onReloadCallback callback called when a reload is requested
  152987. * @param errorCallback callback call if an error occurs
  152988. */
  152989. 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>);
  152990. private _dragEnterHandler;
  152991. private _dragOverHandler;
  152992. private _dropHandler;
  152993. /**
  152994. * Calls this function to listen to drag'n'drop events on a specific DOM element
  152995. * @param elementToMonitor defines the DOM element to track
  152996. */
  152997. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  152998. /** Gets the current list of files to load */
  152999. get filesToLoad(): File[];
  153000. /**
  153001. * Release all associated resources
  153002. */
  153003. dispose(): void;
  153004. private renderFunction;
  153005. private drag;
  153006. private drop;
  153007. private _traverseFolder;
  153008. private _processFiles;
  153009. /**
  153010. * Load files from a drop event
  153011. * @param event defines the drop event to use as source
  153012. */
  153013. loadFiles(event: any): void;
  153014. private _processReload;
  153015. /**
  153016. * Reload the current scene from the loaded files
  153017. */
  153018. reload(): void;
  153019. }
  153020. }
  153021. declare module BABYLON {
  153022. /**
  153023. * Defines the root class used to create scene optimization to use with SceneOptimizer
  153024. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153025. */
  153026. export class SceneOptimization {
  153027. /**
  153028. * Defines the priority of this optimization (0 by default which means first in the list)
  153029. */
  153030. priority: number;
  153031. /**
  153032. * Gets a string describing the action executed by the current optimization
  153033. * @returns description string
  153034. */
  153035. getDescription(): string;
  153036. /**
  153037. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153038. * @param scene defines the current scene where to apply this optimization
  153039. * @param optimizer defines the current optimizer
  153040. * @returns true if everything that can be done was applied
  153041. */
  153042. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153043. /**
  153044. * Creates the SceneOptimization object
  153045. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153046. * @param desc defines the description associated with the optimization
  153047. */
  153048. constructor(
  153049. /**
  153050. * Defines the priority of this optimization (0 by default which means first in the list)
  153051. */
  153052. priority?: number);
  153053. }
  153054. /**
  153055. * Defines an optimization used to reduce the size of render target textures
  153056. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153057. */
  153058. export class TextureOptimization extends SceneOptimization {
  153059. /**
  153060. * Defines the priority of this optimization (0 by default which means first in the list)
  153061. */
  153062. priority: number;
  153063. /**
  153064. * 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
  153065. */
  153066. maximumSize: number;
  153067. /**
  153068. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153069. */
  153070. step: number;
  153071. /**
  153072. * Gets a string describing the action executed by the current optimization
  153073. * @returns description string
  153074. */
  153075. getDescription(): string;
  153076. /**
  153077. * Creates the TextureOptimization object
  153078. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153079. * @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
  153080. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153081. */
  153082. constructor(
  153083. /**
  153084. * Defines the priority of this optimization (0 by default which means first in the list)
  153085. */
  153086. priority?: number,
  153087. /**
  153088. * 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
  153089. */
  153090. maximumSize?: number,
  153091. /**
  153092. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153093. */
  153094. step?: number);
  153095. /**
  153096. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153097. * @param scene defines the current scene where to apply this optimization
  153098. * @param optimizer defines the current optimizer
  153099. * @returns true if everything that can be done was applied
  153100. */
  153101. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153102. }
  153103. /**
  153104. * Defines an optimization used to increase or decrease the rendering resolution
  153105. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153106. */
  153107. export class HardwareScalingOptimization extends SceneOptimization {
  153108. /**
  153109. * Defines the priority of this optimization (0 by default which means first in the list)
  153110. */
  153111. priority: number;
  153112. /**
  153113. * Defines the maximum scale to use (2 by default)
  153114. */
  153115. maximumScale: number;
  153116. /**
  153117. * Defines the step to use between two passes (0.5 by default)
  153118. */
  153119. step: number;
  153120. private _currentScale;
  153121. private _directionOffset;
  153122. /**
  153123. * Gets a string describing the action executed by the current optimization
  153124. * @return description string
  153125. */
  153126. getDescription(): string;
  153127. /**
  153128. * Creates the HardwareScalingOptimization object
  153129. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153130. * @param maximumScale defines the maximum scale to use (2 by default)
  153131. * @param step defines the step to use between two passes (0.5 by default)
  153132. */
  153133. constructor(
  153134. /**
  153135. * Defines the priority of this optimization (0 by default which means first in the list)
  153136. */
  153137. priority?: number,
  153138. /**
  153139. * Defines the maximum scale to use (2 by default)
  153140. */
  153141. maximumScale?: number,
  153142. /**
  153143. * Defines the step to use between two passes (0.5 by default)
  153144. */
  153145. step?: number);
  153146. /**
  153147. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153148. * @param scene defines the current scene where to apply this optimization
  153149. * @param optimizer defines the current optimizer
  153150. * @returns true if everything that can be done was applied
  153151. */
  153152. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153153. }
  153154. /**
  153155. * Defines an optimization used to remove shadows
  153156. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153157. */
  153158. export class ShadowsOptimization extends SceneOptimization {
  153159. /**
  153160. * Gets a string describing the action executed by the current optimization
  153161. * @return description string
  153162. */
  153163. getDescription(): string;
  153164. /**
  153165. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153166. * @param scene defines the current scene where to apply this optimization
  153167. * @param optimizer defines the current optimizer
  153168. * @returns true if everything that can be done was applied
  153169. */
  153170. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153171. }
  153172. /**
  153173. * Defines an optimization used to turn post-processes off
  153174. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153175. */
  153176. export class PostProcessesOptimization extends SceneOptimization {
  153177. /**
  153178. * Gets a string describing the action executed by the current optimization
  153179. * @return description string
  153180. */
  153181. getDescription(): string;
  153182. /**
  153183. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153184. * @param scene defines the current scene where to apply this optimization
  153185. * @param optimizer defines the current optimizer
  153186. * @returns true if everything that can be done was applied
  153187. */
  153188. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153189. }
  153190. /**
  153191. * Defines an optimization used to turn lens flares off
  153192. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153193. */
  153194. export class LensFlaresOptimization extends SceneOptimization {
  153195. /**
  153196. * Gets a string describing the action executed by the current optimization
  153197. * @return description string
  153198. */
  153199. getDescription(): string;
  153200. /**
  153201. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153202. * @param scene defines the current scene where to apply this optimization
  153203. * @param optimizer defines the current optimizer
  153204. * @returns true if everything that can be done was applied
  153205. */
  153206. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153207. }
  153208. /**
  153209. * Defines an optimization based on user defined callback.
  153210. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153211. */
  153212. export class CustomOptimization extends SceneOptimization {
  153213. /**
  153214. * Callback called to apply the custom optimization.
  153215. */
  153216. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  153217. /**
  153218. * Callback called to get custom description
  153219. */
  153220. onGetDescription: () => string;
  153221. /**
  153222. * Gets a string describing the action executed by the current optimization
  153223. * @returns description string
  153224. */
  153225. getDescription(): string;
  153226. /**
  153227. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153228. * @param scene defines the current scene where to apply this optimization
  153229. * @param optimizer defines the current optimizer
  153230. * @returns true if everything that can be done was applied
  153231. */
  153232. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153233. }
  153234. /**
  153235. * Defines an optimization used to turn particles off
  153236. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153237. */
  153238. export class ParticlesOptimization extends SceneOptimization {
  153239. /**
  153240. * Gets a string describing the action executed by the current optimization
  153241. * @return description string
  153242. */
  153243. getDescription(): string;
  153244. /**
  153245. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153246. * @param scene defines the current scene where to apply this optimization
  153247. * @param optimizer defines the current optimizer
  153248. * @returns true if everything that can be done was applied
  153249. */
  153250. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153251. }
  153252. /**
  153253. * Defines an optimization used to turn render targets off
  153254. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153255. */
  153256. export class RenderTargetsOptimization extends SceneOptimization {
  153257. /**
  153258. * Gets a string describing the action executed by the current optimization
  153259. * @return description string
  153260. */
  153261. getDescription(): string;
  153262. /**
  153263. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153264. * @param scene defines the current scene where to apply this optimization
  153265. * @param optimizer defines the current optimizer
  153266. * @returns true if everything that can be done was applied
  153267. */
  153268. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153269. }
  153270. /**
  153271. * Defines an optimization used to merge meshes with compatible materials
  153272. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153273. */
  153274. export class MergeMeshesOptimization extends SceneOptimization {
  153275. private static _UpdateSelectionTree;
  153276. /**
  153277. * Gets or sets a boolean which defines if optimization octree has to be updated
  153278. */
  153279. static get UpdateSelectionTree(): boolean;
  153280. /**
  153281. * Gets or sets a boolean which defines if optimization octree has to be updated
  153282. */
  153283. static set UpdateSelectionTree(value: boolean);
  153284. /**
  153285. * Gets a string describing the action executed by the current optimization
  153286. * @return description string
  153287. */
  153288. getDescription(): string;
  153289. private _canBeMerged;
  153290. /**
  153291. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153292. * @param scene defines the current scene where to apply this optimization
  153293. * @param optimizer defines the current optimizer
  153294. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  153295. * @returns true if everything that can be done was applied
  153296. */
  153297. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  153298. }
  153299. /**
  153300. * Defines a list of options used by SceneOptimizer
  153301. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153302. */
  153303. export class SceneOptimizerOptions {
  153304. /**
  153305. * Defines the target frame rate to reach (60 by default)
  153306. */
  153307. targetFrameRate: number;
  153308. /**
  153309. * Defines the interval between two checkes (2000ms by default)
  153310. */
  153311. trackerDuration: number;
  153312. /**
  153313. * Gets the list of optimizations to apply
  153314. */
  153315. optimizations: SceneOptimization[];
  153316. /**
  153317. * Creates a new list of options used by SceneOptimizer
  153318. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  153319. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  153320. */
  153321. constructor(
  153322. /**
  153323. * Defines the target frame rate to reach (60 by default)
  153324. */
  153325. targetFrameRate?: number,
  153326. /**
  153327. * Defines the interval between two checkes (2000ms by default)
  153328. */
  153329. trackerDuration?: number);
  153330. /**
  153331. * Add a new optimization
  153332. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  153333. * @returns the current SceneOptimizerOptions
  153334. */
  153335. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  153336. /**
  153337. * Add a new custom optimization
  153338. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  153339. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  153340. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153341. * @returns the current SceneOptimizerOptions
  153342. */
  153343. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  153344. /**
  153345. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  153346. * @param targetFrameRate defines the target frame rate (60 by default)
  153347. * @returns a SceneOptimizerOptions object
  153348. */
  153349. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153350. /**
  153351. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  153352. * @param targetFrameRate defines the target frame rate (60 by default)
  153353. * @returns a SceneOptimizerOptions object
  153354. */
  153355. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153356. /**
  153357. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  153358. * @param targetFrameRate defines the target frame rate (60 by default)
  153359. * @returns a SceneOptimizerOptions object
  153360. */
  153361. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153362. }
  153363. /**
  153364. * Class used to run optimizations in order to reach a target frame rate
  153365. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153366. */
  153367. export class SceneOptimizer implements IDisposable {
  153368. private _isRunning;
  153369. private _options;
  153370. private _scene;
  153371. private _currentPriorityLevel;
  153372. private _targetFrameRate;
  153373. private _trackerDuration;
  153374. private _currentFrameRate;
  153375. private _sceneDisposeObserver;
  153376. private _improvementMode;
  153377. /**
  153378. * Defines an observable called when the optimizer reaches the target frame rate
  153379. */
  153380. onSuccessObservable: Observable<SceneOptimizer>;
  153381. /**
  153382. * Defines an observable called when the optimizer enables an optimization
  153383. */
  153384. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  153385. /**
  153386. * Defines an observable called when the optimizer is not able to reach the target frame rate
  153387. */
  153388. onFailureObservable: Observable<SceneOptimizer>;
  153389. /**
  153390. * Gets a boolean indicating if the optimizer is in improvement mode
  153391. */
  153392. get isInImprovementMode(): boolean;
  153393. /**
  153394. * Gets the current priority level (0 at start)
  153395. */
  153396. get currentPriorityLevel(): number;
  153397. /**
  153398. * Gets the current frame rate checked by the SceneOptimizer
  153399. */
  153400. get currentFrameRate(): number;
  153401. /**
  153402. * Gets or sets the current target frame rate (60 by default)
  153403. */
  153404. get targetFrameRate(): number;
  153405. /**
  153406. * Gets or sets the current target frame rate (60 by default)
  153407. */
  153408. set targetFrameRate(value: number);
  153409. /**
  153410. * Gets or sets the current interval between two checks (every 2000ms by default)
  153411. */
  153412. get trackerDuration(): number;
  153413. /**
  153414. * Gets or sets the current interval between two checks (every 2000ms by default)
  153415. */
  153416. set trackerDuration(value: number);
  153417. /**
  153418. * Gets the list of active optimizations
  153419. */
  153420. get optimizations(): SceneOptimization[];
  153421. /**
  153422. * Creates a new SceneOptimizer
  153423. * @param scene defines the scene to work on
  153424. * @param options defines the options to use with the SceneOptimizer
  153425. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  153426. * @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)
  153427. */
  153428. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  153429. /**
  153430. * Stops the current optimizer
  153431. */
  153432. stop(): void;
  153433. /**
  153434. * Reset the optimizer to initial step (current priority level = 0)
  153435. */
  153436. reset(): void;
  153437. /**
  153438. * Start the optimizer. By default it will try to reach a specific framerate
  153439. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  153440. */
  153441. start(): void;
  153442. private _checkCurrentState;
  153443. /**
  153444. * Release all resources
  153445. */
  153446. dispose(): void;
  153447. /**
  153448. * Helper function to create a SceneOptimizer with one single line of code
  153449. * @param scene defines the scene to work on
  153450. * @param options defines the options to use with the SceneOptimizer
  153451. * @param onSuccess defines a callback to call on success
  153452. * @param onFailure defines a callback to call on failure
  153453. * @returns the new SceneOptimizer object
  153454. */
  153455. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  153456. }
  153457. }
  153458. declare module BABYLON {
  153459. /**
  153460. * Class used to serialize a scene into a string
  153461. */
  153462. export class SceneSerializer {
  153463. /**
  153464. * Clear cache used by a previous serialization
  153465. */
  153466. static ClearCache(): void;
  153467. /**
  153468. * Serialize a scene into a JSON compatible object
  153469. * @param scene defines the scene to serialize
  153470. * @returns a JSON compatible object
  153471. */
  153472. static Serialize(scene: Scene): any;
  153473. /**
  153474. * Serialize a mesh into a JSON compatible object
  153475. * @param toSerialize defines the mesh to serialize
  153476. * @param withParents defines if parents must be serialized as well
  153477. * @param withChildren defines if children must be serialized as well
  153478. * @returns a JSON compatible object
  153479. */
  153480. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  153481. }
  153482. }
  153483. declare module BABYLON {
  153484. /**
  153485. * Class used to host texture specific utilities
  153486. */
  153487. export class TextureTools {
  153488. /**
  153489. * Uses the GPU to create a copy texture rescaled at a given size
  153490. * @param texture Texture to copy from
  153491. * @param width defines the desired width
  153492. * @param height defines the desired height
  153493. * @param useBilinearMode defines if bilinear mode has to be used
  153494. * @return the generated texture
  153495. */
  153496. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  153497. }
  153498. }
  153499. declare module BABYLON {
  153500. /**
  153501. * This represents the different options available for the video capture.
  153502. */
  153503. export interface VideoRecorderOptions {
  153504. /** Defines the mime type of the video. */
  153505. mimeType: string;
  153506. /** Defines the FPS the video should be recorded at. */
  153507. fps: number;
  153508. /** Defines the chunk size for the recording data. */
  153509. recordChunckSize: number;
  153510. /** The audio tracks to attach to the recording. */
  153511. audioTracks?: MediaStreamTrack[];
  153512. }
  153513. /**
  153514. * This can help with recording videos from BabylonJS.
  153515. * This is based on the available WebRTC functionalities of the browser.
  153516. *
  153517. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  153518. */
  153519. export class VideoRecorder {
  153520. private static readonly _defaultOptions;
  153521. /**
  153522. * Returns whether or not the VideoRecorder is available in your browser.
  153523. * @param engine Defines the Babylon Engine.
  153524. * @returns true if supported otherwise false.
  153525. */
  153526. static IsSupported(engine: Engine): boolean;
  153527. private readonly _options;
  153528. private _canvas;
  153529. private _mediaRecorder;
  153530. private _recordedChunks;
  153531. private _fileName;
  153532. private _resolve;
  153533. private _reject;
  153534. /**
  153535. * True when a recording is already in progress.
  153536. */
  153537. get isRecording(): boolean;
  153538. /**
  153539. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  153540. * @param engine Defines the BabylonJS Engine you wish to record.
  153541. * @param options Defines options that can be used to customize the capture.
  153542. */
  153543. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  153544. /**
  153545. * Stops the current recording before the default capture timeout passed in the startRecording function.
  153546. */
  153547. stopRecording(): void;
  153548. /**
  153549. * Starts recording the canvas for a max duration specified in parameters.
  153550. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  153551. * If null no automatic download will start and you can rely on the promise to get the data back.
  153552. * @param maxDuration Defines the maximum recording time in seconds.
  153553. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  153554. * @return A promise callback at the end of the recording with the video data in Blob.
  153555. */
  153556. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  153557. /**
  153558. * Releases internal resources used during the recording.
  153559. */
  153560. dispose(): void;
  153561. private _handleDataAvailable;
  153562. private _handleError;
  153563. private _handleStop;
  153564. }
  153565. }
  153566. declare module BABYLON {
  153567. /**
  153568. * Class containing a set of static utilities functions for screenshots
  153569. */
  153570. export class ScreenshotTools {
  153571. /**
  153572. * Captures a screenshot of the current rendering
  153573. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153574. * @param engine defines the rendering engine
  153575. * @param camera defines the source camera
  153576. * @param size This parameter can be set to a single number or to an object with the
  153577. * following (optional) properties: precision, width, height. If a single number is passed,
  153578. * it will be used for both width and height. If an object is passed, the screenshot size
  153579. * will be derived from the parameters. The precision property is a multiplier allowing
  153580. * rendering at a higher or lower resolution
  153581. * @param successCallback defines the callback receives a single parameter which contains the
  153582. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153583. * src parameter of an <img> to display it
  153584. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153585. * Check your browser for supported MIME types
  153586. */
  153587. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  153588. /**
  153589. * Captures a screenshot of the current rendering
  153590. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153591. * @param engine defines the rendering engine
  153592. * @param camera defines the source camera
  153593. * @param size This parameter can be set to a single number or to an object with the
  153594. * following (optional) properties: precision, width, height. If a single number is passed,
  153595. * it will be used for both width and height. If an object is passed, the screenshot size
  153596. * will be derived from the parameters. The precision property is a multiplier allowing
  153597. * rendering at a higher or lower resolution
  153598. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153599. * Check your browser for supported MIME types
  153600. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153601. * to the src parameter of an <img> to display it
  153602. */
  153603. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  153604. /**
  153605. * Generates an image screenshot from the specified camera.
  153606. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153607. * @param engine The engine to use for rendering
  153608. * @param camera The camera to use for rendering
  153609. * @param size This parameter can be set to a single number or to an object with the
  153610. * following (optional) properties: precision, width, height. If a single number is passed,
  153611. * it will be used for both width and height. If an object is passed, the screenshot size
  153612. * will be derived from the parameters. The precision property is a multiplier allowing
  153613. * rendering at a higher or lower resolution
  153614. * @param successCallback The callback receives a single parameter which contains the
  153615. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153616. * src parameter of an <img> to display it
  153617. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153618. * Check your browser for supported MIME types
  153619. * @param samples Texture samples (default: 1)
  153620. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153621. * @param fileName A name for for the downloaded file.
  153622. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153623. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  153624. */
  153625. 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;
  153626. /**
  153627. * Generates an image screenshot from the specified camera.
  153628. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153629. * @param engine The engine to use for rendering
  153630. * @param camera The camera to use for rendering
  153631. * @param size This parameter can be set to a single number or to an object with the
  153632. * following (optional) properties: precision, width, height. If a single number is passed,
  153633. * it will be used for both width and height. If an object is passed, the screenshot size
  153634. * will be derived from the parameters. The precision property is a multiplier allowing
  153635. * rendering at a higher or lower resolution
  153636. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153637. * Check your browser for supported MIME types
  153638. * @param samples Texture samples (default: 1)
  153639. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153640. * @param fileName A name for for the downloaded file.
  153641. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153642. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153643. * to the src parameter of an <img> to display it
  153644. */
  153645. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  153646. /**
  153647. * Gets height and width for screenshot size
  153648. * @private
  153649. */
  153650. private static _getScreenshotSize;
  153651. }
  153652. }
  153653. declare module BABYLON {
  153654. /**
  153655. * Interface for a data buffer
  153656. */
  153657. export interface IDataBuffer {
  153658. /**
  153659. * Reads bytes from the data buffer.
  153660. * @param byteOffset The byte offset to read
  153661. * @param byteLength The byte length to read
  153662. * @returns A promise that resolves when the bytes are read
  153663. */
  153664. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  153665. /**
  153666. * The byte length of the buffer.
  153667. */
  153668. readonly byteLength: number;
  153669. }
  153670. /**
  153671. * Utility class for reading from a data buffer
  153672. */
  153673. export class DataReader {
  153674. /**
  153675. * The data buffer associated with this data reader.
  153676. */
  153677. readonly buffer: IDataBuffer;
  153678. /**
  153679. * The current byte offset from the beginning of the data buffer.
  153680. */
  153681. byteOffset: number;
  153682. private _dataView;
  153683. private _dataByteOffset;
  153684. /**
  153685. * Constructor
  153686. * @param buffer The buffer to read
  153687. */
  153688. constructor(buffer: IDataBuffer);
  153689. /**
  153690. * Loads the given byte length.
  153691. * @param byteLength The byte length to load
  153692. * @returns A promise that resolves when the load is complete
  153693. */
  153694. loadAsync(byteLength: number): Promise<void>;
  153695. /**
  153696. * Read a unsigned 32-bit integer from the currently loaded data range.
  153697. * @returns The 32-bit integer read
  153698. */
  153699. readUint32(): number;
  153700. /**
  153701. * Read a byte array from the currently loaded data range.
  153702. * @param byteLength The byte length to read
  153703. * @returns The byte array read
  153704. */
  153705. readUint8Array(byteLength: number): Uint8Array;
  153706. /**
  153707. * Read a string from the currently loaded data range.
  153708. * @param byteLength The byte length to read
  153709. * @returns The string read
  153710. */
  153711. readString(byteLength: number): string;
  153712. /**
  153713. * Skips the given byte length the currently loaded data range.
  153714. * @param byteLength The byte length to skip
  153715. */
  153716. skipBytes(byteLength: number): void;
  153717. }
  153718. }
  153719. declare module BABYLON {
  153720. /**
  153721. * Class for storing data to local storage if available or in-memory storage otherwise
  153722. */
  153723. export class DataStorage {
  153724. private static _Storage;
  153725. private static _GetStorage;
  153726. /**
  153727. * Reads a string from the data storage
  153728. * @param key The key to read
  153729. * @param defaultValue The value if the key doesn't exist
  153730. * @returns The string value
  153731. */
  153732. static ReadString(key: string, defaultValue: string): string;
  153733. /**
  153734. * Writes a string to the data storage
  153735. * @param key The key to write
  153736. * @param value The value to write
  153737. */
  153738. static WriteString(key: string, value: string): void;
  153739. /**
  153740. * Reads a boolean from the data storage
  153741. * @param key The key to read
  153742. * @param defaultValue The value if the key doesn't exist
  153743. * @returns The boolean value
  153744. */
  153745. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  153746. /**
  153747. * Writes a boolean to the data storage
  153748. * @param key The key to write
  153749. * @param value The value to write
  153750. */
  153751. static WriteBoolean(key: string, value: boolean): void;
  153752. /**
  153753. * Reads a number from the data storage
  153754. * @param key The key to read
  153755. * @param defaultValue The value if the key doesn't exist
  153756. * @returns The number value
  153757. */
  153758. static ReadNumber(key: string, defaultValue: number): number;
  153759. /**
  153760. * Writes a number to the data storage
  153761. * @param key The key to write
  153762. * @param value The value to write
  153763. */
  153764. static WriteNumber(key: string, value: number): void;
  153765. }
  153766. }
  153767. declare module BABYLON {
  153768. /**
  153769. * Class used to record delta files between 2 scene states
  153770. */
  153771. export class SceneRecorder {
  153772. private _trackedScene;
  153773. private _savedJSON;
  153774. /**
  153775. * Track a given scene. This means the current scene state will be considered the original state
  153776. * @param scene defines the scene to track
  153777. */
  153778. track(scene: Scene): void;
  153779. /**
  153780. * Get the delta between current state and original state
  153781. * @returns a string containing the delta
  153782. */
  153783. getDelta(): any;
  153784. private _compareArray;
  153785. private _compareObjects;
  153786. private _compareCollections;
  153787. private static GetShadowGeneratorById;
  153788. /**
  153789. * Apply a given delta to a given scene
  153790. * @param deltaJSON defines the JSON containing the delta
  153791. * @param scene defines the scene to apply the delta to
  153792. */
  153793. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  153794. private static _ApplyPropertiesToEntity;
  153795. private static _ApplyDeltaForEntity;
  153796. }
  153797. }
  153798. declare module BABYLON {
  153799. /**
  153800. * An interface for all Hit test features
  153801. */
  153802. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  153803. /**
  153804. * Triggered when new babylon (transformed) hit test results are available
  153805. */
  153806. onHitTestResultObservable: Observable<T[]>;
  153807. }
  153808. /**
  153809. * Options used for hit testing
  153810. */
  153811. export interface IWebXRLegacyHitTestOptions {
  153812. /**
  153813. * Only test when user interacted with the scene. Default - hit test every frame
  153814. */
  153815. testOnPointerDownOnly?: boolean;
  153816. /**
  153817. * The node to use to transform the local results to world coordinates
  153818. */
  153819. worldParentNode?: TransformNode;
  153820. }
  153821. /**
  153822. * Interface defining the babylon result of raycasting/hit-test
  153823. */
  153824. export interface IWebXRLegacyHitResult {
  153825. /**
  153826. * Transformation matrix that can be applied to a node that will put it in the hit point location
  153827. */
  153828. transformationMatrix: Matrix;
  153829. /**
  153830. * The native hit test result
  153831. */
  153832. xrHitResult: XRHitResult | XRHitTestResult;
  153833. }
  153834. /**
  153835. * The currently-working hit-test module.
  153836. * Hit test (or Ray-casting) is used to interact with the real world.
  153837. * For further information read here - https://github.com/immersive-web/hit-test
  153838. */
  153839. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  153840. /**
  153841. * options to use when constructing this feature
  153842. */
  153843. readonly options: IWebXRLegacyHitTestOptions;
  153844. private _direction;
  153845. private _mat;
  153846. private _onSelectEnabled;
  153847. private _origin;
  153848. /**
  153849. * The module's name
  153850. */
  153851. static readonly Name: string;
  153852. /**
  153853. * The (Babylon) version of this module.
  153854. * This is an integer representing the implementation version.
  153855. * This number does not correspond to the WebXR specs version
  153856. */
  153857. static readonly Version: number;
  153858. /**
  153859. * Populated with the last native XR Hit Results
  153860. */
  153861. lastNativeXRHitResults: XRHitResult[];
  153862. /**
  153863. * Triggered when new babylon (transformed) hit test results are available
  153864. */
  153865. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  153866. /**
  153867. * Creates a new instance of the (legacy version) hit test feature
  153868. * @param _xrSessionManager an instance of WebXRSessionManager
  153869. * @param options options to use when constructing this feature
  153870. */
  153871. constructor(_xrSessionManager: WebXRSessionManager,
  153872. /**
  153873. * options to use when constructing this feature
  153874. */
  153875. options?: IWebXRLegacyHitTestOptions);
  153876. /**
  153877. * execute a hit test with an XR Ray
  153878. *
  153879. * @param xrSession a native xrSession that will execute this hit test
  153880. * @param xrRay the ray (position and direction) to use for ray-casting
  153881. * @param referenceSpace native XR reference space to use for the hit-test
  153882. * @param filter filter function that will filter the results
  153883. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153884. */
  153885. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  153886. /**
  153887. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  153888. * @param event the (select) event to use to select with
  153889. * @param referenceSpace the reference space to use for this hit test
  153890. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153891. */
  153892. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  153893. /**
  153894. * attach this feature
  153895. * Will usually be called by the features manager
  153896. *
  153897. * @returns true if successful.
  153898. */
  153899. attach(): boolean;
  153900. /**
  153901. * detach this feature.
  153902. * Will usually be called by the features manager
  153903. *
  153904. * @returns true if successful.
  153905. */
  153906. detach(): boolean;
  153907. /**
  153908. * Dispose this feature and all of the resources attached
  153909. */
  153910. dispose(): void;
  153911. protected _onXRFrame(frame: XRFrame): void;
  153912. private _onHitTestResults;
  153913. private _onSelect;
  153914. }
  153915. }
  153916. declare module BABYLON {
  153917. /**
  153918. * Options used for hit testing (version 2)
  153919. */
  153920. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  153921. /**
  153922. * Do not create a permanent hit test. Will usually be used when only
  153923. * transient inputs are needed.
  153924. */
  153925. disablePermanentHitTest?: boolean;
  153926. /**
  153927. * Enable transient (for example touch-based) hit test inspections
  153928. */
  153929. enableTransientHitTest?: boolean;
  153930. /**
  153931. * Offset ray for the permanent hit test
  153932. */
  153933. offsetRay?: Vector3;
  153934. /**
  153935. * Offset ray for the transient hit test
  153936. */
  153937. transientOffsetRay?: Vector3;
  153938. /**
  153939. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  153940. */
  153941. useReferenceSpace?: boolean;
  153942. /**
  153943. * Override the default entity type(s) of the hit-test result
  153944. */
  153945. entityTypes?: XRHitTestTrackableType[];
  153946. }
  153947. /**
  153948. * Interface defining the babylon result of hit-test
  153949. */
  153950. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  153951. /**
  153952. * The input source that generated this hit test (if transient)
  153953. */
  153954. inputSource?: XRInputSource;
  153955. /**
  153956. * Is this a transient hit test
  153957. */
  153958. isTransient?: boolean;
  153959. /**
  153960. * Position of the hit test result
  153961. */
  153962. position: Vector3;
  153963. /**
  153964. * Rotation of the hit test result
  153965. */
  153966. rotationQuaternion: Quaternion;
  153967. /**
  153968. * The native hit test result
  153969. */
  153970. xrHitResult: XRHitTestResult;
  153971. }
  153972. /**
  153973. * The currently-working hit-test module.
  153974. * Hit test (or Ray-casting) is used to interact with the real world.
  153975. * For further information read here - https://github.com/immersive-web/hit-test
  153976. *
  153977. * Tested on chrome (mobile) 80.
  153978. */
  153979. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  153980. /**
  153981. * options to use when constructing this feature
  153982. */
  153983. readonly options: IWebXRHitTestOptions;
  153984. private _tmpMat;
  153985. private _tmpPos;
  153986. private _tmpQuat;
  153987. private _transientXrHitTestSource;
  153988. private _xrHitTestSource;
  153989. private initHitTestSource;
  153990. /**
  153991. * The module's name
  153992. */
  153993. static readonly Name: string;
  153994. /**
  153995. * The (Babylon) version of this module.
  153996. * This is an integer representing the implementation version.
  153997. * This number does not correspond to the WebXR specs version
  153998. */
  153999. static readonly Version: number;
  154000. /**
  154001. * When set to true, each hit test will have its own position/rotation objects
  154002. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  154003. * the developers will clone them or copy them as they see fit.
  154004. */
  154005. autoCloneTransformation: boolean;
  154006. /**
  154007. * Triggered when new babylon (transformed) hit test results are available
  154008. */
  154009. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  154010. /**
  154011. * Use this to temporarily pause hit test checks.
  154012. */
  154013. paused: boolean;
  154014. /**
  154015. * Creates a new instance of the hit test feature
  154016. * @param _xrSessionManager an instance of WebXRSessionManager
  154017. * @param options options to use when constructing this feature
  154018. */
  154019. constructor(_xrSessionManager: WebXRSessionManager,
  154020. /**
  154021. * options to use when constructing this feature
  154022. */
  154023. options?: IWebXRHitTestOptions);
  154024. /**
  154025. * attach this feature
  154026. * Will usually be called by the features manager
  154027. *
  154028. * @returns true if successful.
  154029. */
  154030. attach(): boolean;
  154031. /**
  154032. * detach this feature.
  154033. * Will usually be called by the features manager
  154034. *
  154035. * @returns true if successful.
  154036. */
  154037. detach(): boolean;
  154038. /**
  154039. * Dispose this feature and all of the resources attached
  154040. */
  154041. dispose(): void;
  154042. protected _onXRFrame(frame: XRFrame): void;
  154043. private _processWebXRHitTestResult;
  154044. }
  154045. }
  154046. declare module BABYLON {
  154047. /**
  154048. * Configuration options of the anchor system
  154049. */
  154050. export interface IWebXRAnchorSystemOptions {
  154051. /**
  154052. * a node that will be used to convert local to world coordinates
  154053. */
  154054. worldParentNode?: TransformNode;
  154055. /**
  154056. * If set to true a reference of the created anchors will be kept until the next session starts
  154057. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  154058. */
  154059. doNotRemoveAnchorsOnSessionEnded?: boolean;
  154060. }
  154061. /**
  154062. * A babylon container for an XR Anchor
  154063. */
  154064. export interface IWebXRAnchor {
  154065. /**
  154066. * A babylon-assigned ID for this anchor
  154067. */
  154068. id: number;
  154069. /**
  154070. * Transformation matrix to apply to an object attached to this anchor
  154071. */
  154072. transformationMatrix: Matrix;
  154073. /**
  154074. * The native anchor object
  154075. */
  154076. xrAnchor: XRAnchor;
  154077. /**
  154078. * if defined, this object will be constantly updated by the anchor's position and rotation
  154079. */
  154080. attachedNode?: TransformNode;
  154081. }
  154082. /**
  154083. * An implementation of the anchor system for WebXR.
  154084. * For further information see https://github.com/immersive-web/anchors/
  154085. */
  154086. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  154087. private _options;
  154088. private _lastFrameDetected;
  154089. private _trackedAnchors;
  154090. private _referenceSpaceForFrameAnchors;
  154091. private _futureAnchors;
  154092. /**
  154093. * The module's name
  154094. */
  154095. static readonly Name: string;
  154096. /**
  154097. * The (Babylon) version of this module.
  154098. * This is an integer representing the implementation version.
  154099. * This number does not correspond to the WebXR specs version
  154100. */
  154101. static readonly Version: number;
  154102. /**
  154103. * Observers registered here will be executed when a new anchor was added to the session
  154104. */
  154105. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  154106. /**
  154107. * Observers registered here will be executed when an anchor was removed from the session
  154108. */
  154109. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  154110. /**
  154111. * Observers registered here will be executed when an existing anchor updates
  154112. * This can execute N times every frame
  154113. */
  154114. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  154115. /**
  154116. * Set the reference space to use for anchor creation, when not using a hit test.
  154117. * Will default to the session's reference space if not defined
  154118. */
  154119. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  154120. /**
  154121. * constructs a new anchor system
  154122. * @param _xrSessionManager an instance of WebXRSessionManager
  154123. * @param _options configuration object for this feature
  154124. */
  154125. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  154126. private _tmpVector;
  154127. private _tmpQuaternion;
  154128. private _populateTmpTransformation;
  154129. /**
  154130. * Create a new anchor point using a hit test result at a specific point in the scene
  154131. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154132. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154133. *
  154134. * @param hitTestResult The hit test result to use for this anchor creation
  154135. * @param position an optional position offset for this anchor
  154136. * @param rotationQuaternion an optional rotation offset for this anchor
  154137. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154138. */
  154139. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  154140. /**
  154141. * Add a new anchor at a specific position and rotation
  154142. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  154143. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  154144. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154145. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154146. *
  154147. * @param position the position in which to add an anchor
  154148. * @param rotationQuaternion an optional rotation for the anchor transformation
  154149. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  154150. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154151. */
  154152. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  154153. /**
  154154. * detach this feature.
  154155. * Will usually be called by the features manager
  154156. *
  154157. * @returns true if successful.
  154158. */
  154159. detach(): boolean;
  154160. /**
  154161. * Dispose this feature and all of the resources attached
  154162. */
  154163. dispose(): void;
  154164. protected _onXRFrame(frame: XRFrame): void;
  154165. /**
  154166. * avoiding using Array.find for global support.
  154167. * @param xrAnchor the plane to find in the array
  154168. */
  154169. private _findIndexInAnchorArray;
  154170. private _updateAnchorWithXRFrame;
  154171. private _createAnchorAtTransformation;
  154172. }
  154173. }
  154174. declare module BABYLON {
  154175. /**
  154176. * Options used in the plane detector module
  154177. */
  154178. export interface IWebXRPlaneDetectorOptions {
  154179. /**
  154180. * The node to use to transform the local results to world coordinates
  154181. */
  154182. worldParentNode?: TransformNode;
  154183. /**
  154184. * If set to true a reference of the created planes will be kept until the next session starts
  154185. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  154186. */
  154187. doNotRemovePlanesOnSessionEnded?: boolean;
  154188. }
  154189. /**
  154190. * A babylon interface for a WebXR plane.
  154191. * A Plane is actually a polygon, built from N points in space
  154192. *
  154193. * Supported in chrome 79, not supported in canary 81 ATM
  154194. */
  154195. export interface IWebXRPlane {
  154196. /**
  154197. * a babylon-assigned ID for this polygon
  154198. */
  154199. id: number;
  154200. /**
  154201. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  154202. */
  154203. polygonDefinition: Array<Vector3>;
  154204. /**
  154205. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  154206. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  154207. */
  154208. transformationMatrix: Matrix;
  154209. /**
  154210. * the native xr-plane object
  154211. */
  154212. xrPlane: XRPlane;
  154213. }
  154214. /**
  154215. * The plane detector is used to detect planes in the real world when in AR
  154216. * For more information see https://github.com/immersive-web/real-world-geometry/
  154217. */
  154218. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  154219. private _options;
  154220. private _detectedPlanes;
  154221. private _enabled;
  154222. private _lastFrameDetected;
  154223. /**
  154224. * The module's name
  154225. */
  154226. static readonly Name: string;
  154227. /**
  154228. * The (Babylon) version of this module.
  154229. * This is an integer representing the implementation version.
  154230. * This number does not correspond to the WebXR specs version
  154231. */
  154232. static readonly Version: number;
  154233. /**
  154234. * Observers registered here will be executed when a new plane was added to the session
  154235. */
  154236. onPlaneAddedObservable: Observable<IWebXRPlane>;
  154237. /**
  154238. * Observers registered here will be executed when a plane is no longer detected in the session
  154239. */
  154240. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  154241. /**
  154242. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  154243. * This can execute N times every frame
  154244. */
  154245. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  154246. /**
  154247. * construct a new Plane Detector
  154248. * @param _xrSessionManager an instance of xr Session manager
  154249. * @param _options configuration to use when constructing this feature
  154250. */
  154251. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  154252. /**
  154253. * detach this feature.
  154254. * Will usually be called by the features manager
  154255. *
  154256. * @returns true if successful.
  154257. */
  154258. detach(): boolean;
  154259. /**
  154260. * Dispose this feature and all of the resources attached
  154261. */
  154262. dispose(): void;
  154263. protected _onXRFrame(frame: XRFrame): void;
  154264. private _init;
  154265. private _updatePlaneWithXRPlane;
  154266. /**
  154267. * avoiding using Array.find for global support.
  154268. * @param xrPlane the plane to find in the array
  154269. */
  154270. private findIndexInPlaneArray;
  154271. }
  154272. }
  154273. declare module BABYLON {
  154274. /**
  154275. * Options interface for the background remover plugin
  154276. */
  154277. export interface IWebXRBackgroundRemoverOptions {
  154278. /**
  154279. * Further background meshes to disable when entering AR
  154280. */
  154281. backgroundMeshes?: AbstractMesh[];
  154282. /**
  154283. * flags to configure the removal of the environment helper.
  154284. * If not set, the entire background will be removed. If set, flags should be set as well.
  154285. */
  154286. environmentHelperRemovalFlags?: {
  154287. /**
  154288. * Should the skybox be removed (default false)
  154289. */
  154290. skyBox?: boolean;
  154291. /**
  154292. * Should the ground be removed (default false)
  154293. */
  154294. ground?: boolean;
  154295. };
  154296. /**
  154297. * don't disable the environment helper
  154298. */
  154299. ignoreEnvironmentHelper?: boolean;
  154300. }
  154301. /**
  154302. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  154303. */
  154304. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  154305. /**
  154306. * read-only options to be used in this module
  154307. */
  154308. readonly options: IWebXRBackgroundRemoverOptions;
  154309. /**
  154310. * The module's name
  154311. */
  154312. static readonly Name: string;
  154313. /**
  154314. * The (Babylon) version of this module.
  154315. * This is an integer representing the implementation version.
  154316. * This number does not correspond to the WebXR specs version
  154317. */
  154318. static readonly Version: number;
  154319. /**
  154320. * registered observers will be triggered when the background state changes
  154321. */
  154322. onBackgroundStateChangedObservable: Observable<boolean>;
  154323. /**
  154324. * constructs a new background remover module
  154325. * @param _xrSessionManager the session manager for this module
  154326. * @param options read-only options to be used in this module
  154327. */
  154328. constructor(_xrSessionManager: WebXRSessionManager,
  154329. /**
  154330. * read-only options to be used in this module
  154331. */
  154332. options?: IWebXRBackgroundRemoverOptions);
  154333. /**
  154334. * attach this feature
  154335. * Will usually be called by the features manager
  154336. *
  154337. * @returns true if successful.
  154338. */
  154339. attach(): boolean;
  154340. /**
  154341. * detach this feature.
  154342. * Will usually be called by the features manager
  154343. *
  154344. * @returns true if successful.
  154345. */
  154346. detach(): boolean;
  154347. /**
  154348. * Dispose this feature and all of the resources attached
  154349. */
  154350. dispose(): void;
  154351. protected _onXRFrame(_xrFrame: XRFrame): void;
  154352. private _setBackgroundState;
  154353. }
  154354. }
  154355. declare module BABYLON {
  154356. /**
  154357. * Options for the controller physics feature
  154358. */
  154359. export class IWebXRControllerPhysicsOptions {
  154360. /**
  154361. * Should the headset get its own impostor
  154362. */
  154363. enableHeadsetImpostor?: boolean;
  154364. /**
  154365. * Optional parameters for the headset impostor
  154366. */
  154367. headsetImpostorParams?: {
  154368. /**
  154369. * The type of impostor to create. Default is sphere
  154370. */
  154371. impostorType: number;
  154372. /**
  154373. * the size of the impostor. Defaults to 10cm
  154374. */
  154375. impostorSize?: number | {
  154376. width: number;
  154377. height: number;
  154378. depth: number;
  154379. };
  154380. /**
  154381. * Friction definitions
  154382. */
  154383. friction?: number;
  154384. /**
  154385. * Restitution
  154386. */
  154387. restitution?: number;
  154388. };
  154389. /**
  154390. * The physics properties of the future impostors
  154391. */
  154392. physicsProperties?: {
  154393. /**
  154394. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  154395. * Note that this requires a physics engine that supports mesh impostors!
  154396. */
  154397. useControllerMesh?: boolean;
  154398. /**
  154399. * The type of impostor to create. Default is sphere
  154400. */
  154401. impostorType?: number;
  154402. /**
  154403. * the size of the impostor. Defaults to 10cm
  154404. */
  154405. impostorSize?: number | {
  154406. width: number;
  154407. height: number;
  154408. depth: number;
  154409. };
  154410. /**
  154411. * Friction definitions
  154412. */
  154413. friction?: number;
  154414. /**
  154415. * Restitution
  154416. */
  154417. restitution?: number;
  154418. };
  154419. /**
  154420. * the xr input to use with this pointer selection
  154421. */
  154422. xrInput: WebXRInput;
  154423. }
  154424. /**
  154425. * Add physics impostor to your webxr controllers,
  154426. * including naive calculation of their linear and angular velocity
  154427. */
  154428. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  154429. private readonly _options;
  154430. private _attachController;
  154431. private _controllers;
  154432. private _debugMode;
  154433. private _delta;
  154434. private _headsetImpostor?;
  154435. private _headsetMesh?;
  154436. private _lastTimestamp;
  154437. private _tmpQuaternion;
  154438. private _tmpVector;
  154439. /**
  154440. * The module's name
  154441. */
  154442. static readonly Name: string;
  154443. /**
  154444. * The (Babylon) version of this module.
  154445. * This is an integer representing the implementation version.
  154446. * This number does not correspond to the webxr specs version
  154447. */
  154448. static readonly Version: number;
  154449. /**
  154450. * Construct a new Controller Physics Feature
  154451. * @param _xrSessionManager the corresponding xr session manager
  154452. * @param _options options to create this feature with
  154453. */
  154454. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  154455. /**
  154456. * @hidden
  154457. * enable debugging - will show console outputs and the impostor mesh
  154458. */
  154459. _enablePhysicsDebug(): void;
  154460. /**
  154461. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  154462. * @param xrController the controller to add
  154463. */
  154464. addController(xrController: WebXRInputSource): void;
  154465. /**
  154466. * attach this feature
  154467. * Will usually be called by the features manager
  154468. *
  154469. * @returns true if successful.
  154470. */
  154471. attach(): boolean;
  154472. /**
  154473. * detach this feature.
  154474. * Will usually be called by the features manager
  154475. *
  154476. * @returns true if successful.
  154477. */
  154478. detach(): boolean;
  154479. /**
  154480. * Get the headset impostor, if enabled
  154481. * @returns the impostor
  154482. */
  154483. getHeadsetImpostor(): PhysicsImpostor | undefined;
  154484. /**
  154485. * Get the physics impostor of a specific controller.
  154486. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  154487. * @param controller the controller or the controller id of which to get the impostor
  154488. * @returns the impostor or null
  154489. */
  154490. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  154491. /**
  154492. * Update the physics properties provided in the constructor
  154493. * @param newProperties the new properties object
  154494. */
  154495. setPhysicsProperties(newProperties: {
  154496. impostorType?: number;
  154497. impostorSize?: number | {
  154498. width: number;
  154499. height: number;
  154500. depth: number;
  154501. };
  154502. friction?: number;
  154503. restitution?: number;
  154504. }): void;
  154505. protected _onXRFrame(_xrFrame: any): void;
  154506. private _detachController;
  154507. }
  154508. }
  154509. declare module BABYLON {
  154510. /**
  154511. * A babylon interface for a "WebXR" feature point.
  154512. * Represents the position and confidence value of a given feature point.
  154513. */
  154514. export interface IWebXRFeaturePoint {
  154515. /**
  154516. * Represents the position of the feature point in world space.
  154517. */
  154518. position: Vector3;
  154519. /**
  154520. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  154521. */
  154522. confidenceValue: number;
  154523. }
  154524. /**
  154525. * The feature point system is used to detect feature points from real world geometry.
  154526. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  154527. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  154528. */
  154529. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  154530. private _enabled;
  154531. private _featurePointCloud;
  154532. /**
  154533. * The module's name
  154534. */
  154535. static readonly Name: string;
  154536. /**
  154537. * The (Babylon) version of this module.
  154538. * This is an integer representing the implementation version.
  154539. * This number does not correspond to the WebXR specs version
  154540. */
  154541. static readonly Version: number;
  154542. /**
  154543. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  154544. * Will notify the observers about which feature points have been added.
  154545. */
  154546. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  154547. /**
  154548. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  154549. * Will notify the observers about which feature points have been updated.
  154550. */
  154551. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  154552. /**
  154553. * The current feature point cloud maintained across frames.
  154554. */
  154555. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  154556. /**
  154557. * construct the feature point system
  154558. * @param _xrSessionManager an instance of xr Session manager
  154559. */
  154560. constructor(_xrSessionManager: WebXRSessionManager);
  154561. /**
  154562. * Detach this feature.
  154563. * Will usually be called by the features manager
  154564. *
  154565. * @returns true if successful.
  154566. */
  154567. detach(): boolean;
  154568. /**
  154569. * Dispose this feature and all of the resources attached
  154570. */
  154571. dispose(): void;
  154572. /**
  154573. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  154574. */
  154575. protected _onXRFrame(frame: XRFrame): void;
  154576. /**
  154577. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  154578. */
  154579. private _init;
  154580. }
  154581. }
  154582. declare module BABYLON {
  154583. /**
  154584. * Configuration interface for the hand tracking feature
  154585. */
  154586. export interface IWebXRHandTrackingOptions {
  154587. /**
  154588. * The xrInput that will be used as source for new hands
  154589. */
  154590. xrInput: WebXRInput;
  154591. /**
  154592. * Configuration object for the joint meshes
  154593. */
  154594. jointMeshes?: {
  154595. /**
  154596. * Should the meshes created be invisible (defaults to false)
  154597. */
  154598. invisible?: boolean;
  154599. /**
  154600. * A source mesh to be used to create instances. Defaults to a sphere.
  154601. * This mesh will be the source for all other (25) meshes.
  154602. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  154603. */
  154604. sourceMesh?: Mesh;
  154605. /**
  154606. * Should the source mesh stay visible. Defaults to false
  154607. */
  154608. keepOriginalVisible?: boolean;
  154609. /**
  154610. * Scale factor for all instances (defaults to 2)
  154611. */
  154612. scaleFactor?: number;
  154613. /**
  154614. * Should each instance have its own physics impostor
  154615. */
  154616. enablePhysics?: boolean;
  154617. /**
  154618. * If enabled, override default physics properties
  154619. */
  154620. physicsProps?: {
  154621. friction?: number;
  154622. restitution?: number;
  154623. impostorType?: number;
  154624. };
  154625. /**
  154626. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  154627. */
  154628. handMesh?: AbstractMesh;
  154629. };
  154630. }
  154631. /**
  154632. * Parts of the hands divided to writs and finger names
  154633. */
  154634. export const enum HandPart {
  154635. /**
  154636. * HandPart - Wrist
  154637. */
  154638. WRIST = "wrist",
  154639. /**
  154640. * HandPart - The THumb
  154641. */
  154642. THUMB = "thumb",
  154643. /**
  154644. * HandPart - Index finger
  154645. */
  154646. INDEX = "index",
  154647. /**
  154648. * HandPart - Middle finger
  154649. */
  154650. MIDDLE = "middle",
  154651. /**
  154652. * HandPart - Ring finger
  154653. */
  154654. RING = "ring",
  154655. /**
  154656. * HandPart - Little finger
  154657. */
  154658. LITTLE = "little"
  154659. }
  154660. /**
  154661. * Representing a single hand (with its corresponding native XRHand object)
  154662. */
  154663. export class WebXRHand implements IDisposable {
  154664. /** the controller to which the hand correlates */
  154665. readonly xrController: WebXRInputSource;
  154666. /** the meshes to be used to track the hand joints */
  154667. readonly trackedMeshes: AbstractMesh[];
  154668. /**
  154669. * Hand-parts definition (key is HandPart)
  154670. */
  154671. static HandPartsDefinition: {
  154672. [key: string]: number[];
  154673. };
  154674. /**
  154675. * Populate the HandPartsDefinition object.
  154676. * This is called as a side effect since certain browsers don't have XRHand defined.
  154677. */
  154678. static _PopulateHandPartsDefinition(): void;
  154679. /**
  154680. * Construct a new hand object
  154681. * @param xrController the controller to which the hand correlates
  154682. * @param trackedMeshes the meshes to be used to track the hand joints
  154683. */
  154684. constructor(
  154685. /** the controller to which the hand correlates */
  154686. xrController: WebXRInputSource,
  154687. /** the meshes to be used to track the hand joints */
  154688. trackedMeshes: AbstractMesh[]);
  154689. /**
  154690. * Update this hand from the latest xr frame
  154691. * @param xrFrame xrFrame to update from
  154692. * @param referenceSpace The current viewer reference space
  154693. * @param scaleFactor optional scale factor for the meshes
  154694. */
  154695. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  154696. /**
  154697. * Get meshes of part of the hand
  154698. * @param part the part of hand to get
  154699. * @returns An array of meshes that correlate to the hand part requested
  154700. */
  154701. getHandPartMeshes(part: HandPart): AbstractMesh[];
  154702. /**
  154703. * Dispose this Hand object
  154704. */
  154705. dispose(): void;
  154706. }
  154707. /**
  154708. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  154709. */
  154710. export class WebXRHandTracking extends WebXRAbstractFeature {
  154711. /**
  154712. * options to use when constructing this feature
  154713. */
  154714. readonly options: IWebXRHandTrackingOptions;
  154715. private static _idCounter;
  154716. /**
  154717. * The module's name
  154718. */
  154719. static readonly Name: string;
  154720. /**
  154721. * The (Babylon) version of this module.
  154722. * This is an integer representing the implementation version.
  154723. * This number does not correspond to the WebXR specs version
  154724. */
  154725. static readonly Version: number;
  154726. /**
  154727. * This observable will notify registered observers when a new hand object was added and initialized
  154728. */
  154729. onHandAddedObservable: Observable<WebXRHand>;
  154730. /**
  154731. * This observable will notify its observers right before the hand object is disposed
  154732. */
  154733. onHandRemovedObservable: Observable<WebXRHand>;
  154734. private _hands;
  154735. /**
  154736. * Creates a new instance of the hit test feature
  154737. * @param _xrSessionManager an instance of WebXRSessionManager
  154738. * @param options options to use when constructing this feature
  154739. */
  154740. constructor(_xrSessionManager: WebXRSessionManager,
  154741. /**
  154742. * options to use when constructing this feature
  154743. */
  154744. options: IWebXRHandTrackingOptions);
  154745. /**
  154746. * Check if the needed objects are defined.
  154747. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  154748. */
  154749. isCompatible(): boolean;
  154750. /**
  154751. * attach this feature
  154752. * Will usually be called by the features manager
  154753. *
  154754. * @returns true if successful.
  154755. */
  154756. attach(): boolean;
  154757. /**
  154758. * detach this feature.
  154759. * Will usually be called by the features manager
  154760. *
  154761. * @returns true if successful.
  154762. */
  154763. detach(): boolean;
  154764. /**
  154765. * Dispose this feature and all of the resources attached
  154766. */
  154767. dispose(): void;
  154768. /**
  154769. * Get the hand object according to the controller id
  154770. * @param controllerId the controller id to which we want to get the hand
  154771. * @returns null if not found or the WebXRHand object if found
  154772. */
  154773. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  154774. /**
  154775. * Get a hand object according to the requested handedness
  154776. * @param handedness the handedness to request
  154777. * @returns null if not found or the WebXRHand object if found
  154778. */
  154779. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  154780. protected _onXRFrame(_xrFrame: XRFrame): void;
  154781. private _attachHand;
  154782. private _detachHand;
  154783. }
  154784. }
  154785. declare module BABYLON {
  154786. /**
  154787. * The motion controller class for all microsoft mixed reality controllers
  154788. */
  154789. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  154790. protected readonly _mapping: {
  154791. defaultButton: {
  154792. valueNodeName: string;
  154793. unpressedNodeName: string;
  154794. pressedNodeName: string;
  154795. };
  154796. defaultAxis: {
  154797. valueNodeName: string;
  154798. minNodeName: string;
  154799. maxNodeName: string;
  154800. };
  154801. buttons: {
  154802. "xr-standard-trigger": {
  154803. rootNodeName: string;
  154804. componentProperty: string;
  154805. states: string[];
  154806. };
  154807. "xr-standard-squeeze": {
  154808. rootNodeName: string;
  154809. componentProperty: string;
  154810. states: string[];
  154811. };
  154812. "xr-standard-touchpad": {
  154813. rootNodeName: string;
  154814. labelAnchorNodeName: string;
  154815. touchPointNodeName: string;
  154816. };
  154817. "xr-standard-thumbstick": {
  154818. rootNodeName: string;
  154819. componentProperty: string;
  154820. states: string[];
  154821. };
  154822. };
  154823. axes: {
  154824. "xr-standard-touchpad": {
  154825. "x-axis": {
  154826. rootNodeName: string;
  154827. };
  154828. "y-axis": {
  154829. rootNodeName: string;
  154830. };
  154831. };
  154832. "xr-standard-thumbstick": {
  154833. "x-axis": {
  154834. rootNodeName: string;
  154835. };
  154836. "y-axis": {
  154837. rootNodeName: string;
  154838. };
  154839. };
  154840. };
  154841. };
  154842. /**
  154843. * The base url used to load the left and right controller models
  154844. */
  154845. static MODEL_BASE_URL: string;
  154846. /**
  154847. * The name of the left controller model file
  154848. */
  154849. static MODEL_LEFT_FILENAME: string;
  154850. /**
  154851. * The name of the right controller model file
  154852. */
  154853. static MODEL_RIGHT_FILENAME: string;
  154854. profileId: string;
  154855. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154856. protected _getFilenameAndPath(): {
  154857. filename: string;
  154858. path: string;
  154859. };
  154860. protected _getModelLoadingConstraints(): boolean;
  154861. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154862. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154863. protected _updateModel(): void;
  154864. }
  154865. }
  154866. declare module BABYLON {
  154867. /**
  154868. * The motion controller class for oculus touch (quest, rift).
  154869. * This class supports legacy mapping as well the standard xr mapping
  154870. */
  154871. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  154872. private _forceLegacyControllers;
  154873. private _modelRootNode;
  154874. /**
  154875. * The base url used to load the left and right controller models
  154876. */
  154877. static MODEL_BASE_URL: string;
  154878. /**
  154879. * The name of the left controller model file
  154880. */
  154881. static MODEL_LEFT_FILENAME: string;
  154882. /**
  154883. * The name of the right controller model file
  154884. */
  154885. static MODEL_RIGHT_FILENAME: string;
  154886. /**
  154887. * Base Url for the Quest controller model.
  154888. */
  154889. static QUEST_MODEL_BASE_URL: string;
  154890. profileId: string;
  154891. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  154892. protected _getFilenameAndPath(): {
  154893. filename: string;
  154894. path: string;
  154895. };
  154896. protected _getModelLoadingConstraints(): boolean;
  154897. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154898. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154899. protected _updateModel(): void;
  154900. /**
  154901. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  154902. * between the touch and touch 2.
  154903. */
  154904. private _isQuest;
  154905. }
  154906. }
  154907. declare module BABYLON {
  154908. /**
  154909. * The motion controller class for the standard HTC-Vive controllers
  154910. */
  154911. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  154912. private _modelRootNode;
  154913. /**
  154914. * The base url used to load the left and right controller models
  154915. */
  154916. static MODEL_BASE_URL: string;
  154917. /**
  154918. * File name for the controller model.
  154919. */
  154920. static MODEL_FILENAME: string;
  154921. profileId: string;
  154922. /**
  154923. * Create a new Vive motion controller object
  154924. * @param scene the scene to use to create this controller
  154925. * @param gamepadObject the corresponding gamepad object
  154926. * @param handedness the handedness of the controller
  154927. */
  154928. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154929. protected _getFilenameAndPath(): {
  154930. filename: string;
  154931. path: string;
  154932. };
  154933. protected _getModelLoadingConstraints(): boolean;
  154934. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154935. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154936. protected _updateModel(): void;
  154937. }
  154938. }
  154939. declare module BABYLON {
  154940. /**
  154941. * A cursor which tracks a point on a path
  154942. */
  154943. export class PathCursor {
  154944. private path;
  154945. /**
  154946. * Stores path cursor callbacks for when an onchange event is triggered
  154947. */
  154948. private _onchange;
  154949. /**
  154950. * The value of the path cursor
  154951. */
  154952. value: number;
  154953. /**
  154954. * The animation array of the path cursor
  154955. */
  154956. animations: Animation[];
  154957. /**
  154958. * Initializes the path cursor
  154959. * @param path The path to track
  154960. */
  154961. constructor(path: Path2);
  154962. /**
  154963. * Gets the cursor point on the path
  154964. * @returns A point on the path cursor at the cursor location
  154965. */
  154966. getPoint(): Vector3;
  154967. /**
  154968. * Moves the cursor ahead by the step amount
  154969. * @param step The amount to move the cursor forward
  154970. * @returns This path cursor
  154971. */
  154972. moveAhead(step?: number): PathCursor;
  154973. /**
  154974. * Moves the cursor behind by the step amount
  154975. * @param step The amount to move the cursor back
  154976. * @returns This path cursor
  154977. */
  154978. moveBack(step?: number): PathCursor;
  154979. /**
  154980. * Moves the cursor by the step amount
  154981. * If the step amount is greater than one, an exception is thrown
  154982. * @param step The amount to move the cursor
  154983. * @returns This path cursor
  154984. */
  154985. move(step: number): PathCursor;
  154986. /**
  154987. * Ensures that the value is limited between zero and one
  154988. * @returns This path cursor
  154989. */
  154990. private ensureLimits;
  154991. /**
  154992. * Runs onchange callbacks on change (used by the animation engine)
  154993. * @returns This path cursor
  154994. */
  154995. private raiseOnChange;
  154996. /**
  154997. * Executes a function on change
  154998. * @param f A path cursor onchange callback
  154999. * @returns This path cursor
  155000. */
  155001. onchange(f: (cursor: PathCursor) => void): PathCursor;
  155002. }
  155003. }
  155004. declare module BABYLON {
  155005. /** @hidden */
  155006. export var blurPixelShader: {
  155007. name: string;
  155008. shader: string;
  155009. };
  155010. }
  155011. declare module BABYLON {
  155012. /** @hidden */
  155013. export var pointCloudVertexDeclaration: {
  155014. name: string;
  155015. shader: string;
  155016. };
  155017. }
  155018. // Mixins
  155019. interface Window {
  155020. mozIndexedDB: IDBFactory;
  155021. webkitIndexedDB: IDBFactory;
  155022. msIndexedDB: IDBFactory;
  155023. webkitURL: typeof URL;
  155024. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  155025. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  155026. WebGLRenderingContext: WebGLRenderingContext;
  155027. MSGesture: MSGesture;
  155028. CANNON: any;
  155029. AudioContext: AudioContext;
  155030. webkitAudioContext: AudioContext;
  155031. PointerEvent: any;
  155032. Math: Math;
  155033. Uint8Array: Uint8ArrayConstructor;
  155034. Float32Array: Float32ArrayConstructor;
  155035. mozURL: typeof URL;
  155036. msURL: typeof URL;
  155037. VRFrameData: any; // WebVR, from specs 1.1
  155038. DracoDecoderModule: any;
  155039. setImmediate(handler: (...args: any[]) => void): number;
  155040. }
  155041. interface HTMLCanvasElement {
  155042. requestPointerLock(): void;
  155043. msRequestPointerLock?(): void;
  155044. mozRequestPointerLock?(): void;
  155045. webkitRequestPointerLock?(): void;
  155046. /** Track wether a record is in progress */
  155047. isRecording: boolean;
  155048. /** Capture Stream method defined by some browsers */
  155049. captureStream(fps?: number): MediaStream;
  155050. }
  155051. interface CanvasRenderingContext2D {
  155052. msImageSmoothingEnabled: boolean;
  155053. }
  155054. interface MouseEvent {
  155055. mozMovementX: number;
  155056. mozMovementY: number;
  155057. webkitMovementX: number;
  155058. webkitMovementY: number;
  155059. msMovementX: number;
  155060. msMovementY: number;
  155061. }
  155062. interface Navigator {
  155063. mozGetVRDevices: (any: any) => any;
  155064. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155065. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155066. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155067. webkitGetGamepads(): Gamepad[];
  155068. msGetGamepads(): Gamepad[];
  155069. webkitGamepads(): Gamepad[];
  155070. }
  155071. interface HTMLVideoElement {
  155072. mozSrcObject: any;
  155073. }
  155074. interface Math {
  155075. fround(x: number): number;
  155076. imul(a: number, b: number): number;
  155077. }
  155078. interface WebGLRenderingContext {
  155079. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  155080. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  155081. vertexAttribDivisor(index: number, divisor: number): void;
  155082. createVertexArray(): any;
  155083. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  155084. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  155085. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  155086. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  155087. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  155088. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  155089. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  155090. // Queries
  155091. createQuery(): WebGLQuery;
  155092. deleteQuery(query: WebGLQuery): void;
  155093. beginQuery(target: number, query: WebGLQuery): void;
  155094. endQuery(target: number): void;
  155095. getQueryParameter(query: WebGLQuery, pname: number): any;
  155096. getQuery(target: number, pname: number): any;
  155097. MAX_SAMPLES: number;
  155098. RGBA8: number;
  155099. READ_FRAMEBUFFER: number;
  155100. DRAW_FRAMEBUFFER: number;
  155101. UNIFORM_BUFFER: number;
  155102. HALF_FLOAT_OES: number;
  155103. RGBA16F: number;
  155104. RGBA32F: number;
  155105. R32F: number;
  155106. RG32F: number;
  155107. RGB32F: number;
  155108. R16F: number;
  155109. RG16F: number;
  155110. RGB16F: number;
  155111. RED: number;
  155112. RG: number;
  155113. R8: number;
  155114. RG8: number;
  155115. UNSIGNED_INT_24_8: number;
  155116. DEPTH24_STENCIL8: number;
  155117. MIN: number;
  155118. MAX: number;
  155119. /* Multiple Render Targets */
  155120. drawBuffers(buffers: number[]): void;
  155121. readBuffer(src: number): void;
  155122. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  155123. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  155124. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  155125. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  155126. // Occlusion Query
  155127. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  155128. ANY_SAMPLES_PASSED: number;
  155129. QUERY_RESULT_AVAILABLE: number;
  155130. QUERY_RESULT: number;
  155131. }
  155132. interface WebGLProgram {
  155133. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  155134. }
  155135. interface EXT_disjoint_timer_query {
  155136. QUERY_COUNTER_BITS_EXT: number;
  155137. TIME_ELAPSED_EXT: number;
  155138. TIMESTAMP_EXT: number;
  155139. GPU_DISJOINT_EXT: number;
  155140. QUERY_RESULT_EXT: number;
  155141. QUERY_RESULT_AVAILABLE_EXT: number;
  155142. queryCounterEXT(query: WebGLQuery, target: number): void;
  155143. createQueryEXT(): WebGLQuery;
  155144. beginQueryEXT(target: number, query: WebGLQuery): void;
  155145. endQueryEXT(target: number): void;
  155146. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  155147. deleteQueryEXT(query: WebGLQuery): void;
  155148. }
  155149. interface WebGLUniformLocation {
  155150. _currentState: any;
  155151. }
  155152. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  155153. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  155154. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  155155. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155156. interface WebGLRenderingContext {
  155157. readonly RASTERIZER_DISCARD: number;
  155158. readonly DEPTH_COMPONENT24: number;
  155159. readonly TEXTURE_3D: number;
  155160. readonly TEXTURE_2D_ARRAY: number;
  155161. readonly TEXTURE_COMPARE_FUNC: number;
  155162. readonly TEXTURE_COMPARE_MODE: number;
  155163. readonly COMPARE_REF_TO_TEXTURE: number;
  155164. readonly TEXTURE_WRAP_R: number;
  155165. readonly HALF_FLOAT: number;
  155166. readonly RGB8: number;
  155167. readonly RED_INTEGER: number;
  155168. readonly RG_INTEGER: number;
  155169. readonly RGB_INTEGER: number;
  155170. readonly RGBA_INTEGER: number;
  155171. readonly R8_SNORM: number;
  155172. readonly RG8_SNORM: number;
  155173. readonly RGB8_SNORM: number;
  155174. readonly RGBA8_SNORM: number;
  155175. readonly R8I: number;
  155176. readonly RG8I: number;
  155177. readonly RGB8I: number;
  155178. readonly RGBA8I: number;
  155179. readonly R8UI: number;
  155180. readonly RG8UI: number;
  155181. readonly RGB8UI: number;
  155182. readonly RGBA8UI: number;
  155183. readonly R16I: number;
  155184. readonly RG16I: number;
  155185. readonly RGB16I: number;
  155186. readonly RGBA16I: number;
  155187. readonly R16UI: number;
  155188. readonly RG16UI: number;
  155189. readonly RGB16UI: number;
  155190. readonly RGBA16UI: number;
  155191. readonly R32I: number;
  155192. readonly RG32I: number;
  155193. readonly RGB32I: number;
  155194. readonly RGBA32I: number;
  155195. readonly R32UI: number;
  155196. readonly RG32UI: number;
  155197. readonly RGB32UI: number;
  155198. readonly RGBA32UI: number;
  155199. readonly RGB10_A2UI: number;
  155200. readonly R11F_G11F_B10F: number;
  155201. readonly RGB9_E5: number;
  155202. readonly RGB10_A2: number;
  155203. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  155204. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  155205. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  155206. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  155207. readonly DEPTH_COMPONENT32F: number;
  155208. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  155209. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  155210. 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;
  155211. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  155212. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  155213. readonly TRANSFORM_FEEDBACK: number;
  155214. readonly INTERLEAVED_ATTRIBS: number;
  155215. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  155216. createTransformFeedback(): WebGLTransformFeedback;
  155217. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  155218. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  155219. beginTransformFeedback(primitiveMode: number): void;
  155220. endTransformFeedback(): void;
  155221. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  155222. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155223. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155224. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155225. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  155226. }
  155227. interface ImageBitmap {
  155228. readonly width: number;
  155229. readonly height: number;
  155230. close(): void;
  155231. }
  155232. interface WebGLQuery extends WebGLObject {
  155233. }
  155234. declare var WebGLQuery: {
  155235. prototype: WebGLQuery;
  155236. new(): WebGLQuery;
  155237. };
  155238. interface WebGLSampler extends WebGLObject {
  155239. }
  155240. declare var WebGLSampler: {
  155241. prototype: WebGLSampler;
  155242. new(): WebGLSampler;
  155243. };
  155244. interface WebGLSync extends WebGLObject {
  155245. }
  155246. declare var WebGLSync: {
  155247. prototype: WebGLSync;
  155248. new(): WebGLSync;
  155249. };
  155250. interface WebGLTransformFeedback extends WebGLObject {
  155251. }
  155252. declare var WebGLTransformFeedback: {
  155253. prototype: WebGLTransformFeedback;
  155254. new(): WebGLTransformFeedback;
  155255. };
  155256. interface WebGLVertexArrayObject extends WebGLObject {
  155257. }
  155258. declare var WebGLVertexArrayObject: {
  155259. prototype: WebGLVertexArrayObject;
  155260. new(): WebGLVertexArrayObject;
  155261. };
  155262. // Type definitions for WebVR API
  155263. // Project: https://w3c.github.io/webvr/
  155264. // Definitions by: six a <https://github.com/lostfictions>
  155265. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155266. interface VRDisplay extends EventTarget {
  155267. /**
  155268. * Dictionary of capabilities describing the VRDisplay.
  155269. */
  155270. readonly capabilities: VRDisplayCapabilities;
  155271. /**
  155272. * z-depth defining the far plane of the eye view frustum
  155273. * enables mapping of values in the render target depth
  155274. * attachment to scene coordinates. Initially set to 10000.0.
  155275. */
  155276. depthFar: number;
  155277. /**
  155278. * z-depth defining the near plane of the eye view frustum
  155279. * enables mapping of values in the render target depth
  155280. * attachment to scene coordinates. Initially set to 0.01.
  155281. */
  155282. depthNear: number;
  155283. /**
  155284. * An identifier for this distinct VRDisplay. Used as an
  155285. * association point in the Gamepad API.
  155286. */
  155287. readonly displayId: number;
  155288. /**
  155289. * A display name, a user-readable name identifying it.
  155290. */
  155291. readonly displayName: string;
  155292. readonly isConnected: boolean;
  155293. readonly isPresenting: boolean;
  155294. /**
  155295. * If this VRDisplay supports room-scale experiences, the optional
  155296. * stage attribute contains details on the room-scale parameters.
  155297. */
  155298. readonly stageParameters: VRStageParameters | null;
  155299. /**
  155300. * Passing the value returned by `requestAnimationFrame` to
  155301. * `cancelAnimationFrame` will unregister the callback.
  155302. * @param handle Define the hanle of the request to cancel
  155303. */
  155304. cancelAnimationFrame(handle: number): void;
  155305. /**
  155306. * Stops presenting to the VRDisplay.
  155307. * @returns a promise to know when it stopped
  155308. */
  155309. exitPresent(): Promise<void>;
  155310. /**
  155311. * Return the current VREyeParameters for the given eye.
  155312. * @param whichEye Define the eye we want the parameter for
  155313. * @returns the eye parameters
  155314. */
  155315. getEyeParameters(whichEye: string): VREyeParameters;
  155316. /**
  155317. * Populates the passed VRFrameData with the information required to render
  155318. * the current frame.
  155319. * @param frameData Define the data structure to populate
  155320. * @returns true if ok otherwise false
  155321. */
  155322. getFrameData(frameData: VRFrameData): boolean;
  155323. /**
  155324. * Get the layers currently being presented.
  155325. * @returns the list of VR layers
  155326. */
  155327. getLayers(): VRLayer[];
  155328. /**
  155329. * Return a VRPose containing the future predicted pose of the VRDisplay
  155330. * when the current frame will be presented. The value returned will not
  155331. * change until JavaScript has returned control to the browser.
  155332. *
  155333. * The VRPose will contain the position, orientation, velocity,
  155334. * and acceleration of each of these properties.
  155335. * @returns the pose object
  155336. */
  155337. getPose(): VRPose;
  155338. /**
  155339. * Return the current instantaneous pose of the VRDisplay, with no
  155340. * prediction applied.
  155341. * @returns the current instantaneous pose
  155342. */
  155343. getImmediatePose(): VRPose;
  155344. /**
  155345. * The callback passed to `requestAnimationFrame` will be called
  155346. * any time a new frame should be rendered. When the VRDisplay is
  155347. * presenting the callback will be called at the native refresh
  155348. * rate of the HMD. When not presenting this function acts
  155349. * identically to how window.requestAnimationFrame acts. Content should
  155350. * make no assumptions of frame rate or vsync behavior as the HMD runs
  155351. * asynchronously from other displays and at differing refresh rates.
  155352. * @param callback Define the eaction to run next frame
  155353. * @returns the request handle it
  155354. */
  155355. requestAnimationFrame(callback: FrameRequestCallback): number;
  155356. /**
  155357. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  155358. * Repeat calls while already presenting will update the VRLayers being displayed.
  155359. * @param layers Define the list of layer to present
  155360. * @returns a promise to know when the request has been fulfilled
  155361. */
  155362. requestPresent(layers: VRLayer[]): Promise<void>;
  155363. /**
  155364. * Reset the pose for this display, treating its current position and
  155365. * orientation as the "origin/zero" values. VRPose.position,
  155366. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  155367. * updated when calling resetPose(). This should be called in only
  155368. * sitting-space experiences.
  155369. */
  155370. resetPose(): void;
  155371. /**
  155372. * The VRLayer provided to the VRDisplay will be captured and presented
  155373. * in the HMD. Calling this function has the same effect on the source
  155374. * canvas as any other operation that uses its source image, and canvases
  155375. * created without preserveDrawingBuffer set to true will be cleared.
  155376. * @param pose Define the pose to submit
  155377. */
  155378. submitFrame(pose?: VRPose): void;
  155379. }
  155380. declare var VRDisplay: {
  155381. prototype: VRDisplay;
  155382. new(): VRDisplay;
  155383. };
  155384. interface VRLayer {
  155385. leftBounds?: number[] | Float32Array | null;
  155386. rightBounds?: number[] | Float32Array | null;
  155387. source?: HTMLCanvasElement | null;
  155388. }
  155389. interface VRDisplayCapabilities {
  155390. readonly canPresent: boolean;
  155391. readonly hasExternalDisplay: boolean;
  155392. readonly hasOrientation: boolean;
  155393. readonly hasPosition: boolean;
  155394. readonly maxLayers: number;
  155395. }
  155396. interface VREyeParameters {
  155397. /** @deprecated */
  155398. readonly fieldOfView: VRFieldOfView;
  155399. readonly offset: Float32Array;
  155400. readonly renderHeight: number;
  155401. readonly renderWidth: number;
  155402. }
  155403. interface VRFieldOfView {
  155404. readonly downDegrees: number;
  155405. readonly leftDegrees: number;
  155406. readonly rightDegrees: number;
  155407. readonly upDegrees: number;
  155408. }
  155409. interface VRFrameData {
  155410. readonly leftProjectionMatrix: Float32Array;
  155411. readonly leftViewMatrix: Float32Array;
  155412. readonly pose: VRPose;
  155413. readonly rightProjectionMatrix: Float32Array;
  155414. readonly rightViewMatrix: Float32Array;
  155415. readonly timestamp: number;
  155416. }
  155417. interface VRPose {
  155418. readonly angularAcceleration: Float32Array | null;
  155419. readonly angularVelocity: Float32Array | null;
  155420. readonly linearAcceleration: Float32Array | null;
  155421. readonly linearVelocity: Float32Array | null;
  155422. readonly orientation: Float32Array | null;
  155423. readonly position: Float32Array | null;
  155424. readonly timestamp: number;
  155425. }
  155426. interface VRStageParameters {
  155427. sittingToStandingTransform?: Float32Array;
  155428. sizeX?: number;
  155429. sizeY?: number;
  155430. }
  155431. interface Navigator {
  155432. getVRDisplays(): Promise<VRDisplay[]>;
  155433. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  155434. }
  155435. interface Window {
  155436. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  155437. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  155438. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  155439. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155440. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155441. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  155442. }
  155443. interface Gamepad {
  155444. readonly displayId: number;
  155445. }
  155446. type XRSessionMode = "inline" | "immersive-vr" | "immersive-ar";
  155447. type XRReferenceSpaceType = "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded";
  155448. type XREnvironmentBlendMode = "opaque" | "additive" | "alpha-blend";
  155449. type XRVisibilityState = "visible" | "visible-blurred" | "hidden";
  155450. type XRHandedness = "none" | "left" | "right";
  155451. type XRTargetRayMode = "gaze" | "tracked-pointer" | "screen";
  155452. type XREye = "none" | "left" | "right";
  155453. type XREventType = "devicechange" | "visibilitychange" | "end" | "inputsourceschange" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "reset";
  155454. interface XRSpace extends EventTarget {}
  155455. interface XRRenderState {
  155456. depthNear?: number;
  155457. depthFar?: number;
  155458. inlineVerticalFieldOfView?: number;
  155459. baseLayer?: XRWebGLLayer;
  155460. }
  155461. interface XRInputSource {
  155462. handedness: XRHandedness;
  155463. targetRayMode: XRTargetRayMode;
  155464. targetRaySpace: XRSpace;
  155465. gripSpace: XRSpace | undefined;
  155466. gamepad: Gamepad | undefined;
  155467. profiles: Array<string>;
  155468. hand: XRHand | undefined;
  155469. }
  155470. interface XRSessionInit {
  155471. optionalFeatures?: string[];
  155472. requiredFeatures?: string[];
  155473. }
  155474. interface XRSession {
  155475. addEventListener: Function;
  155476. removeEventListener: Function;
  155477. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  155478. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  155479. requestAnimationFrame: Function;
  155480. end(): Promise<void>;
  155481. renderState: XRRenderState;
  155482. inputSources: Array<XRInputSource>;
  155483. // hit test
  155484. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  155485. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  155486. // legacy AR hit test
  155487. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  155488. // legacy plane detection
  155489. updateWorldTrackingState(options: { planeDetectionState?: { enabled: boolean } }): void;
  155490. }
  155491. interface XRReferenceSpace extends XRSpace {
  155492. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  155493. onreset: any;
  155494. }
  155495. type XRPlaneSet = Set<XRPlane>;
  155496. type XRAnchorSet = Set<XRAnchor>;
  155497. interface XRFrame {
  155498. session: XRSession;
  155499. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  155500. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  155501. // AR
  155502. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult>;
  155503. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  155504. // Anchors
  155505. trackedAnchors?: XRAnchorSet;
  155506. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  155507. // Planes
  155508. worldInformation: {
  155509. detectedPlanes?: XRPlaneSet;
  155510. };
  155511. // Hand tracking
  155512. getJointPose(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose;
  155513. }
  155514. interface XRViewerPose extends XRPose {
  155515. views: Array<XRView>;
  155516. }
  155517. interface XRPose {
  155518. transform: XRRigidTransform;
  155519. emulatedPosition: boolean;
  155520. }
  155521. interface XRWebGLLayerOptions {
  155522. antialias?: boolean;
  155523. depth?: boolean;
  155524. stencil?: boolean;
  155525. alpha?: boolean;
  155526. multiview?: boolean;
  155527. framebufferScaleFactor?: number;
  155528. }
  155529. declare var XRWebGLLayer: {
  155530. prototype: XRWebGLLayer;
  155531. new (session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  155532. };
  155533. interface XRWebGLLayer {
  155534. framebuffer: WebGLFramebuffer;
  155535. framebufferWidth: number;
  155536. framebufferHeight: number;
  155537. getViewport: Function;
  155538. }
  155539. declare class XRRigidTransform {
  155540. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  155541. position: DOMPointReadOnly;
  155542. orientation: DOMPointReadOnly;
  155543. matrix: Float32Array;
  155544. inverse: XRRigidTransform;
  155545. }
  155546. interface XRView {
  155547. eye: XREye;
  155548. projectionMatrix: Float32Array;
  155549. transform: XRRigidTransform;
  155550. }
  155551. interface XRInputSourceChangeEvent {
  155552. session: XRSession;
  155553. removed: Array<XRInputSource>;
  155554. added: Array<XRInputSource>;
  155555. }
  155556. interface XRInputSourceEvent extends Event {
  155557. readonly frame: XRFrame;
  155558. readonly inputSource: XRInputSource;
  155559. }
  155560. // Experimental(er) features
  155561. declare class XRRay {
  155562. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  155563. origin: DOMPointReadOnly;
  155564. direction: DOMPointReadOnly;
  155565. matrix: Float32Array;
  155566. }
  155567. declare enum XRHitTestTrackableType {
  155568. "point",
  155569. "plane",
  155570. "mesh",
  155571. }
  155572. interface XRHitResult {
  155573. hitMatrix: Float32Array;
  155574. }
  155575. interface XRTransientInputHitTestResult {
  155576. readonly inputSource: XRInputSource;
  155577. readonly results: Array<XRHitTestResult>;
  155578. }
  155579. interface XRHitTestResult {
  155580. getPose(baseSpace: XRSpace): XRPose | undefined;
  155581. // When anchor system is enabled
  155582. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  155583. }
  155584. interface XRHitTestSource {
  155585. cancel(): void;
  155586. }
  155587. interface XRTransientInputHitTestSource {
  155588. cancel(): void;
  155589. }
  155590. interface XRHitTestOptionsInit {
  155591. space: XRSpace;
  155592. entityTypes?: Array<XRHitTestTrackableType>;
  155593. offsetRay?: XRRay;
  155594. }
  155595. interface XRTransientInputHitTestOptionsInit {
  155596. profile: string;
  155597. entityTypes?: Array<XRHitTestTrackableType>;
  155598. offsetRay?: XRRay;
  155599. }
  155600. interface XRAnchor {
  155601. anchorSpace: XRSpace;
  155602. delete(): void;
  155603. }
  155604. interface XRPlane {
  155605. orientation: "Horizontal" | "Vertical";
  155606. planeSpace: XRSpace;
  155607. polygon: Array<DOMPointReadOnly>;
  155608. lastChangedTime: number;
  155609. }
  155610. interface XRJointSpace extends XRSpace {}
  155611. interface XRJointPose extends XRPose {
  155612. radius: number | undefined;
  155613. }
  155614. declare class XRHand extends Array<XRJointSpace> {
  155615. readonly length: number;
  155616. static readonly WRIST = 0;
  155617. static readonly THUMB_METACARPAL = 1;
  155618. static readonly THUMB_PHALANX_PROXIMAL = 2;
  155619. static readonly THUMB_PHALANX_DISTAL = 3;
  155620. static readonly THUMB_PHALANX_TIP = 4;
  155621. static readonly INDEX_METACARPAL = 5;
  155622. static readonly INDEX_PHALANX_PROXIMAL = 6;
  155623. static readonly INDEX_PHALANX_INTERMEDIATE = 7;
  155624. static readonly INDEX_PHALANX_DISTAL = 8;
  155625. static readonly INDEX_PHALANX_TIP = 9;
  155626. static readonly MIDDLE_METACARPAL = 10;
  155627. static readonly MIDDLE_PHALANX_PROXIMAL = 11;
  155628. static readonly MIDDLE_PHALANX_INTERMEDIATE = 12;
  155629. static readonly MIDDLE_PHALANX_DISTAL = 13;
  155630. static readonly MIDDLE_PHALANX_TIP = 14;
  155631. static readonly RING_METACARPAL = 15;
  155632. static readonly RING_PHALANX_PROXIMAL = 16;
  155633. static readonly RING_PHALANX_INTERMEDIATE = 17;
  155634. static readonly RING_PHALANX_DISTAL = 18;
  155635. static readonly RING_PHALANX_TIP = 19;
  155636. static readonly LITTLE_METACARPAL = 20;
  155637. static readonly LITTLE_PHALANX_PROXIMAL = 21;
  155638. static readonly LITTLE_PHALANX_INTERMEDIATE = 22;
  155639. static readonly LITTLE_PHALANX_DISTAL = 23;
  155640. static readonly LITTLE_PHALANX_TIP = 24;
  155641. }
  155642. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  155643. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  155644. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  155645. interface XRSession {
  155646. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  155647. }
  155648. interface XRFrame {
  155649. featurePointCloud? : Array<number>;
  155650. }